AnimeManager: Manager for Anime This component is used to get Anime data from the Jikan API
- endpoint: string
-
getAnime(animeId: number): Promise<animeModel.Anime>
getAnime: Get an Anime from the Jikan API by its ID
-
getAnimeCharacters(animeId: number): Promise<animeModel.AnimeCharacterRole[]>
getAnimeCharacters: Get an Anime's Characters from the Jikan API by its ID
-
getAnimeEpisode(): Promise<animeModel.AnimeEpisodeFull>animeId: number,episodeNumber: number
getAnimeEpisode: Get an Anime's Episode from the Jikan API by its ID and Episode number
-
getAnimeEpisodes(): Promise<animeModel.AnimeEpisode[]>animeId: number,params?: baseManager.PageSearchParameter
getAnimeEpisodes: Get an Anime's Episodes from the Jikan API by its ID
-
getAnimeExternal(animeId: number): Promise<baseModel.External[]>
getAnimeExternal: Get an Anime's External from the Jikan API by its ID
-
getAnimeForum(): Promise<baseModel.Forum[]>animeId: number,params?: AnimeForumSearchParameters
getAnimeForum: Get an Anime's Forum from the Jikan API by its ID
-
getAnimeFull(animeId: number): Promise<animeModel.AnimeFull>
getAnimeFull: Get an AnimeFull from the Jikan API by its ID
-
getAnimeMoreInfo(animeId: number): Promise<baseModel.MoreInfo>
getAnimeMoreInfo: Get an Anime's More Info from the Jikan API by its ID
-
getAnimeNews(): Promise<baseModel.News[]>animeId: number,params?: baseManager.PageSearchParameter
getAnimeNews: Get an Anime's News from the Jikan API by its ID
-
getAnimePictures(animeId: number): Promise<baseModel.CommonImage[]>
getAnimePictures: Get an Anime's Pictures from the Jikan API by its ID
-
getAnimeRecommendations(animeId: number): Promise<animeModel.AnimeMeta[]>
getAnimeRecommendations: Get an Anime's Recommendations from the Jikan API by its ID
-
getAnimeRelations(animeId: number): Promise<baseModel.Relation[]>
getAnimeRelations: Get an Anime's Relations from the Jikan API by its ID
-
getAnimeReviews(): Promise<animeModel.AnimeReview[]>animeId: number,params?: baseManager.ReviewsParameters
getAnimeReviews: Get an Anime's Reviews from the Jikan API by its ID
-
getAnimeStaff(animeId: number): Promise<baseModel.Staff[]>
getAnimeStaff: Get an Anime's Staff from the Jikan API by its ID
-
getAnimeStatistics(animeId: number): Promise<animeModel.AnimeStatistics>
getAnimeStatistics: Get an Anime's statistics from the Jikan API by its ID
-
getAnimeStreaming(animeId: number): Promise<baseModel.External[]>
getAnimeStreaming: Get an Anime's Streaming from the Jikan API by its ID
-
getAnimeThemes(animeId: number): Promise<animeModel.Theme>
getAnimeThemes: Get an Anime's Themes from the Jikan API by its ID
-
getAnimeUserUpdates(): Promise<animeModel.AnimeUserUpdate[]>animeId: number,params?: baseManager.PageSearchParameter
getAnimeUserUpdates: Get an Anime's User Updates from the Jikan API by its ID
-
getAnimeVideos(animeId: number): Promise<animeModel.AnimeVideo>
getAnimeVideos: Get an Anime's Videos from the Jikan API by its ID
-
getAnimeVideosEpisodes(): Promise<animeModel.VideoEpisode[]>animeId: number,params?: baseManager.PageSearchParameter
getAnimeVideosEpisodes: Get an Anime's Videos
-
getAnimes(params?: AnimeSearchParameters): Promise<animeModel.Anime[]>
getAnimes: Get an Anime array from the Jikan API
BaseManager: Base class for all managers This component is an abstract class used to create managers for the Jikan API
CacheManager: Manager class for the cache This component is used to manage the cache of the Jikan API The cache isn't implemented yet, the manager only creates a cache directory and deletes it when the program exits
CharacterManager: Manager class for the Character endpoint This component is used to make requests to the Jikan API's Character endpoint
- endpoint: string
-
getCharacter(characterId: number): Promise<characterModel.Character>
getCharacter: Get a Character from the Jikan API by its ID
-
getCharacterAnime(characterId: number): Promise<characterModel.AnimeRole[]>
getCharacterAnime: Get a Character's Anime from the Jikan API by its ID
-
getCharacterFull(characterId: number): Promise<characterModel.CharacterFull>
getCharacter: Get a CharacterFull from the Jikan API by its ID
-
getCharacterManga(characterId: number): Promise<characterModel.MangaRole[]>
getCharacterManga: Get a Character's Manga from the Jikan API by its ID
-
getCharacterPictures(characterId: number): Promise<baseModel.CommonImage[]>
getCharacterPictures: Get a Character's Pictures from the Jikan API by its ID
-
getCharacterVoiceActors(characterId: number): Promise<baseModel.VoiceActors[]>
getCharacterVoiceActors: Get a Character's Voice Actors from the Jikan API by its ID
-
getCharacters(params?: CharacterSearchParameters): Promise<characterModel.Character[]>
getCharacters: Get a Character array from the Jikan API
JikanClient: Main class for the Jikan API client This component is used to interact with the Jikan API using internal managers
- animeManager: animeManager.AnimeManager
- cacheManager: cacheManager.CacheManager
- characterManager: characterManager.CharacterManager
-
getAnime(animeId: number): Promise<animeModel.Anime>
getAnime: Get an Anime from the Jikan API by its ID
-
getAnimeCharacters(animeId: number): Promise<animeModel.AnimeCharacterRole[]>
getAnimeCharacters: Get an Anime's Characters from the Jikan API by its ID
-
getAnimeEpisode(): Promise<animeModel.AnimeEpisodeFull>animeId: number,episodeNumber: number
getAnimeEpisode: Get an Anime's Episode from the Jikan API by its ID and Episode number
-
getAnimeEpisodes(): Promise<animeModel.AnimeEpisode[]>animeId: number,params?: baseManager.PageSearchParameter
getAnimeEpisodes: Get an Anime's Episodes from the Jikan API by its ID
-
getAnimeExternal(animeId: number): Promise<baseModel.External[]>
getAnimeExternal: Get an Anime's External Links from the Jikan API by its ID
-
getAnimeForum(animeId: number): Promise<baseModel.Forum[]>
getAnimeForum: Get an Anime's Forum from the Jikan API by its ID
-
getAnimeFull(animeId: number): Promise<animeModel.AnimeFull>
getAnimeFull: Get an AnimeFull from the Jikan API by its ID
-
getAnimeMoreInfo(animeId: number): Promise<baseModel.MoreInfo>
getAnimeMoreInfo: Get an Anime's More Info from the Jikan API by its ID
-
getAnimeNews(): Promise<baseModel.News[]>animeId: number,params?: baseManager.PageSearchParameter
getAnimeNews: Get an Anime's News from the Jikan API by its ID
-
getAnimePictures(animeId: number): Promise<baseModel.CommonImage[]>
getAnimePictures: Get an Anime's Pictures from the Jikan API by its ID
-
getAnimeRandom(): Promise<animeModel.Anime>
getAnimeRandom: Get a random Anime from the Jikan API
-
getAnimeRecommendations(animeId: number): Promise<animeModel.AnimeMeta[]>
getAnimeRecommendations: Get an Anime's Recommendations from the Jikan API by its ID
-
getAnimeRelations(animeId: number): Promise<baseModel.Relation[]>
getAnimeForum: Get an Anime's Forum from the Jikan API by its ID
-
getAnimeReviews(): Promise<animeModel.AnimeReview[]>animeId: number,params?: baseManager.ReviewsParameters
getAnimeReviews: Get an Anime's Reviews from the Jikan API by its ID
-
getAnimeStaff(animeId: number): Promise<baseModel.Staff[]>
getAnimeStaff: Get an Anime's Staff from the Jikan API by its ID
-
getAnimeStatistics(animeId: number): Promise<animeModel.AnimeStatistics>
getAnimeStatistics: Get an Anime's Statistics from the Jikan API by its ID
-
getAnimeStreaming(animeId: number): Promise<baseModel.External[]>
getAnimeStreaming: Get an Anime's Streaming Links from the Jikan API by its ID
-
getAnimeThemes(animeId: number): Promise<animeModel.Theme>
getAnimeThemes: Get an Anime's Themes from the Jikan API by its ID
-
getAnimeUserUpdates(animeId: number): Promise<animeModel.AnimeUserUpdate[]>
getAnimeUserUpdates: Get an Anime's User Updates from the Jikan API by its ID
-
getAnimeVideos(animeId: number): Promise<animeModel.AnimeVideo>
getAnimeVideos: Get an Anime's Videos from the Jikan API by its ID
-
getAnimeVideosEpisodes(): Promise<animeModel.VideoEpisode[]>animeId: number,params?: baseManager.PageSearchParameter
getAnimeVideosEpisodes: Get an Anime's Videos Episodes from the Jikan API by its ID
-
getAnimes(params?: animeManager.AnimeSearchParameters): Promise<animeModel.Anime[]>
getAnimes: Get an Anime array from the Jikan API
-
getCharacter(characterId: number): Promise<characterModel.Character>
getCharacter: Get a Character from the Jikan API by its ID
-
getCharacterAnime(characterId: number): Promise<characterModel.AnimeRole[]>
getCharacterAnime: Get a Character's Anime from the Jikan API by its ID
-
getCharacterFull(characterId: number): Promise<characterModel.CharacterFull>
getCharacterFull: Get a CharacterFull from the Jikan API by its ID
-
getCharacterManga(characterId: number): Promise<characterModel.MangaRole[]>
getCharacterManga: Get a Character's Manga from the Jikan API by its ID
-
getCharacterPictures(characterId: number): Promise<baseModel.CommonImage[]>
getCharacterPictures: Get a Character's Pictures from the Jikan API by its ID
-
getCharacterRandom(): Promise<characterModel.Character>
getCharacterRandom: Get a random Character from the Jikan API
-
getCharacterVoiceActors(characterId: number): Promise<baseModel.VoiceActors[]>
getCharacterVoiceActors: Get a Character's Voice Actors from the Jikan API by its ID
-
getCharacters(params?: characterManager.CharacterSearchParameters): Promise<characterModel.Character[]>
getCharacters: Get a Character array from the Jikan API
-
getManga(mangaId: number): Promise<mangaModel.Manga>
getManga: Get a Manga from the Jikan API by its ID
-
getMangaCharacters(mangaId: number): Promise<mangaModel.MangaCharacterRole[]>
getMangaCharacters: Get a Manga's Characters from the Jikan API by its ID
-
getMangaExternal(mangaId: number): Promise<baseModel.External[]>
getMangaExternal: Get a Manga's External Links from the Jikan API by its ID
-
getMangaFull(mangaId: number): Promise<mangaModel.MangaFull>
getMangaFull: Get a MangaFull from the Jikan API by its ID
-
getMangaMoreInfo(mangaId: number): Promise<baseModel.MoreInfo>
getMangaMoreInfo: Get a Manga's More Info from the Jikan API by its ID
-
getMangaNews(): Promise<baseModel.News[]>mangaId: number,params?: baseManager.PageSearchParameter
getMangaNews: Get a Manga's News from the Jikan API by its ID
-
getMangaPictures(mangaId: number): Promise<mangaModel.MangaImages[]>
getMangaPictures: Get a Manga's Pictures from the Jikan API by its ID
-
getMangaRandom(): Promise<mangaModel.Manga>
getMangaRandom: Get a random Manga from the Jikan API
-
getMangaRecommendations(mangaId: number): Promise<baseModel.MalEntries[]>
getMangaRecommendations: Get a Manga's Recommendations from the Jikan API by its ID
-
getMangaRelations(mangaId: number): Promise<baseModel.Relation[]>
getMangaRelations: Get a Manga's Relations from the Jikan API by its ID
-
getMangaReviews(): Promise<mangaModel.MangaReview[]>mangaId: number,params?: baseManager.ReviewsParameters
getMangaReviews: Get a Manga's Reviews from the Jikan API by its ID
-
getMangaStatistics(mangaId: number): Promise<mangaModel.MangaStatistics>
getMangaStatistics: Get a Manga's Statistics from the Jikan API by its ID
-
getMangaTopics(): Promise<baseModel.Forum[]>mangaId: number,params?: mangaManager.MangaTopicsSearchParameters
getMangaTopics: Get a Manga's Topics from the Jikan API by its ID
-
getMangaUserUpdates(): Promise<mangaModel.MangaUserUpdate[]>mangaId: number,params?: baseManager.PageSearchParameter
getMangaUserUpdates: Get a Manga's User Updates from the Jikan API by its ID
-
getMangas(params?: mangaManager.MangaSearchParameters): Promise<mangaModel.Manga[]>
getMangas: Get a Manga array from the Jikan API
- mangaManager: mangaManager.MangaManager
- options: ClientOptions
- randomManager: randomManager.RandomManager
- requestManager: requestManager.RequestManager
- setDefaultOptions(options?: Partial<ClientOptions>): ClientOptions
MangaManager: Manager for the Manga endpoint This component is used to get Manga data from the Jikan API
- endpoint: string
-
getManga(mangaId: number): Promise<mangaModel.Manga>
getManga: Get a Manga from the Jikan API by its ID
-
getMangaCharacters(mangaId: number): Promise<mangaModel.MangaCharacterRole[]>
getMangaCharacters: Get a Manga's Characters from the Jikan API by its ID
-
getMangaExternal(mangaId: number): Promise<baseModel.External[]>
getMangaExternals: Get a Manga's Externals from the Jikan API by its ID
-
getMangaFull(mangaId: number): Promise<mangaModel.MangaFull>
getMangaFull: Get a Manga from the Jikan API by its ID with full details
-
getMangaMoreInfo(mangaId: number): Promise<baseModel.MoreInfo>
getMangaMoreInfo: Get a Manga's More Info from the Jikan API by its ID
-
getMangaNews(): Promise<baseModel.News[]>mangaId: number,params?: baseManager.PageSearchParameter
getMangaNews: Get a Manga's News from the Jikan API by its ID
-
getMangaPictures(mangaId: number): Promise<mangaModel.MangaImages[]>
getMangaPictures: Get a Manga's Pictures from the Jikan API by its ID
-
getMangaRecommendations(mangaId: number): Promise<baseModel.MalEntries[]>
getMangaRecommendations: Get a Manga's Recommendations from the Jikan API by its ID
-
getMangaRelations(mangaId: number): Promise<baseModel.Relation[]>
getMangaRelations: Get a Manga's Relations from the Jikan API by its ID
-
getMangaReviews(): Promise<mangaModel.MangaReview[]>mangaId: number,params?: baseManager.ReviewsParameters
getMangaReviews: Get a Manga's Reviews from the Jikan API by its ID
-
getMangaStatistics(mangaId: number): Promise<mangaModel.MangaStatistics>
getMangaStatistics: Get a Manga's Statistics from the Jikan API by its ID
-
getMangaTopics(): Promise<baseModel.Forum[]>mangaId: number,params?: MangaTopicsSearchParameters
getMangaTopics: Get a Manga's Topics from the Jikan API by its ID
-
getMangaUserUpdates(): Promise<mangaModel.MangaUserUpdate[]>mangaId: number,params?: baseManager.PageSearchParameter
getMangaUserUpdates: Get a Manga's User Updates from the Jikan API by its ID
-
getMangas(params?: MangaSearchParameters): Promise<mangaModel.Manga[]>
getMangas: Get a list of Manga from the Jikan API
RandomManager: Manager for the Random endpoint This component is used to get random data from the Jikan API
- endpoint: string
-
getRandomAnime(): Promise<animeModel.Anime>
getRandomAnime: Get a random Anime from the Jikan API
-
getRandomCharacter(): Promise<characterModel.Character>
getRandomCharacter: Get a random Character from the Jikan API
-
getRandomManga(): Promise<mangaModel.Manga>
getRandomManga: Get a random Manga from the Jikan API
-
_createErrorResponse(): Responsemessage: string,errorCode: string,status: number,statusText: string,retryAfter?: number
- _isProcessing: boolean
- buildURL(requestQuery: apiModel.APIRequestQuery): URL
- client: JikanClient
- processQueue(): Promise<void>
-
request(requestQuery: apiModel.APIRequestQuery): Promise<Response>
request: Enqueue a APIRequestQuery and return a promise of the response
- _maxSize: number
- _queue: (apiModel.APIRequestPromise)[]
- _size: number
-
dequeue(): apiModel.APIRequestPromise | undefined
dequeue: Remove an item from the queue
-
enqueue(requestPromise: apiModel.APIRequestPromise): void
enqueue: Add an item to the queue
- isEmpty(): boolean
- isFull(): boolean
- maxSize(): number
- size(): number
AnimeForumFilter: Enum for Anime Forum filters (i.e. All, Episode, Other)
BaseSort: Enum for base sorting
AnimeForumSearchParameters: Interface for Anime Forum search parameters
AnimeSearchParameters: Interface for Anime search parameters
-
end_date: string
Filter by ending data. Format: YYYY-MM-DD. e.g
2022,2005-05,2005-01-01 -
genres: string
Filter by genre(s) IDs. Can pass multiple with a comma as a delimiter. e.g 1,2,3
-
genres_exclude: string
Exclude genre(s) IDs. Can pass multiple with a comma as a delimiter. e.g 1,2,3
-
max_score: number
Set a maximum score for results.
-
min_score: number
Set a minimum score for results.
-
order_by: "mal_id"
| "title"
| "start_date"
| "end_date"
| "episodes"
| "score"
| "scored_by"
| "rank"
| "popularity"
| "members"
| "favorites"Available Anime order_by properties
-
producers: string
Filter by producers. Can pass multiple with a comma as a delimiter. e.g 1,2,3
-
rating: "g" | "pg" | "pg13" | "r17" | "r" | "rx"
Available Anime audience ratings
- score: number
-
sfw: boolean
Filter out Adult entries
-
start_date: string
Filter by starting data. Format: YYYY-MM-DD. e.g
2022,2005-05,2005-01-01 -
status: "airing" | "complete" | "upcoming"
Available Anime statuses
-
type: "tv"
| "movie"
| "ova"
| "special"
| "ona"
| "music"
| "cm"
| "pv"
| "tv_special"Available Anime types
-
unapproved: boolean
This is a flag. When supplied it will include entries which are unapproved. Unapproved entries on MyAnimeList are those that are user submitted and have not yet been approved by MAL to show up on other pages. They will have their own specifc pages and are often removed resulting in a 404 error. You do not need to pass a value to it.
- aired: { from?: string; to?: string; }
- airing: boolean
- approved: boolean
- background: string
- broadcast: { day?: string; time?: string; timezone?: string; string?: string; }
- demographics: baseModel.MalEntries[]
- duration: string
- episodes: number
- explicit_genres: baseModel.MalEntries[]
- favorites: number
- genres: baseModel.MalEntries[]
- images: AnimeImages
- licensors: baseModel.MalEntries[]
- members: number
- popularity: number
- producers: baseModel.MalEntries[]
- rank: number
-
rating: "G - All Ages"
| "PG - Children"
| "PG-13 - Teens 13 or older"
| "R - 17+ (violence & profanity)"
| "R+ - Mild Nudity"
| "Rx - Hentai" - score: number
- scored_by: number
- season: Season
- source: string
- status: string
- studios: baseModel.MalEntries[]
- synopsis: string
- themes: baseModel.MalEntries[]
- titles: baseModel.Titles[]
- trailer: TrailerBase
- type: AnimeType
- year: number
BaseSearchParameters: Interface for base search parameters
-
letter: string
Return entries starting with the specified letter
- limit: number
- q: string
-
sort: "asc" | "desc"
Search query sort direction
PageSearchParameter: Interface for page search parameter
ReviewsParameters: Interface for Reviews search parameters
-
from: string
Date ISO8601
- prop: { from: DateProp; to: DateProp; string?: string; }
-
to: string
Date ISO8601
-
cache: boolean
Enable or disable the cache
-
cacheExpiration: number
Cache expiration time in milliseconds
-
cachePath: string
Data path for the cache
-
deleteCacheOnExit: boolean
Delete the cache when the program exits
CharacterSearchParameters: Interface for Character search parameters
-
order_by: "mal_id" | "name" | "favorites"
Available Character order_by properties
-
baseUri: string
The base pathname for the Jikan API.
-
cacheOptions: Partial<cacheManager.CacheOptions>
Cache options (optional)
-
host: string
Jikan http client host Change it if you want to use a different Jikan API host (e.g. local instance)
-
maxPendingRequests: number
Maximum pending requests in the queue
-
rateLimit: number
The rate limit interval in milliseconds
-
timeout: number
Timeout for the request in milliseconds for each request to the Jikan API
MangaSearchParameters: Interface for Manga search parameters
-
end_date: string
Filter by ending date. Format: YYYY-MM-DD. e.g
2022,2005-05,2005-01-01 -
genres: string
Filter by genre(s) IDs. Can pass multiple with a comma as a delimiter. e.g 1,2,3
-
genres_exclude: string
Exclude genre(s) IDs. Can pass multiple with a comma as a delimiter. e.g 1,2,3
-
magazine: string
Filter by magazine(s) IDs. Can pass multiple with a comma as a delimiter. e.g 1,2,3
-
max_score: number
Set a maximum score for results.
-
min_score: number
Set a minimum score for results.
-
order_by: "mal_id"
| "title"
| "start_date"
| "end_date"
| "chapters"
| "volumes"
| "score"
| "scored_by"
| "rank"
| "popularity"
| "members"
| "favorites"Available Manga order_by properties
- score: number
-
sfw: boolean
Filter out Adult entries
-
stard_date: string
Filter by starting date. Format: YYYY-MM-DD. e.g
2022,2005-05,2005-01-01 -
status: "publishing"
| "complete"
| "hiatus"
| "discontinued"
| "upcoming"Available Manga statuses
-
type: "manga"
| "novel"
| "lightnovel"
| "oneshot"
| "doujin"
| "manhwa"
| "manhua"Available Manga types
-
unapproved: boolean
This is a flag. When supplied it will include entries which are unapproved. Unapproved entries on MyAnimeList are those that are user submitted and have not yet been approved by MAL to show up on other pages. They will have their own specifc pages and are often removed resulting in a 404 error. You do not need to pass a value to it.
- approved: boolean
- authors: baseModel.MalEntries[]
- background: string
- chapters: number
- demographics: baseModel.MalEntries[]
- explicit_genres: baseModel.MalEntries[]
- favorites: number
- genres: baseModel.MalEntries[]
- images: MangaImages
- members: number
- popularity: number
- published: baseModel.DateRange
- publishing: boolean
- rank: number
- score: number
- scored_by: number
- serializations: baseModel.MalEntries[]
- status: MangaStatus
- synopsis: string
- themes: baseModel.MalEntries[]
- titles: baseModel.Titles[]
- type: MangaType
- volumes: number