1.0.8 • Published 3 years ago
@zuraaa-projects/charlotte v1.0.8
Charlotte
Charlotte é um Wrapper para Javascript/Typescript criado para facilitar o uso da API do Zuraaa List.
Contendo as principais funcionalidades como pegar informações dos ‘bots’ e usuários diretamente da API, bem como um mini servidor de WebHook para receber votos em tempo real.
Estilo de código
Instalação
$ npm i --save @zuraaa-projects/charlotte
Exemplo de utilização:
- Rest:
const { ZuraaaRestApi } = require('@zuraaa-projects/charlotte')
const apiRest = new ZuraaaRestApi()
apiRest.getBot('id do bot')
.then(console.log)
.catch(console.err)
apiRest.getUser('id do usuario')
.then(console.log)
.catch(console.err)
WebHook
const { ZuraaaWebHook } = require('@zuraaa-projects/charlotte') //criar webhook com as configurações default const webhook = new ZuraaaWebHook() //criar webhook com configuração personalizada const webhook = new ZuraaaWebHook({ port: 5000, endpoint: 'webhook/callback', auth: 'imagine um hash daora aqui ou um password' }) webhook.on('vote', dataVote => { //ação que deseja tomar quando o bot receber um voto }) webhook.start()
Suporte
- Suporte feito através do nosso Discord
Fair Use
- Fica livre o uso desse software bem como modificações no mesmo desde que dentro da licença MIT.