Class CurseForgeFile

Represents a mod file.

Hierarchy

Constructors

Properties

alternateFileId: null | number
dependencies: CurseForgeFileDependency[]

List of dependencies files.

displayName: string

Display name of the file.

downloadCount: number

The number of downloads for the file.

downloadUrl: string

The file download URL.

earlyAccessEndDate: null | Date
exposeAsAlternative: null | boolean
fileDate: Date

The file timestamp.

fileFingerprint: number
fileLength: number

The file length in bytes.

fileName: string

Exact file name.

fileSizeOnDisk: null | number

The file's size on disk.

Status of the file.

gameId: number

The game id related to the mod that this file belongs to.

gameVersions: string[]

List of game versions this file is relevant for.

The file hash (i.e. md5 or sha1).

id: number

The file id.

isAvailable: boolean

Whether the file is available to download.

isEarlyAccessContent: null | boolean
isServerPack: null | boolean
modId: number

The mod id.

parentProjectFileId: null | number

The file release type.

serverPackFileId: null | number
sortableGameVersions: CurseForgeSortableGameVersion[]

Metadata used for sorting by game versions.

Methods

  • Get the changelog of a file in HTML format.

    Throws

    CurseForgeResponseError when the request fails

    Returns

    The HTML changelog

    Returns Promise<string>

Generated using TypeDoc