Function asRelativePath

asRelativePath(
pathOrUri: string | Uri,
includeWorkspaceFolder?: boolean,
): undefined | string
Returns a path that is relative to the workspace folder or folders.

When there are no workspace folders or when the path is not contained in them, the input is returned.
Parameters
- pathOrUri: string | Uri
  A path or uri. When a uri is given its fsPath is used.
- OptionalincludeWorkspaceFolder: boolean
  When true and when the given path is contained inside a workspace folder the name of the workspace is prepended. Defaults to true when there are multiple workspace folders and false otherwise.
Returns undefined | string
A path relative to the root or the input.
- Defined in packages/plugin/src/theia.d.ts:8185