Class User

Hierarchy

Omit<UserSource, UserSourceOmit>
ModrinthObject<typeof User, User, UserSource>
- User

Index

Constructors

constructor

Properties

Constructors

constructor

new User(modrinth: Modrinth, source: UserSource): User

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

Properties

avatar_url

avatar_url: string

bio

bio: string

created

created: Date

email

email: null

github_id

github_id: number

id

id: string

name

name: string

object_url

object_url: string

resource_url

resource_url: string

role

role: string

username

username: string

Methods

get

get(): Promise<User>

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

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

mods

mods(): Promise<Mod[]>

- Defined in models/User.ts:93
Returns Promise<Mod[]>

mutate

mutate(source: UserSource): User

- Defined in models/User.ts:80
Parameters
- source: UserSource
Returns User

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<User>): Promise<User>

- Defined in models/User.ts:88
Parameters
- update: Partial<User>
Returns Promise<User>

Static current

current(modrinth: Modrinth): Promise<User>

- Defined in models/User.ts:69
Parameters
- modrinth: Modrinth
Returns Promise<User>

Static fetch

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

- Defined in models/User.ts:24
Parameters
- modrinth: Modrinth
- id: string
Returns Promise<UserSource>

Static fetchMultiple

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

- Defined in models/User.ts:28
Parameters
- modrinth: Modrinth
- ids: string[]
Returns Promise<UserSource[]>

Static fromSource

fromSource(modrinth: Modrinth, source: UserSource): User

- Defined in models/User.ts:59
Parameters
- modrinth: Modrinth
- source: UserSource
Returns User

Static get

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

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

Static getCacheKey

getCacheKey(id: string): string

- Defined in models/User.ts:40
Parameters
- id: string
Returns string

Static getMultiple

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

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

Static getObjectLocation

getObjectLocation(id: string): string

- Defined in models/User.ts:32
Parameters
- id: string
Returns string

Static getResourceLocation

getResourceLocation(id: string): string

- Defined in models/User.ts:36
Parameters
- id: string
Returns string

Static toSource

toSource(object: User): Partial<UserSource>

- Defined in models/User.ts:44
Parameters
- object: User
Returns Partial<UserSource>

Static update

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

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

Generated using TypeDoc