Uri
txt
foo://example.com:8042/over/there?name=ferret#nose
\_/ \______________/\_________/ \_________/ \__/
| | | | |
scheme authority path query fragment
| _____________________|__
/ \ / \
urn:example:animal:ferret:nose
快捷链接
Cconstructor
Pauthority
Pfragment
Ppath
Pquery
Pscheme
AfsPath
MtoJSON
MtoString
Mwith
Mfile
Mfrom
MisUri
MjoinPath
Mparse
Mrevive
Implements
constructor
ts
new Uri(): Uri
authority
- 类型:
string
- 描述: authority是 www.example.com , http://www.example.com/some/path?query#fragment ==> host+port 部分。
- 示例:
js
http://www.example.com/
authority = www.example.com
host = www.example.com
http://255.255.255.255:8080/
authority = 255.255.255.255:8080
host = 255.255.255.255
fragment
- 类型:
string
- 描述: fragment是 http://www.example.com/some/path?query#fragment ==> #fragment
path
- 类型:
string
- 描述: path是 http://www.example.com/some/path?query#fragment ==> /some/path
query
- 类型:
string
- 描述: query是 http://www.example.com/some/path?query#fragment ==> ?query
scheme
- 类型:
string
- 描述: scheme是 http://www.example.com/some/path?query#fragment ==> http
fsPath
- 类型:
string
- 描述: fsPath是 http://www.example.com/some/path?query#fragment ==> /some/path
toJSON
- 语法:
() =>
UriComponents - 描述: 将 Uri 转换为 JSON, 可快速获取 query、path等属性
toString
- 语法:
(skipEncoding?: boolean) => string
- 参数:
skipEncoding
:是否对结果进行编码
- 描述: 将 Uri 转换为字符串
with
- 语法:
with(change): Uri
- 参数:
authority
:string
;fragment
:string
;path
:string
;query
:string
;scheme
:string
;
- 描述: 创建一个新的 Uri,使用提供的参数替换当前 Uri 的参数
file
- 语法:
file(path): Uri
- 参数:
path
:string
详见 fsPath; - 描述:创建一个文件 Uri
- 示例:
js
const good = Uri.file('/coding/c#/project1');
good.scheme === 'file';
good.path === '/coding/c#/project1';
good.fragment === '';
const bad = Uri.parse('file://' + '/coding/c#/project1');
bad.scheme === 'file';
bad.path === '/coding/c'; // path is now broken
bad.fragment === '/project1';
from
- 语法:
from(components, strict?): Uri
- 参数:
components
:UriComponents;strict
:boolean
;
isUri
- 语法:
isUri(thing): boolean
- 参数:
thing
:any
; - 描述:判断是否为 Uri
joinPath
- 语法:
joinPath(uri: Uri, ...pathFragment: string[]): Uri
- 参数:
uri
:Uri
;pathFragment
:string[]
;
- 描述:将多个路径片段拼接成一个 Uri
parse
- 语法:
revive(value: string, _strict?: boolean): Uri
- 参数:
value
:string
;_strict
:boolean
;
- 描述:将字符串解析为 Uri
revive
- 语法:
revive(data): Uri
- 参数:
data
:Uri | UriComponents
; - 描述:将 UriComponents 转换为 Uri