Class Util

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

Hierarchy

Util

Constructors

constructor

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

Properties

`Static` BASE64URL_REGEX

BASE64URL_REGEX: RegExp = ...

Methods

_setLimit

_setLimit(values?: number | Record<string, number>, defaultValue?: number): number | Record<string, number>
Parameters
- Optional values: number | Record<string, number>
- defaultValue: number = Infinity
Returns number | Record<string, number>
- Defined in lib/util/Util.ts:88

componentToParsed

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

componentToRaw

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

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

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

convertImage

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

convertSticker

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

embedsToParsed

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

embedsToRaw

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

formatAllowedMentions

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

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

getMagic

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

optionToParsed

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

optionToRaw

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

updateChannel

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

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

updateThread

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

`Static` rawEmbeds

rawEmbeds(embeds: RawEmbed): Embed
Parameters
- embeds: RawEmbed
Returns Embed
- Defined in lib/util/Util.ts:49
rawEmbeds(embeds: RawEmbed[]): Embed[]
Parameters
- embeds: RawEmbed[]
Returns Embed[]
- Defined in lib/util/Util.ts:50

`Static` rawMessageComponents

rawMessageComponents(components: RawMessageActionRow): MessageActionRow
Parameters
- components: RawMessageActionRow
Returns MessageActionRow
- Defined in lib/util/Util.ts:56
rawMessageComponents(components: RawMessageActionRow[]): MessageActionRow[]
Parameters
- components: RawMessageActionRow[]
Returns MessageActionRow[]
- Defined in lib/util/Util.ts:57

`Static` rawModalComponents

rawModalComponents(components: RawModalActionRow): ModalActionRow
Parameters
- components: RawModalActionRow
Returns ModalActionRow
- Defined in lib/util/Util.ts:63
rawModalComponents(components: RawModalActionRow[]): ModalActionRow[]
Parameters
- components: RawModalActionRow[]
Returns ModalActionRow[]
- Defined in lib/util/Util.ts:64