Class Util

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

Constructors

constructor

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

Methods

_setLimit

_setLimit(values?, defaultValue?): 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:115

componentToParsed

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

componentToRaw

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

componentsToParsed

componentsToParsed<T>(components): 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:241

componentsToRaw

componentsToRaw<T>(components): 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:248

convertEmoji

convertEmoji(raw): GuildEmoji
Parameters
- raw: RawGuildEmoji
Returns GuildEmoji
- Defined in lib/util/Util.ts:255

convertImage

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

convertSticker

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

embedsToParsed

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

embedsToRaw

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

formatAllowedMentions

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

formatImage

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

getMagic

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

modalSubmitComponentToParsed

modalSubmitComponentToParsed<T>(component): ToModalSubmitComponentFromRaw<T>
Type Parameters
- T extends RawModalSubmitTextInputComponent
Parameters
- component: T
Returns ToModalSubmitComponentFromRaw<T>
- Defined in lib/util/Util.ts:433

modalSubmitComponentsToParsed

modalSubmitComponentsToParsed<T>(components): ModalSubmitComponentsActionRow[]
Type Parameters
- T extends RawModalSubmitComponentsActionRow
Parameters
- components: T[]
Returns ModalSubmitComponentsActionRow[]
- Defined in lib/util/Util.ts:448

optionToParsed

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

optionToRaw

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

replacePollAnswer

replacePollAnswer(poll, answerID, count, users?): void
Internal
Parameters
- poll: Poll
- answerID: number
- count: number
- Optional users: string[]
Returns void
- Defined in lib/util/Util.ts:497

updateChannel

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

updateEntitlement

updateEntitlement<T>(data): T
Internal
Type Parameters
- T extends Entitlement | TestEntitlement = Entitlement | TestEntitlement
Parameters
- data: RawBaseEntitlement
Returns T
- Defined in lib/util/Util.ts:538

updateMember

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

updateMessage

updateMessage<T>(data): Message<T>
Internal
Type Parameters
- T extends Uncached | AnyTextableChannel
Parameters
- data: RawMessage
Returns Message<T>
- Defined in lib/util/Util.ts:563

updatePollAnswer

updatePollAnswer(poll, answerID, count, user?): void
Internal
Parameters
- poll: Poll
- answerID: number
- count: number
- Optional user: string
Returns void
- Defined in lib/util/Util.ts:573

updateThread

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

`Static` rawEmbeds

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

`Static` rawMessageComponents

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

`Static` rawModalComponents

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