url

构建，验证，解析URL

Globals

构造函数

URL(source, base)

URL构造函数可以创建一个URL对象，并验证提供的字符串是否是有效的URL。SDK中，任何接受URL参数的API，除非特殊说明，均接受的是此对象而不是字符串。

参数

source : string
一个表示URL的字符串，如果接受的参数不是有效的URL字符串，此构造函数会抛出一个异常。

base : string
一个设置的字符串，用来表示一个相对路径的源。

DataURL(uri)

DataURL构造函数创建一个data: URL对象, 并验证提供的字符串是否是一个有效的data: URL。

参数

uri : string
一个表示Data URL的字符串。如果它不是一个合法的URL字符串，此构造函数会抛出一个错误。

函数

toFilename(url)

尝试将给定的URL转换成本地文件路径。这个方法会自动尝试解决非文件协议, such as the resource: protocol, to their place on the file system. 除非URL无法转换，否则，本方法会将本地路径作为字符串返回。

参数

url : string
字符串格式的URL。

返回

string : 转换后的本地路径字符串

fromFilename(path)

讲一个给定的路径转换成 file: URL.

参数

path : string
需要被转换的本地文件路径字符串。

Returns

string : 转换后的字符串。

isValidURI(uri)

检查一个URL字符串是合法。 isValidURI("https://mozilla.org") 将返回 true, 而 isValidURI("mozilla.org") 将返回 false。

参数

uri : string
需要被测试的URL。

Returns

boolean : 代表字符串是否有效的布尔值。

getTLD(url)

返回给定域名的顶级域名： 内部使用的是 getPublicSuffix() 。

var urls = require("sdk/url");
console.log(urls.getTLD("https://www.bbc.co.uk/"));          // "co.uk"
console.log(urls.getTLD("https://developer.mozilla.org/")); // "org"

参数

url : string
给定的URL字符串

返回

string : 对应的顶级域名。

URL

方法

toString()

返回URL的字符表示形式。

返回

string : 字符串格式的URL。

属性

scheme

URL使用的协议

userPass

URL中的username:password 部分，null 表示不存在。

host

URL的主机部分。 null 表示无此部分。例子：

var url = require("sdk/url").URL("https://developer.mozilla.org/en-US/Add-ons");
console.log(url.host);  // developer.mozilla.org

port

URL使用的端口。 null 表示不存在。

path

URL的路径部分，例子：

var url = require("sdk/url").URL("https://developer.mozilla.org/en-US/Add-ons");
console.log(url.path);  // /en-US/Add-ons

hostname

表示URL的域的字符串。参见 window.location.hostname。

pathname

从 '/'开始的路径字符串。参见 window.location.pathname。

hash

从 '#' 开始的hash字符串，参见 window.location.hash。

href

整个URL字符串，参见 window.location.href。

origin

该URL的源的字符串，参见 window.location.origin。

protocol

该URL使用的协议字符串，包括最后的':'，参见 window.location.protocol。

search

以'?'开始的URL的参数段，包括最开始的'?'。 参见window.location.search.

DataURL

方法

toString()

返回数据的URL字符串形式。如果是 base64 的URL，数据会以base64编码方式编码。

返回

string : URL字符串

属性

mimeType

数据的MIME类型，默认为空字符串。

parameters

一个HashMap的数据包含URL参数。默认情况下是一个空对象。

base64

定义了数据属性值的编码。

data

包含数据的URL字符串。如果URI给构造函数包含Base64参数，这个字符串会被解码。