zuritor / jikanjs Goto Github PK

A small Wrapper for the unofficial MAL API jikan.moe

JavaScript 100.00%

jikanjs's Introduction

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
});

jikanjs's People

Stargazers

Watchers

Forkers

khairul-abdi kany0r0 loucass003 mehaksadique hudhorisan ankanbal franciscblop yuis-ice yaroster mateoaranda amoskaredd

jikanjs's Issues

Jikan API v3.2 Update

Hi, I just released Jikan v3.2. It has some new additions and changes, thought I'd let wrapper devs know directly.

New Features

Anime/Manga Reviews, Recommendations, User Updates
Club Information, Members
Season Later

Specification

Reviews

Anime

GET /v3/anime/{id}/reviews/{page}

Manga

GET /v3/anime/{id}/reviews/{page}

Remarks: Only 20 items are shown per page for reviews

Recommendations

Anime

GET /v3/anime/{id}/recommendations

Manga

GET /v3/anime/{id}/recommendations

User Updates

Anime

GET /v3/anime/{id}/userupdates/{page}

Manga

GET /v3/anime/{id}/userupdates/{page}

Season Later

GET /v3/season/later

Club Information

GET /v3/club/{id}

Club Members

GET /v3/club/{id}/members

Changes

All data from user related endpoints /v3/user/* are now cached for 5 minutes only
(Anime/Manga) Bug fixed for related property. It's an object but returns an array when it was empty. This is fixed now.
Error messages are now different and readable.

Documentation: https://jikan.docs.apiary.io

this.baseURL = new URL(`/v${this.v}`, baseURL);

c:\Users\nyste\Desktop\bot\node_modules\jikanjs\lib\util\Settings.js:23
this.baseURL = new URL(/v${this.v}, baseURL);
^
ReferenceError: URL is not defined

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

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
});`

Add Advanced Search

Documentation: https://jikan.docs.apiary.io/#reference/0/search

Can we login using Jikanjs?

I just want to know whether I can login into myanimelist using the jikanjs wrapper?

Thank you.

Request cache validation

Can you give an example for cache validation as given in this url? Thanks in advance.

update Readme

405 method not allowed when using jikanjs

Hi !

I wanted to try your wrapper to call the Jikan API but I can't seem to make it work with a simple call on my app (laravel + vuejs).

Whenever I make a call I'm having 405 method not allowed.
Here is my code :

window.jikanjs = require('jikanjs'); 

jikanjs.loadAnime(1).then(function (response) {
    console.log(response);
}).catch(function (err) {
    console.log(err);
});

Here's the error :

OPTIONS https://api.jikan.moe/v3/anime/1 405 (Method Not Allowed)
Failed to load https://api.jikan.moe/v3/anime/1: Response for preflight does not have HTTP ok status.

The issue seems to be with Axios. Nekomata recommanded me to try with fetch() method directly on the API endpoint and it works perfectly.

Have you got any idea how to fix this?

[Meta] Adding JikanJS to the list of Jikan wrappers on the Jikan Repo & Website

Hello!
It's nice to see a JS wrapper for the API! If it's cool with you I'd love to add it to Jikan Repo and the website

Rate Limiting

As stated in the docs add a 5 second delay to a request. Will also fix the Travis-Ci problem.

url: https://jikan.docs.apiary.io/#introduction/information/rate-limiting

zuritor / jikanjs Goto Github PK

jikanjs's Introduction

Jikanjs

Installation

wrapped jikan Features

Additional

Usage

Modify API Version

API Methods

Examples

jikanjs's People

Stargazers

Watchers

Forkers

jikanjs's Issues

New Features

Specification

Reviews

Recommendations

User Updates

Season Later

Club Information

Club Members

Changes

Recommend Projects

Recommend Topics

Recommend Org