Class People

Hierarchy

People

Index

Constructors

Methods

getPeopleSearch getPersonAnime getPersonById getPersonByIdFull getPersonManga getPersonPictures getPersonVoices

Constructors

constructor

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

Methods

getPeopleSearch

getPeopleSearch(config?): Promise<{
data: IPerson[];
pagination: IExtendedPagination;
}>
Searches for person in MyAnimeList
Parameters
- Optional config: IPersonSearchConfig
  
  Config to make the search
Returns Promise<{
data: IPerson[];
pagination: IExtendedPagination;
}>
Results of the search
- Defined in lib/jikan/people.ts:86

getPersonAnime

getPersonAnime(id): Promise<PersonSource<"anime">[]>
Gets list of the anime contributed by a person from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the person
Returns Promise<PersonSource<"anime">[]>
List of anime contributed by the person
- Defined in lib/jikan/people.ts:42

getPersonById

getPersonById(id): Promise<IPerson>
Gets the data of a person from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the person
Returns Promise<IPerson>
Data of the person
- Defined in lib/jikan/people.ts:20

getPersonByIdFull

getPersonByIdFull(id): Promise<IPersonFull>
Gets the full data of a person from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the person
Returns Promise<IPersonFull>
Full data of the person
- Defined in lib/jikan/people.ts:31

getPersonManga

getPersonManga(id): Promise<PersonSource<"manga">[]>
Gets list of the manga contributed by a person from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the person
Returns Promise<PersonSource<"manga">[]>
List of manga contributed by the person
- Defined in lib/jikan/people.ts:64

getPersonPictures

getPersonPictures(id): Promise<ICommonPicture[]>
Gets the pictures of a person from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the person
Returns Promise<ICommonPicture[]>
Pictures of the person
- Defined in lib/jikan/people.ts:75

getPersonVoices

getPersonVoices(id): Promise<IPersonVoice[]>
Gets list of the voices featured by a person from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the person
Returns Promise<IPersonVoice[]>
List of voices featured by the person
- Defined in lib/jikan/people.ts:53

Generated using TypeDoc