<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > Uri | VS Code API< / title >
< meta name = "description" content = "Documentation for VS Code API" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.json" data-base = ".." >
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
< a href = "../index.html" class = "title" > VS Code API< / a >
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< input type = "checkbox" id = "tsd-filter-externals" checked / >
< label class = "tsd-widget" for = "tsd-filter-externals" > Externals< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
< a href = "../modules.html" > VS Code API< / a >
< / li >
< li >
< a href = "Uri.html" > Uri< / a >
< / li >
< / ul >
< h1 > Class Uri< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< section class = "tsd-panel tsd-comment" >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > A universal resource identifier representing either a file on disk
or another resource, like untitled resources.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > Uri< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > Index< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section " >
< h3 > Methods< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static" > < a href = "Uri.html#parse" class = "tsd-kind-icon" > parse< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static" > < a href = "Uri.html#file" class = "tsd-kind-icon" > file< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static" > < a href = "Uri.html#joinPath" class = "tsd-kind-icon" > join< wbr > Path< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static" > < a href = "Uri.html#from" class = "tsd-kind-icon" > from< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "Uri.html#with" class = "tsd-kind-icon" > with< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "Uri.html#toString" class = "tsd-kind-icon" > to< wbr > String< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "Uri.html#toJSON" class = "tsd-kind-icon" > toJSON< / a > < / li >
< / ul >
< / section >
< section class = "tsd-index-section " >
< h3 > Properties< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "Uri.html#scheme" class = "tsd-kind-icon" > scheme< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "Uri.html#authority" class = "tsd-kind-icon" > authority< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "Uri.html#path" class = "tsd-kind-icon" > path< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "Uri.html#query" class = "tsd-kind-icon" > query< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "Uri.html#fragment" class = "tsd-kind-icon" > fragment< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "Uri.html#fsPath" class = "tsd-kind-icon" > fs< wbr > Path< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Methods< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static" >
< a name = "parse" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagStatic" > Static< / span > parse< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static" >
< li class = "tsd-signature tsd-kind-icon" > parse< span class = "tsd-signature-symbol" > (< / span > value< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , strict< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L1266" > vscode.d.ts:1266< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Create an URI from a string, e.g. < code > http://www.msft.com/some/path< / code > ,
< code > file:///usr/home< / code > , or < code > scheme:with/path< / code > .< / p >
< / div >
< p > < em > Note< / em > that for a while uris without a < code > scheme< / code > were accepted. That is not correct
as all uris should have a scheme. To avoid breakage of existing code the optional
< code > strict< / code > -argument has been added. We < em > strongly< / em > advise to use it, e.g. < code > Uri.parse(' my:uri' , true)< / code > < / p >
< dl class = "tsd-comment-tags" >
< dt > see< / dt >
< dd > < p > < a href = "Uri.html#toString" > Uri.toString< / a > < / p >
< / dd >
< / dl >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > value: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The string value of an Uri.< / p >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > strict: < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Throw an error when < code > value< / code > is empty or when no < code > scheme< / code > can be parsed.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / h4 >
< p > A new Uri instance.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static" >
< a name = "file" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagStatic" > Static< / span > file< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static" >
< li class = "tsd-signature tsd-kind-icon" > file< span class = "tsd-signature-symbol" > (< / span > path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L1291" > vscode.d.ts:1291< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Create an URI from a file system path. The < a href = "Uri.html#scheme" > scheme< / a >
will be < code > file< / code > .< / p >
< / div >
< p > The < em > difference< / em > between < a href = "Uri.html#parse" > Uri.parse< / a > and < a href = "Uri.html#file" > Uri.file< / a > is that the latter treats the argument
as path, not as stringified-uri. E.g. < code > Uri.file(path)< / code > is < em > not< / em > the same as
< code > Uri.parse(' file://' + path)< / code > because the path might contain characters that are
interpreted (# and ?). See the following sample:< / p >
< pre > < code class = "language-ts" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > good< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0070C1" > URI< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > file< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' /coding/c#/project1' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #001080" > good< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > scheme< / span > < span style = "color: #000000" > === < / span > < span style = "color: #A31515" > ' file' < / span > < span style = "color: #000000" > ;< / span >
< span style = "color: #001080" > good< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > path< / span > < span style = "color: #000000" > === < / span > < span style = "color: #A31515" > ' /coding/c#/project1' < / span > < span style = "color: #000000" > ;< / span >
< span style = "color: #001080" > good< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > fragment< / span > < span style = "color: #000000" > === < / span > < span style = "color: #A31515" > ' ' < / span > < span style = "color: #000000" > ;< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > bad< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0070C1" > URI< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > parse< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' file://' < / span > < span style = "color: #000000" > + < / span > < span style = "color: #A31515" > ' /coding/c#/project1' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #001080" > bad< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > scheme< / span > < span style = "color: #000000" > === < / span > < span style = "color: #A31515" > ' file' < / span > < span style = "color: #000000" > ;< / span >
< span style = "color: #001080" > bad< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > path< / span > < span style = "color: #000000" > === < / span > < span style = "color: #A31515" > ' /coding/c' < / span > < span style = "color: #000000" > ; < / span > < span style = "color: #008000" > // path is now broken< / span >
< span style = "color: #001080" > bad< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > fragment< / span > < span style = "color: #000000" > === < / span > < span style = "color: #A31515" > ' /project1' < / span > < span style = "color: #000000" > ;< / span >
< / code > < / pre >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > path: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > A file system or UNC path.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / h4 >
< p > A new Uri instance.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static" >
< a name = "joinPath" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagStatic" > Static< / span > join< wbr > Path< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static" >
< li class = "tsd-signature tsd-kind-icon" > join< wbr > Path< span class = "tsd-signature-symbol" > (< / span > base< span class = "tsd-signature-symbol" > : < / span > < a href = "Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > , < span class = "tsd-signature-symbol" > ...< / span > pathSegments< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L1313" > vscode.d.ts:1313< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Create a new uri which path is the result of joining
the path of the base uri with the provided path segments.< / p >
< / div >
< ul >
< li > Note 1: < code > joinPath< / code > only affects the path component
and all other components (scheme, authority, query, and fragment) are
left as they are.< / li >
< li > Note 2: The base uri must have a path; an error is thrown otherwise.< / li >
< / ul >
< p > The path segments are normalized in the following ways:< / p >
< ul >
< li > sequences of path separators (< code > /< / code > or < code > \< / code > ) are replaced with a single separator< / li >
< li > for < code > file< / code > -uris on windows, the backslash-character (< code > \< / code > ) is considered a path-separator< / li >
< li > the < code > ..< / code > -segment denotes the parent segment, the < code > .< / code > denotes the current segment< / li >
< li > paths have a root which always remains, for instance on windows drive-letters are roots
so that is true: < code > joinPath(Uri.file(' file:///c:/root' ), ' ../../other' ).fsPath === ' c:/other' < / code > < / li >
< / ul >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > base: < a href = "Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > An uri. Must have a path.< / p >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagRest" > Rest< / span > < span class = "tsd-signature-symbol" > ...< / span > pathSegments: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > One more more path fragments< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / h4 >
< p > A new uri which path is joined with the given fragments< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static" >
< a name = "from" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagStatic" > Static< / span > from< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static" >
< li class = "tsd-signature tsd-kind-icon" > from< span class = "tsd-signature-symbol" > (< / span > components< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > scheme< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > authority< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > path< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > query< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > fragment< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L1322" > vscode.d.ts:1322< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Create an URI from its component parts< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > see< / dt >
< dd > < p > < a href = "Uri.html#toString" > Uri.toString< / a > < / p >
< / dd >
< / dl >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > components: < span class = "tsd-signature-symbol" > { < / span > scheme< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > authority< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > path< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > query< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > fragment< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The component parts of an Uri.< / p >
< / div >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > scheme< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > authority< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > path< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > query< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > fragment< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< / ul >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / h4 >
< p > A new Uri instance.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
< a name = "with" class = "tsd-anchor" > < / a >
< h3 > with< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > with< span class = "tsd-signature-symbol" > (< / span > change< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > scheme< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > authority< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > path< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > query< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > fragment< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L1392" > vscode.d.ts:1392< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Derive a new Uri from this Uri.< / p >
< / div >
< pre > < code class = "language-ts" > < span style = "color: #0000FF" > let< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > file< / span > < span style = "color: #000000" > = < / span > < span style = "color: #001080" > Uri< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > parse< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' before:some/file/path' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #0000FF" > let< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > other< / span > < span style = "color: #000000" > = < / span > < span style = "color: #001080" > file< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > with< / span > < span style = "color: #000000" > ({ < / span > < span style = "color: #001080" > scheme:< / span > < span style = "color: #000000" > < / span > < span style = "color: #A31515" > ' after' < / span > < span style = "color: #000000" > });< / span >
< span style = "color: #001080" > assert< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > ok< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > other< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > toString< / span > < span style = "color: #000000" > () === < / span > < span style = "color: #A31515" > ' after:some/file/path' < / span > < span style = "color: #000000" > );< / span >
< / code > < / pre >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > change: < span class = "tsd-signature-symbol" > { < / span > scheme< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > authority< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > path< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > query< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > fragment< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > An object that describes a change to this Uri. To unset components use < code > null< / code > or
the empty string.< / p >
< / div >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > scheme< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > authority< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > path< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > query< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > fragment< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< / ul >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / h4 >
< p > A new Uri that reflects the given change. Will return < code > this< / code > Uri if the change
is not changing anything.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
< a name = "toString" class = "tsd-anchor" > < / a >
< h3 > to< wbr > String< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > to< wbr > String< span class = "tsd-signature-symbol" > (< / span > skipEncoding< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L1411" > vscode.d.ts:1411< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Returns a string representation of this Uri. The representation and normalization
of a URI depends on the scheme.< / p >
< / div >
< ul >
< li > The resulting string can be safely used with < a href = "Uri.html#parse" > Uri.parse< / a > .< / li >
< li > The resulting string shall < em > not< / em > be used for display purposes.< / li >
< / ul >
< p > < em > Note< / em > that the implementation will encode < em > aggressive< / em > which often leads to unexpected,
but not incorrect, results. For instance, colons are encoded to < code > %3A< / code > which might be unexpected
in file-uri. Also < code > & < / code > and < code > =< / code > will be encoded which might be unexpected for http-uris. For stability
reasons this cannot be changed anymore. If you suffer from too aggressive encoding you should use
the < code > skipEncoding< / code > -argument: < code > uri.toString(true)< / code > .< / p >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > skipEncoding: < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Do not percentage-encode the result, defaults to < code > false< / code > . Note that
the < code > #< / code > and < code > ?< / code > characters occurring in the path will always be encoded.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > string< / span > < / h4 >
< p > A string representation of this Uri.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
< a name = "toJSON" class = "tsd-anchor" > < / a >
< h3 > toJSON< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > toJSON< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L1418" > vscode.d.ts:1418< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Returns a JSON representation of this Uri.< / p >
< / div >
< / div >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > any< / span > < / h4 >
< p > An object.< / p >
< / li >
< / ul >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Properties< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "scheme" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > scheme< / h3 >
< div class = "tsd-signature tsd-kind-icon" > scheme< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L1333" > vscode.d.ts:1333< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Scheme is the < code > http< / code > part of < code > http://www.msft.com/some/path?query#fragment< / code > .
The part before the first colon.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "authority" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > authority< / h3 >
< div class = "tsd-signature tsd-kind-icon" > authority< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L1339" > vscode.d.ts:1339< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Authority is the < code > www.msft.com< / code > part of < code > http://www.msft.com/some/path?query#fragment< / code > .
The part between the first double slashes and the next slash.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "path" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > path< / h3 >
< div class = "tsd-signature tsd-kind-icon" > path< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L1344" > vscode.d.ts:1344< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Path is the < code > /some/path< / code > part of < code > http://www.msft.com/some/path?query#fragment< / code > .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "query" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > query< / h3 >
< div class = "tsd-signature tsd-kind-icon" > query< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L1349" > vscode.d.ts:1349< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Query is the < code > query< / code > part of < code > http://www.msft.com/some/path?query#fragment< / code > .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "fragment" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > fragment< / h3 >
< div class = "tsd-signature tsd-kind-icon" > fragment< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L1354" > vscode.d.ts:1354< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Fragment is the < code > fragment< / code > part of < code > http://www.msft.com/some/path?query#fragment< / code > .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "fsPath" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > fs< wbr > Path< / h3 >
< div class = "tsd-signature tsd-kind-icon" > fs< wbr > Path< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L1376" > vscode.d.ts:1376< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The string representing the corresponding file system path of this Uri.< / p >
< / div >
< p > Will handle UNC paths and normalize windows drive letters to lower-case. Also
uses the platform specific path separator.< / p >
< ul >
< li > Will < em > not< / em > validate the path for invalid characters and semantics.< / li >
< li > Will < em > not< / em > look at the scheme of this Uri.< / li >
< li > The resulting string shall < em > not< / em > be used for display purposes but
for disk operations, like < code > readFile< / code > et al.< / li >
< / ul >
< p > The < em > difference< / em > to the < a href = "Uri.html#path" > < code > path< / code > < / a > -property is the use of the platform specific
path separator and the handling of UNC paths. The sample below outlines the difference:< / p >
< pre > < code class = "language-ts" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > u< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0070C1" > URI< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > parse< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' file://server/c$/folder/file.txt' < / span > < span style = "color: #000000" > )< / span >
< span style = "color: #001080" > u< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > authority< / span > < span style = "color: #000000" > === < / span > < span style = "color: #A31515" > ' server' < / span >
< span style = "color: #001080" > u< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > path< / span > < span style = "color: #000000" > === < / span > < span style = "color: #A31515" > ' /shares/c$/file.txt' < / span >
< span style = "color: #001080" > u< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > fsPath< / span > < span style = "color: #000000" > === < / span > < span style = "color: #A31515" > ' < / span > < span style = "color: #EE0000" > \\< / span > < span style = "color: #A31515" > server< / span > < span style = "color: #EE0000" > \c< / span > < span style = "color: #A31515" > $< / span > < span style = "color: #EE0000" > \f< / span > < span style = "color: #A31515" > older< / span > < span style = "color: #EE0000" > \f< / span > < span style = "color: #A31515" > ile.txt' < / span >
< / code > < / pre >
< / div >
< / section >
< / section >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = " " >
< a href = "../modules.html" > Exports< / a >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-class" >
< a href = "Uri.html" class = "tsd-kind-icon" > Uri< / a >
< ul >
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-static" >
< a href = "Uri.html#parse" class = "tsd-kind-icon" > parse< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-static" >
< a href = "Uri.html#file" class = "tsd-kind-icon" > file< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-static" >
< a href = "Uri.html#joinPath" class = "tsd-kind-icon" > join< wbr > Path< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-static" >
< a href = "Uri.html#from" class = "tsd-kind-icon" > from< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "Uri.html#scheme" class = "tsd-kind-icon" > scheme< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "Uri.html#authority" class = "tsd-kind-icon" > authority< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "Uri.html#path" class = "tsd-kind-icon" > path< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "Uri.html#query" class = "tsd-kind-icon" > query< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "Uri.html#fragment" class = "tsd-kind-icon" > fragment< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "Uri.html#fsPath" class = "tsd-kind-icon" > fs< wbr > Path< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "Uri.html#with" class = "tsd-kind-icon" > with< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "Uri.html#toString" class = "tsd-kind-icon" > to< wbr > String< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "Uri.html#toJSON" class = "tsd-kind-icon" > toJSON< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > Legend< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static method< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > Generated using < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< / body >
< / html >
