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

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

import type { JikanImages, PeopleSearchParams, Person, PersonAnimePosition, PersonFull, PersonMangaPosition, PersonVoiceActingRole } from '../models';
import { BaseClient } from './base.client';
/**
 * **People Client**
 *
 * Client used to access the People Endpoints:
 *
 * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
 */
export declare class PeopleClient extends BaseClient {
    /**
     * Get complete person data
     * @param id Person ID
     */
    getPersonFullById(id: number): Promise<import("../models").JikanResponse<PersonFull>>;
    /**
     * Get person by ID
     * @param id Person ID
     */
    getPersonById(id: number): Promise<import("../models").JikanResponse<Person>>;
    /**
     * Get anime staff positions of a person
     * @param id Person ID
     */
    getPersonAnime(id: number): Promise<import("../models").JikanResponse<PersonAnimePosition[]>>;
    /**
     * Get voice acting roles of a person
     * @param id Person ID
     */
    getPersonVoices(id: number): Promise<import("../models").JikanResponse<PersonVoiceActingRole[]>>;
    /**
     * Get manga works of a person
     * @param id Person ID
     */
    getPersonManga(id: number): Promise<import("../models").JikanResponse<PersonMangaPosition[]>>;
    /**
     * Get pictures of a person
     * @param id Person ID
     */
    getPersonPictures(id: number): Promise<import("../models").JikanResponse<JikanImages[]>>;
    /**
     * Search people
     * @param searchParams Search parameters
     */
    getPeopleSearch(searchParams?: Partial<PeopleSearchParams>): Promise<import("../models").JikanResponse<Person[]>>;
}