包含位置和我们需要检索它或创建派生资源的任何其他参数的资源。它还提供了重试请求的功能。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
String | Object |
具有以下属性的网址或对象
|
Example:
function refreshTokenRetryCallback(resource, error) {
if (error.statusCode === 403) {
// 403 status code means a new token should be generated
return getNewAccessToken()
.then(function(token) {
resource.queryParameters.access_token = token;
return true;
})
.otherwise(function() {
return false;
});
}
return false;
}
var resource = new Resource({
url: 'http://server.com/path/to/resource.json',
proxy: new DefaultProxy('/proxy/'),
headers: {
'X-My-Header': 'valueOfHeader'
},
queryParameters: {
'access_token': '123-435-456-000'
},
retryCallback: refreshTokenRetryCallback,
retryAttempts: 1
});
Members
static constant LSGlobe.Resource.DEFAULT : Resource
资源实例已初始化为当前浏览器位置
如果支持blob,则返回true。
资源的文件扩展名。
如果资源具有请求标头,则为True。这等效于检查headers属性是否具有任何键。
与请求一起发送的其他HTTP标头。
如果资源引用Blob URI,则为true。
如果资源引用跨源URL,则为True。
如果资源引用数据URI,则为True。
proxy : Proxy
加载资源时要使用的代理。
查询参数附加到URL。
request : Request
将使用的Request对象。仅用于内部使用。
放弃之前应调用retryCallback的次数。
当对此资源的请求失败时调用的函数。如果返回true或Promise解析为true,则将重试该请求。
键/值对,用于替换url中的模板参数。
资源的url(已设置模板)替换为模板值,附加查询字符串并由代理编码。
Methods
从URL创建资源,并在其上调用delete()。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
String | Object |
具有以下属性的网址或对象
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
从URL创建资源并在其上调用fetch()。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
String | Object |
具有以下属性的网址或对象
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
创建一个资源,并在其上调用fetchArrayBuffer()。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
String | Object |
具有以下属性的网址或对象
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
创建一个资源,并在其上调用fetchBlob()。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
String | Object |
具有以下属性的网址或对象
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
static LSGlobe.Resource.fetchImage (options) → Promise.<ImageBitmap>|Promise.<HTMLImageElement>|undefined
创建一个资源,并在其上调用fetchImage()。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
String | Object |
具有以下属性的网址或对象
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
创建一个资源,并在其上调用fetchJson()。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
String | Object |
具有以下属性的网址或对象
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
从URL创建资源,并在其上调用fetchJsonp()。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
String | Object |
具有以下属性的网址或对象
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
创建一个资源,并在其上调用fetchText()。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
String | Object |
具有以下属性的网址或对象
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
创建一个资源,并在其上调用fetchXML()。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
String | Object |
具有以下属性的网址或对象
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
从URL创建资源并在其上调用head()。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
String | Object |
具有以下属性的网址或对象
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
从URL创建资源并在其上调用options()。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
String | Object |
具有以下属性的网址或对象
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
从URL创建资源并在其上调用patch()。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
Object |
具有以下属性的网址或对象
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
从URL创建资源并在其上调用post()。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
Object |
具有以下属性的网址或对象
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
从URL创建资源并在其上调用put()。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
Object |
具有以下属性的网址或对象
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
在URL后面加上斜杠。
组合指定的对象和现有的查询参数。这使您可以一次添加许多参数, 而不是一次将它们一次添加到queryParameters属性。
Name | Type | Description |
---|---|---|
params
|
Object | 查询参数 |
clone ( result ) → Resource
复制资源实例。
Name | Type | Description |
---|---|---|
result
|
Resource | 可选 将结果存储到的对象。 |
Returns:
修改后的结果参数或一个新的Resource实例(如果未提供)。
异步删除给定资源。返回一个承诺,将解决加载后返回结果,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
Object |
可选
具有以下属性的对象:
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
Example:
resource.delete()
.then(function(body) {
// use the data
}).otherwise(function(error) {
// an error occurred
});
See:
异步加载给定资源。返回一个承诺,将解决加载后返回结果,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。建议您使用更具体的功能,例如fetchJson,fetchBlob等。
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
Object |
可选
具有以下属性的对象:
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
Example:
resource.fetch()
.then(function(body) {
// use the data
}).otherwise(function(error) {
// an error occurred
});
See:
异步将资源作为原始二进制数据加载。返回一个承诺,将解决ArrayBuffer加载后,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
Example:
// load a single URL asynchronously
resource.fetchArrayBuffer().then(function(arrayBuffer) {
// use the data
}).otherwise(function(error) {
// an error occurred
});
See:
异步将给定资源加载为Blob。返回一个承诺,将解决Blob一旦加载,或者如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
Example:
// load a single URL asynchronously
resource.fetchBlob().then(function(blob) {
// use the data
}).otherwise(function(error) {
// an error occurred
});
See:
异步加载给定的图像资源。返回一个承诺,将解决如果
preferImageBitmap
为true并且浏览器支持
ImageBitmap
code> createImageBitmap 或其他
图像
一旦加载,或者如果图像加载失败则拒绝。
Name | Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
Object |
可选
具有以下属性的对象。
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
Example:
// load a single image asynchronously
resource.fetchImage().then(function(image) {
// use the loaded image
}).otherwise(function(error) {
// an error occurred
});
// load several images in parallel
when.all([resource1.fetchImage(), resource2.fetchImage()]).then(function(images) {
// images is an array containing all the loaded images
});
See:
异步将给定资源加载为JSON。返回一个承诺,将解决JSON对象一旦加载,或者如果资源加载失败则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。这个功能如果没有,在请求标头中添加' Accept:application/json,*/*; q = 0.01'已经指定。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
Example:
resource.fetchJson().then(function(jsonData) {
// Do something with the JSON object
}).otherwise(function(error) {
// an error occurred
});
See:
使用JSONP请求资源。
Name | Type | Default | Description |
---|---|---|---|
callbackParameterName
|
String |
'callback'
|
可选 服务器期望的回调参数名称。 |
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
Example:
// load a data asynchronously
resource.fetchJsonp().then(function(data) {
// use the loaded data
}).otherwise(function(error) {
// an error occurred
});
See:
异步加载给定资源为文本。返回一个承诺,将解决一次加载String,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
Example:
// load text from a URL, setting a custom header
var resource = new Resource({
url: 'http://someUrl.com/someJson.txt',
headers: {
'X-Custom-Header' : 'some value'
}
});
resource.fetchText().then(function(text) {
// Do something with the text
}).otherwise(function(error) {
// an error occurred
});
See:
异步将给定资源加载为XML。返回一个承诺,将解决XML文档一旦加载,或者如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
Example:
// load XML from a URL, setting a custom header
LSGlobe.loadXML('http://someUrl.com/someXML.xml', {
'X-Custom-Header' : 'some value'
}).then(function(document) {
// Do something with the document
}).otherwise(function(error) {
// an error occurred
});
See:
返回资源的基本路径。
Name | Type | Default | Description |
---|---|---|---|
includeQuery
|
Boolean |
false
|
可选 是否在uri中包含查询字符串和片段 |
Returns:
资源的基本URI
getDerivedResource (options) → Resource
返回相对于当前实例的资源。除非在选项中覆盖,否则所有属性均与当前实例相同。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
Object |
具有以下属性的对象
|
Returns:
从当前资源派生的资源。
返回url(可选)和查询字符串,并由代理处理。
Name | Type | Default | Description |
---|---|---|---|
query
|
Boolean |
false
|
可选 如果为true,则包含查询字符串。 |
proxy
|
Boolean |
false
|
可选 如果为true,则该URL由代理对象(如果已定义)处理。 |
Returns:
具有所有要求的组件的URL。
异步获取标头给定的资源。返回一个承诺,将解决加载后返回结果,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
Object |
可选
具有以下属性的对象:
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
Example:
resource.head()
.then(function(headers) {
// use the data
}).otherwise(function(error) {
// an error occurred
});
See:
异步获取给定资源的选项。返回一个承诺,将解决加载后返回结果,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options
|
Object |
可选
具有以下属性的对象:
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
Example:
resource.options()
.then(function(headers) {
// use the data
}).otherwise(function(error) {
// an error occurred
});
See:
异步将数据修补到给定资源。返回一个承诺,将解决加载后返回结果,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data
|
Object | 与资源一起发布的数据。 | ||||||||||||
options
|
Object |
可选
具有以下属性的对象:
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
Example:
resource.patch(data)
.then(function(result) {
// use the result
}).otherwise(function(error) {
// an error occurred
});
See:
异步将数据发布到给定资源。返回一个承诺,将解决加载后返回结果,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data
|
Object | 与资源一起发布的数据。 | |||||||||||||||
options
|
Object |
可选
具有以下属性的对象:
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
Example:
resource.post(data)
.then(function(result) {
// use the result
}).otherwise(function(error) {
// an error occurred
});
See:
异步将数据放入给定资源。返回一个承诺,将解决加载后返回结果,如果资源加载失败,则拒绝。数据已加载使用XMLHttpRequest,这意味着为了向另一个来源发出请求,服务器必须启用跨域资源共享(CORS)标头。
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data
|
Object | 与资源一起发布的数据。 | ||||||||||||
options
|
Object |
可选
具有以下属性的对象:
|
Returns:
一个承诺,将在加载时解析为请求的数据。如果未返回,则返回undefined
request.throttle
为true,并且请求的优先级不够高。
Example:
resource.put(data)
.then(function(result) {
// use the result
}).otherwise(function(error) {
// an error occurred
});
See:
组合指定的对象和现有的查询参数。这使您可以一次添加许多参数, 而不是一次将它们一次添加到queryParameters属性。如果已经设置了一个值,它将被新值替换。
Name | Type | Default | Description |
---|---|---|---|
params
|
Object | 查询参数 | |
useAsDefault
|
Boolean |
false
|
可选 如果为true,则将使用参数作为默认值,因此只有在未定义参数的情况下才会设置这些参数。 |
组合指定的对象和现有的模板值。这样您可以一次添加多个值, 而不是一次将它们一次添加到templateValues属性。如果已经设置了一个值,它将成为一个数组并附加新值。
Name | Type | Default | Description |
---|---|---|---|
template
|
Object | 模板值 | |
useAsDefault
|
Boolean |
false
|
可选 如果为true,则将这些值用作默认值,因此只有在未定义它们时才设置它们。 |
覆盖Object#toString,以便隐式字符串转换为此资源表示的完整URL。
Returns:
此资源表示的URL
Type Definitions
一个返回属性值的函数。
Name | Type | Description |
---|---|---|
resource
|
Resource | 可选 无法加载的资源。 |
error
|
Error | 可选 资源加载期间发生的错误。 |
Returns:
如果为true或一个承诺变为true,则将重试该资源。否则,将返回故障。