Class Top

Hierarchy

Top

Index

Constructors

Methods

getTopAnime getTopCharacters getTopManga getTopPeople getTopReviews

Constructors

constructor

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

Methods

getTopAnime

getTopAnime(config?): Promise<{
data: IAnime[];
pagination: IExtendedPagination;
}>
Gets the top list of anime in MyAnimeList
Parameters
- Optional config: ITopAnimeConfig
  
  Config to get the top list
Returns Promise<{
data: IAnime[];
pagination: IExtendedPagination;
}>
The top list of the anime in MyAnimeList
- Defined in lib/jikan/top.ts:32

getTopCharacters

getTopCharacters(config?): Promise<{
data: ICharacter[];
pagination: IExtendedPagination;
}>
Gets the top list of characters in MyAnimeList
Parameters
- Optional config: ITopCommonConfig
  
  Config to get the top list
Returns Promise<{
data: ICharacter[];
pagination: IExtendedPagination;
}>
The top list of characters in MyAnimeList
- Defined in lib/jikan/top.ts:68

getTopManga

getTopManga(config?): Promise<{
data: IManga[];
pagination: IExtendedPagination;
}>
Gets the top list of manga in MyAnimeList
Parameters
- Optional config: ITopMangaConfig
  
  Config to get the top list
Returns Promise<{
data: IManga[];
pagination: IExtendedPagination;
}>
The top list of the manga in MyAnimeList
- Defined in lib/jikan/top.ts:44

getTopPeople

getTopPeople(config?): Promise<{
data: IPerson[];
pagination: IExtendedPagination;
}>
Gets the top list of people in MyAnimeList
Parameters
- Optional config: ITopCommonConfig
  
  Config to get the top list
Returns Promise<{
data: IPerson[];
pagination: IExtendedPagination;
}>
The top list of people in MyAnimeList
- Defined in lib/jikan/top.ts:56

getTopReviews

getTopReviews(config?): Promise<{
data: (IAnimeReview | IMangaReview)[];
pagination: IExtendedPagination;
}>
Gets the top list of reviews in MyAnimeList
Parameters
- Optional config: ITopReviewConfig
  
  Config to get the top list
Returns Promise<{
data: (IAnimeReview | IMangaReview)[];
pagination: IExtendedPagination;
}>
The top list of reviews in MyAnimeList
- Defined in lib/jikan/top.ts:80

Generated using TypeDoc