Skip to content

Latest commit

 

History

History
453 lines (316 loc) · 21.5 KB

modules.md

File metadata and controls

453 lines (316 loc) · 21.5 KB
Raw

curseforge / Exports

curseforge

Table of contents

Type aliases

Functions

Type aliases

AddonAttachmentInfo

Ƭ AddonAttachmentInfo: Object

Type declaration

Name Type
description string
id number
isDefault boolean
projectId number
status number
thumbnailUrl string
title string
url string

Defined in

types.ts:49

AddonAuthorInfo

Ƭ AddonAuthorInfo: Object

Type declaration

Name Type
id number
name string
projectId number
projectTitleId 2
projectTitleTitle "Author"
twitchId number
url string
userId number

Defined in

types.ts:38

AddonCategoryInfo

Ƭ AddonCategoryInfo: Object

Type declaration

Name Type
avatarId number
avatarUrl string
categoryId number
dateModified string
gameId number
name string
parentId number
projectId number
rootId number
slug string
url string

Defined in

types.ts:118

AddonGameVersionLatestFile

Ƭ AddonGameVersionLatestFile: Object

Type declaration

Name Type
fileType number
gameVersion string
gameVersionFlavor null | unknown
gameVersionTypeId number
projectFileId number
projectFileName string

Defined in

types.ts:109

AddonInfo

Ƭ AddonInfo: Object

Type declaration

Name Type
attachments AddonAttachmentInfo[]
authors AddonAuthorInfo[]
categories AddonCategoryInfo[]
categorySection Object
categorySection.extraIncludePattern string | null
categorySection.gameCategoryId number
categorySection.gameId number
categorySection.id number
categorySection.initialInclusionPattern string
categorySection.name string
categorySection.packageType number
categorySection.path string
dateCreated string
dateModified string
dateReleased string
defaultFileId number
downloadCount number
gameId number
gameName string
gamePopularityRank number
gameSlug string
gameVersionLatestFiles AddonGameVersionLatestFile[]
id number
isAvailable boolean
isExperiemental boolean
isFeatured boolean
issueTrackerUrl? string
latestFiles AddonLatestFileInfo[]
modLoaders? string[]
name string
popularityScore number
portalName string
primaryCategoryId number
primaryLanguage string
slug string
status number
summary string
websiteUrl? string
wikiUrl? string

Defined in

types.ts:132

AddonLatestFileInfo

Ƭ AddonLatestFileInfo: Object

Type declaration

Name Type
alternateFileId number
categorySectionPackageType number
changelog null | unknown
dependencies unknown[]
displayName string
downloadCount number
downloadUrl string
exposeAsAlternative null | unknown
fileDate string
fileLegacyMappingId null | unknown
fileLength number
fileName string
fileStatus number
fileTypeId null | unknown
gameId number
gameVersion string[]
gameVersionDateReleased string
gameVersionFlavor null | unknown
gameVersionId number
gameVersionMappingId number
hasInstallScript boolean
hashes { algorithm: 1 ; value: "fa2b42a52a1d1164749fa367dac981418733f69b" }[]
id number
installMetadata null | unknown
isAlternate boolean
isAvailable boolean
isCompatibleWithClient boolean
isServerPack boolean
modules { fingerprint: number ; foldername: string ; type: number }[]
packageFingerprint number
packageFingerprintId number
parentFileLegacyMappingId null | unknown
parentProjectFileId null | unknown
projectId number
projectStatus number
releaseType number
renderCacheId number
restrictProjectFileAccess number
serverPackFileId number
sortableGameVersion { gameVersion: string ; gameVersionName: string ; gameVersionPadded: string ; gameVersionReleaseDate: string ; gameVersionTypeId: number }[]

Defined in

types.ts:60

MinecraftVersionInfo

Ƭ MinecraftVersionInfo: Object

Type declaration

Name Type
approved boolean
dateModified string
gameVersionId number
gameVersionStatus number
gameVersionTypeId number
gameVersionTypeStatus number
id number
jarDownloadUrl string
jsonDownloadUrl string
versionString string

Defined in

types.ts:1

ModloaderBasicInfo

Ƭ ModloaderBasicInfo: Object

Type declaration

Name Type
dateModified string
gameVersion string
latest boolean
name string
recommended boolean

Defined in

types.ts:14

ModloaderInfo

Ƭ ModloaderInfo: Object

Type declaration

Name Type
approved boolean
dateModified string
downloadUrl string
filename string
forgeVersion? string
gameVersionId number
id number
installMethod number
latest boolean
minecraftGameVersionId number
name string
recommended boolean
type number

Defined in

types.ts:22

Functions

fetchAddonFilesInfo

▸ Const fetchAddonFilesInfo(addonId): Promise<unknown>

Parameters

Name Type
addonId string | number

Returns

Promise<unknown>

Defined in

index.ts:72

fetchAddonInfo

▸ Const fetchAddonInfo(addonId): Promise<AddonInfo>

Parameters

Name Type
addonId string | number

Returns

Promise<AddonInfo>

Defined in

index.ts:68

fetchMinecraftModSearch

▸ Const fetchMinecraftModSearch(gameVersion, searchFilter): Promise<AddonInfo[]>

Parameters

Name Type
gameVersion string
searchFilter string

Returns

Promise<AddonInfo[]>

Defined in

index.ts:38

fetchMinecraftModpackSearch

▸ Const fetchMinecraftModpackSearch(gameVersion, searchFilter): Promise<AddonInfo>

Parameters

Name Type
gameVersion string
searchFilter string

Returns

Promise<AddonInfo>

Defined in

index.ts:49

fetchMinecraftVersionInfo

▸ Const fetchMinecraftVersionInfo(mcVersion): Promise<MinecraftVersionInfo>

Parameters

Name Type
mcVersion string

Returns

Promise<MinecraftVersionInfo>

Defined in

index.ts:34

fetchMinecraftVersionList

▸ Const fetchMinecraftVersionList(): Promise<MinecraftVersionInfo[]>

Returns

Promise<MinecraftVersionInfo[]>

Defined in

index.ts:30

fetchModloaderInfo

▸ Const fetchModloaderInfo(loaderVersion): Promise<ModloaderInfo>

Parameters

Name Type
loaderVersion string

Returns

Promise<ModloaderInfo>

Defined in

index.ts:64

fetchModloaderList

▸ Const fetchModloaderList(): Promise<ModloaderBasicInfo[]>

Returns

Promise<ModloaderBasicInfo[]>

Defined in

index.ts:60