Source: Core/loadText.js

  1. /*global define*/
  2. define([
  3.         './loadWithXhr'
  4.     ], function(
  5.         loadWithXhr) {
  6.     'use strict';
  8.     /**
  9.      * Asynchronously loads the given URL as text.  Returns a promise that will resolve to
  10.      * a String once loaded, or reject if the URL failed to load.  The data is loaded
  11.      * using XMLHttpRequest, which means that in order to make requests to another origin,
  12.      * the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
  13.      *
  14.      * @exports loadText
  15.      *
  16.      * @param {String|Promise.<String>} url The URL to request, or a promise for the URL.
  17.      * @param {Object} [headers] HTTP headers to send with the request.
  18.      * @returns {Promise.<String>} a promise that will resolve to the requested data when loaded.
  19.      *
  20.      *
  21.      * @example
  22.      * // load text from a URL, setting a custom header
  23.      * Cesium.loadText('http://someUrl.com/someJson.txt', {
  24.      *   'X-Custom-Header' : 'some value'
  25.      * }).then(function(text) {
  26.      *     // Do something with the text
  27.      * }).otherwise(function(error) {
  28.      *     // an error occurred
  29.      * });
  30.      * 
  31.      * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest|XMLHttpRequest}
  32.      * @see {@link http://www.w3.org/TR/cors/|Cross-Origin Resource Sharing}
  33.      * @see {@link http://wiki.commonjs.org/wiki/Promises/A|CommonJS Promises/A}
  34.      */
  35.     function loadText(url, headers) {
  36.         return loadWithXhr({
  37.             url : url,
  38.             headers : headers
  39.         });
  40.     }
  42.     return loadText;
  43. });