Class Manga

Hierarchy

Manga

Index

Constructors

Methods

getMangaById getMangaCharacters getMangaExternal getMangaFullById getMangaMoreInfo getMangaNews getMangaPictures getMangaRecommendations getMangaRelations getMangaReviews getMangaSearch getMangaStatistics getMangaTopics getMangaUserUpdates

Constructors

constructor

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

Methods

getMangaById

getMangaById(id): Promise<IManga>
Gets the data of a manga from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the manga
Returns Promise<IManga>
The data of the manga
- Defined in lib/jikan/manga.ts:38

getMangaCharacters

getMangaCharacters(id): Promise<ICharacterFromSource[]>
Gets the list of characters of a manga from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the manga
Returns Promise<ICharacterFromSource[]>
List of characters of the manga
- Defined in lib/jikan/manga.ts:60

getMangaExternal

getMangaExternal(id): Promise<IResource[]>
Get external sites of a manga from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the manga
Returns Promise<IResource[]>
External sites of the manga
- Defined in lib/jikan/manga.ts:192

getMangaFullById

getMangaFullById(id): Promise<IMangaFull>
Gets the full data of a manga from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the manga
Returns Promise<IMangaFull>
The full data of the manga
- Defined in lib/jikan/manga.ts:49

getMangaMoreInfo

getMangaMoreInfo(id): Promise<IMoreInfo>
Gets more info of a manga from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the manga
Returns Promise<IMoreInfo>
More info of the manga
- Defined in lib/jikan/manga.ts:125

getMangaNews

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

getMangaPictures

getMangaPictures(id): Promise<IPicture[]>
Gets the pictures of a manga from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the manga
Returns Promise<IPicture[]>
Pictures of the manga
- Defined in lib/jikan/manga.ts:103

getMangaRecommendations

getMangaRecommendations(id): Promise<IRecommendation[]>
Gets recommendations of a manga from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the manga
Returns Promise<IRecommendation[]>
List of recommendations from the manga
- Defined in lib/jikan/manga.ts:136

getMangaRelations

getMangaRelations(id): Promise<IRelation[]>
Gets relation of a manga from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the manga
Returns Promise<IRelation[]>
Relations of the manga
- Defined in lib/jikan/manga.ts:181

getMangaReviews

getMangaReviews(id, config?): Promise<{
data: IMangaReview[];
pagination: IPagination;
}>
Gets the reviews of a manga from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the manga
- Optional config: IReviewConfig
  
  Config to make the request
Returns Promise<{
data: IMangaReview[];
pagination: IPagination;
}>
- Defined in lib/jikan/manga.ts:165

getMangaSearch

getMangaSearch(config?): Promise<{
data: IManga[];
pagination: IExtendedPagination;
}>
Searches for manga in MyAnimeList
Parameters
- Optional config: IMangaSearchConfig
  
  Config to make the search
Returns Promise<{
data: IManga[];
pagination: IExtendedPagination;
}>
Search results of the manga
- Defined in lib/jikan/manga.ts:203

getMangaStatistics

getMangaStatistics(id): Promise<IMangaStatistics>
Gets the statistics of a manga from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the manga
Returns Promise<IMangaStatistics>
Statistics of the manga
- Defined in lib/jikan/manga.ts:114

getMangaTopics

getMangaTopics(id, config?): Promise<IForum[]>
Gets the topics related to a manga from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the manga
- Optional config: IForumConfig
Returns Promise<IForum[]>
List of topics related to the manga
- Defined in lib/jikan/manga.ts:88

getMangaUserUpdates

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

Generated using TypeDoc