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
| Parameter | Type | Description |
|---|---|---|
| argument | ...any | Anything 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)
| Parameter | Type | Description |
|---|---|---|
| executor | function | The function to be debounced |
| delay | number | Number 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.
| Parameter | Type | Description |
|---|---|---|
| html | string | HTML 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.
| Parameter | Type | Description |
|---|---|---|
| extendee | object | Object to be extended |
| extenders | ...object | Objects 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.
| Parameter | Type | Optional | Default | Description |
|---|---|---|---|---|
| tree | object | ❌ | none | Tree that should be walked |
| searchFilter | callable | ❌ | none | Filter to check against each object and subobject |
| options | object | ❌ | none | Additional options to customize the search |
| options.walkable | Array.<string>|null | ✅ | none | Array of strings to use as keys that are allowed to be walked on. null indicates all keys are walkable. |
| options.ignore | Array.<string> | ✅ | [] | Array of strings to use as keys to exclude from the search. Most helpful when walkable = null. |
Returns: void
getNestedValue
Gets a nested value (if it exists) of an object safely. keyPath should be something like key.key2.key3. Numbers can be used for arrays as well like key.key2.array.0.id.
| Parameter | Type | Description |
|---|---|---|
| obj | object | object to get nested value from |
| keyPath | string | key path to the desired value |
Returns: void
semverCompare
This works on semantic versioning e.g. "1.0.0".
| Parameter | Type | Description |
|---|---|---|
| currentVersion | string | |
| newVersion | string |
Returns: number - 0 indicates equal, -1 indicates left hand greater, 1 indicates right hand greater