Jikan-ts

Appearance

Return to top
On this page

Manga Client

Usage

Client used to access the Manga Endpoints:

See also: JikanAPI Documentation

getMangaSearch /manga

Search mangas within the given filter params. If no params are given, returns all the mangas.

Params

Response

Example

ts
import { MangaClient, MangaSearchParams, MangaType, JikanResponse, Manga } from '@tutkli/jikan-ts';

(async () => {
    const mangaClient = new MangaClient();

    const searchParams: MangaSearchParams = {
        type: MangaType.manwha
    }

    await mangaClient
        .getMangaSearch(searchParams)
        .then((jikanResponse: JikanResponse<Manga[]>) => { /* your code */ })
        .catch((error) => console.error(error));
})();

getMangaById /manga/{id}

Get partial data of a Manga.

Params

  • [Required] mal_id: number

Response

Example

ts
import { MangaClient, JikanResponse, Manga } from '@tutkli/jikan-ts';

(async () => {
    const mangaClient = new MangaClient();

    await mangaClient
        .getMangaById(1)
        .then((jikanResponse: JikanResponse<Manga>) => { /* your code */ })
        .catch((error) => console.error(error));
})();

getMangaFullById /manga/{id}/full

Get complete data of a Manga.

Params

  • [Required] mal_id: number

Response

Example

ts
import { MangaClient, JikanResponse, Manga } from '@tutkli/jikan-ts';

(async () => {
    const mangaClient = new MangaClient();

    await mangaClient
        .getMangaFullById(1)
        .then((jikanResponse: JikanResponse<Manga>) => { /* your code */ })
        .catch((error) => console.error(error));
})();

getMangaCharacters /manga/{id}/characters

Get Characters of a specific Manga.

Params

  • [Required] mal_id: number

Response

Example

ts
import { MangaClient, JikanResponse, MangaCharacter } from '@tutkli/jikan-ts';

(async () => {
    const mangaClient = new MangaClient();

    await mangaClient
        .getMangaCharacters(1)
        .then((jikanResponse: JikanResponse<MangaCharacter[]>) => { /* your code */ })
        .catch((error) => console.error(error));
})();

getMangaPictures /manga/{id}/pictures

Get Pictures related to a specific Manga.

Params

  • [Required] mal_id: number

Response

Example

ts
import { MangaClient, JikanResponse, JikanImages } from '@tutkli/jikan-ts';

(async () => {
    const mangaClient = new MangaClient();

    await mangaClient
        .getMangaPictures(1)
        .then((jikanResponse: JikanResponse<JikanImages[]>) => { /* your code */ })
        .catch((error) => console.error(error));
})();

getMangaStatistics /manga/{id}/statistics

Get Statistics related to a specific Manga.

Params

  • [Required] mal_id: number

Response

Example

ts
import { MangaClient, JikanResponse, MangaStatistics } from '@tutkli/jikan-ts';

(async () => {
    const mangaClient = new MangaClient();

    await mangaClient
        .getMangaStatistics(1)
        .then((jikanResponse: JikanResponse<MangaStatistics>) => { /* your code */ })
        .catch((error) => console.error(error));
})();

getMangaRecommendations /manga/{id}/recommendations

Get Recommendations related to a specific Manga.

Params

  • [Required] mal_id: number

Response

Example

ts
import { MangaClient, JikanResponse, Recommendation } from '@tutkli/jikan-ts';

(async () => {
    const mangaClient = new MangaClient();

    await mangaClient
        .getMangaRecommendations(1)
        .then((jikanResponse: JikanResponse<Recommendation[]>) => { /* your code */ })
        .catch((error) => console.error(error));
})();