Source: components/UserComponent.js

  1. 'use strict';
  3. const Component = require('./Component')
  4.     , ApiConstants = require('../Constants').API
  5.     , User = require('../struct/User')
  6.     , UserScore = require('../struct/UserScore');
  8. /**
  9.  * User-related API component
  10.  * @memberof module:Components
  11.  * @example
  12.  * api.user
  13.  *     .get('4222959')
  14.  *     .then(console.log);
  15.  */
  16. class UserComponent extends Component {
  17.     /**
  18.      * Gets general user information.
  19.      * @param {String} user The username or id to lookup.
  20.      * @param {Mode} [mode] The gamemode.
  21.      * @param {Number} [eventDays] The max number of event days.
  22.      * @param {LookupType} [lookupType] The lookup type, id/string to lookup the user.
  23.      * @return {Promise<Object|User>} The object from the API, or User object if parsing is enabled.
  24.      */
  25.     get(user, mode, eventDays, lookupType) {
  26.         let options = { u: user };
  27.         if (mode !== undefined)
  28.             options.m = mode;
  29.         if (eventDays !== undefined)
  30.             options.event_days = eventDays;
  31.         if (lookupType !== undefined)
  32.             options.type = lookupType
  34.         return this.api.requester.get(ApiConstants.USER_GET, options, true, true, User)
  35.             .then(d => d[0]); // there can only be one user
  36.     }
  38.     /**
  39.      * Gets the top scores for the user specified.
  40.      * @param {String} user The username or id to lookup.
  41.      * @param {Mode} [mode] The gamemode.
  42.      * @param {Number} [limit] Amount of results to limit to.
  43.      * @param {LookupType} [lookupType] The lookup type, id/string to lookup the user.
  44.      * @return {Promise<Object[]|UserScore[]>} The object array from the API, or UserScore object array if parsing is enabled.
  45.      */
  46.     getBest(user, mode, limit, lookupType) {
  47.         let options = { u: user };
  48.         if (mode !== undefined)
  49.             options.m = mode;
  50.         if (limit !== undefined)
  51.             options.limit = limit;
  52.         if (lookupType !== undefined)
  53.             options.type = lookupType;
  55.         return this.api.requester.get(ApiConstants.USER_GET_BEST, options, true, true, UserScore);
  56.     }
  58.     /**
  59.      * Gets the recent plays for the user specified.
  60.      * @param {String} user The username or id to lookup.
  61.      * @param {Mode} [mode] The gamemode.
  62.      * @param {Number} [limit] Amount of results to limit to.
  63.      * @param {LookupType} [lookupType] The lookup type, id/string to lookup the user.
  64.      * @return {Promise<Object[]|UserScore[]>} The object array from the API, or UserScore object array if parsing is enabled.
  65.      */
  66.     getRecent(user, mode, limit, lookupType) {
  67.         let options = { u: user };
  68.         if (mode !== undefined)
  69.             options.m = mode;
  70.         if (limit !== undefined)
  71.             options.limit = limit;
  72.         if (lookupType !== undefined)
  73.             options.type = lookupType;
  75.         return this.api.requester.get(ApiConstants.USER_GET_RECENT, options, true, true, UserScore);
  76.     }
  77. }
  79. module.exports = UserComponent;