shikimori.ts - JavaScript & TypeScript wrapper for shikimori.one
- Added lists of friends, clubs and favorites to the
getUser()
function
- Full TypeScript support
- Support all platforms
- Easy to use
npm i shikimori.ts
yarn add shikimori.ts
const { Shikimori } = require('shikimori.ts');
import { Shikimori } from 'shikimori.ts';
Returns the user object.
id
- Type:
String
- Description: Shikimori user ID.
- Type:
name
- Type:
String
- Description: Shikimori username.
- Type:
Promise<Object>
Shikimori.getUser({ id: '823641' }).then(user => console.log(user));
// => {
// id: 823641,
// nickname: "simplname",
// avatar: "https://...",
// ...
// }
Shikimori.getUser({ name: 'simplname' }).then(user => console.log(user));
// => {
// id: 823641,
// nickname: "simplname",
// avatar: "https://...",
// ...
// }
Returns the anime object.
id
- Type:
String
- Description: Shikimori anime ID.
- Type:
name
- Type:
String
- Description: Shikimori anime name(you can also use Russian names).
- Type:
Promise<Object>
Shikimori.getAnime({ id: '20' }).then(anime => console.log(anime));
// => {
// id: 20,
// name: "Naruto",
// russian: "Наруто",
// image: { ... },
// ...
// }
Shikimori.getAnime({ name: 'Naruto' }).then(anime => console.log(anime));
// => {
// id: 20,
// name: "Naruto",
// russian: "Наруто",
// image: { ... },
// ...
// }
Returns the manga object.
id
- Type:
String
- Description: Shikimori manga ID.
- Type:
name
- Type:
String
- Description: Shikimori manga name(you can also use Russian names).
- Type:
Promise<Object>
Shikimori.getManga({ id: '33327' }).then(manga => console.log(manga));
// => {
// id: 33327,
// name: "Tokyo Ghoul",
// russian: "Токийский гуль",
// image: { ... },
// ...
// }
Shikimori.getManga({ name: 'Tokyo Ghoul' }).then(manga => console.log(manga));
// => {
// id: 33327,
// name: "Tokyo Ghoul",
// russian: "Токийский гуль",
// image: { ... },
// ...
// }
Returns the ranobe object.
id
- Type:
String
- Description: Shikimori ranobe ID.
- Type:
name
- Type:
String
- Description: Shikimori ranobe name(you can also use Russian names).
- Type:
Promise<Object>
Shikimori.getRanobe({ id: '70399' }).then(ranobe => console.log(ranobe));
// => {
// id: 70399,
// name: "Seishun Buta Yarou Series",
// russian: "Этот глупый свин",
// image: { ... },
// ...
// }
Shikimori.getRanobe({ name: 'Seishun Buta Yarou Series' }).then(ranobe => console.log(ranobe));
// => {
// id: 70399,
// name: "Seishun Buta Yarou Series",
// russian: "Этот глупый свин",
// image: { ... },
// ...
// }
Returns the character object.
id
- Type:
String
- Description: Shikimori character ID.
- Type:
name
- Type:
String
- Description: Shikimori character name(you can also use Russian names).
- Type:
Promise<Object>
Shikimori.getCharacter({ id: '17' }).then(character => console.log(character));
// => {
// id: 17,
// name: "Naruto Uzumaki",
// russian: "Наруто Узумаки",
// image: { ... },
// ...
// }
Shikimori.getCharacter({ name: 'Naruto Uzumaki' }).then(character => console.log(character));
// => {
// id: 17,
// name: "Naruto Uzumaki",
// russian: "Наруто Узумаки",
// image: { ... },
// ...
// }
Returns the animes array.
Promise<Array>
Shikimori.getCalendar().then(calendar => console.log(calendar));
// => [
// {
// next_episode: 1,
// next_episode_at: "2022-01-13T09:00:00.000+03:00",
// duration: 120,
// anime: { ... },
// ...
// },
// {
// next_episode: 1,
// next_episode_at: "2022-01-14T09:00:00.000+03:00",
// duration: null,
// anime: { ... },
// ...
// },
// ...
// ]
© Ja1z666