Class CurseforgeV1Client

Reference the https://docs.curseforge.com/#curseforge-core-api-mods

🏭 Constructors

constructor

CurseforgeV1Client(apiKey: string, options: CurseforgeClientOptions): CurseforgeV1Client

Parameters

• apiKey: string
• options: CurseforgeClientOptions

Return Type

• CurseforgeV1Client

Defined in: packages/curseforge/index.ts:573

🏷️ Properties

headers

headers: Record<string, string>

Defined in: packages/curseforge/index.ts:569

🔧 Methods

getCategories

getCategories(signal: AbortSignal): Promise<ModCategory[]>

Parameters

• signal: AbortSignal

Return Type

• Promise<ModCategory[]>

Defined in: packages/curseforge/index.ts:585

getFiles

getFiles(fileIds: number[], signal: AbortSignal): Promise<File[]>

Parameters

• fileIds: number[]
• signal: AbortSignal

Return Type

• Promise<File[]>

Defined in: packages/curseforge/index.ts:713

getFingerprintsFuzzyMatchesByGameId

getFingerprintsFuzzyMatchesByGameId(gameId: number, fingerprints: number[], signal: AbortSignal): Promise<{ fuzzyMatches: FingerprintFuzzyMatch[] }>

Parameters

• gameId: number
• fingerprints: number[]
• signal: AbortSignal

Return Type

• Promise<{ fuzzyMatches: FingerprintFuzzyMatch[] }>

Defined in: packages/curseforge/index.ts:802

getFingerprintsMatchesByGameId

getFingerprintsMatchesByGameId(gameId: number, fingerprints: number[], signal: AbortSignal): Promise<{ exactFingerprints: number[]; exactMatches: FingerprintMatch[]; isCacheBuilt: boolean; partialFingerprints: object; partialMatches: FingerprintMatch[]; unmatchedFingerprints: number[] }>

Parameters

• gameId: number
• fingerprints: number[]
• signal: AbortSignal

Return Type

• Promise<{ exactFingerprints: number[]; exactMatches: FingerprintMatch[]; isCacheBuilt: boolean; partialFingerprints: object; partialMatches: FingerprintMatch[]; unmatchedFingerprints: number[] }>

Defined in: packages/curseforge/index.ts:783

getMod

getMod(modId: number, signal: AbortSignal): Promise<Mod>

Get the mod by mod Id.

Parameters

• modId: number The id of mod
• signal: AbortSignal

Return Type

• Promise<Mod>

Defined in: packages/curseforge/index.ts:608

getModDescription

getModDescription(modId: number, signal: AbortSignal): Promise<string>

Parameters

• modId: number
• signal: AbortSignal

Return Type

• Promise<string>

Defined in: packages/curseforge/index.ts:627

getModFile

getModFile(modId: number, fileId: number, signal: AbortSignal): Promise<File>

Parameters

• modId: number
• fileId: number
• signal: AbortSignal

Return Type

• Promise<File>

Defined in: packages/curseforge/index.ts:672

getModFileChangelog

getModFileChangelog(modId: number, fileId: number, signal: AbortSignal): Promise<string>

https://docs.curseforge.com/#get-mod-file-changelog

Parameters

• modId: number
• fileId: number
• signal: AbortSignal

Return Type

• Promise<string>

Defined in: packages/curseforge/index.ts:767

getModFiles

getModFiles(options: GetModFilesOptions, signal: AbortSignal): Promise<{ data: File[]; pagination: Pagination }>

Parameters

• options: GetModFilesOptions
• signal: AbortSignal

Return Type

• Promise<{ data: File[]; pagination: Pagination }>

Defined in: packages/curseforge/index.ts:646

getMods

getMods(modIds: number[], signal: AbortSignal): Promise<Mod[]>

Parameters

• modIds: number[]
• signal: AbortSignal

Return Type

• Promise<Mod[]>

Defined in: packages/curseforge/index.ts:691

searchMods

searchMods(options: SearchOptions, signal: AbortSignal): Promise<{ data: Mod[]; pagination: Pagination }>

Parameters

• options: SearchOptions
• signal: AbortSignal

Return Type

• Promise<{ data: Mod[]; pagination: Pagination }>

Defined in: packages/curseforge/index.ts:735