Class URI

Hierarchy

URI

Constructors

constructor

new URI(uri?: string | URI): URI

- Defined in packages/core/src/common/uri.ts:33
Parameters
- uri: string | URI = ''
Returns URI

Properties

Private _path

_path: undefined | Path

Private Readonly codeUri

codeUri: URI

Accessors

allLocations

get allLocations(): URI[]

- Defined in packages/core/src/common/uri.ts:60
Return all uri from the current to the top most.

Returns URI[]

authority

get authority(): string

- Defined in packages/core/src/common/uri.ts:197
Returns string

displayName

get displayName(): string

- Defined in packages/core/src/common/uri.ts:46
TODO move implementation to DefaultUriLabelProviderContribution.getName

deprecated
use LabelProvider.getName instead

Returns string

fragment

get fragment(): string

- Defined in packages/core/src/common/uri.ts:212
Returns string

parent

get parent(): URI

- Defined in packages/core/src/common/uri.ts:71
Returns URI

path

get path(): Path

- Defined in packages/core/src/common/uri.ts:201
Returns Path

query

get query(): string

- Defined in packages/core/src/common/uri.ts:208
Returns string

scheme

get scheme(): string

- Defined in packages/core/src/common/uri.ts:193
Returns string

Methods

Private hasSameOrigin

hasSameOrigin(uri: URI): boolean

- Defined in packages/core/src/common/uri.ts:253
Parameters
- uri: URI
Returns boolean

isEqual

isEqual(uri: URI, caseSensitive?: boolean): boolean

- Defined in packages/core/src/common/uri.ts:220
Parameters
- uri: URI
- caseSensitive: boolean = true
Returns boolean

isEqualOrParent

isEqualOrParent(uri: URI, caseSensitive?: boolean): boolean

- Defined in packages/core/src/common/uri.ts:230
Parameters
- uri: URI
- caseSensitive: boolean = true
Returns boolean

normalizePath

normalizePath(): URI

- Defined in packages/core/src/common/uri.ts:189
return a new URI replacing the current with its normalized path, resolving '..' and '.' segments

Returns URI

relative

relative(uri: URI): undefined | Path

- Defined in packages/core/src/common/uri.ts:78
Parameters
- uri: URI
Returns undefined | Path

resolve

resolve(path: string | Path): URI

- Defined in packages/core/src/common/uri.ts:85
Parameters
- path: string | Path
Returns URI

resolveToAbsolute

resolveToAbsolute(...pathSegments: (string | Path)[]): undefined | URI

- Defined in packages/core/src/common/uri.ts:92
Parameters
- Rest ...pathSegments: (string | Path)[]
Returns undefined | URI
a new, absolute URI if one can be computed from the path segments passed in.

toComponents

toComponents(): UriComponents

- Defined in packages/core/src/common/uri.ts:257
Returns UriComponents

toString

toString(skipEncoding?: boolean): string

- Defined in packages/core/src/common/uri.ts:216
Parameters
- Optional skipEncoding: boolean
Returns string

withAuthority

withAuthority(authority: string): URI

- Defined in packages/core/src/common/uri.ts:113
return a new URI replacing the current with the given authority

Parameters
- authority: string
Returns URI

withFragment

withFragment(fragment: string): URI

- Defined in packages/core/src/common/uri.ts:170
return a new URI replacing the current with the given fragment

Parameters
- fragment: string
Returns URI

withPath

withPath(path: string | Path): URI

- Defined in packages/core/src/common/uri.ts:132
return a new URI replacing the current with the given path

Parameters
- path: string | Path
Returns URI

withQuery

withQuery(query: string): URI

- Defined in packages/core/src/common/uri.ts:151
return a new URI replacing the current with the given query

Parameters
- query: string
Returns URI

withScheme

withScheme(scheme: string): URI

- Defined in packages/core/src/common/uri.ts:102
return a new URI replacing the current with the given scheme

Parameters
- scheme: string
Returns URI

withoutAuthority

withoutAuthority(): URI

- Defined in packages/core/src/common/uri.ts:125
return this URI without a authority

Returns URI

withoutFragment

withoutFragment(): URI

- Defined in packages/core/src/common/uri.ts:182
return this URI without a fragment

Returns URI

withoutPath

withoutPath(): URI

- Defined in packages/core/src/common/uri.ts:144
return this URI without a path

Returns URI

withoutQuery

withoutQuery(): URI

- Defined in packages/core/src/common/uri.ts:163
return this URI without a query

Returns URI

Static fromComponents

fromComponents(components: UriComponents): URI

- Defined in packages/core/src/common/uri.ts:22
Parameters
- components: UriComponents
Returns URI

Static fromFilePath

fromFilePath(path: string): URI

- Defined in packages/core/src/common/uri.ts:26
Parameters
- path: string
Returns URI

Static getDistinctParents

getDistinctParents(uris: URI[]): URI[]

- Defined in packages/core/src/common/uri.ts:243
Parameters
- uris: URI[]
Returns URI[]