Animasher docs User

Name	Type	Description
`param0`	`Object`	user data

# static fromDatabase(data, ctx) → {User}

Loads the user from database data

Parameters:

Name	Type	Description
`data`	`DBUser`
`ctx`	`RequestContext`

View Source classes/user.ts, line 561

Returns:

Type: User

# async static getUser(id, ctx, client) → {Promise.<User>}

Loads user from DB

Parameters:

Name	Type	Description
`id`	`number` \| `Snowflake` \| `string`	User snowflake to load
`ctx`	`RequestContext`
`client`	`UserClient`

View Source classes/user.ts, line 584

Returns:

user

Type: Promise.<User>

# static isUser(user) → {boolean}

Checks if user resolvable is user or not. Used for TS.

Parameters:

Name	Type	Description
`user`	`UserResolvable`

View Source classes/user.ts, line 544

Returns:

Type: boolean

# static resolveUserID(user) → {SnowflakeString}

Resolves params to string

Parameters:

Name	Type	Description
`user`	`UserResolvable`

View Source classes/user.ts, line 551

Returns:

Type: SnowflakeString

# static searchUsers(filters) → {Promise.<Collection.<string, User>>}

Searches users

Parameters:

Name	Type	Description
`filters`	`UserFilters`

View Source classes/user.ts, line 592

Returns:

Type: Promise.<Collection.<string, User>>

# static searchUsersCount(filters) → {number}

Returns number of results for a specific search

Parameters:

Name	Type	Description
`filters`	`UserFilters`

View Source classes/user.ts, line 600

Returns:

Type: number

# static userFromDB(ids, user, ctx) → {User}

Loads user from DB (OLD)

Parameters:

Name	Type	Description
`ids`	`SnowflakeResolvable`
`user`	`any`
`ctx`	`RequestContext`

Deprecated:

Yes

View Source classes/user.ts, line 106

Returns:

Type: User

# comparePosition(userOrType) → {boolean}

Compares position of user and user/type

Parameters:

Name	Type	Description
`userOrType`	`User` \| `UserType`	to compare

View Source classes/user.ts, line 726

Returns:

Type: boolean

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

Counts friends

View Source classes/user.ts, line 615

Returns:

Type: 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

View Source classes/user.ts, line 648

Returns:

Type: Promise.<Collection.<SnowflakeString, BasicAnimation>>

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

Gets number of animations created by user

View Source classes/user.ts, line 655

Returns:

Type: Promise.<number>

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

Gets user's avatar

View Source classes/user.ts, line 608

Returns:

Type: 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

View Source classes/user.ts, line 705

Returns:

Type: 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

View Source classes/user.ts, line 689

Returns:

Type: 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

View Source classes/user.ts, line 696

Returns:

Type: Promise.<number>

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

Gets followers

View Source classes/user.ts, line 639

Returns:

Type: Promise.<Array.<UserRelation>>

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

Gets followed users

View Source classes/user.ts, line 631

Returns:

Type: 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

View Source classes/user.ts, line 672

Returns:

Type: Promise.<Collection.<SnowflakeString, Rating>>

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

Gets number of ratings created by user

View Source classes/user.ts, line 679

Returns:

Type: Promise.<number>

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

Gets relation between client and specified user

Parameters:

Name	Type	Description
`uid`	`UserResolvable`

View Source classes/user.ts, line 623

Returns:

Type: Promise.<UserRelation>

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

Fetches system relation

View Source classes/user.ts, line 733

Returns:

Type: 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.

View Source classes/user.ts, line 663

Returns:

Type: boolean

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

Sets new type of user

Parameters:

Name	Type	Description
`ctx`	`RequestContext`
`type`	`UserType`	New type to set

View Source classes/user.ts, line 742

Returns:

Type: Promise.<void>

# toJSON() → {Object}

Returns JSON-compatible object to be used in stringify

View Source classes/user.ts, line 748

Returns:

Type: Object

Animasher docs

# new User(param0)

Parameters:

Classes

Methods

# static fromDatabase(data, ctx) → {User}

Parameters:

# async static getUser(id, ctx, client) → {Promise.<User>}

Parameters:

# static isUser(user) → {boolean}

Parameters:

# static resolveUserID(user) → {SnowflakeString}

Parameters:

# static searchUsers(filters) → {Promise.<Collection.<string, User>>}

Parameters:

# static searchUsersCount(filters) → {number}

Parameters:

# static userFromDB(ids, user, ctx) → {User}

Parameters:

# comparePosition(userOrType) → {boolean}

Parameters:

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

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

Parameters:

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

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

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

Parameters:

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

Parameters:

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

Parameters:

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

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

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

Parameters:

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

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

Parameters:

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

# hasPremium() → {boolean}

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

Parameters:

# toJSON() → {Object}