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

Properties

BASE64URL_REGEX

Methods

componentToParsed componentToRaw componentsToParsed componentsToRaw convertImage convertSticker embedsToParsed embedsToRaw formatAllowedMentions formatImage getMagic optionToParsed optionToRaw updateChannel updateMember updateThread

Constructors

constructor

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

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

componentToRaw

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

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

componentsToRaw

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

convertImage

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

convertSticker

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

embedsToParsed

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

embedsToRaw

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

formatAllowedMentions

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

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

getMagic

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

optionToParsed

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

optionToRaw

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

updateChannel

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

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

updateThread

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