superagent/lib/node/response.js

elegant & feature rich browser / node HTTP with a fluent API

"use strict";

/**
 * Module dependencies.
 */

const util = require('node:util');
const Stream = require('node:stream');
const ResponseBase = require('../response-base');
const _require = require('../utils'),
  mixin = _require.mixin;

/**
 * Expose `Response`.
 */

module.exports = Response;

/**
 * Initialize a new `Response` with the given `xhr`.
 *
 *  - set flags (.ok, .error, etc)
 *  - parse header
 *
 * @param {Request} req
 * @param {Object} options
 * @constructor
 * @extends {Stream}
 * @implements {ReadableStream}
 * @api private
 */

function Response(request) {
  Stream.call(this);
  this.res = request.res;
  const res = this.res;
  this.request = request;
  this.req = request.req;
  this.text = res.text;
  this.files = res.files || {};
  this.buffered = request._resBuffered;
  this.headers = res.headers;
  this.header = this.headers;
  this._setStatusProperties(res.statusCode);
  this._setHeaderProperties(this.header);
  this.setEncoding = res.setEncoding.bind(res);
  res.on('data', this.emit.bind(this, 'data'));
  res.on('end', this.emit.bind(this, 'end'));
  res.on('close', this.emit.bind(this, 'close'));
  res.on('error', this.emit.bind(this, 'error'));
}

// Lazy access res.body.
// https://github.com/nodejs/node/pull/39520#issuecomment-889697136
Object.defineProperty(Response.prototype, 'body', {
  get() {
    return this._body === undefined ? this.res.body === undefined ? {} : this.res.body : this._body;
  },
  set(value) {
    this._body = value;
  }
});

/**
 * Inherit from `Stream`.
 */

util.inherits(Response, Stream);
mixin(Response.prototype, ResponseBase.prototype);

/**
 * Implements methods of a `ReadableStream`
 */

Response.prototype.destroy = function (error) {
  this.res.destroy(error);
};

/**
 * Pause.
 */

Response.prototype.pause = function () {
  this.res.pause();
};

/**
 * Resume.
 */

Response.prototype.resume = function () {
  this.res.resume();
};

/**
 * Return an `Error` representative of this response.
 *
 * @return {Error}
 * @api public
 */

Response.prototype.toError = function () {
  const req = this.req;
  const method = req.method;
  const path = req.path;
  const message = `cannot ${method} ${path} (${this.status})`;
  const error = new Error(message);
  error.status = this.status;
  error.text = this.text;
  error.method = method;
  error.path = path;
  return error;
};
Response.prototype.setStatusProperties = function (status) {
  console.warn('In superagent 2.x setStatusProperties is a private method');
  return this._setStatusProperties(status);
};

/**
 * To json.
 *
 * @return {Object}
 * @api public
 */

Response.prototype.toJSON = function () {
  return {
    req: this.request.toJSON(),
    header: this.header,
    status: this.status,
    text: this.text
  };
};
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"names":["util","require","Stream","ResponseBase","_require","mixin","module","exports","Response","request","call","res","req","text","files","buffered","_resBuffered","headers","header","_setStatusProperties","statusCode","_setHeaderProperties","setEncoding","bind","on","emit","Object","defineProperty","prototype","get","_body","undefined","body","set","value","inherits","destroy","error","pause","resume","toError","method","path","message","status","Error","setStatusProperties","console","warn","toJSON"],"sources":["../../src/node/response.js"],"sourcesContent":["/**\n * Module dependencies.\n */\n\nconst util = require('node:util');\nconst Stream = require('node:stream');\nconst ResponseBase = require('../response-base');\nconst { mixin } = require('../utils');\n\n/**\n * Expose `Response`.\n */\n\nmodule.exports = Response;\n\n/**\n * Initialize a new `Response` with the given `xhr`.\n *\n *  - set flags (.ok, .error, etc)\n *  - parse header\n *\n * @param {Request} req\n * @param {Object} options\n * @constructor\n * @extends {Stream}\n * @implements {ReadableStream}\n * @api private\n */\n\nfunction Response(request) {\n  Stream.call(this);\n  this.res = request.res;\n  const { res } = this;\n  this.request = request;\n  this.req = request.req;\n  this.text = res.text;\n  this.files = res.files || {};\n  this.buffered = request._resBuffered;\n  this.headers = res.headers;\n  this.header = this.headers;\n  this._setStatusProperties(res.statusCode);\n  this._setHeaderProperties(this.header);\n  this.setEncoding = res.setEncoding.bind(res);\n  res.on('data', this.emit.bind(this, 'data'));\n  res.on('end', this.emit.bind(this, 'end'));\n  res.on('close', this.emit.bind(this, 'close'));\n  res.on('error', this.emit.bind(this, 'error'));\n}\n\n// Lazy access res.body.\n// https://github.com/nodejs/node/pull/39520#issuecomment-889697136\nObject.defineProperty(Response.prototype, 'body', {\n  get() {\n    return this._body === undefined\n      ? this.res.body === undefined\n        ? {}\n        : this.res.body\n      : this._body;\n  },\n  set(value) {\n    this._body = value;\n  }\n});\n\n/**\n * Inherit from `Stream`.\n */\n\nutil.inherits(Response, Stream);\n\nmixin(Response.prototype, ResponseBase.prototype);\n\n/**\n * Implements methods of a `ReadableStream`\n */\n\nResponse.prototype.destroy = function (error) {\n  this.res.destroy(error);\n};\n\n/**\n * Pause.\n */\n\nResponse.prototype.pause = function () {\n  this.res.pause();\n};\n\n/**\n * Resume.\n */\n\nResponse.prototype.resume = function () {\n  this.res.resume();\n};\n\n/**\n * Return an `Error` representative of this response.\n *\n * @return {Error}\n * @api public\n */\n\nResponse.prototype.toError = function () {\n  const { req } = this;\n  const { method } = req;\n  const { path } = req;\n\n  const message = `cannot ${method} ${path} (${this.status})`;\n  const error = new Error(message);\n  error.status = this.status;\n  error.text = this.text;\n  error.method = method;\n  error.path = path;\n\n  return error;\n};\n\nResponse.prototype.setStatusProperties = function (status) {\n  console.warn('In superagent 2.x setStatusProperties is a private method');\n  return this._setStatusProperties(status);\n};\n\n/**\n * To json.\n *\n * @return {Object}\n * @api public\n */\n\nResponse.prototype.toJSON = function () {\n  return {\n    req: this.request.toJSON(),\n    header: this.header,\n    status: this.status,\n    text: this.text\n  };\n};\n"],"mappings":";;AAAA;AACA;AACA;;AAEA,MAAMA,IAAI,GAAGC,OAAO,CAAC,WAAW,CAAC;AACjC,MAAMC,MAAM,GAAGD,OAAO,CAAC,aAAa,CAAC;AACrC,MAAME,YAAY,GAAGF,OAAO,CAAC,kBAAkB,CAAC;AAChD,MAAAG,QAAA,GAAkBH,OAAO,CAAC,UAAU,CAAC;EAA7BI,KAAK,GAAAD,QAAA,CAALC,KAAK;;AAEb;AACA;AACA;;AAEAC,MAAM,CAACC,OAAO,GAAGC,QAAQ;;AAEzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,QAAQA,CAACC,OAAO,EAAE;EACzBP,MAAM,CAACQ,IAAI,CAAC,IAAI,CAAC;EACjB,IAAI,CAACC,GAAG,GAAGF,OAAO,CAACE,GAAG;EACtB,MAAQA,GAAG,GAAK,IAAI,CAAZA,GAAG;EACX,IAAI,CAACF,OAAO,GAAGA,OAAO;EACtB,IAAI,CAACG,GAAG,GAAGH,OAAO,CAACG,GAAG;EACtB,IAAI,CAACC,IAAI,GAAGF,GAAG,CAACE,IAAI;EACpB,IAAI,CAACC,KAAK,GAAGH,GAAG,CAACG,KAAK,IAAI,CAAC,CAAC;EAC5B,IAAI,CAACC,QAAQ,GAAGN,OAAO,CAACO,YAAY;EACpC,IAAI,CAACC,OAAO,GAAGN,GAAG,CAACM,OAAO;EAC1B,IAAI,CAACC,MAAM,GAAG,IAAI,CAACD,OAAO;EAC1B,IAAI,CAACE,oBAAoB,CAACR,GAAG,CAACS,UAAU,CAAC;EACzC,IAAI,CAACC,oBAAoB,CAAC,IAAI,CAACH,MAAM,CAAC;EACtC,IAAI,CAACI,WAAW,GAAGX,GAAG,CAACW,WAAW,CAACC,IAAI,CAACZ,GAAG,CAAC;EAC5CA,GAAG,CAACa,EAAE,CAAC,MAAM,EAAE,IAAI,CAACC,IAAI,CAACF,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;EAC5CZ,GAAG,CAACa,EAAE,CAAC,KAAK,EAAE,IAAI,CAACC,IAAI,CAACF,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;EAC1CZ,GAAG,CAACa,EAAE,CAAC,OAAO,EAAE,IAAI,CAACC,IAAI,CAACF,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;EAC9CZ,GAAG,CAACa,EAAE,CAAC,OAAO,EAAE,IAAI,CAACC,IAAI,CAACF,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAChD;;AAEA;AACA;AACAG,MAAM,CAACC,cAAc,CAACnB,QAAQ,CAACoB,SAAS,EAAE,MAAM,EAAE;EAChDC,GAAGA,CAAA,EAAG;IACJ,OAAO,IAAI,CAACC,KAAK,KAAKC,SAAS,GAC3B,IAAI,CAACpB,GAAG,CAACqB,IAAI,KAAKD,SAAS,GACzB,CAAC,CAAC,GACF,IAAI,CAACpB,GAAG,CAACqB,IAAI,GACf,IAAI,CAACF,KAAK;EAChB,CAAC;EACDG,GAAGA,CAACC,KAAK,EAAE;IACT,IAAI,CAACJ,KAAK,GAAGI,KAAK;EACpB;AACF,CAAC,CAAC;;AAEF;AACA;AACA;;AAEAlC,IAAI,CAACmC,QAAQ,CAAC3B,QAAQ,EAAEN,MAAM,CAAC;AAE/BG,KAAK,CAACG,QAAQ,CAACoB,SAAS,EAAEzB,YAAY,CAACyB,SAAS,CAAC;;AAEjD;AACA;AACA;;AAEApB,QAAQ,CAACoB,SAAS,CAACQ,OAAO,GAAG,UAAUC,KAAK,EAAE;EAC5C,IAAI,CAAC1B,GAAG,CAACyB,OAAO,CAACC,KAAK,CAAC;AACzB,CAAC;;AAED;AACA;AACA;;AAEA7B,QAAQ,CAACoB,SAAS,CAACU,KAAK,GAAG,YAAY;EACrC,IAAI,CAAC3B,GAAG,CAAC2B,KAAK,CAAC,CAAC;AAClB,CAAC;;AAED;AACA;AACA;;AAEA9B,QAAQ,CAACoB,SAAS,CAACW,MAAM,GAAG,YAAY;EACtC,IAAI,CAAC5B,GAAG,CAAC4B,MAAM,CAAC,CAAC;AACnB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;;AAEA/B,QAAQ,CAACoB,SAAS,CAACY,OAAO,GAAG,YAAY;EACvC,MAAQ5B,GAAG,GAAK,IAAI,CAAZA,GAAG;EACX,MAAQ6B,MAAM,GAAK7B,GAAG,CAAd6B,MAAM;EACd,MAAQC,IAAI,GAAK9B,GAAG,CAAZ8B,IAAI;EAEZ,MAAMC,OAAO,GAAI,UAASF,MAAO,IAAGC,IAAK,KAAI,IAAI,CAACE,MAAO,GAAE;EAC3D,MAAMP,KAAK,GAAG,IAAIQ,KAAK,CAACF,OAAO,CAAC;EAChCN,KAAK,CAACO,MAAM,GAAG,IAAI,CAACA,MAAM;EAC1BP,KAAK,CAACxB,IAAI,GAAG,IAAI,CAACA,IAAI;EACtBwB,KAAK,CAACI,MAAM,GAAGA,MAAM;EACrBJ,KAAK,CAACK,IAAI,GAAGA,IAAI;EAEjB,OAAOL,KAAK;AACd,CAAC;AAED7B,QAAQ,CAACoB,SAAS,CAACkB,mBAAmB,GAAG,UAAUF,MAAM,EAAE;EACzDG,OAAO,CAACC,IAAI,CAAC,2DAA2D,CAAC;EACzE,OAAO,IAAI,CAAC7B,oBAAoB,CAACyB,MAAM,CAAC;AAC1C,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;;AAEApC,QAAQ,CAACoB,SAAS,CAACqB,MAAM,GAAG,YAAY;EACtC,OAAO;IACLrC,GAAG,EAAE,IAAI,CAACH,OAAO,CAACwC,MAAM,CAAC,CAAC;IAC1B/B,MAAM,EAAE,IAAI,CAACA,MAAM;IACnB0B,MAAM,EAAE,IAAI,CAACA,MAAM;IACnB/B,IAAI,EAAE,IAAI,CAACA;EACb,CAAC;AACH,CAAC"}