nosu v0.7.0

nosu

un modulo simple para utilizar la osu!api, por ahora solo está disponible para la v1

Instalacion y actualizacion

puedes instalarlo desde npm con

npm install nosu

y tambien puedes actualizarlo con

npm update nosu

Documentacion

requerimos nosu

const { apiV1, tools } = require("nosu")

Metodos

todos los metodos retornan una Promise Para los parametros de los metodos puedes revisar: https://github.com/ppy/osu-api/wiki

Constructor

Consigue tu token de osu! aqui

const nosu = new apiV1("tu-token-de-api-aqui", {
    parseNum: true, // pasa los numeros a string, (default: true)
    notFound: true  // lanza un error cuando algun metodo no encuentra nada, (default: true)
 // baseUrl: 'https://osu.ppy.sh/api', la url para acceder a la osu!api, (default: https://osu.ppy.sh/api)    
})

beatmaps

retorna un Array con Objects de los beatmaps buscados

(async () => {
  try {
    let beatmap = await nosu.beatmaps({b: 767046});
    console.log(beatmap[0]);
  } catch (err) {
    console.error(err);
  }
})();

users

retorna un Object con la informacion del usuario buscado

(async () => {
  try {
    let user = await nosu.user({u: 17184238, m: 3});
    console.log(user);
  } catch (err) {
    console.error(err);
  }
})();

scores

retorna un Array con los scores del mapa buscado

(async () => {
  try {
    let scores = await nosu.scores({b: 767046});
    console.log(scores);
  } catch (err) {
    console.error(err);
  }
})();

userBest

retorna un Array con Objects de las mejores partidas del usuario buscado

(async () => {
  try {
    let maps = await nosu.userBest({u: 17184238, m: 3});
    console.log(maps);
  } catch (err) {
    console.error(err);
  }
})();

userRecent

retorna un Array con Objects de las partidas mas recientes en las ultimas 24 horas del usuario buscado

(async () => {
  try {
    let recents = await nosu.userRecent({u: 17184238, m: 3});
    console.log(recents[0]);
  } catch (err) {
    console.error(err);
  }
})();

match

retorna un Object con la informacion de la partida multijugador buscada

(async () => {
  try {
    let match = await nosu.match({bm: 25576650});
    console.log(match);
  } catch (err) {
    console.error(err);
  }
})();

Tools

accuracy

retorna un Number con la acc de los hits colocados

let Acc = tools.accuracy('mania', 263, 0, 10, 3, 960, 20); //(modo, h300, h100, miss, h50, geki, katu)
console.log(Acc);

modName

retorna un String con el nombre del mod colocado

let ModName = tools.modName(0); // (id del mod)
console.log(ModName);

modId

retorna un String|Number con el mod colocado

let ModID = tools.modId('MR'); // (nombre del mod)
console.log(ModID);