Documentation Github Live site Local frontend

Class

Leader

Leader()

Used for getting and handling leaders

Constructor

# new Leader()

Creates new leader object

View Source classes/leader.ts, line 10

Extends

Classes

Leader
User

Methods

# static extend(user, count) → {Leader}

Extends user to leader class

Parameters:
Name Type Description
user Leader
count number

View Source classes/leader.ts, line 242

Leader

# static getAnimationLeaders(ctx) → {Promise.<Collection.<SnowflakeString, Leader>>}

Returns users with most animations

Parameters:
Name Type Description
ctx RequestContext

View Source classes/leader.ts, line 249

Promise.<Collection.<SnowflakeString, Leader>>

# static getCommentLeaders(ctx) → {Promise.<Collection.<SnowflakeString, Leader>>}

Returns users with most comments

Parameters:
Name Type Description
ctx RequestContext

View Source classes/leader.ts, line 270

Promise.<Collection.<SnowflakeString, Leader>>

# static getFollowLeaders(ctx) → {Promise.<Collection.<SnowflakeString, Leader>>}

Returns follow leaders

Parameters:
Name Type Description
ctx RequestContext

View Source classes/leader.ts, line 256

Promise.<Collection.<SnowflakeString, Leader>>

# static getRatingLeaders(ctx) → {Promise.<Collection.<SnowflakeString, Leader>>}

Returns users with most 5-star ratings

Parameters:
Name Type Description
ctx RequestContext

View Source classes/leader.ts, line 284

Promise.<Collection.<SnowflakeString, Leader>>

# static getUploadLeaders(ctx) → {Promise.<Collection.<SnowflakeString, Leader>>}

Returns users with most uploads

Parameters:
Name Type Description
ctx RequestContext

View Source classes/leader.ts, line 263

Promise.<Collection.<SnowflakeString, Leader>>

# static getViewLeaders(ctx) → {Promise.<Collection.<SnowflakeString, Leader>>}

Returns users with most views

Parameters:
Name Type Description
ctx RequestContext

View Source classes/leader.ts, line 277

Promise.<Collection.<SnowflakeString, Leader>>

# comparePosition(userOrType) → {boolean}

Compares position of user and user/type

Parameters:
Name Type Description
userOrType User | UserType

to compare
Overrides:

View Source classes/user.ts, line 444

boolean

# async countFollowers() → {Promise.<number>}

Counts friends

Overrides:

View Source classes/user.ts, line 216

Promise.<number>

# async getAnimations(max, page) → {Promise.<Collection.<SnowflakeString, BasicAnimation>>}

Gets animations created by user

Parameters:
Name Type Description
max number

Max animations per page
page number

Current page to show
Overrides:

View Source classes/user.ts, line 281

Promise.<Collection.<SnowflakeString, BasicAnimation>>

# async getAnimationsCount() → {Promise.<number>}

Gets number of animations created by user

Overrides:

View Source classes/user.ts, line 313

Promise.<number>

# async getAvatar() → {Promise.<(File|undefined)>}

Gets user's avatar

Overrides:

View Source classes/user.ts, line 205

Promise.<(File|undefined)>

# async getComments(limit, page) → {Promise.<Collection.<SnowflakeString, Comment>>}

Gets comments created by user

Parameters:
Name Type Description
limit number

Max items per page
page number

Current page
Overrides:

View Source classes/user.ts, line 415

Promise.<Collection.<SnowflakeString, Comment>>

# async getFiles(limit, page, publicOnlyopt) → {Promise.<Collection.<SnowflakeString, File>>}

Gets files uploaded by user

Parameters:
Name Type Attributes Default Description
limit number

Max items per page
page number

Current page
publicOnly boolean <optional>
 true

If true, only public files are returned
Overrides:

View Source classes/user.ts, line 378

Promise.<Collection.<SnowflakeString, File>>

# getFilesCount(publicOnlyopt) → {Promise.<number>}

Gets number of files uploaded by user

Parameters:
Name Type Attributes Default Description
publicOnly boolean <optional>
 true

If true, only public files are counted
Overrides:

View Source classes/user.ts, line 401

Promise.<number>

# async getFollowers() → {Promise.<Array.<UserRelation>>}

Gets followers

Overrides:

View Source classes/user.ts, line 263

Promise.<Array.<UserRelation>>

# async getFollows() → {Promise.<Array.<UserRelation>>}

Gets followed users

Overrides:

View Source classes/user.ts, line 246

Promise.<Array.<UserRelation>>

# async getRatings(max, page) → {Promise.<Collection.<SnowflakeString, Rating>>}

Gets ratings created by user

Parameters:
Name Type Description
max number

Max items per page
page number

Current page
Overrides:

View Source classes/user.ts, line 336

Promise.<Collection.<SnowflakeString, Rating>>

# async getRatingsCount() → {Promise.<number>}

Gets number of ratings created by user

Overrides:

View Source classes/user.ts, line 364

Promise.<number>

# async getRelation(uid) → {Promise.<UserRelation>}

Gets relation between client and specified user

Parameters:
Name Type Description
uid UserResolvable
Overrides:

View Source classes/user.ts, line 230

Promise.<UserRelation>

# async getType() → {Promise.<SystemRelation>}

Fetches system relation

Overrides:

View Source classes/user.ts, line 458

Promise.<SystemRelation>

# hasPremium() → {boolean}

Gets if the user has active premium or not. Should not be used for 'is user getting billed' - can be mod for that.

Overrides:

View Source classes/user.ts, line 326

boolean

# async setType(ctx, type) → {Promise.<void>}

Sets new type of user

Parameters:
Name Type Description
ctx RequestContext
type UserType

New type to set
Overrides:

View Source classes/user.ts, line 479

Promise.<void>

# toJSON() → {object}

Converts to JSON compatible object

Overrides:

View Source classes/leader.ts, line 290

object