Class Clubs

Hierarchy

Clubs

Index

Constructors

Methods

getClubMembers getClubRelations getClubStaff getClubsById getClubsSearch

Constructors

constructor

new Clubs(cacheOptions?): Clubs
Constructs an instance of the clubs client
Parameters
- Optional cacheOptions: CacheOptions
  
  Cache options for the client to make requests
Returns Clubs
- Defined in lib/jikan/clubs.ts:19

Methods

getClubMembers

getClubMembers(id, config?): Promise<{
data: IClubMember[];
pagination: IPagination;
}>
Gets the members of a MyAnimeList club from its id
Parameters
- id: string | number
  
  MyAnimelist ID of the club
- Optional config: ICommonConfig
Returns Promise<{
data: IClubMember[];
pagination: IPagination;
}>
Members of the club
- Defined in lib/jikan/clubs.ts:39

getClubRelations

getClubRelations(id): Promise<IClubRelations>
Gets the relations of a MyAnimeList club from its ID
Parameters
- id: string | number
  
  MyAnimeList ID of the club
Returns Promise<IClubRelations>
Relations of the club
- Defined in lib/jikan/clubs.ts:66

getClubStaff

getClubStaff(id): Promise<IClubStaff[]>
Gets the staffs of a MyAnimeList club from its ID
Parameters
- id: string | number
  
  MyAnimeList ID of the club
Returns Promise<IClubStaff[]>
Staffs of the club
- Defined in lib/jikan/clubs.ts:55

getClubsById

getClubsById(id): Promise<IClub>
Gets the data of a MyAnimeList club from its ID
Parameters
- id: string | number
  
  MyAnimeList ID of the club
Returns Promise<IClub>
The data of the club
- Defined in lib/jikan/clubs.ts:28

getClubsSearch

getClubsSearch(config?): Promise<{
data: IClub[];
pagination: IPagination;
}>
Searches for MyAnimeList clubs
Parameters
- Optional config: IClubSearchConfig
  
  Config to make the search
Returns Promise<{
data: IClub[];
pagination: IPagination;
}>
Search results of the clubs
- Defined in lib/jikan/clubs.ts:77

Generated using TypeDoc