jikanjs

0.7.0 • Public • Published

Build Status Coverage Status Known Vulnerabilities

Jikanjs

Jikanjs is a small Wrapper for the unofficial MAL API jikan.me. For more information about the jikan.me, please visit the jikan.me documentation.

Installation

npm install jikanjs --save

wrapped jikan Features

  • Anime Parsing
  • Manga Parsing
  • Character Parsing
  • People Parsing
  • Search
  • Seasonal Anime
  • Season Archive (v3)
  • Season Later (v3)
  • Anime Schedule
  • Genre (v3)
  • Producer (v3)
  • Magazine (v3)
  • User (v3)
  • Top
  • Club (v3)
  • Club Members (v3)
  • Meta

Additional

Usage

const jikanjs  = require('jikanjs'); // Uses per default the API version 3

Modify API Version

It is possible to change the API version and the API Base URL

jikanjs.settings.version = 2; // changes the API version to 2
jikanjs.settings.setBaseURL('apiurl'); // sets the API Base URL
jikanjs.settings.setBaseURL('apiurl', 2); // sets also the api version

API Methods

  • All API functions are promised Based
  • Information of all possible parameter are located at the Jikan REST-ful API documentation https://jikan.docs.apiary.io/
jikanjs.loadAnime(id [, request [, parameter]])
jikanjs.loadManga(id [, request])
jikanjs.loadPerson(id [, request])
jikanjs.loadCharacter(id [, request])
jikanjs.search(type, query [, page [, params]])
jikanjs.loadSeason(year, season)
jikanjs.loadSeasonArchive()
jikanjs.loadSeasonLater()
jikanjs.loadSchedule(day)
jikanjs.loadTop(type [, page [, subtype]])
jikanjs.loadGenre(type, id [, page])
jikanjs.loadProducer(id [, page])
jikanjs.loadMagazine(id [, page])
jikanjs.loadUser(username [, request [, data]])
jikanjs.loadClub(id)
jikanjs.loadClubMembers(id [, page])
jikanjs.loadMeta(type, period [, offset])
jikanjs.loadStatus()
jikanjs.raw(urlParts [, queryParameter])

Examples

To print for example all episodes titles of the anime "No Game No Life" you can do the following:

jikanjs.loadAnime(19815, 'episodes').then((response) => {
    response.episodes.forEach(element => {
        console.log(`${element.episode_id}${element.title} - ${element.title_romanji} - ${element.title_japanese}`);
    })
}).catch((err) => {
    console.error(err); // in case a error happens
});

Readme

Keywords

none

Package Sidebar

Install

npm i jikanjs

Weekly Downloads

114

Version

0.7.0

License

MIT

Unpacked Size

36.8 kB

Total Files

9

Last publish

Collaborators

  • zuritor