Bem Vindo ao anime-info 👋

License: MIT gitmoji-changelog

> Plugin usado para buscar informações de personagens direto do site oficial da [Fandom](https://www.fandom.com/) e retorna um JSON.

🙅‍♂️ Atenção !!! Essa biblioteca foi criada apenas para fins didáticos e a propriedade intelectual das informações pertence a seus respectivos criadores.

Possibilidade de buscar de personagem por anime
Anime Quantidade
Naruto + 994
DragonBall Z + 250
One Punch Man + 135
Hunter x Hunter + 96
## ✨ Demo - Site: [Anime Info Demo](https://anime-info-demo.herokuapp.com/) - Repositório [Anime Info Demo](https://github.com/1995Everton/anime-info-demo) ## 👉 Instalação ```sh npm install anime-info ``` ## 🚀 Uso ```ts import { Naruto } from "anime-info"; const naruto = new Naruto(); async function searchCharacter(){ const itachi = await naruto.getCharacter("Itachi_Uchiha"); console.log(itachi); } searchCharacter(); ``` 🐛 [Alerta] Você deve usar o nome completo do personagem separando por "_". 😉 [Dica] Existe também o método `getListCharacters` que retorna uma lista dos personagem mais relevantes. Também e possível desabilitar um ou mais campos com a propriedade`exclude`. ```ts const itachi = await naruto.getCharacter("Itachi_Uchiha",{ exclude: [ "name", "birthday" ] }); ``` Ou buscar campos específicos com a propriedade `only` ```ts const itachi = await naruto.getCharacter("Itachi_Uchiha",{ only: [ "name", "debut" ] }); ``` Ambos recebem um array de string com o nome exato da propriedade escolhida. ## 🌎 Internacionalização ```ts import { Naruto } from "anime-info"; // default "pt-br" const naruto = new Naruto({ lang : "es" }); ```
Linguagens lang Naruto Dragon Ball Z One Punch Man Hunter x Hunter
Português pr-br ✔ ✔ ✖ ✖
Espanol es ✔ ✔ ✔ ✔
English en ✖ ✔ ✔ ✔
## 📖 Documentação ### Métodos #### 📌 getCharacter - Retorna os dados de um determinado personagem `getCharacter(name , option): Promise;`
Opção Type Requirido Padrão Descrição
name String true null Nome do personagem que deseja buscar
option Object false {
"exclude": [ ],
"only": [       `all fields`
   ]
}		 Opções de retorno do JSON
#### 📌 getListCharacters - Retorna uma lista com os nomes dos personagens `getListCharacters(search): Array;`
Opção Type Requirido Padrão Descrição
search String false Filtra o nome dos personagens, retorna todos se não informado
### 💯 Suporte ao TypeScript ## 🤝 Contribuindo Contribuições, problemas e solicitações de recursos são bem-vindos.
Sinta-se livre para verificar [issues page](https://github.com/1995Everton/anime-info/issues) se você quiser contribuir.
## Autor 👤 **Everton Cardoso** - Github: [1995Everton](https://github.com/1995Everton) ## Mostre seu apoio Por favor ⭐️ esse repositório se ele lhe ajudou! ## 📝 License Copyright © 2020 [Everton](https://github.com/1995Everton).
Esse projeto e licenciado por [MIT](https://github.com/1995Everton/anime-info/blob/master/LICENSE). --- _This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_