Teal TealUI

URL 处理util/url

提供解析和格式化 URL 的工具函数。

本组件利用原生 JavaScript 解析地址。利用浏览器自带的 <a> 标签实现解析见URL 处理（基于 DOM）。

API

Url 类

表示一个地址。

参考

字段 类型 描述
⮞ protocol : string

协议部分。如 "http:"。

 string

协议部分。如 "http:"。
⮞ slashes : boolean

判断地址是否包含分隔符(//)。

 boolean

判断地址是否包含分隔符(//)。
⮞ auth : string

验证部分。如 "name:password"。

 string

验证部分。如 "name:password"。
⮞ host : string

主机部分。如 "localhost:80"。

 string

主机部分。如 "localhost:80"。
⮞ port : string

端口部分。如 "80"。

 string

端口部分。如 "80"。
⮞ hostname : string

主机名部分。如 "localhost"。

 string

主机名部分。如 "localhost"。
⮞ hash : string

哈希值部分。如 "#hash"。

 string

哈希值部分。如 "#hash"。
⮞ search : string

查询参数部分。如 "?q=1"。

 string

查询参数部分。如 "?q=1"。
⮞ query : string | { [key: string]: string; }

查询参数部分。如 {q: 1}。

 string | object

查询参数部分。如 {q: 1}。
⮞ pathname : string

路径名部分。如 "/foo/a.html?q=1"。

 string

路径名部分。如 "/foo/a.html?q=1"。
⮞ path : string

路径部分。如 "/foo/a.html"。

 string

路径部分。如 "/foo/a.html"。
⮞ href : string

完整地址。如 "http://localhost:80/foo/a.html?q=1"。

 string

完整地址。如 "http://localhost:80/foo/a.html?q=1"。
方法 描述
⮞ toString()():string

转换地址为字符串。

返回值

类型：string

返回格式化后的字符串。

转换地址为字符串。
⮞ resolve(relative)(relative:string | Url):Url

基于当前地址解析指定的相对地址。

参数 类型 描述 默认值
relative* string | Url —

返回值

类型：Url

返回新地址对象。

基于当前地址解析指定的相对地址。
⮞ Url.parse(url, ...)(url:string | Url, parseQueryString?:boolean, slashesDenoteHost?:boolean):Url

解析地址。

参数 类型 描述 默认值
url* string | Url —
parseQueryString boolean —
slashesDenoteHost boolean —

返回值

类型：Url

返回新地址对象。

解析地址。
⮞ Url.format(obj)(obj:Partial<Url>):string

格式化地址对象为字符串。

参数 类型 描述 默认值
obj* Partial<Url> —

返回值

类型：string

返回格式化后的字符串。

格式化地址对象为字符串。
⮞ Url.resolve(source, relative)(source:string | Url, relative:string):string

基于指定地址解析指定的相对地址返回绝对地址。

参数 类型 描述 默认值
source* string | Url —
relative* string —

返回值

类型：string

返回解析后的地址。

基于指定地址解析指定的相对地址返回绝对地址。