Params Typings #

interface JikanSearchParams {
  q?: string;
  page?: number;
  limit?: number;
  score?: number;
  min_score?: number;
  max_score?: number;
  sfw?: boolean;
  genres?: string;
  genres_exclude?: string;
  sort?: SortOptions | string;
  letter?: string;
  producers?: string;
  start_date?: string;
  end_date?: string;
}

interface AnimeSearchParams extends JikanSearchParams {
  type?: AnimeType | string;
  status?: AnimeStatus | string;
  rating?: AnimeRating | string;
  order_by?: AnimeSearchOrder | SearchOrder | string;
}

interface MangaSearchParams extends JikanSearchParams {
  type?: MangaType | string;
  status?: MangaStatus | string;
  order_by?: MangaSearchOrder | SearchOrder | string;
  magazines?: string;
}

enum SortOptions {
  asc = 'asc',
  desc = 'desc',
}

enum SearchOrder {
  mal_id = 'mal_id',
  title = 'title',
  start_date = 'start_date',
  end_date = 'end_date',
  score = 'score',
  scored_by = 'scored_by',
  rank = 'rank',
  popularity = 'popularity',
  members = 'members',
  favorites = 'favorites',
}

enum AnimeSearchOrder {
  type = 'type',
  rating = 'rating',
  episodes = 'episodes',
}

enum MangaSearchOrder {
    chapters = 'chapters',
    volumes = 'volumes',
}

interface JikanTopParams {
  page?: number;
  limit?: number;
}

interface AnimeTopParams extends JikanTopParams {
  type?: AnimeType;
  filter?: TopAnimeFilter;
}

interface MangaTopParams extends JikanTopParams {
    type?: MangaType;
    filter: TopMangaFilter;
}

enum TopAnimeFilter {
  airing = 'airing',
  upcoming = 'upcoming',
  bypopularity = 'bypopularity',
  favorite = 'favorite',
}

enum TopMangaFilter {
  publishing = 'publishing',
  upcoming = 'upcoming',
  bypopularity = 'bypopularity',
  favorite = 'favorite',
}

interface JikanSeasonsParams {
    page?: number;
    limit?: number;
    filter?: AnimeType;
}

type SeasonNowParams = Omit<JikanSeasonsParams, 'filter'>;