mice.js v0.0.1

mice.js

É um wrapper em javascript para trabalhar com a API do Club Mice.

Links

• :mouse: Club Mice
• :us: Documentation in English
• :es: Documentación en Español

Informações

:exclamation: Club Mice API é uma ferramenta projetada para desenvolvedores que permite obter dados dos perfis do Transformice. Graças a esta ferramenta, você pode mostrar informações sobre ratos em sua aplicação.

:exclamation: Primeiro de tudo, é importante saber que a API nem sempre funciona. O Transformice leva cerca de 1 hora para atualizar os perfis e, durante esse período, a API do Mice do Clube não funcionará, exceto a classificação.

Instalação

Utilizando o NPM

$ npm install mice.js --save

Utilizando o Yarn

$ yarn add mice.js

Como usar

const mice = require('mice.js')

mice.mouse.getData('Ramonrod').then(data => { // aqui você manipula os dados. }

## Métodos
> Aqui estão alguns métodos que a biblioteca oferece.
### mouse.getData(nome)
> Retorna os dados do Jogador

**Argumentos**
| Argumento | Tipo | Opções |
|-----------|-------|-------|
|`nome`   |*String* | 'Procura os dados do Jogador'|

**Exemplo**
```js
mice.mouse.getData('Ramonrod').then(data => {
  console.log(`Você jogou ${data.round_played} partidas.`)
}

tribe.getByName(nome || id)

Retorna os dados da Tribol

Argumentos | Argumento | Tipo | Opções | |-----------|-------|-------| |nome |String | 'Procura pelo o nome da Tribo'|

Exemplo

// Procurando com nome
mice.tribe.getByName('Vamos CNB').then(tribe => {
  console.log(`O ID da tribo é ${tribe.id}`)
}

Autor

Ramon Rodrigues

Licença

Este projeto esta sob a licença do MIT, leia o arquivo LICENCE.md para mais informações.