Class Curseforge

the default exported class of the package.

Hierarchy

Curseforge

Constructors

constructor

new Curseforge(token: string): Curseforge

- Defined in src/index.ts:513
Create a new curseforge client.

Parameters
- token: string
  
  The API Token from Curseforge. You can receive one from https://console.curseforge.com/#/api-keys
Returns Curseforge

Methods

get_categories

get_categories(game: number | Game, classId?: number): Promise<Category[]>

- Defined in src/index.ts:159
Return a list of categories associated for a game.

Parameters
- game: number | Game
  
  the game id or game object.
- Optional classId: number
  
  optional root category (for example. Resourcepacks, Savegames, Mods)
Returns Promise<Category[]>
list of Categories fitting the game (and also classId)

get_featured_mods

get_featured_mods(game: number | Game, gameVersionType?: number | GameVersionType, excludedMods?: number[]): Promise<{ featured: Mod[]; popular: Mod[]; recentlyUpdated: Mod[] }>

- Defined in src/index.ts:268
Parameters
- game: number | Game
- Optional gameVersionType: number | GameVersionType
- Optional excludedMods: number[]
Returns Promise<{ featured: Mod[]; popular: Mod[]; recentlyUpdated: Mod[] }>

get_file

get_file(mod: number | Mod, fileId: number): Promise<ModFile>

- Defined in src/index.ts:320
Parameters
- mod: number | Mod
- fileId: number
Returns Promise<ModFile>

get_file_changelog

get_file_changelog(mod: number | Mod, file: number | ModFile): Promise<string>

- Defined in src/index.ts:370
Parameters
- mod: number | Mod
- file: number | ModFile
Returns Promise<string>

get_file_download

get_file_download(mod: number | Mod, file: number | ModFile): Promise<string>

- Defined in src/index.ts:387
Parameters
- mod: number | Mod
- file: number | ModFile
Returns Promise<string>

get_files

get_files(mod: number | Mod, searchOptions?: { gameVersion?: string; gameVersionTypeId?: number; modLoaderType?: number } & PagingOptions): Promise<ModFile[] & { paging: Pagination }>

- Defined in src/index.ts:337
Parameters
- mod: number | Mod
- Optional searchOptions: { gameVersion?: string; gameVersionTypeId?: number; modLoaderType?: number } & PagingOptions
Returns Promise<ModFile[] & { paging: Pagination }>

get_fingerprints

get_fingerprints(fingerprints: number[]): Promise<FingerprintMatchResult>

- Defined in src/index.ts:406
Parameters
- fingerprints: number[]
Returns Promise<FingerprintMatchResult>

get_fingerprints_fuzzy

get_fingerprints_fuzzy(game: number | Game, fingerprints: FolderFingerprints[]): Promise<FingerprintFuzzyMatch[]>

- Defined in src/index.ts:423
Parameters
- game: number | Game
- fingerprints: FolderFingerprints[]
Returns Promise<FingerprintFuzzyMatch[]>

get_game

get_game(game_id: string | number): Promise<Game>

- Defined in src/index.ts:42
Get a game specified by game_id

Parameters
- game_id: string | number
  
  Game id or slug to use.
Returns Promise<Game>

get_game_versions

get_game_versions(game: number | Game): Promise<GameVersionsByType[]>

- Defined in src/index.ts:113
Get the different game versions supported by CFCore.

Parameters
- game: number | Game
  
  Game to request the versions for.
Returns Promise<GameVersionsByType[]>
Array of Game Versions

get_game_versions_type

get_game_versions_type(game: number | Game): Promise<GameVersionType[]>

- Defined in src/index.ts:135
Return a list of version types.

Parameters
- game: number | Game
Returns Promise<GameVersionType[]>

get_games

get_games(index?: number, pageSize?: number): Promise<Game[] & { paging: Pagination }>

- Defined in src/index.ts:84
Get multiple available games.

Parameters
- Optional index: number
  
  Optional index to use for paging.
- Optional pageSize: number
  
  Size to show per page. Maximum is 50.
Returns Promise<Game[] & { paging: Pagination }>
A Promise with a paging property filled with the Pagination.

get_minecraft_modloader

get_minecraft_modloader(modloader: string): Promise<default>

- Defined in src/index.ts:491
Parameters
- modloader: string
Returns Promise<default>

get_minecraft_modloaders

get_minecraft_modloaders(): Promise<default[]>

- Defined in src/index.ts:474
Returns Promise<default[]>

get_minecraft_version

get_minecraft_version(version: number | default): Promise<default>

- Defined in src/index.ts:457
Parameters
- version: number | default
Returns Promise<default>

get_minecraft_versions

get_minecraft_versions(): Promise<default[]>

- Defined in src/index.ts:440
Returns Promise<default[]>

get_mod

get_mod(mod_id: number): Promise<Mod>

- Defined in src/index.ts:228
Parameters
- mod_id: number
Returns Promise<Mod>

get_mod_description

get_mod_description(mod: number | Mod): Promise<string>

- Defined in src/index.ts:299
Parameters
- mod: number | Mod
Returns Promise<string>

get_mods

get_mods(...mods: number[]): Promise<Mod[]>

- Defined in src/index.ts:247
Parameters
- Rest ...mods: number[]
Returns Promise<Mod[]>

search_mods

search_mods(game: number | Game, options?: SearchOptions & PagingOptions): Promise<Mod[] & { paging: Pagination }>

- Defined in src/index.ts:193
Parameters
- game: number | Game
- Optional options: SearchOptions & PagingOptions
Returns Promise<Mod[] & { paging: Pagination }>

set_token

set_token(token: string): void

- Defined in src/index.ts:29
Set the token for this instance.

Parameters
- token: string
  
  the CFCore token.
Returns void

Generated using TypeDoc