Utilsnamespace

Builders for embeds, components and modals, plus markup, permission and regex helpers.

On this page

Namespaces2
Classes32
Interfaces25
Functions25
Type aliases16
Variables1

import { Utils } from 'detritus-client';

2 namespaces · 32 classes · 25 interfaces · 16 type aliases · 1 variables · 25 functions

Namespaces

Grouped exports, reached as properties of the package.

namespaceMarkup Format and escape text with Discord's markdown. 12 interfaces · 4 variables · 16 functions namespacePermissionTools Check and combine permission bitfields. 1 type aliases · 1 functions

Classes

Classes you create or receive from the library.

Interfaces

Object shapes for options, payloads and events.

Functions

Standalone helpers.

addQuery()

function src/utils/index.ts:72

function addQuery(url: string, query?: UrlQuery): string

anyToCamelCase()

function src/utils/index.ts:92

function anyToCamelCase(object: any, skip?: string[]): any

createComponentListenerOrNone()

function src/utils/components/index.ts:36

function createComponentListenerOrNone(
  options?: string | CreateComponentListenerOrNone,
  id?: string,
): [string, Components | null, boolean] | null

diffApplicationCommands()

function src/utils/applicationcommands.ts:181

function diffApplicationCommands(
  local: InteractionCommand,
  remote: ApplicationCommand,
  options?: NormalizeApplicationCommandOptions,
): string[]

Returns the fields that differ between our local command and the one Discord has stored, empty if they match

diffNormalized()

function src/utils/applicationcommands.ts:145

function diffNormalized(a: any, b: any, path?: string): string[]

Deep compares two normalized payloads, returning the paths that differ (e.g. options[0:user].description)

Parameters

any

path?

string

Default ''

generateWaveform()

function src/utils/index.ts:120

function generateWaveform(samples: Float32Array, sampleRate?: number): string

Parameters

samples

Float32Array

sampleRate?

number

Default 48000

getAcronym()

function src/utils/index.ts:146

function getAcronym(name?: string): string

getFiles()

function async src/utils/index.ts:154

function getFiles(directory: string, subdirectories?: boolean): Promise<string[]>

getFirstArgument()

function src/utils/index.ts:244

function getFirstArgument(value: string): [string, string]

getFormatFromHash()

function src/utils/index.ts:192

function getFormatFromHash(
  hash: string,
  format?: string | null,
  defaultFormat?: string,
): string

Parameters

hash

string

format?

string | null

defaultFormat?

string

Default ImageFormats.PNG

getQueryForImage()

function src/utils/index.ts:212

function getQueryForImage(query?: number | UrlQuery): UrlQuery | undefined

hexToInt()

function src/utils/index.ts:271

function hexToInt(hex: string): number

intToHex()

function src/utils/index.ts:275

function intToHex(int: number, hashtag?: boolean): string

intToRGB()

function src/utils/index.ts:279

function intToRGB(int: number): { b: number; g: number; r: number }

normalizeApplicationCommand()

function src/utils/applicationcommands.ts:90

function normalizeApplicationCommand(
  command: ApplicationCommandLike,
  options?: NormalizeApplicationCommandOptions,
): Record<string, any>

Converts a local or remote command into the same plain payload shape, with defaults filled in and empty values collapsed, so that two equivalent commands produce deeply-equal objects

normalizeApplicationCommandOption()

function src/utils/applicationcommands.ts:113

function normalizeApplicationCommandOption(
  option: ApplicationCommandOptionLike,
): Record<string, any>

normalizeApplicationCommandOptionChoice()

function src/utils/applicationcommands.ts:132

function normalizeApplicationCommandOptionChoice(
  choice: ApplicationCommandOptionChoiceLike,
): Record<string, any>

normalizeContexts()

function src/utils/applicationcommands.ts:77

function normalizeContexts(
  value?: InteractionContextTypes[] | null,
): InteractionContextTypes[] | null

normalizeIntegrationTypes()

function src/utils/applicationcommands.ts:81

function normalizeIntegrationTypes(
  value?: ApplicationIntegrationTypes[] | null,
): ApplicationIntegrationTypes[] | null

normalizeLocalizations()

function src/utils/applicationcommands.ts:39

function normalizeLocalizations(
  value?: Record<string, string | undefined> | null,
): Record<string, string> | null

parseMentionsInText()

function src/utils/index.ts:292

function parseMentionsInText(
  context: Interaction | Message,
  content: string,
  options?: { escapeMentions?: boolean; guildSpecific?: boolean; nick?: boolean; text?: string },
): string

Parameters

context

Interaction | Message

content

string

options?

{ escapeMentions?: boolean; guildSpecific?: boolean; nick?: boolean; text?: string }

options.escapeMentions?

boolean

options.guildSpecific?

boolean

options.nick?

boolean

options.text?

string

regex()

function src/utils/index.ts:431

function regex(
  regexName: string,
  content: string,
  onlyFirst?: boolean,
): DiscordRegexPayload

Parameters

regexName

string

content

string

onlyFirst?

boolean

Default false

requireOrImport()

function async src/utils/index.ts:59

function requireOrImport(filepath: string): Promise<any>

Loads a command file with require() (its cache can be cleared, so reloading commands works) and falls back to import() for es modules require() can't load (like .mjs on older node, or ones with top-level await)

rgbToInt()

function src/utils/index.ts:506

function rgbToInt(r: number, g: number, b: number): number

toCamelCase()

function src/utils/casing.ts:1

function toCamelCase(value: string): string

Type aliases

Named types used across the API.

ApplicationCommandLike

type src/utils/applicationcommands.ts:18

type ApplicationCommandLike = ApplicationCommand | InteractionCommand

ApplicationCommandOptionChoiceLike

type src/utils/applicationcommands.ts:20

type ApplicationCommandOptionChoiceLike = ApplicationCommandOptionChoice | InteractionCommandOptionChoice

ApplicationCommandOptionLike

type src/utils/applicationcommands.ts:19

type ApplicationCommandOptionLike = ApplicationCommandOption | InteractionCommandOption

ComponentEmojiData

type src/utils/components/actionbase.ts:20

type ComponentEmojiData = { animated?: boolean; id?: null | string; name: string } | string | Emoji

ComponentLabelChild

type src/utils/components/label.ts:15

type ComponentLabelChild = ComponentCheckbox | ComponentCheckboxGroup | ComponentFileUpload | ComponentInputText | ComponentRadioGroup | ComponentSelectMenu

ComponentOnError

type src/utils/components/components.ts:25

type ComponentOnError = (context: ComponentContext, error: Error) => unknown

ComponentOnTimeout

type src/utils/components/components.ts:23

type ComponentOnTimeout = () => unknown

ComponentRun

type src/utils/components/components.ts:24

type ComponentRun = (context: ComponentContext) => unknown

DiscordRegexPayload

type src/utils/index.ts:424

type DiscordRegexPayload = DiscordRegexPayloadEmoji | DiscordRegexPayloadJumpChannel | DiscordRegexPayloadJumpChannelMessage | DiscordRegexPayloadMentionChannelOrRole | DiscordRegexPayloadMentionUser | DiscordRegexPayloadTextCodeblock | DiscordRegexPayloadTextGeneric | DiscordRegexPayloadTimestamp

InteractionModalArgs

type src/utils/modal/modal.ts:36

type InteractionModalArgs = Record<string, any>

InteractionModalOnError

type src/utils/modal/modal.ts:40

type InteractionModalOnError = (context: InteractionModalContext, args: InteractionModalArgs, error: Error) => unknown

InteractionModalOnTimeout

type src/utils/modal/modal.ts:38

type InteractionModalOnTimeout = () => unknown

InteractionModalRun

type src/utils/modal/modal.ts:39

type InteractionModalRun = (context: InteractionModalContext, args: InteractionModalArgs) => unknown

Omit

type src/utils/index.ts:50

type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>

PartialBy

type src/utils/index.ts:51

type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>

UrlQuery

type src/utils/index.ts:53

type UrlQuery = Record<string, any>

Variables

Exported values.

KeyGenerator

variable const src/utils/index.ts:515

const KeyGenerator: Readonly<{ ApplicationCommand: (command: ApplicationCommand | InteractionCommand<…>) => string; ApplicationCommandOption: (option: InteractionCommandOption<…> | ApplicationCommandOption) => string; ApplicationCommandOptionChoice: (choice: InteractionCommandOptionChoice | ApplicationCommandOptionChoice) => string }>

Show definition (38 lines)

export const KeyGenerator = Object.freeze({
  ApplicationCommand: (command: ApplicationCommand | InteractionCommand): string => {
    return [
      command.name,
      command.description,
      command.type,
      (command.options) ? command.options.map((x) => x.key).join(':') : '',
      JSON.stringify(normalizeLocalizations(command.descriptionLocalizations)),
      JSON.stringify(normalizeLocalizations(command.nameLocalizations)),
      command.defaultMemberPermissions,
      (command.dmPermission === undefined || command.dmPermission === null) ? true : !!command.dmPermission,
      normalizeContexts(command.contexts),
      normalizeIntegrationTypes(command.integrationTypes),
      Boolean(command.nsfw),
    ].join('-');
  },
  ApplicationCommandOption: (option: ApplicationCommandOption | InteractionCommandOption): string => {
    return [
      option.name,
      option.description,
      option.type,
      !!option.required,
      !!option.autocomplete,
      (option.options) ? option.options.map((x) => x.key).join(':') : '',
      (option.choices) ? option.choices.map((x) => x.key).join(':') : '',
      JSON.stringify(normalizeLocalizations(option.descriptionLocalizations)),
      JSON.stringify(normalizeLocalizations(option.nameLocalizations)),
      JSON.stringify(option.channelTypes),
      option.maxValue,
      option.minValue,
      option.maxLength,
      option.minLength,
    ].join('-');
  },
  ApplicationCommandOptionChoice: (choice: ApplicationCommandOptionChoice | InteractionCommandOptionChoice): string => {
    return `${choice.name}-${choice.value}-${typeof(choice.value)}-${JSON.stringify(normalizeLocalizations(choice.nameLocalizations))}`;
  },
});