Interface CurseForgeSearchModsOptions

Hierarchy

  • CurseForgeSearchModsOptions

Properties

authorId?: number

Filter only mods that the given authorId is a member of.

categoryId?: number

Filter by category id.

categoryIds?: string

Filter by a list of category ids - this will override categoryId.

classId?: number

Filter by section id (discoverable via Categories).

gameVersion?: string

Filter by game version string.

gameVersionTypeId?: number

Filter only mods that contain files tagged with versions of the given gameVersionTypeId.

gameVersions?: string

Filter by a list of game version strings - this will override.

index?: number

A zero based index of the first item to include in the response, the limit is: (index + pageSize <= 10,000).

modLoaderType?: CurseForgeModLoaderType

Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion.

modLoaderTypes?: string

Filter by a list of mod loader types - this will override modLoaderType.

pageSize?: number

The number of items to include in the response, the default/maximum value is 50.

primaryAuthorId?: number

Filter only mods that the given primaryAuthorId is the owner of.

searchFilter?: string

Filter by free text search in the mod name and author.

slug?: string

Filter by slug (coupled with classId will result in a unique result).

Filter by ModsSearchSortField enumeration.

'asc' if sort is in ascending order, 'desc' if sort is in descending order.

Generated using TypeDoc