User

Extends

ObjectToLower<APIUser>.DiscordBase<APIUser>

Constructors

new User(client, data)

1
new User(client: UsingClient, data: APIUser): User

Parameters

Parameter	Type	Description
`client`	`UsingClient`	-
`data`	`APIUser`	Unique ID of the object

Returns

User

Inherited from

ObjectToLower<APIUser>.constructor

Source

seyfert/src/structures/extra/DiscordBase.ts:7

Properties

Property	Modifier	Type	Inherited from
`accentColor`	`public`	`undefined` \| `null` \| `number`	`ObjectToLower.accentColor`
`avatar`	`public`	`null` \| `string`	`ObjectToLower.avatar`
`avatarDecoration`	`public`	`undefined` \| `null` \| `string`	`ObjectToLower.avatarDecoration`
`banner`	`public`	`undefined` \| `null` \| `string`	`ObjectToLower.banner`
`bot`	`public`	`undefined` \| `boolean`	`ObjectToLower.bot`
`client`	`readonly`	`UsingClient`	-
`discriminator`	`public`	`string`	`ObjectToLower.discriminator`
`email`	`public`	`undefined` \| `null` \| `string`	`ObjectToLower.email`
`flags`	`public`	`undefined` \| `UserFlags`	`ObjectToLower.flags`
`globalName`	`public`	`null` \| `string`	`ObjectToLower.globalName`
`id`	`public`	`string`	`ObjectToLower.id`
`locale`	`public`	`undefined` \| `string`	`ObjectToLower.locale`
`mfaEnabled`	`public`	`undefined` \| `boolean`	`ObjectToLower.mfaEnabled`
`premiumType`	`public`	`undefined` \| `UserPremiumType`	`ObjectToLower.premiumType`
`publicFlags`	`public`	`undefined` \| `UserFlags`	`ObjectToLower.publicFlags`
`system`	`public`	`undefined` \| `boolean`	`ObjectToLower.system`
`username`	`public`	`string`	`ObjectToLower.username`
`verified`	`public`	`undefined` \| `boolean`	`ObjectToLower.verified`

Accessors

createdAt

1
get createdAt(): Date

createdAt gets the creation Date instace of the current object.

Returns

Date

Source

seyfert/src/structures/extra/DiscordBase.ts:27

createdTimestamp

1
get createdTimestamp(): number

Create a timestamp for the current object.

Returns

number

Source

seyfert/src/structures/extra/DiscordBase.ts:20

name

1
get name(): string

Returns

string

Source

seyfert/src/structures/User.ts:14

tag

1
get tag(): string

Returns

string

Source

seyfert/src/structures/User.ts:10

Methods

avatarDecorationURL()

1
avatarDecorationURL(options?: CDNUrlOptions): undefined | string

Parameters

Parameter	Type
`options`?	`CDNUrlOptions`

Returns

undefined | string

Source

seyfert/src/structures/User.ts:43

avatarURL()

1
avatarURL(options?: CDNUrlOptions): string

Parameters

Parameter	Type
`options`?	`CDNUrlOptions`

Returns

string

Source

seyfert/src/structures/User.ts:36

bannerURL()

1
bannerURL(options?: CDNUrlOptions): undefined | string

Parameters

Parameter	Type
`options`?	`CDNUrlOptions`

Returns

undefined | string

Source

seyfert/src/structures/User.ts:48

dm()

1
dm(force: boolean): Promise<DMChannel>

Open a DM with the user

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<DMChannel>

Source

seyfert/src/structures/User.ts:28

fetch()

1
fetch(force: boolean): Promise<User>

Fetch user

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<User>

Source

seyfert/src/structures/User.ts:21

presence()

1
presence(): ReturnCache<undefined | Omit<GatewayPresenceUpdate, "user"> & Object & Object>

Returns

ReturnCache<undefined | Omit<GatewayPresenceUpdate, "user"> & Object & Object>

Source

seyfert/src/structures/User.ts:53

toString()

1
toString(): string

Returns

string

Source

seyfert/src/structures/User.ts:57

write()

1
write(body: Omit<RESTPostAPIChannelMessageJSONBody, "components" | "embeds" | "poll"> & SendResolverProps): Promise<Message>

Parameters

Parameter	Type
`body`	`Omit`<`RESTPostAPIChannelMessageJSONBody`, `"components"` \| `"embeds"` \| `"poll"`> & `SendResolverProps`

Returns

Promise<Message>

Source

seyfert/src/structures/User.ts:32