@ima/plugin-rest-client/dist/esm/Response.js

Generic REST API client plugin for the IMA application framework.

import clone from 'clone';
import AbstractEntity from './AbstractEntity';
import Request from './Request';
import { deepFreeze } from './utils';
/**
 * Typed representation of a REST API response.
 */ export default class Response {
    /**
   * Initializes the response representation using the provided data.
   *
   * @param {{
   *            status: number
   *            headers: Object<string, string>
   *            body: *
   *            cached: boolean
   *            request: Request
   *        }} responseData The data representing this response. See the
   *        fields of this class for more information.
   */ constructor(responseData){
        /**
     * The HTTP response status code of this response.
     *
     * @type {number}
     */ this.status = responseData.status;
        /**
     * The response headers. The keys are header names in lower-case, the
     * values are header values.
     *
     * @type {Object<string, string>}
     */ this.headers = Object.assign({}, responseData.headers);
        if ($Debug) {
            Object.freeze(this.headers);
        }
        let bodyData;
        if (responseData.body instanceof Array) {
            bodyData = responseData.body.map((element)=>{
                if (element instanceof AbstractEntity) {
                    return element;
                } else {
                    return clone(element);
                }
            });
        } else if (responseData.body instanceof AbstractEntity) {
            bodyData = responseData.body;
        } else {
            bodyData = clone(responseData.body);
        }
        /**
     * The response of the body, already parsed according to the value of
     * the response's {@code Content-Type} header.
     *
     * @type {*}
     */ this.body = bodyData;
        if ($Debug) {
            if (!(this.body instanceof AbstractEntity)) {
                deepFreeze(this.body);
            }
        }
        /**
     * The flag signalling whether this request was handled by the HTTP
     * agent's cache.
     *
     * @type {boolean}
     */ this.cached = responseData.cached;
        /**
     * The REST API request that was made and resulted in this response.
     *
     * @type {Request}
     */ this.request = new Request(responseData.request);
        if ($Debug) {
            Object.freeze(this);
        }
    }
}

//# sourceMappingURL=Response.js.map