@tutkli/jikan-ts/dist/clients/top.client.d.ts

Node.js wrapper for the Jikan API with built-in typings.

import type { Anime, AnimeReview, AnimeTopParams, Character, JikanTopParams, Manga, MangaTopParams, Person } from '../models';
import { BaseClient } from './base.client';
/**
 * **Top Client**
 *
 * Client used to access the Top Endpoints:
 *
 * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
 */
export declare class TopClient extends BaseClient {
    /**
     * Get the top Animes
     * @param searchParams Filter parameters
     */
    getTopAnime(searchParams?: Partial<AnimeTopParams>): Promise<import("../models").JikanResponse<Anime[]>>;
    /**
     * Get the top Mangas
     * @param searchParams Filter parameters
     */
    getTopManga(searchParams?: Partial<MangaTopParams>): Promise<import("../models").JikanResponse<Manga[]>>;
    /**
     * Get the top Characters
     * @param searchParams Filter parameters
     */
    getTopCharacters(searchParams?: Partial<JikanTopParams>): Promise<import("../models").JikanResponse<Character[]>>;
    /**
     * Get top people
     * @param params pagination params
     */
    getTopPeople(params?: Partial<JikanTopParams>): Promise<import("../models").JikanResponse<Person[]>>;
    /**
     * Get top reviews
     * @param params pagination params
     */
    getTopReviews(params?: Partial<JikanTopParams>): Promise<import("../models").JikanResponse<AnimeReview[]>>;
}