@tutkli/jikan-ts
Version:
Node.js wrapper for the Jikan API with built-in typings.
48 lines (47 loc) • 1.7 kB
TypeScript
import type { AnimeRating, AnimeSearchType } from '../Anime';
import type { MangaSearchType } from '../Manga';
export type SortOptions = 'asc' | 'desc';
export type SearchOrder = 'mal_id' | 'title' | 'start_date' | 'end_date' | 'score' | 'scored_by' | 'rank' | 'popularity' | 'members' | 'favorites';
export type AnimeSearchOrder = 'type' | 'rating' | 'episodes' | 'status' | SearchOrder;
export type AnimeSearchStatus = 'airing' | 'complete' | 'upcoming';
export type MangaSearchOrder = 'chapters' | 'volumes' | 'status' | SearchOrder;
export type MangaSearchStatus = 'publishing' | 'complete' | 'hiatus' | 'discontinued' | 'upcoming';
export 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;
letter?: string;
producers?: string;
start_date?: string;
end_date?: string;
unapproved?: boolean;
}
/**
* QueryParams used in **getMangaSearch** call
*
* See also: [Jikan API Documentation](https://docs.api.jikan.moe/#tag/manga/operation/getMangaSearch)
*/
export interface MangaSearchParams extends JikanSearchParams {
type?: MangaSearchType;
status?: MangaSearchStatus;
order_by?: MangaSearchOrder;
magazines?: string;
}
/**
* QueryParams used in **getAnimeSearch** call
*
* See also: [Jikan API Documentation](https://docs.api.jikan.moe/#tag/anime/operation/getAnimeSearch)
*/
export interface AnimeSearchParams extends JikanSearchParams {
type?: AnimeSearchType;
status?: AnimeSearchStatus;
rating?: AnimeRating;
order_by?: AnimeSearchOrder;
}