一種資源,包括位置和我們檢索它或創(chuàng)建派生資源所需的任何其他參數(shù)。它還提供了重試請(qǐng)求的能力。
new Resource(options)
Parameters:
options
((String | Object))
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
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) DEFAULT : Resource
初始化到當(dāng)前瀏覽器位置的資源實(shí)例
(static, readonly) isBlobSupported : Boolean
如果支持blob,則返回true。
(readonly) extension : String
資源的文件擴(kuò)展名。
hasHeaders : Boolean
如果資源具有請(qǐng)求頭,則為true。這相當(dāng)于檢查headers屬性是否有任何鍵。
headers : Object
將隨請(qǐng)求一起發(fā)送的其他HTTP頭。
isBlobUri : Boolean
如果資源引用blob uri,則為true。
isCrossOriginUrl : Boolean
如果資源引用跨源URL,則為true。
isDataUri : Boolean
如果資源引用數(shù)據(jù)URI,則為true。
proxy : DefaultProxy
加載資源時(shí)要使用的代理。
(readonly) queryParameters : Object
附加到URL的查詢參數(shù)。
request : Request
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。
retryAttempts : Number
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。
retryCallback : function
當(dāng)請(qǐng)求此資源失敗時(shí)調(diào)用的函數(shù)。如果返回“真”或解析為“真”的承諾,將重試請(qǐng)求。
(readonly) templateValues : Object
用于替換URL中模板參數(shù)的鍵/值對(duì)。
url : String
替換模板值、追加查詢字符串并由代理(如果設(shè)置了)編碼的資源的URL。
Methods
(static) delete(options) → {Promise.<Object>|undefined}
從URL創(chuàng)建資源并對(duì)其調(diào)用delete()。
Parameters:
options
((String | Object))
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.data
Object
|
與資源一起發(fā)布的數(shù)據(jù)。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
options.responseType
String
|
響應(yīng)類型。這控制返回的項(xiàng)的類型。 |
options.overrideMimeType
String
|
重寫服務(wù)器返回的mime類型。 |
從URL創(chuàng)建資源并對(duì)其調(diào)用fetch()。
Parameters:
options
((String | Object))
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
options.responseType
String
|
響應(yīng)類型。這控制返回的項(xiàng)的類型。 |
options.overrideMimeType
String
|
重寫服務(wù)器返回的mime類型。 |
創(chuàng)建資源并對(duì)其調(diào)用fetcharrayBuffer()。
Parameters:
options
((String | Object))
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
創(chuàng)建資源并對(duì)其調(diào)用fetchblob()。
Parameters:
options
((String | Object))
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
創(chuàng)建資源并對(duì)其調(diào)用fetchImage()。
Parameters:
options
((String | Object))
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.flipY
Boolean
default false
|
在提取和解碼期間是否垂直翻轉(zhuǎn)圖像。僅在請(qǐng)求圖像時(shí)適用,并且瀏覽器支持createImageBitmap 。
|
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
options.preferBlob
Boolean
default false
|
如果為真,我們將通過blob加載圖像。 |
options.preferImageBitmap
Boolean
default false
|
如果為真,則圖像將在提取期間解碼,并返回ImageBitmap 。
|
創(chuàng)建資源并對(duì)其調(diào)用fetchjson()。
Parameters:
options
((String | Object))
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
從URL創(chuàng)建資源并對(duì)其調(diào)用fetchjsonp()。
Parameters:
options
((String | Object))
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
options.callbackParameterName
String
default 'callback'
|
服務(wù)器需要的回調(diào)參數(shù)名。 |
創(chuàng)建資源并對(duì)其調(diào)用fetchText()。
Parameters:
options
((String | Object))
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
創(chuàng)建資源并對(duì)其調(diào)用fetchxml()。
Parameters:
options
((String | Object))
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
從URL創(chuàng)建資源并對(duì)其調(diào)用head()。
Parameters:
options
((String | Object))
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
options.responseType
String
|
響應(yīng)類型。這控制返回的項(xiàng)的類型。 |
options.overrideMimeType
String
|
重寫服務(wù)器返回的mime類型。 |
從URL創(chuàng)建資源并對(duì)其調(diào)用options()。
Parameters:
options
((String | Object))
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
options.responseType
String
|
響應(yīng)類型。這控制返回的項(xiàng)的類型。 |
options.overrideMimeType
String
|
重寫服務(wù)器返回的mime類型。 |
從URL創(chuàng)建資源并對(duì)其調(diào)用patch()。
Parameters:
options
(Object)
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.data
Object
|
與資源一起發(fā)布的數(shù)據(jù)。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
options.responseType
String
|
響應(yīng)類型。這控制返回的項(xiàng)的類型。 |
options.overrideMimeType
String
|
重寫服務(wù)器返回的mime類型。 |
從URL創(chuàng)建資源并對(duì)其調(diào)用post()。
Parameters:
options
(Object)
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.data
Object
|
與資源一起發(fā)布的數(shù)據(jù)。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
options.responseType
String
|
響應(yīng)類型。這控制返回的項(xiàng)的類型。 |
options.overrideMimeType
String
|
重寫服務(wù)器返回的mime類型。 |
從URL創(chuàng)建資源并調(diào)用Put()。
Parameters:
options
(Object)
具有以下屬性的URL或?qū)ο?/span>
Name | Description |
---|---|
options.url
String
|
資源的URL。 |
options.data
Object
|
與資源一起發(fā)布的數(shù)據(jù)。 |
options.queryParameters
Object
|
包含檢索資源時(shí)將發(fā)送的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
請(qǐng)求此資源失敗時(shí)要調(diào)用的函數(shù)。如果返回true,將重試請(qǐng)求。 |
options.retryAttempts
Number
default 0
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
options.responseType
String
|
響應(yīng)類型。這控制返回的項(xiàng)的類型。 |
options.overrideMimeType
String
|
重寫服務(wù)器返回的mime類型。 |
向URL追加正斜杠。
組合指定的對(duì)象和現(xiàn)有查詢參數(shù)。這允許您一次添加多個(gè)參數(shù),而不是一次將它們添加到QueryParameters屬性中。
Parameters:
params
(Object)
查詢參數(shù)
復(fù)制資源實(shí)例。
Parameters:
異步刪除給定的資源。返回一個(gè)承諾,該承諾將在加載后解析為結(jié)果,或者在資源加載失敗時(shí)拒絕。使用xmlhttpRequest加載數(shù)據(jù),這意味著為了向另一個(gè)來源發(fā)出請(qǐng)求,服務(wù)器必須啟用跨來源資源共享(cors)頭。
Parameters:
options
(Object)
Name | Description |
---|---|
options.responseType
String
|
響應(yīng)類型。這控制返回的項(xiàng)的類型。 |
options.headers
Object
|
與請(qǐng)求一起發(fā)送的附加HTTP頭(如果有)。 |
options.overrideMimeType
String
|
重寫服務(wù)器返回的mime類型。 |
Example
resource.delete()
.then(function(body) {
// use the data
}).otherwise(function(error) {
// an error occurred
});
異步加載給定的資源。返回一個(gè)承諾,該承諾將在加載后解析為結(jié)果,或者在資源加載失敗時(shí)拒絕。使用xmlhttpRequest加載數(shù)據(jù),這意味著為了向另一個(gè)來源發(fā)出請(qǐng)求,服務(wù)器必須啟用跨來源資源共享(cors)頭。建議您使用更具體的函數(shù),如fetchjson、fetchblob等。
Parameters:
options
(Object)
Name | Description |
---|---|
options.responseType
String
|
響應(yīng)類型。這控制返回的項(xiàng)的類型。 |
options.headers
Object
|
與請(qǐng)求一起發(fā)送的附加HTTP頭(如果有)。 |
options.overrideMimeType
String
|
重寫服務(wù)器返回的mime類型。 |
Example
resource.fetch()
.then(function(body) {
// use the data
}).otherwise(function(error) {
// an error occurred
});
異步加載資源作為原始二進(jìn)制數(shù)據(jù)。返回將在加載后解析為ArrayBuffer的承諾,或者在資源加載失敗時(shí)拒絕該承諾。使用xmlhttpRequest加載數(shù)據(jù),這意味著為了向另一個(gè)來源發(fā)出請(qǐng)求,服務(wù)器必須啟用跨來源資源共享(cors)頭。
Example
// load a single URL asynchronously
resource.fetchArrayBuffer().then(function(arrayBuffer) {
// use the data
}).otherwise(function(error) {
// an error occurred
});
以blob的形式異步加載給定的資源。返回一個(gè)承諾,該承諾將在加載后解析為blob,或者在資源加載失敗時(shí)拒絕。使用xmlhttpRequest加載數(shù)據(jù),這意味著為了向另一個(gè)來源發(fā)出請(qǐng)求,服務(wù)器必須啟用跨來源資源共享(cors)頭。
Example
// load a single URL asynchronously
resource.fetchBlob().then(function(blob) {
// use the data
}).otherwise(function(error) {
// an error occurred
});
異步加載給定的映像資源。返回一個(gè)承諾,如果
preferImageBitmap
為真且瀏覽器支持createImageBitmap
或加載后的Image將解析為ImageBitmap,如果圖像加載失敗則拒絕。
Parameters:
options
(Object)
具有以下屬性的對(duì)象。
Name | Description |
---|---|
options.preferBlob
Boolean
default false
|
如果為真,我們將通過blob加載圖像。 |
options.preferImageBitmap
Boolean
default false
|
如果為真,則圖像將在提取期間解碼,并返回ImageBitmap 。
|
options.flipY
Boolean
default false
|
如果為真,則圖像將在解碼過程中垂直翻轉(zhuǎn)。僅當(dāng)瀏覽器支持createImageBitmap 時(shí)適用。
|
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
});
以JSON的形式異步加載給定的資源。返回一個(gè)承諾,該承諾將在加載后解析為JSON對(duì)象,或者在資源加載失敗時(shí)拒絕。使用xmlhttpRequest加載數(shù)據(jù),這意味著為了向另一個(gè)來源發(fā)出請(qǐng)求,服務(wù)器必須啟用跨來源資源共享(cors)頭。此函數(shù)將“accept:application/json,*;/;*;;q=0.01”添加到請(qǐng)求頭(如果尚未指定)。
Example
resource.fetchJson().then(function(jsonData) {
// Do something with the JSON object
}).otherwise(function(error) {
// an error occurred
});
使用JSONP請(qǐng)求資源。
Parameters:
callbackParameterName
(String)
(default 'callback'
)
服務(wù)器需要的回調(diào)參數(shù)名。
Example
// load a data asynchronously
resource.fetchJsonp().then(function(data) {
// use the loaded data
}).otherwise(function(error) {
// an error occurred
});
See:
以文本形式異步加載給定資源。返回將在加載后解析為字符串的承諾,或者在資源加載失敗時(shí)拒絕該承諾。使用xmlhttpRequest加載數(shù)據(jù),這意味著為了向另一個(gè)來源發(fā)出請(qǐng)求,服務(wù)器必須啟用跨來源資源共享(cors)頭。
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
});
以XML的形式異步加載給定的資源。返回一個(gè)承諾,該承諾將在加載后解析為XML文檔,或者在資源加載失敗時(shí)拒絕。使用xmlhttpRequest加載數(shù)據(jù),這意味著為了向另一個(gè)來源發(fā)出請(qǐng)求,服務(wù)器必須啟用跨來源資源共享(cors)頭。
Example
// load XML from a URL, setting a custom header
bmgl.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
});
返回資源的基本路徑。
Parameters:
includeQuery
(Boolean)
(default false
)
是否包含來自URI的查詢字符串和片段
返回相對(duì)于當(dāng)前實(shí)例的資源。除非在選項(xiàng)中被重寫,否則所有屬性與當(dāng)前實(shí)例保持相同。
Parameters:
options
(Object)
具有以下屬性的對(duì)象
Name | Description |
---|---|
options.url
String
|
將相對(duì)于當(dāng)前實(shí)例的URL解析的URL。 |
options.queryParameters
Object
|
包含將與當(dāng)前實(shí)例的查詢參數(shù)組合的查詢參數(shù)的對(duì)象。 |
options.templateValues
Object
|
用于替換模板值的鍵/值對(duì)(例如{x})。這些將與當(dāng)前實(shí)例的合并。 |
options.headers
Object
default {}
|
將發(fā)送的其他HTTP頭。 |
options.proxy
DefaultProxy
|
加載資源時(shí)要使用的代理。 |
options.retryCallback
Resource~RetryCallback
|
加載資源失敗時(shí)要調(diào)用的函數(shù)。 |
options.retryAttempts
Number
|
放棄前應(yīng)調(diào)用RetryCallback的次數(shù)。 |
options.request
Request
|
將要使用的請(qǐng)求對(duì)象。僅供內(nèi)部使用。 |
options.preserveQueryParameters
Boolean
default false
|
如果為true,則將保留當(dāng)前資源和派生資源中的所有查詢參數(shù)。如果為false,派生參數(shù)將替換當(dāng)前資源的參數(shù)。 |
返回由代理處理的、查詢字符串可選的URL。
Parameters:
query
(Boolean)
(default false
)
如果為true,則包含查詢字符串。
proxy
(Boolean)
(default false
)
如果為true,則在定義代理對(duì)象時(shí)處理該URL。
異步獲取給定資源的頭。返回一個(gè)承諾,該承諾將在加載后解析為結(jié)果,或者在資源加載失敗時(shí)拒絕。使用xmlhttpRequest加載數(shù)據(jù),這意味著為了向另一個(gè)來源發(fā)出請(qǐng)求,服務(wù)器必須啟用跨來源資源共享(cors)頭。
Parameters:
options
(Object)
Name | Description |
---|---|
options.responseType
String
|
響應(yīng)類型。這控制返回的項(xiàng)的類型。 |
options.headers
Object
|
與請(qǐng)求一起發(fā)送的附加HTTP頭(如果有)。 |
options.overrideMimeType
String
|
重寫服務(wù)器返回的mime類型。 |
Example
resource.head()
.then(function(headers) {
// use the data
}).otherwise(function(error) {
// an error occurred
});
異步獲取給定資源的選項(xiàng)。返回一個(gè)承諾,該承諾將在加載后解析為結(jié)果,或者在資源加載失敗時(shí)拒絕。使用xmlhttpRequest加載數(shù)據(jù),這意味著為了向另一個(gè)來源發(fā)出請(qǐng)求,服務(wù)器必須啟用跨來源資源共享(cors)頭。
Parameters:
options
(Object)
Name | Description |
---|---|
options.responseType
String
|
響應(yīng)類型。這控制返回的項(xiàng)的類型。 |
options.headers
Object
|
與請(qǐng)求一起發(fā)送的附加HTTP頭(如果有)。 |
options.overrideMimeType
String
|
重寫服務(wù)器返回的mime類型。 |
Example
resource.options()
.then(function(headers) {
// use the data
}).otherwise(function(error) {
// an error occurred
});
異步地將數(shù)據(jù)修補(bǔ)到給定的資源。返回一個(gè)承諾,該承諾將在加載后解析為結(jié)果,或者在資源加載失敗時(shí)拒絕。使用xmlhttpRequest加載數(shù)據(jù),這意味著為了向另一個(gè)來源發(fā)出請(qǐng)求,服務(wù)器必須啟用跨來源資源共享(cors)頭。
Parameters:
data
(Object)
與資源一起發(fā)布的數(shù)據(jù)。
options
(Object)
Name | Description |
---|---|
options.responseType
String
|
響應(yīng)類型。這控制返回的項(xiàng)的類型。 |
options.headers
Object
|
與請(qǐng)求一起發(fā)送的附加HTTP頭(如果有)。 |
options.overrideMimeType
String
|
重寫服務(wù)器返回的mime類型。 |
Example
resource.patch(data)
.then(function(result) {
// use the result
}).otherwise(function(error) {
// an error occurred
});
異步地將數(shù)據(jù)發(fā)布到給定的資源。返回一個(gè)承諾,該承諾將在加載后解析為結(jié)果,或者在資源加載失敗時(shí)拒絕。使用xmlhttpRequest加載數(shù)據(jù),這意味著為了向另一個(gè)來源發(fā)出請(qǐng)求,服務(wù)器必須啟用跨來源資源共享(cors)頭。
Parameters:
data
(Object)
與資源一起發(fā)布的數(shù)據(jù)。
options
(Object)
Name | Description |
---|---|
options.data
Object
|
與資源一起發(fā)布的數(shù)據(jù)。 |
options.responseType
String
|
響應(yīng)類型。這控制返回的項(xiàng)的類型。 |
options.headers
Object
|
與請(qǐng)求一起發(fā)送的附加HTTP頭(如果有)。 |
options.overrideMimeType
String
|
重寫服務(wù)器返回的mime類型。 |
Example
resource.post(data)
.then(function(result) {
// use the result
}).otherwise(function(error) {
// an error occurred
});
異步地將數(shù)據(jù)放入給定的資源。返回一個(gè)承諾,該承諾將在加載后解析為結(jié)果,或者在資源加載失敗時(shí)拒絕。使用xmlhttpRequest加載數(shù)據(jù),這意味著為了向另一個(gè)來源發(fā)出請(qǐng)求,服務(wù)器必須啟用跨來源資源共享(cors)頭。
Parameters:
data
(Object)
與資源一起發(fā)布的數(shù)據(jù)。
options
(Object)
Name | Description |
---|---|
options.responseType
String
|
響應(yīng)類型。這控制返回的項(xiàng)的類型。 |
options.headers
Object
|
與請(qǐng)求一起發(fā)送的附加HTTP頭(如果有)。 |
options.overrideMimeType
String
|
重寫服務(wù)器返回的mime類型。 |
Example
resource.put(data)
.then(function(result) {
// use the result
}).otherwise(function(error) {
// an error occurred
});
組合指定的對(duì)象和現(xiàn)有查詢參數(shù)。這允許您一次添加多個(gè)參數(shù),而不是一次將它們添加到QueryParameters屬性中。如果已經(jīng)設(shè)置了一個(gè)值,它將被替換為新值。
Parameters:
params
(Object)
查詢參數(shù)
useAsDefault
(Boolean)
(default false
)
如果為真,參數(shù)將用作默認(rèn)值,因此只有在未定義參數(shù)時(shí)才會(huì)設(shè)置這些參數(shù)。
組合指定的對(duì)象和現(xiàn)有模板值。這允許您一次添加多個(gè)值,而不是一次將它們添加到TemplateValues屬性。如果已經(jīng)設(shè)置了一個(gè)值,它將成為一個(gè)數(shù)組,并附加新的值。
Parameters:
template
(Object)
模板值
useAsDefault
(Boolean)
(default false
)
如果為真,這些值將用作默認(rèn)值,因此只有在未定義的情況下才會(huì)設(shè)置這些值。
Type Definitions
RetryCallback(resource, error) → {Boolean|Promise.<Boolean>}
返回屬性值的函數(shù)。
Parameters:
error
(Error)
加載資源時(shí)發(fā)生的錯(cuò)誤。