Class Util

A general set of utilities. These are intentionally poorly documented, as they serve almost no usefulness to outside developers.

Hierarchy

Util

Index

Constructors

constructor

new Util(client: Client<ClientEvents>): Util
Parameters
- client: Client<ClientEvents>
Returns Util
- Defined in lib/util/Util.ts:46

Properties

`Static` BASE64URL_REGEX

BASE64URL_REGEX: RegExp = ...

Methods

componentToParsed

componentToParsed<T>(component: T): ToComponentFromRaw<T>
Type Parameters
- T extends RawComponent
Parameters
- component: T
Returns ToComponentFromRaw<T>
- Defined in lib/util/Util.ts:67

componentToRaw

componentToRaw<T>(component: T): ToRawFromComponent<T>
Type Parameters
- T extends Component
Parameters
- component: T
Returns ToRawFromComponent<T>
- Defined in lib/util/Util.ts:120

componentsToParsed

componentsToParsed<T>(components: T[]): T extends RawModalActionRow ? ModalActionRow[] : T extends RawMessageActionRow ? MessageActionRow[] : never
Type Parameters
- T extends RawMessageActionRow | RawModalActionRow
Parameters
- components: T[]
Returns T extends RawModalActionRow ? ModalActionRow[] : T extends RawMessageActionRow ? MessageActionRow[] : never
- Defined in lib/util/Util.ts:173

componentsToRaw

componentsToRaw<T>(components: (T | RawComponentsContainer<ActionRowToRaw<T>>)[]): ActionRowToRaw<T>[]
Type Parameters
- T extends MessageActionRow | ModalActionRow
Parameters
- components: (T | RawComponentsContainer<ActionRowToRaw<T>>)[]
Returns ActionRowToRaw<T>[]
- Defined in lib/util/Util.ts:180

convertImage

convertImage(img: string | Buffer): string
Parameters
- img: string | Buffer
Returns string
- Defined in lib/util/Util.ts:196

convertSticker

convertSticker(raw: RawSticker): Sticker
Parameters
- raw: RawSticker
Returns Sticker
- Defined in lib/util/Util.ts:229

embedsToParsed

embedsToParsed(embeds: RawEmbed[]): Embed[]
Parameters
- embeds: RawEmbed[]
Returns Embed[]
- Defined in lib/util/Util.ts:246

embedsToRaw

embedsToRaw(embeds: (EmbedOptions | RawEmbedsContainer)[]): RawEmbedOptions[]
Parameters
- embeds: (EmbedOptions | RawEmbedsContainer)[]
Returns RawEmbedOptions[]
- Defined in lib/util/Util.ts:294

formatAllowedMentions

formatAllowedMentions(allowed?: AllowedMentions): RawAllowedMentions
Parameters
- Optional allowed: AllowedMentions
Returns RawAllowedMentions
- Defined in lib/util/Util.ts:329

formatImage

formatImage(url: string, format?: "jpg" | "jpeg" | "png" | "webp" | "gif", size?: number): string
Parameters
- url: string
- Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"
- Optional size: number
Returns string
- Defined in lib/util/Util.ts:359

getMagic

getMagic(file: Buffer, len?: number): string
Parameters
- file: Buffer
- len: number = 4
Returns string
- Defined in lib/util/Util.ts:369

optionToParsed

optionToParsed(option: RawApplicationCommandOption): ApplicationCommandOptions
Parameters
- option: RawApplicationCommandOption
Returns ApplicationCommandOptions
- Defined in lib/util/Util.ts:373

optionToRaw

optionToRaw(option: ApplicationCommandOptions): RawApplicationCommandOption
Parameters
- option: ApplicationCommandOptions
Returns RawApplicationCommandOption
- Defined in lib/util/Util.ts:394

updateChannel

updateChannel<T>(channelData: RawChannel): T
Type Parameters
- T extends AnyChannel
Parameters
- channelData: RawChannel
Returns T
- Defined in lib/util/Util.ts:414

updateMember

updateMember(guildID: string, memberID: string, member: RawMember | RESTMember): Member
Parameters
- guildID: string
- memberID: string
- member: RawMember | RESTMember
Returns Member
- Defined in lib/util/Util.ts:426

updateThread

updateThread<T>(threadData: RawThreadChannel): T
Type Parameters
- T extends AnyThreadChannel
Parameters
- threadData: RawThreadChannel
Returns T
- Defined in lib/util/Util.ts:439

`Static` raw

raw(data: RawEmbedOptions): RawEmbedsContainer
Parameters
- data: RawEmbedOptions
Returns RawEmbedsContainer
- Defined in lib/util/Util.ts:50
raw(data: RawEmbedOptions[]): RawEmbedsContainer[]
Parameters
- data: RawEmbedOptions[]
Returns RawEmbedsContainer[]
- Defined in lib/util/Util.ts:51
raw<T>(data: T): RawComponentsContainer<T>
Type Parameters
- T extends RawMessageActionRow | RawModalActionRow
Parameters
- data: T
Returns RawComponentsContainer<T>
- Defined in lib/util/Util.ts:52
raw<T>(data: T[]): RawComponentsContainer<T>[]
Type Parameters
- T extends RawMessageActionRow | RawModalActionRow
Parameters
- data: T[]
Returns RawComponentsContainer<T>[]
- Defined in lib/util/Util.ts:53

Class Util

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client<ClientEvents>

Returns Util

Properties

Static BASE64URL_REGEX

Methods

componentToParsed

Type Parameters

T extends RawComponent

Parameters

component: T

Returns ToComponentFromRaw<T>

componentToRaw

Type Parameters

T extends Component

Parameters

component: T

Returns ToRawFromComponent<T>

componentsToParsed

Type Parameters

T extends RawMessageActionRow | RawModalActionRow

Parameters

components: T[]

Returns T extends RawModalActionRow ? ModalActionRow[] : T extends RawMessageActionRow ? MessageActionRow[] : never

componentsToRaw

Type Parameters

T extends MessageActionRow | ModalActionRow

Parameters

components: (T | RawComponentsContainer<ActionRowToRaw<T>>)[]

Returns ActionRowToRaw<T>[]

convertImage

Parameters

img: string | Buffer

Returns string

convertSticker

Parameters

raw: RawSticker

Returns Sticker

embedsToParsed

Parameters

embeds: RawEmbed[]

Returns Embed[]

embedsToRaw

Parameters

embeds: (EmbedOptions | RawEmbedsContainer)[]

Returns RawEmbedOptions[]

formatAllowedMentions

Parameters

Optional allowed: AllowedMentions

Returns RawAllowedMentions

formatImage

Parameters

url: string

Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

Optional size: number

Returns string

getMagic

Parameters

file: Buffer

len: number = 4

Returns string

optionToParsed

Parameters

option: RawApplicationCommandOption

Returns ApplicationCommandOptions

optionToRaw

Parameters

option: ApplicationCommandOptions

Returns RawApplicationCommandOption

updateChannel

Type Parameters

T extends AnyChannel

`Static` BASE64URL_REGEX

`Optional` allowed: AllowedMentions

`Optional` format: "jpg" | "jpeg" | "png" | "webp" | "gif"

`Optional` size: number

`Static` raw