utils/core

Core utility functions/classes for Transformers.js.

These are only used internally, meaning an end-user shouldn’t need to access anything here.

• utils/core
  • static
    • .reverseDictionary(data) ⇒ Object
    • .escapeRegExp(string) ⇒ string
    • .isTypedArray(val) ⇒ boolean
    • .isIntegralNumber(x) ⇒ boolean
    • .isNullishDimension(x) ⇒ boolean
    • .calculateDimensions(arr) ⇒ Array.<number>
    • .pop(obj, key, defaultValue) ⇒ *
    • .mergeArrays(arrs) ⇒ Array
    • .calculateReflectOffset(i, w) ⇒ number
    • .pick(o, props) ⇒ Object
    • .len(s) ⇒ number
    • .count(arr, value)
  • inner
    • ~InitiateProgressInfo : Object
    • ~DownloadProgressInfo : Object
    • ~ProgressStatusInfo : Object
    • ~DoneProgressInfo : Object
    • ~ReadyProgressInfo : Object
    • ~ProgressInfo : InitiateProgressInfo | DownloadProgressInfo | ProgressStatusInfo | DoneProgressInfo | ReadyProgressInfo
    • ~ProgressCallback ⇒ void

---

utils/core.reverseDictionary(data) ⇒ <code> Object </code>

Reverses the keys and values of an object.

Kind: static method of utils/core
Returns: Object - The reversed object.
See: https://ultimatecourses.com/blog/reverse-object-keys-and-values-in-javascript

Param	Type	Description
data	Object	The object to reverse.

---

utils/core.escapeRegExp(string) ⇒ <code> string </code>

Escapes regular expression special characters from a string by replacing them with their escaped counterparts.

Kind: static method of utils/core
Returns: string - The escaped string.

Param	Type	Description
string	string	The string to escape.

---

utils/core.isTypedArray(val) ⇒ <code> boolean </code>

Check if a value is a typed array.

Kind: static method of utils/core
Returns: boolean - True if the value is a TypedArray, false otherwise.

Adapted from https://stackoverflow.com/a/71091338/13989043

Param	Type	Description
val	*	The value to check.

---

utils/core.isIntegralNumber(x) ⇒ <code> boolean </code>

Check if a value is an integer.

Kind: static method of utils/core
Returns: boolean - True if the value is a string, false otherwise.

Param	Type	Description
x	*	The value to check.

---

utils/core.isNullishDimension(x) ⇒ <code> boolean </code>

Determine if a provided width or height is nullish.

Kind: static method of utils/core
Returns: boolean - True if the value is null, undefined or -1, false otherwise.

Param	Type	Description
x	*	The value to check.

---

utils/core.calculateDimensions(arr) ⇒ <code> Array. < number > </code>

Calculates the dimensions of a nested array.

Kind: static method of utils/core
Returns: Array.<number> - An array containing the dimensions of the input array.

Param	Type	Description
arr	Array.<any>	The nested array to calculate dimensions for.

---

utils/core.pop(obj, key, defaultValue) ⇒ <code> * </code>

Replicate python’s .pop() method for objects.

Kind: static method of utils/core
Returns: * - The value of the popped key.
Throws:

• Error If the key does not exist and no default value is provided.

Param	Type	Description
obj	Object	The object to pop from.
key	string	The key to pop.
defaultValue	*	The default value to return if the key does not exist.

---

utils/core.mergeArrays(arrs) ⇒ <code> Array </code>

Efficiently merge arrays, creating a new copy. Adapted from https://stackoverflow.com/a/6768642/13989043

Kind: static method of utils/core
Returns: Array - The merged array.

Param	Type	Description
arrs	Array.<Array>	Arrays to merge.

---

utils/core.calculateReflectOffset(i, w) ⇒ <code> number </code>

Calculates the index offset for a given index and window size.

Kind: static method of utils/core
Returns: number - The index offset.

Param	Type	Description
i	number	The index.
w	number	The window size.

---

utils/core.pick(o, props) ⇒ <code> Object </code>

Kind: static method of utils/core

Param	Type
o	Object
props	Array.<string>

---

utils/core.len(s) ⇒ <code> number </code>

Calculate the length of a string, taking multi-byte characters into account. This mimics the behavior of Python’s len function.

Kind: static method of utils/core
Returns: number - The length of the string.

Param	Type	Description
s	string	The string to calculate the length of.

---

utils/core.count(arr, value)

Count the occurrences of a value in an array or string. This mimics the behavior of Python’s count method.

Kind: static method of utils/core

Param	Type	Description
arr	Array<any> | string	The array or string to search.
value	any	The value to count.

---

utils/core~InitiateProgressInfo : <code> Object </code>

Kind: inner typedef of utils/core
Properties

Name	Type	Description
status	'initiate'
name	string	The model id or directory path.
file	string	The name of the file.

---

utils/core~DownloadProgressInfo : <code> Object </code>

Kind: inner typedef of utils/core
Properties

Name	Type	Description
status	'download'
name	string	The model id or directory path.
file	string	The name of the file.

---

utils/core~ProgressStatusInfo : <code> Object </code>

Kind: inner typedef of utils/core
Properties

Name	Type	Description
status	'progress'
name	string	The model id or directory path.
file	string	The name of the file.
progress	number	A number between 0 and 100.
loaded	number	The number of bytes loaded.
total	number	The total number of bytes to be loaded.

---

utils/core~DoneProgressInfo : <code> Object </code>

Kind: inner typedef of utils/core
Properties

Name	Type	Description
status	'done'
name	string	The model id or directory path.
file	string	The name of the file.

---

utils/core~ReadyProgressInfo : <code> Object </code>

Kind: inner typedef of utils/core
Properties

Name	Type	Description
status	'ready'
task	string	The loaded task.
model	string	The loaded model.

---

utils/core~ProgressInfo : <code> InitiateProgressInfo </code> | <code> DownloadProgressInfo </code> | <code> ProgressStatusInfo </code> | <code> DoneProgressInfo </code> | <code> ReadyProgressInfo </code>

Kind: inner typedef of utils/core

---

utils/core~ProgressCallback ⇒ <code> void </code>

A callback function that is called with progress information.

Kind: inner typedef of utils/core

Param	Type
progressInfo	ProgressInfo

---

< > Update on GitHub