Class URI

Constructors

constructor

new URI(uri?: string | URI): URI
Parameters
- uri: string | URI = ''
Returns URI
- Defined in packages/core/src/common/uri.ts:35

Accessors

allLocations

get allLocations(): URI[]
Return all uri from the current to the top most.

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

authority

get authority(): string
Returns string
- Defined in packages/core/src/common/uri.ts:199

displayName

get displayName(): string
TODO move implementation to DefaultUriLabelProviderContribution.getName

Returns string
Deprecated
use LabelProvider.getName instead
- Defined in packages/core/src/common/uri.ts:48

fragment

get fragment(): string
Returns string
- Defined in packages/core/src/common/uri.ts:214

parent

get parent(): URI
Returns URI
- Defined in packages/core/src/common/uri.ts:73

path

get path(): Path
Returns Path
- Defined in packages/core/src/common/uri.ts:203

query

get query(): string
Returns string
- Defined in packages/core/src/common/uri.ts:210

scheme

get scheme(): string
Returns string
- Defined in packages/core/src/common/uri.ts:195

Methods

isEqual

isEqual(uri: URI, caseSensitive?: boolean): boolean
Parameters
- uri: URI
- caseSensitive: boolean = true
Returns boolean
- Defined in packages/core/src/common/uri.ts:222

isEqualOrParent

isEqualOrParent(uri: URI, caseSensitive?: boolean): boolean
Parameters
- uri: URI
- caseSensitive: boolean = true
Returns boolean
- Defined in packages/core/src/common/uri.ts:232

normalizePath

normalizePath(): URI
return a new URI replacing the current with its normalized path, resolving '..' and '.' segments

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

relative

relative(uri: URI): undefined | Path
Parameters
- uri: URI
Returns undefined | Path
- Defined in packages/core/src/common/uri.ts:80

resolve

resolve(path: string | Path): URI
Parameters
- path: string | Path
Returns URI
- Defined in packages/core/src/common/uri.ts:87

resolveToAbsolute

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

toComponents

toComponents(): UriComponents
Returns UriComponents
- Defined in packages/core/src/common/uri.ts:259

toString

toString(skipEncoding?: boolean): string
Parameters
- OptionalskipEncoding: boolean
Returns string
- Defined in packages/core/src/common/uri.ts:218

withAuthority

withAuthority(authority: string): URI
return a new URI replacing the current with the given authority
Parameters
- authority: string
Returns URI
- Defined in packages/core/src/common/uri.ts:115

withFragment

withFragment(fragment: string): URI
return a new URI replacing the current with the given fragment
Parameters
- fragment: string
Returns URI
- Defined in packages/core/src/common/uri.ts:172

withoutAuthority

withoutAuthority(): URI
return this URI without a authority

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

withoutFragment

withoutFragment(): URI
return this URI without a fragment

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

withoutPath

withoutPath(): URI
return this URI without a path

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

withoutQuery

withoutQuery(): URI
return this URI without a query

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

withPath

withPath(path: string | Path): URI
return a new URI replacing the current with the given path
Parameters
- path: string | Path
Returns URI
- Defined in packages/core/src/common/uri.ts:134

withQuery

withQuery(query: string): URI
return a new URI replacing the current with the given query
Parameters
- query: string
Returns URI
- Defined in packages/core/src/common/uri.ts:153

withScheme

withScheme(scheme: string): URI
return a new URI replacing the current with the given scheme
Parameters
- scheme: string
Returns URI
- Defined in packages/core/src/common/uri.ts:104

`Static`fromComponents

fromComponents(components: UriComponents): URI
Parameters
- components: UriComponents
Returns URI
- Defined in packages/core/src/common/uri.ts:22
fromComponents(components: undefined): undefined
Parameters
- components: undefined
Returns undefined
- Defined in packages/core/src/common/uri.ts:23

`Static`fromFilePath

fromFilePath(path: string): URI
Parameters
- path: string
Returns URI
- Defined in packages/core/src/common/uri.ts:28

`Static`getDistinctParents

getDistinctParents(uris: URI[]): URI[]
Parameters
- uris: URI[]
Returns URI[]
- Defined in packages/core/src/common/uri.ts:245