Structuresnamespace

Typed, cached objects built from Discord's payloads, like Message, Guild and User, with helpers for the endpoints that act on them.

On this page

Classes153
Interfaces10
Functions4
Type aliases11
Variables7

import { Structures } from 'detritus-client';

153 classes · 10 interfaces · 11 type aliases · 7 variables · 4 functions

Classes

Classes you create or receive from the library.

Interfaces

Object shapes for options, payloads and events.

interfaceApplicationDeveloper 2 properties interfaceApplicationExecutable 3 properties interfaceApplicationGuildPartial 4 properties interfaceApplicationPublisher 2 properties interfaceBaseStructureData interfaceCallOptions 2 properties interfaceGuildIncidentsData 4 properties interfaceMessagePollAnswerCount 3 properties interfaceMessageReplyOptions 1 property interfaceRoleColors 3 properties

Functions

Standalone helpers.

convertKey()

function src/structures/basestructure.ts:16

function convertKey(snake: string): string

createChannelFromData()

function src/structures/channel.ts:76

function createChannelFromData(
  client: ShardClient,
  data?: BaseStructureData,
  isClone?: boolean,
): Channel

messageSystemContent()

function src/structures/message.ts:2015

function messageSystemContent(message: Message, text?: string): string

setStructureUncloneable()

function src/structures/basestructure.ts:43

function setStructureUncloneable(structure: Function): void

Type aliases

Named types used across the API.

Channel

type src/structures/channel.ts:49

type Channel = ChannelBase | ChannelDM | ChannelGuildVoice | ChannelDMGroup | ChannelGuildType

ChannelGuildType

type src/structures/channel.ts:57

type ChannelGuildType = ChannelGuildBase | ChannelGuildCategory | ChannelGuildText | ChannelGuildVoice | ChannelGuildStore | ChannelGuildThread | ChannelGuildStageVoice | ChannelGuildDirectory | ChannelGuildForum

ChannelTextType

type src/structures/channel.ts:69

type ChannelTextType = ChannelDM | ChannelDMGroup | ChannelGuildText | ChannelGuildThread

ComponentLabelChild

type src/structures/components.ts:571

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

ComponentsTopLevel

type src/structures/components.ts:29

type ComponentsTopLevel = ComponentActionRow | ComponentContainer | ComponentFile | ComponentMediaGallery | ComponentSection | ComponentSeparator | ComponentTextDisplay | ComponentUnknown

InteractionDataModalComponent

type src/structures/interaction.ts:848

type InteractionDataModalComponent = ComponentActionRow | ComponentLabel | ComponentTextDisplay | ComponentUnknown

InteractionEditOrRespond

type src/structures/interaction.ts:42

type InteractionEditOrRespond = RequestTypes.CreateInteractionResponseInnerPayload & RequestTypes.EditWebhookTokenMessage

InteractionResponseData

type src/structures/interaction.ts:49

type InteractionResponseData = RequestTypes.CreateInteractionResponseInnerPayload | InteractionModal | string

InteractionResponseOptions

type src/structures/interaction.ts:48

type InteractionResponseOptions = RequestTypes.CreateInteractionResponse | InteractionModal | number

Pass an InteractionModal itself (not its json) as either argument to respond with it, so its run gets called when it's submitted e.g. respond(modal) or respond(InteractionCallbackTypes.MODAL, modal)

MemberOrUser

type src/structures/member.ts:34

type MemberOrUser = Member | User

StructureKeysName

type src/structures/basestructure.ts:32

type StructureKeysName = "_keys" | "_keysMerge" | "_keysSkipDifference"

Variables

Exported values.

EmbeddableRegexes

variable const src/structures/attachment.ts:15

const EmbeddableRegexes: Readonly<{ audio: RegExp; image: RegExp; video: RegExp }>

Show definition (5 lines)

export const EmbeddableRegexes = Object.freeze({
  audio: /^(?:mp3|ogg|wav|flac)$/i,
  image: /^(?:png|jpe?g|webp|gif)$/i,
  video: /^(?:mp4|webm|mov)$/i,
});

ImageSizes

variable const src/structures/presence.ts:39

const ImageSizes: Readonly<{ LARGE: 160; SMALL: 64 }>

Show definition (4 lines)

export const ImageSizes = Object.freeze({
  SMALL: 64,
  LARGE: 160,
});

keysStoreApplicationAsset

variable const src/structures/store.ts:202

const keysStoreApplicationAsset: BaseSet<string>

Show definition (9 lines)

export const keysStoreApplicationAsset = new BaseSet<string>([
  DiscordKeys.APPLICATION_ID,
  DiscordKeys.FILENAME,
  DiscordKeys.HEIGHT,
  DiscordKeys.ID,
  DiscordKeys.MIME_TYPE,
  DiscordKeys.SIZE,
  DiscordKeys.WIDTH,
]);

MimeClassTypes

variable const src/structures/attachment.ts:21

const MimeClassTypes: { classType: string; regex: RegExp; type: string }[]

Show definition (72 lines)

export const MimeClassTypes: Array<{
  classType: string,
  regex: RegExp,
  type: string,
}> = [
  {
    type: 'name',
    classType: 'acrobat',
    regex: /\.pdf$/i,
  },
  {
    type: 'name',
    classType: 'ae',
    regex: /\.ae/i,
  },
  {
    type: 'name',
    classType: 'ai',
    regex: /\.ai$/i,
  },
  {
    type: 'name',
    classType: 'archive',
    regex: /\.(?:rar|zip|7z|tar|tar\.gz)$/i,
  },
  {
    type: 'name',
    classType: 'audio',
    regex: /\.(?:mp3|ogg|wav|flac)$/i,
  },
  {
    type: 'name',
    classType: 'code',
    regex: /\.(?:c\+\+|cpp|cc|c|h|hpp|mm|m|json|js|rb|rake|py|asm|fs|pyc|dtd|cgi|bat|rss|java|graphml|idb|lua|o|gml|prl|sls|conf|cmake|make|sln|vbe|cxx|wbf|vbs|r|wml|php|bash|applescript|fcgi|yaml|ex|exs|sh|ml|actionscript)$/i,
  },
  {
    type: 'name',
    classType: 'document',
    regex: /\.(?:txt|rtf|doc|docx|md|pages|ppt|pptx|pptm|key|log)$/i,
  },
  {
    // before `image` since it's an `image/` mimetype too
    type: 'mime',
    classType: 'photoshop',
    regex: /^image\/vnd.adobe.photoshop/,
  },
  {
    type: 'mime',
    classType: 'image',
    regex: /^image\//,
  },
  {
    type: 'name',
    classType: 'sketch',
    regex: /\.sketch$/i,
  },
  {
    type: 'name',
    classType: 'spreadsheet',
    regex: /\.(?:xls|xlsx|numbers|csv)$/i,
  },
  {
    type: 'mime',
    classType: 'video',
    regex: /^video\//,
  },
  {
    type: 'name',
    classType: 'webcode',
    regex: /\.(?:html|xhtml|htm|js|xml|xls|xsd|css|styl)$/i,
  },
];

SpecialApplications

variable const src/structures/presence.ts:31

const SpecialApplications: Readonly<{ XBOX: "438122941302046720" }>

Show definition (3 lines)

export const SpecialApplications = Object.freeze({
  XBOX: '438122941302046720',
});

SpecialPrefixes

variable const src/structures/presence.ts:35

const SpecialPrefixes: Readonly<{ SPOTIFY: "spotify:" }>

Show definition (3 lines)

export const SpecialPrefixes = Object.freeze({
  SPOTIFY: 'spotify:',
});

SpecialThirdPartySkus

variable const src/structures/application.ts:41

const SpecialThirdPartySkus: { [key: string]: string }

Show definition (7 lines)

export const SpecialThirdPartySkus: {[key: string]: string} = Object.freeze({
  'Call of Duty Black Ops 4': 'call-of-duty',
  'Call of Duty Modern Warfare': 'call-of-duty-mw',
  'StarCraft': 'starcraft-remastered',
  'World of Warcraft Classic': 'world-of-warcraft',
  'World of Warcraft Public Test': 'world-of-warcraft',
});