@tutkli/jikan-ts
Version:
Node.js wrapper for the Jikan API with built-in typings.
33 lines (32 loc) • 1.24 kB
TypeScript
import type { Anime, AnimeSeason, JikanSeasonsParams, SeasonNowParams, SeasonsListData } from '../models';
import { BaseClient } from './base.client';
/**
* **Seasons Client**
*
* Client used to access the Seasons Endpoints
*
* See also: [Jikan Documentation](https://docs.api.jikan.moe/)
*/
export declare class SeasonsClient extends BaseClient {
/**
* Get the seasonal anime by year and season
* @param year Season year
* @param season Season value
* @param searchParams Filter parameters
*/
getSeason(year: number, season: AnimeSeason, searchParams?: Partial<JikanSeasonsParams>): Promise<import("../models").JikanResponse<Anime[]>>;
/**
* Get current seasonal anime
* @param searchParams Filter parameters
*/
getSeasonNow(searchParams?: Partial<SeasonNowParams>): Promise<import("../models").JikanResponse<Anime[]>>;
/**
* Get available list of seasons
*/
getSeasonsList(): Promise<import("../models").JikanResponse<SeasonsListData[]>>;
/**
* Get upcoming season's anime
* @param searchParams Filter parameters
*/
getSeasonUpcoming(searchParams?: Partial<JikanSeasonsParams>): Promise<import("../models").JikanResponse<Anime[]>>;
}