Class Profile

User Profile Structure only non-bots will ever see these

Hierarchy

BaseStructure
- Profile

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Profile(client: ShardClient, data?: BaseStructureData, isClone?: boolean): Profile

Overrides BaseStructure.constructor
- Defined in src/structures/profile.ts:36
Parameters
- client: ShardClient
- Optional data: BaseStructureData
- Optional isClone: boolean
Returns Profile

Properties

Readonly _keys

_keys: BaseSet<string> = ...

Readonly client

client: ShardClient

connectedAccounts

connectedAccounts: BaseCollection<string, ConnectedAccount> = ...

mutualGuilds

mutualGuilds: BaseCollection<string, { id: string; nick: null | string }> = ...

nicks

nicks: BaseCollection<string, string> = ...

premiumGuildSinceUnix

premiumGuildSinceUnix: number = 0

premiumSinceUnix

premiumSinceUnix: number = 0

user

user: UserWithFlags

Accessors

isClone

get isClone(): boolean

- Defined in src/structures/basestructure.ts:317
Returns boolean

premiumGuildSince

get premiumGuildSince(): null | Date

- Defined in src/structures/profile.ts:47
Returns null | Date

premiumSince

get premiumSince(): null | Date

- Defined in src/structures/profile.ts:54
Returns null | Date

shardId

get shardId(): number

- Defined in src/structures/basestructure.ts:321
Returns number

Methods

[custom]

[custom](): object

Inherited from BaseStructure.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_getFromSnake

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_setFromSnake

_setFromSnake(key: string, value: any): any

Inherited from BaseStructure._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

clone

clone(): Profile

Inherited from BaseStructure.clone
- Defined in src/structures/basestructure.ts:325
Returns Profile

difference

difference(key: string, value: any): [boolean, any]

Inherited from BaseStructure.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from BaseStructure.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from BaseStructure.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

hasDifference

hasDifference(key: string, value: any): boolean

Inherited from BaseStructure.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

merge

merge(data?: BaseStructureData): void

Inherited from BaseStructure.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

mergeValue(key: string, value: any): void

Overrides BaseStructure.mergeValue
- Defined in src/structures/profile.ts:61
Parameters
- key: string
- value: any
Returns void

toJSON

toJSON(): object

Inherited from BaseStructure.toJSON
- Defined in src/structures/basestructure.ts:259
Returns object

Generated using TypeDoc