Class Characters

Hierarchy

Characters

Index

Constructors

Methods

getCharacterAnime getCharacterById getCharacterFullById getCharacterManga getCharacterPictures getCharacterVoiceActors getCharactersSearch

Constructors

constructor

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

Methods

getCharacterAnime

getCharacterAnime(id): Promise<CharacterSource<"anime">[]>
Gets the list of anime appeared by a character from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the character
Returns Promise<CharacterSource<"anime">[]>
List of anime appeared by the character
- Defined in lib/jikan/characters.ts:42

getCharacterById

getCharacterById(id): Promise<ICharacter>
Gets the data of a character from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the character
Returns Promise<ICharacter>
The data of the character
- Defined in lib/jikan/characters.ts:20

getCharacterFullById

getCharacterFullById(id): Promise<ICharacterFull>
Gets the full data of a character from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the character
Returns Promise<ICharacterFull>
The full data of the character
- Defined in lib/jikan/characters.ts:31

getCharacterManga

getCharacterManga(id): Promise<CharacterSource<"manga">[]>
Gets the list of manga appeared by a character from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the character
Returns Promise<CharacterSource<"manga">[]>
List of manga appeared by the character
- Defined in lib/jikan/characters.ts:53

getCharacterPictures

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

getCharacterVoiceActors

getCharacterVoiceActors(id): Promise<IVoiceActor[]>
Gets the voice actors of a character from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the character
Returns Promise<IVoiceActor[]>
Voice actors of the character
- Defined in lib/jikan/characters.ts:64

getCharactersSearch

getCharactersSearch(config?): Promise<{
data: ICharacter[];
pagination: IExtendedPagination;
}>
Searches for a character in MyAnimeList
Parameters
- Optional config: ICharacterSearchConfig
  
  Config to make the search
Returns Promise<{
data: ICharacter[];
pagination: IExtendedPagination;
}>
The results of the search
- Defined in lib/jikan/characters.ts:86

Generated using TypeDoc