Jikan Api

This package provides a javascript client to fetch information from https://jikan.moe.

TypeDoc is available at https://thorbens.gitlab.io/anime/jikan-api.

Usage

The api client relies on fetch and is intended for server side use. All options for the constructor are optional.

import { JikanApiClient } from "@thorbens/jikan-api";

const apiClient = new JikanApiClient();

Example

Example for fetching detail information of the anime https://myanimelist.net/anime/1/Cowboy_Bebop:

// fetches detail information for https://myanimelist.net/anime/1/Cowboy_Bebop
const detail = await apiClient.getDetail(1); // return a JikanApiAnimeModel

Options

The following options are available in the constructor.

Option	Description
fetchApi	The fetch implementation to use. By default, node-fetch is used.
endpointUrl	The jikan endpoint to use. By default, https://api.jikan.moe/v3 is used.
logger	The logger to use. By default, the console is used.
fetchOptions	Additional fetch options to use for each request. Empty by default.

Example for a custom endpoint:

import {JikanApiClient} from "@thorbens/jikan-api";

const endpointUrl = "https://exmaple.com/v3"; // no tailing slash
const apiClient = new JikanApiClient({endpointUrl});

See https://github.com/jikan-me/jikan-rest for hosting your own endpoint.

Error Handling

fetch does not throw an error if the response is not ok. Therefore, the ok field is checked and the promise will be rejected accordingly. The rejection can contain the actual response body (as json object).

The helper isErrorResponse can be used to check if the response is an actual api error (JikanApiError) and not a network error or else.

Logging

By default, logging will be performed on the console. To use a custom logger, implement the interface from @thorben/logger-model and pass it to the api client:

import {Logger} from "@thorbens/logger-model";

class CustomLogger implements Logger {
    ...
}
const logger = new CustomLogger();
const apiClient = new JikanApiClient({ logger });