Class Producers

Hierarchy

Producers

Index

Constructors

Methods

getProducerById getProducerExternal getProducerFullById getProducers

Constructors

constructor

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

Methods

getProducerById

getProducerById(id): Promise<IProducer>
Gets the data of a producer from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the producer
Returns Promise<IProducer>
Data of the producer
- Defined in lib/jikan/producers.ts:20

getProducerExternal

getProducerExternal(id): Promise<IResource[]>
Gets the external sites of a producer from its MyAnimeList ID
Parameters
- id: string | number
  
  MyAnimeList ID of the producer
Returns Promise<IResource[]>
External sites of the producer
- Defined in lib/jikan/producers.ts:42

getProducerFullById

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

getProducers

getProducers(config?): Promise<{
data: IProducer[];
pagination: IExtendedPagination;
}>
Searches for producers in MyAnimeList
Parameters
- Optional config: IProducerSearchConfig
  
  Config to make the request
Returns Promise<{
data: IProducer[];
pagination: IExtendedPagination;
}>
Result of the search
- Defined in lib/jikan/producers.ts:53

Generated using TypeDoc