Source: src/models/ItemListResponse.js

  1. 'use strict';
  3. /**
  4.  * Represents a list of items returned from GW2 Spidy's full item list.
  5.  *
  6.  * @param {string} json A string of JSON that represents a Spidy result list
  7.  * @returns {ItemListResponse}
  8.  * @constructor
  9.  */
  10. function ItemListResponse(json) {
  11.   if (! (this instanceof ItemListResponse)) {
  12.     return new ItemListResponse();
  13.   }
  15.   var self = Object.getPrototypeOf(this);
  17.   if (json) {
  18.     var parsedJson = JSON.parse(json);
  19.     Object.keys(parsedJson).forEach(function mapItemJson(val) {
  20.       var prop = (val === 'last_page') ? 'lastPage' : val;
  21.       this[prop] = parsedJson[val];
  22.     }, self);
  23.   }
  24. }
  26. ItemListResponse.prototype = {
  27.   /**
  28.    * The number of results in the current page of results if the API
  29.    * returned such information. Otherwise, it is -1.
  30.    *
  31.    * @returns {number}
  32.    */
  33.   get count() {
  34.     return (this._count) ? this._count : -1;
  35.   },
  36.   set count(count) {
  37.     this._count = (count) ? count : -1;
  38.   },
  40.   /**
  41.    * The current page number of the results if the API returned such
  42.    * information. Otherwise it is -1.
  43.    *
  44.    * @returns {number}
  45.    */
  46.   get page() {
  47.     return (this._page) ? this._page : -1;
  48.   },
  49.   set page(page) {
  50.     this._page = (page) ? page : -1;
  51.   },
  53.   /**
  54.    * The number of the last available page of results if the API returned such
  55.    * information. Otherwise, it is -1.
  56.    *
  57.    * @returns {number}
  58.    */
  59.   get lastPage() {
  60.     return (this._lastPage) ? this._lastPage : -1;
  61.   },
  62.   set lastPage(lastPage) {
  63.     this._lastPage = (lastPage) ? lastPage : -1;
  64.   },
  66.   /**
  67.    * The total number of results if the API returned such information.
  68.    * Otherwise, it is -1.
  69.    *
  70.    * @returns {number}
  71.    */
  72.   get total() {
  73.     return (this._total) ? this._total : -1;
  74.   },
  75.   set total(total) {
  76.     this._total = (total) ? total : -1;
  77.   },
  79.   /**
  80.    * Retrieve the list of {@link Item} objects as returned by the REST API.
  81.    *
  82.    * @returns {array}
  83.    */
  84.   get results() {
  85.     return (this._results) ? this._results : [];
  86.   },
  87.   set results(results) {
  88.     this._results = (results) ? results : [];
  89.   }
  90. };
  92. exports = module.exports = function() {
  93.   return ItemListResponse;
  94. };
  96. exports['@singleton'] = false;