Class Seasons

Hierarchy

Seasons

Index

Constructors

Methods

getSeason getSeasonNow getSeasonUpcoming getSeasonsList

Constructors

constructor

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

Methods

getSeason

getSeason(year, season, config?): Promise<ISeasonResponse>
Gets the list for given season's anime of the given year
Parameters
- year: string | number
  
  Year of the anime
- season: AnimeSeasons
  
  Season of the anime
- Optional config: ISeasonConfig
  
  Config to make the request
Returns Promise<ISeasonResponse>
The list for given season's anime of the given year
- Defined in lib/jikan/seasons.ts:33

getSeasonNow

getSeasonNow(config?): Promise<ISeasonResponse>
Gets the list of current season's anime
Parameters
- Optional config: ISeasonConfig
  
  Config to make the request
Returns Promise<ISeasonResponse>
List of current season's anime
- Defined in lib/jikan/seasons.ts:21

getSeasonUpcoming

getSeasonUpcoming(config?): Promise<ISeasonResponse>
Gets the list of upcoming anime of the current season
Parameters
- Optional config: ISeasonConfig
  
  Config to make the request
Returns Promise<ISeasonResponse>
The list of upcoming anime of the current season
- Defined in lib/jikan/seasons.ts:58

getSeasonsList

getSeasonsList(): Promise<ISeasonList[]>
Gets the list of available seasons of all the years

Returns Promise<ISeasonList[]>
List of available seasons of all the years
- Defined in lib/jikan/seasons.ts:50

Generated using TypeDoc