myanimelist-wrapper
Version:
A comprehensive TypeScript wrapper for the Jikan API v4 (unofficial MyAnimeList API)
38 lines (37 loc) • 1.22 kB
TypeScript
import type { JikanClient } from "../client";
import type { Club, ClubMember, ClubQueryParams, ClubRelation, ClubStaff, JikanPaginatedResponse, JikanResponse } from "../types";
export declare class ClubsEndpoint {
private client;
constructor(client: JikanClient);
/**
* Get club by ID
* @param id Club ID
* @returns Promise with club data
*/
getById(id: number): Promise<JikanResponse<Club>>;
/**
* Get club members
* @param id Club ID
* @param page Page number
* @returns Promise with club members data
*/
getMembers(id: number, page?: number): Promise<JikanPaginatedResponse<ClubMember>>;
/**
* Get club staff
* @param id Club ID
* @returns Promise with club staff data
*/
getStaff(id: number): Promise<JikanResponse<ClubStaff[]>>;
/**
* Get club relations
* @param id Club ID
* @returns Promise with club relations data
*/
getRelations(id: number): Promise<JikanResponse<ClubRelation[]>>;
/**
* Search for clubs
* @param params Search parameters
* @returns Promise with club search results
*/
search(params?: ClubQueryParams): Promise<JikanPaginatedResponse<Club>>;
}