Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Jikan4

Index

Anime

  • animeSearch(params?: { genres?: string; genres_exclude?: string; letter?: string; limit?: number; max_score?: number; min_score?: number; order_by?: "mal_id" | "title" | "type" | "rating" | "start_date" | "end_date" | "episodes" | "score" | "scored_by" | "rank" | "popularity" | "members" | "favorites"; page?: number; producer?: string; q?: string; ranking?: "g" | "pg" | "pg13" | "r17" | "r" | "rx"; score?: number; sfw?: boolean; sort?: "desc" | "asc"; status?: "airing" | "complete" | "upcoming"; type?: "tv" | "movie" | "ova" | "special" | "ona" | "music" }): Promise<AnimeSearch>
  • Parameters

    • Optional params: { genres?: string; genres_exclude?: string; letter?: string; limit?: number; max_score?: number; min_score?: number; order_by?: "mal_id" | "title" | "type" | "rating" | "start_date" | "end_date" | "episodes" | "score" | "scored_by" | "rank" | "popularity" | "members" | "favorites"; page?: number; producer?: string; q?: string; ranking?: "g" | "pg" | "pg13" | "r17" | "r" | "rx"; score?: number; sfw?: boolean; sort?: "desc" | "asc"; status?: "airing" | "complete" | "upcoming"; type?: "tv" | "movie" | "ova" | "special" | "ona" | "music" }
      • Optional genres?: string
      • Optional genres_exclude?: string
      • Optional letter?: string
      • Optional limit?: number
      • Optional max_score?: number
      • Optional min_score?: number
      • Optional order_by?: "mal_id" | "title" | "type" | "rating" | "start_date" | "end_date" | "episodes" | "score" | "scored_by" | "rank" | "popularity" | "members" | "favorites"
      • Optional page?: number
      • Optional producer?: string
      • Optional q?: string
      • Optional ranking?: "g" | "pg" | "pg13" | "r17" | "r" | "rx"
      • Optional score?: number
      • Optional sfw?: boolean
      • Optional sort?: "desc" | "asc"
      • Optional status?: "airing" | "complete" | "upcoming"
      • Optional type?: "tv" | "movie" | "ova" | "special" | "ona" | "music"

    Returns Promise<AnimeSearch>

Character

  • characterSearch(params?: { letter?: string; limit?: number; order_by?: "mal_id" | "favorites" | "name"; page?: number; q?: string; sort?: "desc" | "asc" }): Promise<CharactersSearch>
  • Parameters

    • Optional params: { letter?: string; limit?: number; order_by?: "mal_id" | "favorites" | "name"; page?: number; q?: string; sort?: "desc" | "asc" }
      • Optional letter?: string
      • Optional limit?: number
      • Optional order_by?: "mal_id" | "favorites" | "name"
      • Optional page?: number
      • Optional q?: string
      • Optional sort?: "desc" | "asc"

    Returns Promise<CharactersSearch>

Club

  • clubSearch(params?: { category?: "music" | "other" | "manga" | "anime" | "actors_and_artists" | "characters" | "cities_and_neighborhoods" | "companies" | "conventions" | "games" | "japan" | "schools"; letter?: string; limit?: number; order_by?: "mal_id" | "title" | "members_count" | "pictures_count" | "created"; page?: number; q?: string; sort?: "desc" | "asc"; type?: "public" | "private" | "secret" }): Promise<ClubsSearch>
  • Parameters

    • Optional params: { category?: "music" | "other" | "manga" | "anime" | "actors_and_artists" | "characters" | "cities_and_neighborhoods" | "companies" | "conventions" | "games" | "japan" | "schools"; letter?: string; limit?: number; order_by?: "mal_id" | "title" | "members_count" | "pictures_count" | "created"; page?: number; q?: string; sort?: "desc" | "asc"; type?: "public" | "private" | "secret" }
      • Optional category?: "music" | "other" | "manga" | "anime" | "actors_and_artists" | "characters" | "cities_and_neighborhoods" | "companies" | "conventions" | "games" | "japan" | "schools"
      • Optional letter?: string
      • Optional limit?: number
      • Optional order_by?: "mal_id" | "title" | "members_count" | "pictures_count" | "created"
      • Optional page?: number
      • Optional q?: string
      • Optional sort?: "desc" | "asc"
      • Optional type?: "public" | "private" | "secret"

    Returns Promise<ClubsSearch>

Genres

Manga

  • mangaSearch(params?: { genres?: string; genres_exclude?: string; letter?: string; limit?: number; magazine?: string; max_score?: number; min_score?: number; order_by?: "mal_id" | "title" | "start_date" | "end_date" | "score" | "scored_by" | "rank" | "popularity" | "members" | "favorites" | "chapters" | "volumes"; page?: number; q?: string; score?: number; sfw?: boolean; sort?: "desc" | "asc"; status?: "complete" | "upcoming" | "publishing" | "hiatus" | "discontinued"; type?: "manga" | "novel" | "lightnovel" | "oneshot" | "doujin" | "manhwa" | "manhua" }): Promise<MangaSearch>
  • Parameters

    • Optional params: { genres?: string; genres_exclude?: string; letter?: string; limit?: number; magazine?: string; max_score?: number; min_score?: number; order_by?: "mal_id" | "title" | "start_date" | "end_date" | "score" | "scored_by" | "rank" | "popularity" | "members" | "favorites" | "chapters" | "volumes"; page?: number; q?: string; score?: number; sfw?: boolean; sort?: "desc" | "asc"; status?: "complete" | "upcoming" | "publishing" | "hiatus" | "discontinued"; type?: "manga" | "novel" | "lightnovel" | "oneshot" | "doujin" | "manhwa" | "manhua" }
      • Optional genres?: string
      • Optional genres_exclude?: string
      • Optional letter?: string
      • Optional limit?: number
      • Optional magazine?: string
      • Optional max_score?: number
      • Optional min_score?: number
      • Optional order_by?: "mal_id" | "title" | "start_date" | "end_date" | "score" | "scored_by" | "rank" | "popularity" | "members" | "favorites" | "chapters" | "volumes"
      • Optional page?: number
      • Optional q?: string
      • Optional score?: number
      • Optional sfw?: boolean
      • Optional sort?: "desc" | "asc"
      • Optional status?: "complete" | "upcoming" | "publishing" | "hiatus" | "discontinued"
      • Optional type?: "manga" | "novel" | "lightnovel" | "oneshot" | "doujin" | "manhwa" | "manhua"

    Returns Promise<MangaSearch>

Person

  • personSearch(params?: { letter?: string; limit?: number; order_by?: "mal_id" | "favorites" | "name" | "birthday"; page?: number; q?: string; sort?: "desc" | "asc" }): Promise<PeopleSearch>
  • Parameters

    • Optional params: { letter?: string; limit?: number; order_by?: "mal_id" | "favorites" | "name" | "birthday"; page?: number; q?: string; sort?: "desc" | "asc" }
      • Optional letter?: string
      • Optional limit?: number
      • Optional order_by?: "mal_id" | "favorites" | "name" | "birthday"
      • Optional page?: number
      • Optional q?: string
      • Optional sort?: "desc" | "asc"

    Returns Promise<PeopleSearch>

Producers

Random

Recommendations

  • animeRecommendations(params?: { page?: number }): Promise<{ data: Jikan4.Types.Anime }>
  • mangaRecommendations(params?: { page?: number }): Promise<{ data: Jikan4.Types.Manga }>

Reviews

  • animeReviews(params?: { page?: number }): Promise<AnimeReviews>
  • mangaReviews(params?: { page?: number }): Promise<MangaReviews>

Schedules

  • schedules(params?: { filter?: "other" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "unknown"; page?: number }): Promise<Schedules>
  • Parameters

    • Optional params: { filter?: "other" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "unknown"; page?: number }
      • Optional filter?: "other" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "unknown"
      • Optional page?: number

    Returns Promise<Schedules>

Season

  • season(year: number, season: "spring" | "summer" | "fall" | "winter", params?: { limit?: number; page?: number }): Promise<{ data: Jikan4.Types.Anime[] } & Pagination>
  • Parameters

    • year: number
    • season: "spring" | "summer" | "fall" | "winter"
    • Optional params: { limit?: number; page?: number }
      • Optional limit?: number
      • Optional page?: number

    Returns Promise<{ data: Jikan4.Types.Anime[] } & Pagination>

Top

Watch

  • watchPopularEpisodes(params?: { limit?: number; page?: number }): Promise<WatchEpisodes>
  • watchPopularPromos(params?: { limit?: number; page?: number }): Promise<WatchPromos>
  • watchRecentEpisodes(params?: { limit?: number; page?: number }): Promise<WatchEpisodes>
  • watchRecentPromos(params?: { limit?: number; page?: number }): Promise<WatchPromos>

Other

jikanUrl: "https://api.jikan.moe/v4" = ...

Generated using TypeDoc