@corefw/microservices/lib/response/ReadManyResponse.js

/**
 * @file Defines the ReadManyResponse class.
 *
 * @author Luke Chavers <luke@c2cschools.com>
 * @author Kevin Sanders <kevin@c2cschools.com>
 * @since 5.0.0
 * @license See LICENSE.md for details about licensing.
 * @copyright 2017 C2C Schools, LLC
 */

"use strict";

const SuccessResponse = require( "./SuccessResponse" );

/**
 * This response class represents an API response for a 'ReadMany' endpoint.
 *
 * @memberOf Response
 * @extends Response.SuccessResponse
 */
module.exports = class ReadManyResponse extends SuccessResponse {

	/**
	 * Creates a JSON-API compatible scaffold for the response body [object].
	 *
	 * This method extends the `BaseResponse` scaffold by adding the data.
	 *
	 * @private
	 * @returns {Object} Response body.
	 */
	_createResponseBody() {

		const me = this;

		let sBody = super._createResponseBody();

		sBody.data				= me.data._serializeToJsonApiObject();
		sBody.meta.pagination	= me.pagination;

		return sBody;
	}

	/**
	 * The pagination portion of the response.
	 *
	 * @public
	 * @type {Object}
	 * @default {}
	 */
	get pagination() {

		const me = this;

		return me.getConfigValue( "pagination", {} );
	}

	set pagination( /** Object */ val ) {

		const me = this;

		me.setConfigValue( "pagination", val );
	}
};