Source: Core/RequestErrorEvent.js

  1. /*global define*/
  2. define([
  3.         './defined',
  4.         './parseResponseHeaders'
  5.     ], function(
  6.         defined,
  7.         parseResponseHeaders) {
  8.     'use strict';
  10.     /**
  11.      * An event that is raised when a request encounters an error.
  12.      *
  13.      * @constructor
  14.      * @alias RequestErrorEvent
  15.      *
  16.      * @param {Number} [statusCode] The HTTP error status code, such as 404.
  17.      * @param {Object} [response] The response included along with the error.
  18.      * @param {String|Object} [responseHeaders] The response headers, represented either as an object literal or as a
  19.      *                        string in the format returned by XMLHttpRequest's getAllResponseHeaders() function.
  20.      */
  21.     function RequestErrorEvent(statusCode, response, responseHeaders) {
  22.         /**
  23.          * The HTTP error status code, such as 404.  If the error does not have a particular
  24.          * HTTP code, this property will be undefined.
  25.          *
  26.          * @type {Number}
  27.          */
  28.         this.statusCode = statusCode;
  30.         /**
  31.          * The response included along with the error.  If the error does not include a response,
  32.          * this property will be undefined.
  33.          *
  34.          * @type {Object}
  35.          */
  36.         this.response = response;
  38.         /**
  39.          * The headers included in the response, represented as an object literal of key/value pairs.
  40.          * If the error does not include any headers, this property will be undefined.
  41.          *
  42.          * @type {Object}
  43.          */
  44.         this.responseHeaders = responseHeaders;
  46.         if (typeof this.responseHeaders === 'string') {
  47.             this.responseHeaders = parseResponseHeaders(this.responseHeaders);
  48.         }
  49.     }
  51.     /**
  52.      * Creates a string representing this RequestErrorEvent.
  53.      * @memberof RequestErrorEvent
  54.      *
  55.      * @returns {String} A string representing the provided RequestErrorEvent.
  56.      */
  57.     RequestErrorEvent.prototype.toString = function() {
  58.         var str = 'Request has failed.';
  59.         if (defined(this.statusCode)) {
  60.             str += ' Status Code: ' + this.statusCode;
  61.         }
  62.         return str;
  63.     };
  65.     return RequestErrorEvent;
  66. });