Source: components/ScoresComponent.js

  1. 'use strict';
  3. const Component = require('./Component')
  4.     , ApiConstants = require('../Constants').API
  5.     , BeatmapScore = require('../struct/BeatmapScore');
  7. /**
  8.  * Scores-related API component
  9.  * @memberof module:Components
  10.  * @example
  11.  * api.scores
  12.  *     .get('1110141')
  13.  *     .then(console.log);
  14.  */
  15. class ScoresComponent extends Component {
  16.     /**
  17.      * Gets scores for a specific beatmap
  18.      * @param {String} beatmapId The beatmap ID.
  19.      * @param {Mods} [mods] The bitwise combination for the mods.
  20.      * @param {Mode} [mode] The gamemode.
  21.      * @param {Number} [limit] The limit of scores to get.
  22.      * @param {String} [user] User to lookup.
  23.      * @param {LookupType} [lookupType] Only for if user is given, the lookup mode for it.
  24.      * @return {Promise<Object[]|BeatmapScore[]>} The object array from the API, or BeatmapScore object array if parsing is enabled.
  25.      */
  26.     get(beatmapId, mods, mode, limit, user, lookupType) {
  27.         let options = { b: beatmapId };
  28.         if (mods !== undefined)
  29.             options.mods = mods;
  30.         if (mode !== undefined)
  31.             options.m = mode;
  32.         if (limit !== undefined)
  33.             options.limit = limit;
  34.         if (user !== undefined)
  35.             options.u = user;
  36.         if (lookupType !== undefined)
  37.             options.type = lookupType;
  39.         return this.api.requester.get(ApiConstants.SCORES_GET, options, true, true, BeatmapScore);
  40.     }
  41. }
  43. module.exports = ScoresComponent;