Class Anime

Hierarchy

Anime

Constructors

constructor

new Anime(cacheOptions?): Anime
Constructs an instance of the anime client
Parameters
- Optional cacheOptions: CacheOptions
  
  Cache options for the client to make requests
Returns Anime
- Defined in lib/jikan/anime.ts:35

Methods

getAnimeById

getAnimeById(id): Promise<IAnime>
Gets anime data by its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
Returns Promise<IAnime>
The data of the anime
- Defined in lib/jikan/anime.ts:44

getAnimeCharacters

getAnimeCharacters(id): Promise<IAnimeCharacter[]>
Gets the characters of the anime from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
Returns Promise<IAnimeCharacter[]>
The characters of the given anime ID
- Defined in lib/jikan/anime.ts:66

getAnimeEpisodeById

getAnimeEpisodeById(id, episode_id): Promise<IEpisodeResponse>
Gets the data of an anime's episode by its anime & episode ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
- episode_id: string | number
  
  Episode ID of the anime
Returns Promise<IEpisodeResponse>
Data of the required episode
- Defined in lib/jikan/anime.ts:106

getAnimeEpisodes

getAnimeEpisodes(id, config?): Promise<{
data: IEpisodeFromList[];
pagination: IPagination;
}>
Gets the episodes of the anime from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
- Optional config: ICommonConfig
  
  Config to make the request
Returns Promise<{
data: IEpisodeFromList[];
pagination: IPagination;
}>
List of episodes with the pagination
- Defined in lib/jikan/anime.ts:89

getAnimeExternal

getAnimeExternal(id): Promise<IResource[]>
Gets the external sites of an anime by its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
Returns Promise<IResource[]>
External sites of the anime
- Defined in lib/jikan/anime.ts:284

getAnimeForum

getAnimeForum(id, config?): Promise<IForum[]>
Gets the forums related to an anime from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
- Optional config: IForumConfig
  
  Config to make the request
Returns Promise<IForum[]>
List of the forums related to the anime
- Defined in lib/jikan/anime.ts:141

getAnimeFullById

getAnimeFullById(id): Promise<IAnimeFull>
Gets the full data of anime by its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
Returns Promise<IAnimeFull>
The full data of the anime
- Defined in lib/jikan/anime.ts:55

getAnimeMoreInfo

getAnimeMoreInfo(id): Promise<IMoreInfo>
Gets more info of an anime from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
Returns Promise<IMoreInfo>
More info of the anime
- Defined in lib/jikan/anime.ts:206

getAnimeNews

getAnimeNews(id, config?): Promise<{
data: INewsResponse[];
pagination: IPagination;
}>
Gets the list of news related to a anime from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
- Optional config: ICommonConfig
  
  Config to make the request
Returns Promise<{
data: INewsResponse[];
pagination: IPagination;
}>
List of news related to the anime
- Defined in lib/jikan/anime.ts:124

getAnimePictures

getAnimePictures(id): Promise<IPicture[]>
Gets the pictures of an anime from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
Returns Promise<IPicture[]>
List of images of the anime in different formats
- Defined in lib/jikan/anime.ts:184

getAnimeRecommendations

getAnimeRecommendations(id): Promise<IRecommendation[]>
Gets recommendations of an anime from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
Returns Promise<IRecommendation[]>
List of recommenedations from the anime
- Defined in lib/jikan/anime.ts:217

getAnimeRelations

getAnimeRelations(id): Promise<IRelation[]>
Gets the relations of an anime by its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
Returns Promise<IRelation[]>
Relations of the anime
- Defined in lib/jikan/anime.ts:262

getAnimeReviews

getAnimeReviews(id, config?): Promise<{
data: IAnimeReview[];
pagination: IPagination;
}>
Gets the reviews of an anime by its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
- Optional config: IReviewConfig
  
  Config to make the request
Returns Promise<{
data: IAnimeReview[];
pagination: IPagination;
}>
Reviews of the anime
- Defined in lib/jikan/anime.ts:246

getAnimeSearch

getAnimeSearch(config?): Promise<{
data: IAnime[];
pagination: IExtendedPagination;
}>
Searches for anime in MyAnimeList
Parameters
- Optional config: IAnimeSearchConfig
  
  Config to make the search
Returns Promise<{
data: IAnime[];
pagination: IExtendedPagination;
}>
Results of the search
- Defined in lib/jikan/anime.ts:306

getAnimeStaff

getAnimeStaff(id): Promise<IAnimeStaff[]>
Gets the staffs of the anime from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
Returns Promise<IAnimeStaff[]>
The staffs of given anime ID
- Defined in lib/jikan/anime.ts:77

getAnimeStatistics

getAnimeStatistics(id): Promise<IAnimeStatistics>
Gets the statistics of an anime from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
Returns Promise<IAnimeStatistics>
Stats of the anime
- Defined in lib/jikan/anime.ts:195

getAnimeStreaming

getAnimeStreaming(id): Promise<IResource[]>
Gets streaming platforms of an anime from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
Returns Promise<IResource[]>
Streaming platforms of the anime with their URLs
- Defined in lib/jikan/anime.ts:295

getAnimeThemes

getAnimeThemes(id): Promise<IExtendedResource[]>
Gets the themes of an anime by its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
Returns Promise<IExtendedResource[]>
Themes of the anime
- Defined in lib/jikan/anime.ts:273

getAnimeUserUpdates

getAnimeUserUpdates(id, config?): Promise<{
data: IAnimeUserUpdate[];
pagination: IPagination;
}>
Gets the list of user updates of an anime from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
- Optional config: ICommonConfig
  
  Config to make the request
Returns Promise<{
data: IAnimeUserUpdate[];
pagination: IPagination;
}>
List of user updates of the anime
- Defined in lib/jikan/anime.ts:229

getAnimeVideos

getAnimeVideos(id): Promise<IAnimeVideo>
Gets the anime videos of the given MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
Returns Promise<IAnimeVideo>
Videos of the anime
- Defined in lib/jikan/anime.ts:156

getAnimeVideosEpisodes

getAnimeVideosEpisodes(id, config?): Promise<{
data: IAnimeVideosEpisode[];
pagination: IPagination;
}>
Gets the episode videos of an anime from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the anime
- Optional config: ICommonConfig
  
  Config to make the request
Returns Promise<{
data: IAnimeVideosEpisode[];
pagination: IPagination;
}>
Episode videos of the anime
- Defined in lib/jikan/anime.ts:168

Generated using TypeDoc