Class User

Hierarchy

BaseStructure<APIUser>
- User
  - ExtendedUser

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new User(client: Client, data?: APIUser): User

Inherited from BaseStructure.constructor
- Defined in src/structures/templates/BaseStructure.ts:16
Parameters
- client: Client
- Optional data: APIUser
Returns User

Properties

avatar

avatar: null | string = null

banner

banner: null | string = null

bot

bot: boolean = false

client

client: Client

discriminator

discriminator: string = '0000'

dm

dm: null | DMChannel = null

flags

flags: UserFlags = ...

id

id: string

system

system: boolean = false

username

username: string

Accessors

createdAt

get createdAt(): Date

Inherited from BaseStructure.createdAt
- Defined in src/structures/templates/BaseStructure.ts:12
Returns Date

createdTimestamp

get createdTimestamp(): number

Inherited from BaseStructure.createdTimestamp
- Defined in src/structures/templates/BaseStructure.ts:9
Returns number

tag

get tag(): string

- Defined in src/structures/User.ts:14
Returns string

Methods

_deserialise

_deserialise(data: APIUser): User

Overrides BaseStructure._deserialise
- Defined in src/structures/User.ts:23
Parameters
- data: APIUser
Returns User

createDM

createDM(cache?: boolean): Promise<DMChannel>

- Defined in src/structures/User.ts:45
Parameters
- cache: boolean = false
Returns Promise<DMChannel>

fetch

fetch(): Promise<User>

- Defined in src/structures/User.ts:41
Returns Promise<User>

send

send(content: string | MessagePayload): Promise<Message<TextChannel>>

- Defined in src/structures/User.ts:49
Parameters
- content: string | MessagePayload
Returns Promise<Message<TextChannel>>

toJSON

toJSON(): APIUser

Overrides BaseStructure.toJSON
- Defined in src/structures/User.ts:54
Returns APIUser

toString

toString(): string

- Defined in src/structures/User.ts:37
Returns string

Static toJSON

toJSON(data: any): any

Inherited from BaseStructure.toJSON
- Defined in src/structures/templates/BaseStructure.ts:32
Parameters
- data: any
Returns any

Generated using TypeDoc