node-myanimelist
Version:
Node.js wrappers for MAL.
59 lines (58 loc) • 1.61 kB
TypeScript
import { Anime, Manga } from "./types";
/**
* # AdvancedSearchParameters
*
*/
export interface AdvancedSearchParameters {
q?: string;
page?: number;
type?: Anime.Type | Manga.Type;
status?: Anime.Status | Manga.Status;
rated?: Anime.Rating | Manga.Rating;
genre?: Anime.GenreId | Manga.GenreId;
score?: number;
start_date?: string;
end_date?: string;
genre_exclude?: 0 | 1;
limit?: number;
order_by?: Anime.OrderBy | Manga.OrderBy;
sort?: Anime.Sort | Manga.Sort;
producer?: number;
magazine?: number;
letter?: string;
}
/**
* # Search
*
* #### For more info visit <a href="https://jikan.docs.apiary.io/#reference/0/search" target="_blank">https://jikan.docs.apiary.io</a>
* To search you need to create search object, like that:
* ```ts
* Jikan.search();
* ```
* And then you can choose type of search
* ```ts
* Jikan.search().anime({ q: "Fate", page: 2 });
* Jikan.search().manga({ q: "Fate" });
* Jikan.search().person({ q: "Fate" });
* Jikan.search().character({ q: "Fate" });
*
* Jikan.search().anime({
* q: "fate",
* page: 2,
* genre: Jikan.Anime.GenreId.action,
* });
* ```
*
* {@link AdvancedSearchParameters}
*/
export declare class Search {
/** @ignore */
private baseUrl;
constructor();
private search;
anime(params: AdvancedSearchParameters): Promise<any>;
manga(params: AdvancedSearchParameters): Promise<any>;
person(params: AdvancedSearchParameters): Promise<any>;
character(params: AdvancedSearchParameters): Promise<any>;
}
export declare function search(): Search;