Bem Vindo ao anime-info 👋

Plugin usado para buscar informações de personagens direto do site oficial da Fandom 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.

✨ Demo

• Site: Anime Info Demo
• Repositório Anime Info Demo

👉 Instalação

npm install anime-info

🚀 Uso

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 propriedadeexclude.

 
const itachi = await naruto.getCharacter("Itachi_Uchiha",{ 
    exclude: [
        "name",
        "birthday"
    ]
});
 

Ou buscar campos específicos com a propriedade only

 
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

import { Naruto } from "anime-info";
 
// default "pt-br"
const naruto = new Naruto({ lang : "es" });
 

📖 Documentação

Métodos

📌 getCharacter

• Retorna os dados de um determinado personagem

  getCharacter(name , option): Promise<Object>;

📌 getListCharacters

• Retorna uma lista com os nomes dos personagens

getListCharacters(search): Array<string>;

💯 Suporte ao TypeScript

🤝 Contribuindo

Contribuições, problemas e solicitações de recursos são bem-vindos.
Sinta-se livre para verificar issues page se você quiser contribuir.

Autor

👤 Everton Cardoso

• Github: 1995Everton

Mostre seu apoio

Por favor ⭐️ esse repositório se ele lhe ajudou!

📝 License

Copyright © 2020 Everton.
Esse projeto e licenciado por MIT.

This README was generated with ❤️ by readme-md-generator