Class Mod

Hierarchy

Omit<ModSource, ModSourceOmit>
ModrinthObject<typeof Mod, Mod, ModSource>
- Mod

Index

Constructors

constructor

Properties

Constructors

constructor

new Mod(modrinth: Modrinth, source: ModSource): Mod

Inherited from ModrinthObject.constructor
- Defined in object.ts:34
Parameters
- modrinth: Modrinth
- source: ModSource
Returns Mod

Properties

body

body: string

body_url

body_url: string

categories

categories: string[]

client_side

client_side: string

description

description: string

discord_url

discord_url: string

donation_urls

donation_urls: any[]

downloads

downloads: number

followers

followers: number

icon_url

icon_url: string

id

id: string

issues_url

issues_url: string

license

license: License

object_url

object_url: string

published

published: Date

resource_url

resource_url: string

server_side

server_side: string

slug

slug: string

source_url

source_url: string

status

status: string

team

team: string

title

title: string

updated

updated: Date

wiki_url

wiki_url: string

Methods

createVersion

createVersion(body: any, file: any): Promise<Version>

- Defined in models/Mod.ts:103
Parameters
- body: any
- file: any
Returns Promise<Version>

get

get(): Promise<Mod>

Inherited from ModrinthObject.get
- Defined in object.ts:70
Returns Promise<Mod>

getObjectLocation

getObjectLocation(): string

Inherited from ModrinthObject.getObjectLocation
- Defined in object.ts:82
Returns string

getObjectURL

getObjectURL(): string

Inherited from ModrinthObject.getObjectURL
- Defined in object.ts:86
Returns string

getResourceLocation

getResourceLocation(): string

Inherited from ModrinthObject.getResourceLocation
- Defined in object.ts:74
Returns string

getResourceURL

getResourceURL(): string

Inherited from ModrinthObject.getResourceURL
- Defined in object.ts:78
Returns string

mutate

mutate(source: ModSource): Mod

- Defined in models/Mod.ts:83
Parameters
- source: ModSource
Returns Mod

toJSON

toJSON(): unknown

Inherited from ModrinthObject.toJSON
- Defined in object.ts:90
Returns unknown

toString

toString(): string

Inherited from ModrinthObject.toString
- Defined in object.ts:96
Returns string

update

update(update: Partial<Mod>): Promise<Mod>

- Defined in models/Mod.ts:98
Parameters
- update: Partial<Mod>
Returns Promise<Mod>

versions

versions(): Promise<Version[]>

- Defined in models/Mod.ts:94
Returns Promise<Version[]>

Static fetch

fetch(modrinth: Modrinth, id: string): Promise<ModSource>

- Defined in models/Mod.ts:30
Parameters
- modrinth: Modrinth
- id: string
Returns Promise<ModSource>

Static fetchMultiple

fetchMultiple(modrinth: Modrinth, ids: string[]): Promise<ModSource[]>

- Defined in models/Mod.ts:34
Parameters
- modrinth: Modrinth
- ids: string[]
Returns Promise<ModSource[]>

Static fromSource

fromSource(modrinth: Modrinth, source: ModSource): Mod

- Defined in models/Mod.ts:66
Parameters
- modrinth: Modrinth
- source: ModSource
Returns Mod

Static get

get(modrinth: Modrinth, id: string): Promise<Mod>

- Defined in models/Mod.ts:22
Parameters
- modrinth: Modrinth
- id: string
Returns Promise<Mod>

Static getCacheKey

getCacheKey(id: string): string

- Defined in models/Mod.ts:46
Parameters
- id: string
Returns string

Static getMultiple

getMultiple(modrinth: Modrinth, ids: string[]): Promise<Mod[]>

- Defined in models/Mod.ts:26
Parameters
- modrinth: Modrinth
- ids: string[]
Returns Promise<Mod[]>

Static getObjectLocation

getObjectLocation(id: string): string

- Defined in models/Mod.ts:38
Parameters
- id: string
Returns string

Static getResourceLocation

getResourceLocation(id: string): string

- Defined in models/Mod.ts:42
Parameters
- id: string
Returns string

Static toSource

toSource(object: Mod): Partial<ModSource>

- Defined in models/Mod.ts:50
Parameters
- object: Mod
Returns Partial<ModSource>

Static update

update(modrinth: Modrinth, id: string, update: Partial<Mod>): Promise<void>

- Defined in models/Mod.ts:76
Parameters
- modrinth: Modrinth
- id: string
- update: Partial<Mod>
Returns Promise<void>

Generated using TypeDoc