Resource

一種資源，包括位置和我們檢索它或創建派生資源所需的任何其他參數。它還提供了重試請求的能力。

new Resource(options)

Parameters:

options ((String | Object)) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。

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

初始化到當前瀏覽器位置的資源實例

(static, readonly) isBlobSupported : Boolean

如果支持blob，則返回true。

(readonly) extension : String

資源的文件擴展名。

hasHeaders : Boolean

如果資源具有請求頭，則為true。這相當于檢查headers屬性是否有任何鍵。

headers : Object

將隨請求一起發送的其他HTTP頭。

isBlobUri : Boolean

如果資源引用blob uri，則為true。

isCrossOriginUrl : Boolean

如果資源引用跨源URL，則為true。

isDataUri : Boolean

如果資源引用數據URI，則為true。

proxy : DefaultProxy

加載資源時要使用的代理。

(readonly) queryParameters : Object

附加到URL的查詢參數。

request : Request

將要使用的請求對象。僅供內部使用。

retryAttempts : Number

放棄前應調用RetryCallback的次數。

retryCallback : function

當請求此資源失敗時調用的函數。如果返回“真”或解析為“真”的承諾，將重試請求。

(readonly) templateValues : Object

用于替換URL中模板參數的鍵/值對。

url : String

替換模板值、追加查詢字符串并由代理（如果設置了）編碼的資源的URL。

Methods

(static) delete(options) → {Promise.<Object>|undefined}

從URL創建資源并對其調用delete（）。

Parameters:

options ((String | Object)) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.data `Object`	與資源一起發布的數據。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。
options.responseType `String`	響應類型。這控制返回的項的類型。
options.overrideMimeType `String`	重寫服務器返回的mime類型。

(static) fetch(options) → {Promise.<Object>|undefined}

從URL創建資源并對其調用fetch（）。

Parameters:

options ((String | Object)) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。
options.responseType `String`	響應類型。這控制返回的項的類型。
options.overrideMimeType `String`	重寫服務器返回的mime類型。

(static) fetchArrayBuffer(options) → {Promise.<ArrayBuffer>|undefined}

創建資源并對其調用fetcharrayBuffer（）。

Parameters:

options ((String | Object)) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。

(static) fetchBlob(options) → {Promise.<Blob>|undefined}

創建資源并對其調用fetchblob（）。

Parameters:

options ((String | Object)) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。

(static) fetchImage(options) → {Promise.<ImageBitmap>|Promise.<Image>|undefined}

創建資源并對其調用fetchImage（）。

Parameters:

options ((String | Object)) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.flipY `Boolean` default `false`	在提取和解碼期間是否垂直翻轉圖像。僅在請求圖像時適用，并且瀏覽器支持`createImageBitmap`。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。
options.preferBlob `Boolean` default `false`	如果為真，我們將通過blob加載圖像。
options.preferImageBitmap `Boolean` default `false`	如果為真，則圖像將在提取期間解碼，并返回`ImageBitmap`。

(static) fetchJson(options) → {Promise.<Object>|undefined}

創建資源并對其調用fetchjson（）。

Parameters:

options ((String | Object)) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。

(static) fetchJsonp(options) → {Promise.<Object>|undefined}

從URL創建資源并對其調用fetchjsonp（）。

Parameters:

options ((String | Object)) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。
options.callbackParameterName `String` default `'callback'`	服務器需要的回調參數名。

(static) fetchText(options) → {Promise.<String>|undefined}

創建資源并對其調用fetchText（）。

Parameters:

options ((String | Object)) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。

(static) fetchXML(options) → {Promise.<XMLDocument>|undefined}

創建資源并對其調用fetchxml（）。

Parameters:

options ((String | Object)) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。

(static) head(options) → {Promise.<Object>|undefined}

從URL創建資源并對其調用head（）。

Parameters:

options ((String | Object)) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。
options.responseType `String`	響應類型。這控制返回的項的類型。
options.overrideMimeType `String`	重寫服務器返回的mime類型。

(static) options(options) → {Promise.<Object>|undefined}

從URL創建資源并對其調用options（）。

Parameters:

options ((String | Object)) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。
options.responseType `String`	響應類型。這控制返回的項的類型。
options.overrideMimeType `String`	重寫服務器返回的mime類型。

(static) patch(options) → {Promise.<Object>|undefined}

從URL創建資源并對其調用patch（）。

Parameters:

options (Object) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.data `Object`	與資源一起發布的數據。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。
options.responseType `String`	響應類型。這控制返回的項的類型。
options.overrideMimeType `String`	重寫服務器返回的mime類型。

(static) post(options) → {Promise.<Object>|undefined}

從URL創建資源并對其調用post（）。

Parameters:

options (Object) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.data `Object`	與資源一起發布的數據。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。
options.responseType `String`	響應類型。這控制返回的項的類型。
options.overrideMimeType `String`	重寫服務器返回的mime類型。

(static) put(options) → {Promise.<Object>|undefined}

從URL創建資源并調用Put（）。

Parameters:

options (Object) 具有以下屬性的URL或對象

Name	Description
options.url `String`	資源的URL。
options.data `Object`	與資源一起發布的數據。
options.queryParameters `Object`	包含檢索資源時將發送的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	請求此資源失敗時要調用的函數。如果返回true，將重試請求。
options.retryAttempts `Number` default `0`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。
options.responseType `String`	響應類型。這控制返回的項的類型。
options.overrideMimeType `String`	重寫服務器返回的mime類型。

appendForwardSlash()

向URL追加正斜杠。

appendQueryParameters(params)

組合指定的對象和現有查詢參數。這允許您一次添加多個參數，而不是一次將它們添加到QueryParameters屬性中。

Parameters:

params (Object) 查詢參數

clone(result) → {Resource}

復制資源實例。

Parameters:

result (Resource) 存儲結果的對象。

delete(options) → {Promise.<Object>|undefined}

異步刪除給定的資源。返回一個承諾，該承諾將在加載后解析為結果，或者在資源加載失敗時拒絕。使用xmlhttpRequest加載數據，這意味著為了向另一個來源發出請求，服務器必須啟用跨來源資源共享（cors）頭。

Parameters:

options (Object)

Name	Description
options.responseType `String`	響應類型。這控制返回的項的類型。
options.headers `Object`	與請求一起發送的附加HTTP頭（如果有）。
options.overrideMimeType `String`	重寫服務器返回的mime類型。

Example

resource.delete()
  .then(function(body) {
      // use the data
  }).otherwise(function(error) {
      // an error occurred
  });

fetch(options) → {Promise.<Object>|undefined}

異步加載給定的資源。返回一個承諾，該承諾將在加載后解析為結果，或者在資源加載失敗時拒絕。使用xmlhttpRequest加載數據，這意味著為了向另一個來源發出請求，服務器必須啟用跨來源資源共享（cors）頭。建議您使用更具體的函數，如fetchjson、fetchblob等。

Parameters:

options (Object)

Name	Description
options.responseType `String`	響應類型。這控制返回的項的類型。
options.headers `Object`	與請求一起發送的附加HTTP頭（如果有）。
options.overrideMimeType `String`	重寫服務器返回的mime類型。

Example

resource.fetch()
  .then(function(body) {
      // use the data
  }).otherwise(function(error) {
      // an error occurred
  });

See:

Cross-Origin Resource Sharing
CommonJS Promises/A

fetchArrayBuffer() → {Promise.<ArrayBuffer>|undefined}

異步加載資源作為原始二進制數據。返回將在加載后解析為ArrayBuffer的承諾，或者在資源加載失敗時拒絕該承諾。使用xmlhttpRequest加載數據，這意味著為了向另一個來源發出請求，服務器必須啟用跨來源資源共享（cors）頭。

Example

// load a single URL asynchronously
resource.fetchArrayBuffer().then(function(arrayBuffer) {
    // use the data
}).otherwise(function(error) {
    // an error occurred
});

See:

Cross-Origin Resource Sharing
CommonJS Promises/A

fetchBlob() → {Promise.<Blob>|undefined}

以blob的形式異步加載給定的資源。返回一個承諾，該承諾將在加載后解析為blob，或者在資源加載失敗時拒絕。使用xmlhttpRequest加載數據，這意味著為了向另一個來源發出請求，服務器必須啟用跨來源資源共享（cors）頭。

Example

// load a single URL asynchronously
resource.fetchBlob().then(function(blob) {
    // use the data
}).otherwise(function(error) {
    // an error occurred
});

See:

Cross-Origin Resource Sharing
CommonJS Promises/A

fetchImage(options) → {Promise.<ImageBitmap>|Promise.<Image>|undefined}

異步加載給定的映像資源。返回一個承諾，如果preferImageBitmap為真且瀏覽器支持createImageBitmap或加載后的Image將解析為ImageBitmap，如果圖像加載失敗則拒絕。

Parameters:

options (Object) 具有以下屬性的對象。

Name	Description
options.preferBlob `Boolean` default `false`	如果為真，我們將通過blob加載圖像。
options.preferImageBitmap `Boolean` default `false`	如果為真，則圖像將在提取期間解碼，并返回`ImageBitmap`。
options.flipY `Boolean` default `false`	如果為真，則圖像將在解碼過程中垂直翻轉。僅當瀏覽器支持`createImageBitmap`時適用。

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:

Cross-Origin Resource Sharing
CommonJS Promises/A

fetchJson() → {Promise.<Object>|undefined}

以JSON的形式異步加載給定的資源。返回一個承諾，該承諾將在加載后解析為JSON對象，或者在資源加載失敗時拒絕。使用xmlhttpRequest加載數據，這意味著為了向另一個來源發出請求，服務器必須啟用跨來源資源共享（cors）頭。此函數將“accept:application/json，*；/；*；；q=0.01”添加到請求頭（如果尚未指定）。

Example

resource.fetchJson().then(function(jsonData) {
    // Do something with the JSON object
}).otherwise(function(error) {
    // an error occurred
});

See:

Cross-Origin Resource Sharing
CommonJS Promises/A

fetchJsonp(callbackParameterName) → {Promise.<Object>|undefined}

使用JSONP請求資源。

Parameters:

callbackParameterName (String) (default 'callback') 服務器需要的回調參數名。

Example

// load a data asynchronously
resource.fetchJsonp().then(function(data) {
    // use the loaded data
}).otherwise(function(error) {
    // an error occurred
});

See:

CommonJS Promises/A

fetchText() → {Promise.<String>|undefined}

以文本形式異步加載給定資源。返回將在加載后解析為字符串的承諾，或者在資源加載失敗時拒絕該承諾。使用xmlhttpRequest加載數據，這意味著為了向另一個來源發出請求，服務器必須啟用跨來源資源共享（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
});

See:

XMLHttpRequest
Cross-Origin Resource Sharing
CommonJS Promises/A

fetchXML() → {Promise.<XMLDocument>|undefined}

以XML的形式異步加載給定的資源。返回一個承諾，該承諾將在加載后解析為XML文檔，或者在資源加載失敗時拒絕。使用xmlhttpRequest加載數據，這意味著為了向另一個來源發出請求，服務器必須啟用跨來源資源共享（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
});

See:

XMLHttpRequest
Cross-Origin Resource Sharing
CommonJS Promises/A

getBaseUri(includeQuery) → {String}

返回資源的基本路徑。

Parameters:

includeQuery (Boolean) (default false) 是否包含來自URI的查詢字符串和片段

getDerivedResource(options) → {Resource}

返回相對于當前實例的資源。除非在選項中被重寫，否則所有屬性與當前實例保持相同。

Parameters:

options (Object) 具有以下屬性的對象

Name	Description
options.url `String`	將相對于當前實例的URL解析的URL。
options.queryParameters `Object`	包含將與當前實例的查詢參數組合的查詢參數的對象。
options.templateValues `Object`	用于替換模板值的鍵/值對（例如{x}）。這些將與當前實例的合并。
options.headers `Object` default `{}`	將發送的其他HTTP頭。
options.proxy `DefaultProxy`	加載資源時要使用的代理。
options.retryCallback `Resource~RetryCallback`	加載資源失敗時要調用的函數。
options.retryAttempts `Number`	放棄前應調用RetryCallback的次數。
options.request `Request`	將要使用的請求對象。僅供內部使用。
options.preserveQueryParameters `Boolean` default `false`	如果為true，則將保留當前資源和派生資源中的所有查詢參數。如果為false，派生參數將替換當前資源的參數。

getUrlComponent(query, proxy) → {String}

返回由代理處理的、查詢字符串可選的URL。

Parameters:

query (Boolean) (default false) 如果為true，則包含查詢字符串。

proxy (Boolean) (default false) 如果為true，則在定義代理對象時處理該URL。

head(options) → {Promise.<Object>|undefined}

異步獲取給定資源的頭。返回一個承諾，該承諾將在加載后解析為結果，或者在資源加載失敗時拒絕。使用xmlhttpRequest加載數據，這意味著為了向另一個來源發出請求，服務器必須啟用跨來源資源共享（cors）頭。

Parameters:

options (Object)

Name	Description
options.responseType `String`	響應類型。這控制返回的項的類型。
options.headers `Object`	與請求一起發送的附加HTTP頭（如果有）。
options.overrideMimeType `String`	重寫服務器返回的mime類型。

Example

resource.head()
  .then(function(headers) {
      // use the data
  }).otherwise(function(error) {
      // an error occurred
  });

See:

Cross-Origin Resource Sharing
CommonJS Promises/A

options(options) → {Promise.<Object>|undefined}

異步獲取給定資源的選項。返回一個承諾，該承諾將在加載后解析為結果，或者在資源加載失敗時拒絕。使用xmlhttpRequest加載數據，這意味著為了向另一個來源發出請求，服務器必須啟用跨來源資源共享（cors）頭。

Parameters:

options (Object)

Name	Description
options.responseType `String`	響應類型。這控制返回的項的類型。
options.headers `Object`	與請求一起發送的附加HTTP頭（如果有）。
options.overrideMimeType `String`	重寫服務器返回的mime類型。

Example

resource.options()
  .then(function(headers) {
      // use the data
  }).otherwise(function(error) {
      // an error occurred
  });

See:

Cross-Origin Resource Sharing
CommonJS Promises/A

patch(data, options) → {Promise.<Object>|undefined}

異步地將數據修補到給定的資源。返回一個承諾，該承諾將在加載后解析為結果，或者在資源加載失敗時拒絕。使用xmlhttpRequest加載數據，這意味著為了向另一個來源發出請求，服務器必須啟用跨來源資源共享（cors）頭。

Parameters:

data (Object) 與資源一起發布的數據。

options (Object)

Name	Description
options.responseType `String`	響應類型。這控制返回的項的類型。
options.headers `Object`	與請求一起發送的附加HTTP頭（如果有）。
options.overrideMimeType `String`	重寫服務器返回的mime類型。

Example

resource.patch(data)
  .then(function(result) {
      // use the result
  }).otherwise(function(error) {
      // an error occurred
  });

See:

Cross-Origin Resource Sharing
CommonJS Promises/A

post(data, options) → {Promise.<Object>|undefined}

異步地將數據發布到給定的資源。返回一個承諾，該承諾將在加載后解析為結果，或者在資源加載失敗時拒絕。使用xmlhttpRequest加載數據，這意味著為了向另一個來源發出請求，服務器必須啟用跨來源資源共享（cors）頭。

Parameters:

data (Object) 與資源一起發布的數據。

options (Object)

Name	Description
options.data `Object`	與資源一起發布的數據。
options.responseType `String`	響應類型。這控制返回的項的類型。
options.headers `Object`	與請求一起發送的附加HTTP頭（如果有）。
options.overrideMimeType `String`	重寫服務器返回的mime類型。

Example

resource.post(data)
  .then(function(result) {
      // use the result
  }).otherwise(function(error) {
      // an error occurred
  });

See:

Cross-Origin Resource Sharing
CommonJS Promises/A

put(data, options) → {Promise.<Object>|undefined}

異步地將數據放入給定的資源。返回一個承諾，該承諾將在加載后解析為結果，或者在資源加載失敗時拒絕。使用xmlhttpRequest加載數據，這意味著為了向另一個來源發出請求，服務器必須啟用跨來源資源共享（cors）頭。

Parameters:

data (Object) 與資源一起發布的數據。

options (Object)

Name	Description
options.responseType `String`	響應類型。這控制返回的項的類型。
options.headers `Object`	與請求一起發送的附加HTTP頭（如果有）。
options.overrideMimeType `String`	重寫服務器返回的mime類型。

Example

resource.put(data)
  .then(function(result) {
      // use the result
  }).otherwise(function(error) {
      // an error occurred
  });

See:

Cross-Origin Resource Sharing
CommonJS Promises/A

setQueryParameters(params, useAsDefault)

組合指定的對象和現有查詢參數。這允許您一次添加多個參數，而不是一次將它們添加到QueryParameters屬性中。如果已經設置了一個值，它將被替換為新值。

Parameters:

params (Object) 查詢參數

useAsDefault (Boolean) (default false) 如果為真，參數將用作默認值，因此只有在未定義參數時才會設置這些參數。

setTemplateValues(template, useAsDefault)

組合指定的對象和現有模板值。這允許您一次添加多個值，而不是一次將它們添加到TemplateValues屬性。如果已經設置了一個值，它將成為一個數組，并附加新的值。

Parameters:

template (Object) 模板值

useAsDefault (Boolean) (default false) 如果為真，這些值將用作默認值，因此只有在未定義的情況下才會設置這些值。

Type Definitions

RetryCallback(resource, error) → {Boolean|Promise.<Boolean>}

返回屬性值的函數。

Parameters:

resource (Resource) 加載失敗的資源。

error (Error) 加載資源時發生的錯誤。