shikimori.ts
shikimori.ts - JavaScript & TypeScript wrapper for shikimori.one
Features
Full TypeScript support
Support all platforms
Easy to use
Table of Contents
Quick start
Install
npm
yarn
Initialization
JavaScript
const { Shikimori } = require ( 'shikimori.ts' ) ;
TypeScript
import { Shikimori } from 'shikimori.ts' ;
Methods
getUserReturns the user object.
Options
id
Type: String
Description: Shikimori user ID.
name
Type: String
Description: Shikimori username.
Returns
Promise
Example
console.log(user)); // => { // id: 823641, // nickname: "simplname", // avatar: "https://...", // ... // }">
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://...",
// ...
// }
getAnimeReturns the anime object.
Options
id
Type: String
Description: Shikimori anime ID.
name
Type: String
Description: Shikimori anime name(you can also use Russian names).
Returns
Promise
Example
console.log(anime)); // => { // id: 20, // name: "Naruto", // russian: "Наруто", // image: { ... }, // ... // }">
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: { ... },
// ...
// }
getMangaReturns the manga object.
Options
id
Type: String
Description: Shikimori manga ID.
name
Type: String
Description: Shikimori manga name(you can also use Russian names).
Returns
Promise
Example
console.log(manga)); // => { // id: 33327, // name: "Tokyo Ghoul", // russian: "Токийский гуль", // image: { ... }, // ... // }">
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: { ... },
// ...
// }
getRanobeReturns the ranobe object.
Options
id
Type: String
Description: Shikimori ranobe ID.
name
Type: String
Description: Shikimori ranobe name(you can also use Russian names).
Returns
Promise
Example
console.log(ranobe)); // => { // id: 70399, // name: "Seishun Buta Yarou Series", // russian: "Этот глупый свин", // image: { ... }, // ... // }">
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: { ... },
// ...
// }
getCharacterReturns the character object.
Options
id
Type: String
Description: Shikimori character ID.
name
Type: String
Description: Shikimori character name(you can also use Russian names).
Returns
Promise
Example
console.log(character)); // => { // id: 17, // name: "Naruto Uzumaki", // russian: "Наруто Узумаки", // image: { ... }, // ... // }">
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: { ... },
// ...
// }
getCalendarReturns the animes array.
Returns
Example
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
42 Dec 17, 2022
1.4k Dec 19, 2022
1.4k Jan 6, 2023
2 May 9, 2022
2 Feb 7, 2022
2 Oct 17, 2022
151 Dec 10, 2022
4 May 24, 2022
207 Dec 9, 2022
473 Sep 27, 2022