Util

classe · Source

Contains various general-purpose utility methods.

Methods

flatten

static

flatten(obj: Object, props?: Object<string, (boolean|string)>): Object

Flatten an object. Any properties that are collections will get converted to an array of keys. Parameters

Name	Type	Description
obj	Object	The object to flatten.
props?	Object<string, (boolean|string)>	Specific properties to include/exclude.

Returns: ObjectSource

splitMessage

static · deprecated

splitMessage(text: string, options?: SplitOptions): Array<string>

Splits a string into multiple chunks at a designated character that do not exceed a specific length. Parameters

Name	Type	Description
text	string	Content to split
options?	SplitOptions	Options controlling the behavior of the split

Returns: Array<string>Source

escapeMarkdown

static

escapeMarkdown(text: string, options?: EscapeMarkdownOptions): string

Escapes any Discord-flavour markdown in a string. Parameters

Name	Type	Description
text	string	Content to escape
options?	EscapeMarkdownOptions	Options for escaping the markdown Default: {}.

Returns: stringSource

escapeCodeBlock

static

escapeCodeBlock(text: string): string

Escapes code block markdown in a string. Parameters

Name	Type	Description
text	string	Content to escape

Returns: stringSource

escapeInlineCode

static

escapeInlineCode(text: string): string

Escapes inline code markdown in a string. Parameters

Name	Type	Description
text	string	Content to escape

Returns: stringSource

escapeItalic

static

escapeItalic(text: string): string

Escapes italic markdown in a string. Parameters

Name	Type	Description
text	string	Content to escape

Returns: stringSource

escapeBold

static

escapeBold(text: string): string

Escapes bold markdown in a string. Parameters

Name	Type	Description
text	string	Content to escape

Returns: stringSource

escapeUnderline

static

escapeUnderline(text: string): string

Escapes underline markdown in a string. Parameters

Name	Type	Description
text	string	Content to escape

Returns: stringSource

escapeStrikethrough

static

escapeStrikethrough(text: string): string

Escapes strikethrough markdown in a string. Parameters

Name	Type	Description
text	string	Content to escape

Returns: stringSource

escapeSpoiler

static

escapeSpoiler(text: string): string

Escapes spoiler markdown in a string. Parameters

Name	Type	Description
text	string	Content to escape

Returns: stringSource

escapeEscape

static

escapeEscape(text: string): string

Escapes escape characters in a string. Parameters

Name	Type	Description
text	string	Content to escape

Returns: stringSource

escapeHeading

static

escapeHeading(text: string): string

Escapes heading characters in a string. Parameters

Name	Type	Description
text	string	Content to escape

Returns: stringSource

escapeBulletedList

static

escapeBulletedList(text: string): string

Escapes bulleted list characters in a string. Parameters

Name	Type	Description
text	string	Content to escape

Returns: stringSource

escapeNumberedList

static

escapeNumberedList(text: string): string

Escapes numbered list characters in a string. Parameters

Name	Type	Description
text	string	Content to escape

Returns: stringSource

escapeMaskedLink

static

escapeMaskedLink(text: string): string

Escapes masked link characters in a string. Parameters

Name	Type	Description
text	string	Content to escape

Returns: stringSource

parseEmoji

static · private

parseEmoji(text: string): APIEmoji

Parses emoji info out of a string. The string must be one of:

• A UTF-8 emoji (no id)
• A URL-encoded UTF-8 emoji (no id)
• A Discord custom emoji (<:name:id> or <a:name:id>) Parameters

Name	Type	Description
text	string	Emoji string to parse

Returns: APIEmoji — Object with animated, name, and id properties Source

resolvePartialEmoji

static · private

resolvePartialEmoji(emoji: EmojiIdentifierResolvable): RawEmoji

Resolves a partial emoji object from an EmojiIdentifierResolvable, without checking a Client. Parameters

Name	Type	Description
emoji	EmojiIdentifierResolvable	Emoji identifier to resolve

Returns: RawEmojiSource

cloneObject

static · private

cloneObject(obj: Object): Object

Shallow-copies an object with its class/prototype intact. Parameters

Name	Type	Description
obj	Object	Object to clone

Returns: ObjectSource

mergeDefault

static · private

mergeDefault(def: Object, given: Object): Object

Sets default properties on an object that aren't already specified. Parameters

Name	Type	Description
def	Object	Default properties
given	Object	Object to assign defaults to

Returns: ObjectSource

makeError

static · private

makeError(obj: MakeErrorOptions): Error

Makes an Error from a plain info object. Parameters

Name	Type	Description
obj	MakeErrorOptions	Error info

Returns: ErrorSource

makePlainError

static · private

makePlainError(err: Error): MakeErrorOptions

Makes a plain error info object from an Error. Parameters

Name	Type	Description
err	Error	Error to get info from

Returns: MakeErrorOptionsSource

moveElementInArray

static · private

moveElementInArray(array: Array<*>, element: *, newIndex: number, offset?: boolean): number

Moves an element in an array in place. Parameters

Name	Type	Description
array	Array<*>	Array to modify
element	*	Element to move
newIndex	number	Index or offset to move the element to
offset?	boolean	Move the element by an offset amount rather than to a set index Default: false.

Returns: numberSource

verifyString

static

verifyString(data: string, error?: function, errorMessage?: string, allowEmpty?: boolean): string

Verifies the provided data is a string, otherwise throws provided error. Parameters

Name	Type	Description
data	string	The string resolvable to resolve
error?	function	The Error constructor to instantiate. Defaults to Error
errorMessage?	string	The error message to throw with. Defaults to "Expected string, got <data> instead."
allowEmpty?	boolean	Whether an empty string should be allowed Default: true.

Returns: stringSource

resolveColor

static

resolveColor(color: ColorResolvable): number

Resolves a ColorResolvable into a color number. Parameters

Name	Type	Description
color	ColorResolvable	Color to resolve

Returns: number — A color Source

discordSort

static

discordSort(collection: Collection): Collection

Sorts by Discord's position and id. Parameters

Name	Type	Description
collection	Collection	Collection of objects to sort

Returns: CollectionSource

setPosition

static · async · private

async setPosition(item: Channel | Role, position: number, relative: boolean, sorted: Collection<string, (Channel|Role)>, route: APIRouter, reason?: string): Promise<(Array<Channel>|Array<Role>)>

Sets the position of a Channel or Role. Parameters

Name	Type	Description
item	Channel | Role	Object to set the position of
position	number	New position for the object
relative	boolean	Whether position is relative to its current position
sorted	Collection<string, (Channel|Role)>	A collection of the objects sorted properly
route	APIRouter	Route to call PATCH on
reason?	string	Reason for the change

Returns: Promise<(Array<Channel>\|Array<Role>)> — Updated item list, with id and position properties Source

basename

static · private

basename(path: string, ext?: string): string

Alternative to Node's path.basename, removing query string after the extension if it exists. Parameters

Name	Type	Description
path	string	Path to get the basename of
ext?	string	File extension to remove

Returns: string — Basename of the path Source

removeMentions

static · deprecated

removeMentions(str: string): string

Breaks user, role and everyone/here mentions by adding a zero width space after every @ character Parameters

Name	Type	Description
str	string	The string to sanitize

Returns: stringSource

cleanContent

static

cleanContent(str: string, channel: TextBasedChannels): string

The content to have all mentions replaced by the equivalent text. When Util.removeMentions is removed, this method will no longer sanitize mentions. Use BaseMessageOptions#allowedMentions instead to prevent mentions when sending a message. Parameters

Name	Type	Description
str	string	The string to be converted
channel	TextBasedChannels	The channel the string was sent in

Returns: stringSource

cleanCodeBlockContent

static

cleanCodeBlockContent(text: string): string

The content to put in a code block with all code block fences replaced by the equivalent backticks. Parameters

Name	Type	Description
text	string	The string to be converted

Returns: stringSource

archivedThreadSweepFilter

static · deprecated

archivedThreadSweepFilter(lifetime?: number): SweepFilter

Creates a sweep filter that sweeps archived threads Parameters

Name	Type	Description
lifetime?	number	How long a thread has to be archived to be valid for sweeping Default: 14400.

Returns: SweepFilterSource

resolveAutoArchiveMaxLimit

static · deprecated

resolveAutoArchiveMaxLimit(guild: Guild): number

Resolves the maximum time a guild's thread channels should automatically archive in case of no recent activity. Parameters

Name	Type	Description
guild	Guild	The guild to resolve this limit from.

Returns: numberSource

calculateUserDefaultAvatarIndex

static

calculateUserDefaultAvatarIndex(userId: Snowflake): number

Calculates the default avatar index for a given user id. Parameters

Name	Type	Description
userId	Snowflake	The user id to calculate the default avatar index for

Returns: numberSource

lazy

static

lazy(cb: function): function

Lazily evaluates a callback function (yea it's v14 :yay:) Parameters

Name	Type	Description
cb	function	The callback to lazily evaluate

Returns: function

const User = lazy(() => require('../structures/User'));
const user = new (User())(client, data);

Source

verifyProxyAgent

static

verifyProxyAgent(object: Object): boolean

Hacking check object instanceof Proxy-agent Parameters

Name	Type	Description
object	Object	any

Returns: booleanSource

createTLSOptions

static · private

createTLSOptions(options?: Object | Agent): Object

Creates the TLS options shared by REST and WebSocket connections. User options intentionally take precedence over the browser-like defaults. Parameters

Name	Type	Description
options?	Object | Agent	TLS or HTTPS agent options

Returns: ObjectSource

resolveWebSocketTLS

static · private

resolveWebSocketTLS(options?: WebsocketOptions): Object

Resolves the TLS and agent options accepted by ws. Parameters

Name	Type	Description
options?	WebsocketOptions	Client WebSocket options

Returns: ObjectSource

getPayloadType

static

getPayloadType(codecName: 'opus' | 'H264' | 'H265' | 'VP8' | 'VP9' | 'AV1'): number

Get the payload type of the codec Parameters

Name	Type	Description
codecName	'opus' | 'H264' | 'H265' | 'VP8' | 'VP9' | 'AV1'	Codec name

Returns: numberSource