Skip to main content

Utils

Utils is a utility containing commonly reused functions. Instance is accessible through the BdApi.

Properties

Methods

className

Builds a classname string from any number of arguments. This includes arrays and objects. When given an array all values from the array are added to the list. When given an object they keys are added as the classnames if the value is truthy. Copyright (c) 2018 Jed Watson https://github.com/JedWatson/classnames MIT License

ParameterTypeDescription
argument...anyAnything that should be used to add classnames

Returns: string - Joined classname


debounce

Returns a function, that, as long as it continues to be invoked, will not be triggered. The function will be called after it stops being called for delay milliseconds. It is called at the end of the sequence (trailing edge). Adapted from the version by David Walsh (https://davidwalsh.name/javascript-debounce-function)

ParameterTypeDescription
executorfunctionThe function to be debounced
delaynumberNumber of ms to delay calls

Returns: function - A debounced version of the function


escapeHTML

Takes a string of HTML and escapes it using the browser's own escaping mechanism.

ParameterTypeDescription
htmlstringHTML to be escaped

Returns: string - Escaped HTML string


extend

Deep extends an object with a set of other objects. Objects later in the list of extenders have priority, that is to say if one sets a key to be a primitive, it will be overwritten with the next one with the same key. If it is an object, and the keys match, the object is extended. This happens recursively.

ParameterTypeDescription
extendeeobjectObject to be extended
extenders...objectObjects to extend with

Returns: object - A reference to extendee


findInTree

Finds a value, subobject, or array from a tree that matches a specific filter. This is a DFS.

ParameterTypeOptionalDefaultDescription
treeobjectnoneTree that should be walked
searchFiltercallablenoneFilter to check against each object and subobject
optionsobjectnoneAdditional options to customize the search
options.walkableArray.<string>|nullnoneArray of strings to use as keys that are allowed to be walked on. null indicates all keys are walkable.
options.ignoreArray.<string>[]Array of strings to use as keys to exclude from the search. Most helpful when walkable = null.

Returns: void