Class CurseForgeGame

Represents a game.

Hierarchy

default
- CurseForgeGame

Index

Constructors

Properties

apiStatus assets client dateModified id name slug status

Methods

getVersionTypes getVersions

Constructors

constructor

new CurseForgeGame(client: CurseForgeClient, data: CurseForgeGameRaw): CurseForgeGame
Internal
Constructs a new game representation.
Parameters
- client: CurseForgeClient
  
  The CurseForgeClient associated with this file
- data: CurseForgeGameRaw
  
  The raw API response data
Returns CurseForgeGame
Overrides default.constructor
- Defined in src/v1/Game.ts:23

Properties

apiStatus

apiStatus: CurseForgeCoreApiStatus

assets

assets: CurseForgeGameAssets

client

client: CurseForgeClient

dateModified

dateModified: Date

id

id: number

name

name: string

slug

slug: string

status

status: CurseForgeCoreStatus

Methods

getVersionTypes

getVersionTypes(): Promise<CurseForgeGameVersionType[]>
Get all available version types of the specified game. A private game is only accessible to its respective API key.

Throws
CurseForgeResponseError when the request fails

Returns
A list of version types

Returns Promise<CurseForgeGameVersionType[]>
- Defined in src/v1/Game.ts:47

getVersions

getVersions(): Promise<CurseForgeGameVersionsByType[]>
Get all available versions for each known version type of the specified game. A private game is only accessible to its respective API key.

Throws
CurseForgeResponseError when the request fails

Returns
A list of version types and versions

Returns Promise<CurseForgeGameVersionsByType[]>
- Defined in src/v1/Game.ts:39

Generated using TypeDoc