@nejs/basic-extensions 1.6.1 → 1.7.0

package/README.md

@@ -9,17 +9,17 @@ additional utility methods for common tasks and improving code readability and e
 
 ## Features
 
-- **Array Extensions**: Adds convenience methods to JavaScript arrays, like `first` and `last`,
-  for easy access to the first and last elements.
+*   **Array Extensions**: Adds convenience methods to JavaScript arrays, like `first` and `last`,
+    for easy access to the first and last elements.
 
-- **Object Extensions**: Introduces utility functions to the Object class, such as methods for
-  checking object types and manipulating properties.
+*   **Object Extensions**: Introduces utility functions to the Object class, such as methods for
+    checking object types and manipulating properties.
 
-- **Function Extensions**: Enriches the Function class with methods to identify function types,
-  such as arrow functions, async functions, and bound functions.
+*   **Function Extensions**: Enriches the Function class with methods to identify function types,
+    such as arrow functions, async functions, and bound functions.
 
-- **Reflect Extensions**: Extends the Reflect object with advanced property interaction methods,
-  including checks for the presence of multiple or specific keys.
+*   **Reflect Extensions**: Extends the Reflect object with advanced property interaction methods,
+    including checks for the presence of multiple or specific keys.
 
 ## Installation
 
@@ -49,10 +49,2024 @@ import { FunctionExtensions } from '@nejs/basic-extensions';
 // Use the Function extensions
 ```
 
-## Documentation
+## API
 
-For detailed documentation on each extension and its methods, please refer to the respective
-sections in this README or visit our [documentation website](#).
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+#### Table of Contents
+
+*   [FunctionExtensions](#functionextensions)
+    *   [isClass](#isclass)
+        *   [Parameters](#parameters)
+    *   [isFunction](#isfunction)
+        *   [Parameters](#parameters-1)
+    *   [isAsync](#isasync)
+        *   [Parameters](#parameters-2)
+    *   [isBigArrow](#isbigarrow)
+        *   [Parameters](#parameters-3)
+    *   [isBound](#isbound)
+        *   [Parameters](#parameters-4)
+*   [ObjectExtensions](#objectextensions)
+    *   [isNullDefined](#isnulldefined)
+        *   [Parameters](#parameters-5)
+    *   [hasStringTag](#hasstringtag)
+        *   [Parameters](#parameters-6)
+    *   [getStringTag](#getstringtag)
+        *   [Parameters](#parameters-7)
+    *   [getType](#gettype)
+        *   [Parameters](#parameters-8)
+    *   [isObject](#isobject)
+        *   [Parameters](#parameters-9)
+    *   [isPrimitive](#isprimitive)
+        *   [Parameters](#parameters-10)
+    *   [isValidKey](#isvalidkey)
+        *   [Parameters](#parameters-11)
+    *   [stripTo](#stripto)
+        *   [Parameters](#parameters-12)
+*   [stripTo](#stripto-1)
+    *   [Parameters](#parameters-13)
+*   [getKey](#getkey)
+    *   [Parameters](#parameters-14)
+*   [ReflectExtensions](#reflectextensions)
+    *   [hasAll](#hasall)
+        *   [Parameters](#parameters-15)
+    *   [ownDescriptors](#owndescriptors)
+        *   [Parameters](#parameters-16)
+    *   [hasSome](#hassome)
+        *   [Parameters](#parameters-17)
+    *   [entries](#entries)
+        *   [Parameters](#parameters-18)
+    *   [values](#values)
+        *   [Parameters](#parameters-19)
+*   [StringExtensions](#stringextensions)
+    *   [isString](#isstring)
+        *   [Parameters](#parameters-20)
+*   [SymbolExtensions](#symbolextensions)
+    *   [isSymbol](#issymbol)
+        *   [Parameters](#parameters-21)
+    *   [isRegistered](#isregistered)
+        *   [Parameters](#parameters-22)
+    *   [isNonRegistered](#isnonregistered)
+        *   [Parameters](#parameters-23)
+*   [ArrayPrototypeExtensions](#arrayprototypeextensions)
+    *   [contains](#contains)
+        *   [Parameters](#parameters-24)
+    *   [findEntry](#findentry)
+        *   [Parameters](#parameters-25)
+    *   [first](#first)
+    *   [last](#last)
+*   [object](#object)
+*   [constructor](#constructor)
+    *   [Parameters](#parameters-26)
+*   [isAccessor](#isaccessor)
+*   [isData](#isdata)
+*   [isDescriptor](#isdescriptor)
+*   [configurable](#configurable)
+*   [configurable](#configurable-1)
+    *   [Parameters](#parameters-27)
+*   [enumerable](#enumerable)
+*   [enumerable](#enumerable-1)
+    *   [Parameters](#parameters-28)
+*   [writable](#writable)
+*   [writable](#writable-1)
+    *   [Parameters](#parameters-29)
+*   [value](#value)
+*   [value](#value-1)
+    *   [Parameters](#parameters-30)
+*   [get](#get)
+*   [get](#get-1)
+    *   [Parameters](#parameters-31)
+*   [boundGet](#boundget)
+*   [set](#set)
+*   [set](#set-1)
+    *   [Parameters](#parameters-32)
+*   [boundSet](#boundset)
+*   [hasObject](#hasobject)
+*   [object](#object-1)
+*   [object](#object-2)
+    *   [Parameters](#parameters-33)
+*   [for](#for)
+    *   [Parameters](#parameters-34)
+*   [applyTo](#applyto)
+    *   [Parameters](#parameters-35)
+*   [toPrimitive](#toprimitive)
+    *   [Parameters](#parameters-36)
+*   [toStringTag](#tostringtag)
+*   [for](#for-1)
+    *   [Parameters](#parameters-37)
+*   [getData](#getdata)
+    *   [Parameters](#parameters-38)
+*   [getAccessor](#getaccessor)
+    *   [Parameters](#parameters-39)
+*   [base](#base)
+    *   [Parameters](#parameters-40)
+*   [accessor](#accessor)
+    *   [Parameters](#parameters-41)
+*   [data](#data)
+    *   [Parameters](#parameters-42)
+*   [isDescriptor](#isdescriptor-1)
+    *   [Parameters](#parameters-43)
+*   [isData](#isdata-1)
+    *   [Parameters](#parameters-44)
+*   [isAccessor](#isaccessor-1)
+    *   [Parameters](#parameters-45)
+*   [flexible](#flexible)
+*   [enigmatic](#enigmatic)
+*   [intrinsic](#intrinsic)
+*   [transparent](#transparent)
+*   [SHARED\_KEYS](#shared_keys)
+*   [ACCESSOR\_KEYS](#accessor_keys)
+*   [DATA\_KEYS](#data_keys)
+*   [maskAs](#maskas)
+    *   [Parameters](#parameters-46)
+*   [maskAsString](#maskasstring)
+    *   [Parameters](#parameters-47)
+*   [maskAsNumber](#maskasnumber)
+    *   [Parameters](#parameters-48)
+*   [GenericMask](#genericmask)
+    *   [Parameters](#parameters-49)
+*   [StringMask](#stringmask)
+    *   [Parameters](#parameters-50)
+*   [NumberMask](#numbermask)
+    *   [Parameters](#parameters-51)
+*   [RefSet](#refset)
+    *   [objectifying](#objectifying)
+        *   [Parameters](#parameters-52)
+    *   [objectifyValues](#objectifyvalues)
+    *   [objectifyValues](#objectifyvalues-1)
+        *   [Parameters](#parameters-53)
+    *   [add](#add)
+        *   [Parameters](#parameters-54)
+    *   [addAll](#addall)
+        *   [Parameters](#parameters-55)
+    *   [clean](#clean)
+    *   [entries](#entries-1)
+        *   [Parameters](#parameters-56)
+    *   [forEach](#foreach)
+        *   [Parameters](#parameters-57)
+    *   [values](#values-1)
+    *   [keys](#keys)
+    *   [has](#has)
+        *   [Parameters](#parameters-58)
+    *   [contains](#contains-1)
+        *   [Parameters](#parameters-59)
+    *   [filter](#filter)
+        *   [Parameters](#parameters-60)
+    *   [find](#find)
+        *   [Parameters](#parameters-61)
+    *   [map](#map)
+        *   [Parameters](#parameters-62)
+    *   [toStringTag](#tostringtag-1)
+*   [RefMap](#refmap)
+    *   [Parameters](#parameters-63)
+    *   [objectifying](#objectifying-1)
+        *   [Parameters](#parameters-64)
+    *   [asObject](#asobject)
+    *   [objectifyValues](#objectifyvalues-2)
+    *   [objectifyValues](#objectifyvalues-3)
+        *   [Parameters](#parameters-65)
+    *   [get](#get-2)
+        *   [Parameters](#parameters-66)
+    *   [set](#set-2)
+        *   [Parameters](#parameters-67)
+    *   [setAll](#setall)
+        *   [Parameters](#parameters-68)
+    *   [clean](#clean-1)
+    *   [entries](#entries-2)
+        *   [Parameters](#parameters-69)
+    *   [forEach](#foreach-1)
+        *   [Parameters](#parameters-70)
+    *   [values](#values-2)
+    *   [hasValue](#hasvalue)
+        *   [Parameters](#parameters-71)
+    *   [filter](#filter-1)
+        *   [Parameters](#parameters-72)
+    *   [find](#find-1)
+        *   [Parameters](#parameters-73)
+    *   [map](#map-1)
+        *   [Parameters](#parameters-74)
+    *   [iterator](#iterator)
+    *   [toStringTag](#tostringtag-2)
+*   [isValidReference](#isvalidreference)
+    *   [Parameters](#parameters-75)
+*   [AsyncIterable](#asynciterable)
+    *   [Parameters](#parameters-76)
+    *   [asyncIterator](#asynciterator)
+    *   [toStringTag](#tostringtag-3)
+    *   [isAsyncIterable](#isasynciterable)
+        *   [Parameters](#parameters-77)
+*   [AsyncIterator](#asynciterator-1)
+    *   [Parameters](#parameters-78)
+    *   [asArray](#asarray)
+    *   [asyncIterable](#asynciterable-1)
+    *   [next](#next)
+    *   [reset](#reset)
+    *   [asyncIterator](#asynciterator-2)
+    *   [toStringTag](#tostringtag-4)
+*   [Iterable](#iterable)
+    *   [Parameters](#parameters-79)
+    *   [iterator](#iterator-1)
+    *   [asArray](#asarray-1)
+    *   [toStringTag](#tostringtag-5)
+    *   [isIterable](#isiterable)
+        *   [Parameters](#parameters-80)
+*   [Iterator](#iterator-2)
+    *   [Parameters](#parameters-81)
+    *   [asArray](#asarray-2)
+    *   [iterable](#iterable-1)
+    *   [next](#next-1)
+    *   [reset](#reset-1)
+    *   [iterator](#iterator-3)
+    *   [toStringTag](#tostringtag-6)
+*   [mapEach](#mapeach)
+
+### FunctionExtensions
+
+The `FunctionExtensions` class is a patch applied to the built-in JavaScript
+`Function` constructor. It extends `Function` with additional utility methods
+for determining the specific type or nature of function-like objects. These
+methods allow developers to distinguish between classes, regular functions,
+async functions, and arrow functions in a more intuitive and straightforward
+manner. This class is part of the `@nejs/extension` library and enhances the
+capabilities of function handling and introspection in JavaScript.
+
+#### isClass
+
+Determines if a given value is a class. It checks if the value is an
+instance of `Function` and if its string representation includes the
+keyword 'class'. This method is useful for distinguishing classes from
+other function types in JavaScript.
+
+##### Parameters
+
+*   `value` **any** The value to be checked.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Returns `true` if the value is a class, otherwise
+`false`.
+
+#### isFunction
+
+Checks if a given value is a regular function. This method verifies if
+the value is an instance of `Function`, which includes regular functions,
+classes, and async functions but excludes arrow functions.
+
+##### Parameters
+
+*   `value` **any** The value to be checked.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Returns `true` if the value is a regular function,
+otherwise `false`.
+
+#### isAsync
+
+Determines if a given value is an asynchronous function. It checks if the
+value is an instance of `Function` and if its string representation
+includes the keyword 'Async'. This method is particularly useful for
+identifying async functions.
+
+##### Parameters
+
+*   `value` **any** The value to be checked.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Returns `true` if the value is an async function,
+otherwise `false`.
+
+#### isBigArrow
+
+Checks if a given value is an arrow function. It verifies if the value is
+an instance of `Function`, if its string representation includes the '=>'
+symbol, and if it lacks a prototype, which is a characteristic of arrow
+functions in JavaScript.
+
+##### Parameters
+
+*   `value` **any** The value to be checked.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Returns `true` if the value is an arrow function,
+otherwise `false`.
+
+#### isBound
+
+Determines if a given value is a bound function. Bound functions are
+created using the `Function.prototype.bind` method, which allows setting
+the `this` value at the time of binding. This method checks if the value
+is an instance of `Function`, if its string representation starts with
+'bound', and if it lacks a `prototype` property. These characteristics
+are indicative of bound functions in JavaScript.
+
+##### Parameters
+
+*   `value` **any** The value to be checked, typically a function.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Returns `true` if the value is a bound function,
+otherwise `false`. Bound functions have a specific format in their
+string representation and do not have their own `prototype` property.
+
+### ObjectExtensions
+
+`ObjectExtensions` is a patch for the JavaScript built-in `Object` class.
+It adds utility methods to the `Object` class without modifying the global
+namespace directly. This patch includes methods for key validation, object
+type checking, and retrieving the string tag of an object. These methods
+are useful for enhancing the capabilities of the standard `Object` class
+with additional utility functions.
+
+#### isNullDefined
+
+The function checks if a value is either `undefined` or `null`.
+
+##### Parameters
+
+*   `value` **any** The parameter "value" is a variable that can hold
+    any value.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `true` if the value is either `undefined` or `null`,
+and `false` otherwise.
+
+#### hasStringTag
+
+Checks to see if the supplied `value` is both an object, and has the
+appropriate symbol defined.
+
+##### Parameters
+
+*   `value` **any** the value to determine if it contains a defined
+    `Symbol.toStringTag` defined.
+
+Returns **any** true if the symbol is defined, false otherwise
+
+#### getStringTag
+
+Retrieves the string tag of an object. The string tag is a representation
+of the object's type, as defined by its `Object.prototype.toString`
+method. This utility method is helpful for getting a more descriptive
+type of an object than what is returned by the `typeof` operator,
+especially for custom objects.
+
+##### Parameters
+
+*   `value` **any** The object whose string tag is to be retrieved.
+*   `strict` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** if this is set to true, undefined will be
+    returned whenever a supplied object does not have a
+    `Symbol.toStringTag` defined, period. if false, the default, (optional, default `false`)
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The string tag of the object, indicating its type.
+
+#### getType
+
+Determines the type of the given value based on its string tag. This method
+uses `Object.getStringTag` to obtain the string tag of the value, which
+represents its more specific type (e.g., Array, Map, Set) rather than just
+'object'. The method then maps this string tag to the corresponding type
+present in the provided `owner` object, which defaults to `globalThis`.
+This utility method is especially useful for identifying the specific
+constructor or class of an object, beyond the basic types identified by
+the `typeof` operator.
+
+##### Parameters
+
+*   `value` **any** The value whose type is to be determined.
+*   `owner` **[object](#object)** The object in which to look up the
+    constructor corresponding to the string tag. Defaults to `globalThis`,
+    which covers global constructors like `Array`, `Object`, etc. (optional, default `globalThis`)
+
+Returns **([Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function) | [object](#object) | null | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** Returns the constructor or
+type of the value based on its string tag. For 'Null' and 'Undefined',
+it returns `null` and `undefined`, respectively. For other types, it
+returns the corresponding constructor (e.g., `Array` for arrays) if
+available in the `owner` object.
+
+#### isObject
+
+Determines if the provided value is an object. This method checks whether
+the value is an instance of `Object` or if its type is 'object'. It's a
+utility method for type-checking, ensuring that a value is an object
+before performing operations that are specific to objects.
+
+##### Parameters
+
+*   `value` **any** The value to be checked.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Returns `true` if the value is an object,
+otherwise `false`.
+
+#### isPrimitive
+
+Checks to see if the supplied value is a primitive value.
+
+##### Parameters
+
+*   `value` **any** the value to test to see if it is a primitive value type
+
+Returns **any** true if the object is considered widely to be a primitive value,
+false otherwise.
+
+#### isValidKey
+
+Checks if the given value is a valid key for an object. In JavaScript, a
+valid key can be either a string or a symbol. This method is useful for
+validating object keys before using them in operations like setting or
+getting object properties.
+
+##### Parameters
+
+*   `value` **any** The value to be checked.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Returns `true` if the value is a valid object key
+(string or symbol), otherwise `false`.
+
+#### stripTo
+
+Strips an object down to only the keys specified. Optionally, any
+accessors can be made to retain their context on the source object.
+
+##### Parameters
+
+*   `object` **[object](#object)** the object to pare down
+*   `keys` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [symbol](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol))>** the keys that should appear in the
+    final reduced object
+*   `bindAccessors` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** if this value is true then any
+    accessors from the source object will continue to have their `this`
+    value bound to the source. If the getter or setter on that object is
+    defined using an arrow function, this will not work as intended. (optional, default `true`)
+
+Returns **[object](#object)** an object containing only the keys and symbols
+specified in the `keys` parameter.
+
+### stripTo
+
+Strips an object down to only the keys specified. Optionally, any
+accessors can be made to retain their context on the source object.
+This is a passthrough to the static [Object.stripTo](Object.stripTo) function
+
+#### Parameters
+
+*   `keys` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [symbol](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol))>** the keys that should appear in the
+    final reduced object
+*   `bindAccessors` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** if this value is true then any
+    accessors from the source object will continue to have their `this`
+    value bound to the source. If the getter or setter on that object is
+    defined using an arrow function, this will not work as intended. (optional, default `true`)
+
+Returns **[object](#object)** an object containing only the keys and symbols
+specified in the `keys` parameter.
+
+### getKey
+
+The function `getKey` returns the key associated with a given value
+in a map.
+
+#### Parameters
+
+*   `value` **any** The value parameter is the value that you want to
+    find the corresponding key for in the map.
+*   `strict`  The "strict" parameter is a boolean value that
+    determines whether strict equality (===) or loose equality (==) should
+    be used when comparing the "value" parameter with the values in the
+    entries of the object. If "strict" is set to true, strict equality will
+    be used. (optional, default `true`)
+
+Returns **any** the key associated with the given value. If a matching key is
+found, it is returned. If no matching key is found, null is returned.
+
+### ReflectExtensions
+
+The `ReflectExtensions` class is a patch applied to the built-in JavaScript
+`Reflect` object. It extends `Reflect` with additional utility methods that
+enhance its capabilities. These methods provide more advanced ways of
+interacting with object properties, such as checking for the presence of
+multiple keys at once (`hasAll`) or verifying if at least one specified key
+exists in an object (`hasSome`). This class is part of the `@nejs/extension`
+library and is designed to offer these extended functionalities in a way
+that is consistent with the existing `Reflect` API, making it intuitive for
+developers who are already familiar with standard reflection methods in
+JavaScript.
+
+#### hasAll
+
+The function checks if an object has all the specified keys.
+
+##### Parameters
+
+*   `object`  The `object` parameter is the object that we want to
+    check if it has all the specified keys.
+*   `keys` **...any** The `keys` parameter is a rest parameter, which means
+    it can accept any number of arguments. In this case, it is expected
+    to receive multiple keys as arguments.
+
+Returns **any** a boolean value.
+
+#### ownDescriptors
+
+Fetches all descriptors of an object, including those mapped to a
+symbol descriptor value.
+
+##### Parameters
+
+*   `object` **[object](#object)** the object from whose descriptors need to be
+    retrieved.
+
+<!---->
+
+*   Throws **[TypeError](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypeError)** if the supplied `object` is null or not an object
+    a TypeError exception will be thrown
+
+Returns **[object](#object)** with keys mapped to object descriptors
+
+#### hasSome
+
+The function checks if an object has at least one of the specified keys.
+
+##### Parameters
+
+*   `object`  The `object` parameter is the object that we want to check
+    for the presence of certain keys.
+*   `keys` **...any** The `keys` parameter is a rest parameter, which means it can
+    accept any number of arguments. These arguments are the keys that we want
+    to check if they exist in the `object`.
+
+Returns **any** The function `hasSome` returns a boolean value indicating whether
+at least one of the keys provided as arguments exists in the given object.
+
+#### entries
+
+Retrieves an array of \[key, descriptor] pairs for each property of the
+provided object. This method is akin to `Object.entries` but includes
+property descriptors instead of the property values. It's useful for cases
+where you need detailed information about properties, including their
+configurability, enumerability, and accessors.
+
+##### Parameters
+
+*   `object` **[object](#object)** The object whose property entries are to be
+    retrieved.
+
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** An array of \[key, descriptor] pairs, where each pair
+consists of the property name (key) and its descriptor. Returns an empty
+array if the input is not a valid object.
+
+#### values
+
+Retrieves an array of values from the property descriptors of the given
+object. This method works similarly to `Object.values` but operates on
+property descriptors instead. It's useful when you need the values of
+properties including getters, setters, and other descriptor-specific
+attributes.
+
+##### Parameters
+
+*   `object` **[object](#object)** The object whose property values are to be
+    retrieved.
+
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** An array of values extracted from the object's property
+descriptors. The values correspond to the `value` attribute in each
+property's descriptor. Returns an empty array if the input is not a valid
+object.
+
+### StringExtensions
+
+`StringExtensions` is a patch for the JavaScript built-in `String` class. It
+adds utility methods to the `String` class without modifying the global namespace
+directly. This patch includes methods for key validation, object type checking,
+and retrieving the string tag of an object. These methods are useful for
+enhancing the capabilities of the standard `String` class with additional
+utility functions.
+
+#### isString
+
+The `isString` method does exactly what one would it expect. It returns
+true if the string matches typeof or instanceof as a string.
+
+##### Parameters
+
+*   `value` **any** checks to see if the `value` is a string
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `true` if it is a `String`, `false` otherwise
+
+### SymbolExtensions
+
+`SymbolExtensions` is a patch for the JavaScript built-in `Symbol` class. It
+adds utility methods to the `Symbol` class without modifying the global namespace
+directly. This patch includes methods for key validation, object type checking,
+and retrieving the string tag of an object. These methods are useful for
+enhancing the capabilities of the standard `Symbol` class with additional
+utility functions.
+
+#### isSymbol
+
+The `isSymbol` method does exactly what one would it expect. It returns
+true if the string matches typeof or instanceof as a symbol.
+
+##### Parameters
+
+*   `value` **any** checks to see if the `value` is a string
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `true` if it is a `Symbol`, `false` otherwise
+
+#### isRegistered
+
+Returns true if the supplied value is a Symbol created using
+`Symbol.for()`.
+
+##### Parameters
+
+*   `value` **any** assumption is that the supplied value is of type
+    'symbol' however, unless `allowOnlySymbols` is set to `true`, `false`
+    will be returned for any non-symbol values.
+*   `allowOnlySymbols` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if an error should be thrown
+    if the supplied value is not of type 'symbol' (optional, default `false`)
+
+Returns **any** true if the symbol is registered, meaning, none of the spec
+static symbols (`toStringTag`, `iterator`, etc...), and no symbols
+created by passing a value directly to the Symbol function, such as
+`Symbol('name')`
+
+#### isNonRegistered
+
+A function that returns true if the symbol is not registered, meaning,
+any of the spec static symbols (`toStringTag`, `iterator`, etc...), and
+any symbols created by passing a value directly to the `Symbol` function,
+such as `Symbol('name')`.
+
+##### Parameters
+
+*   `value` **any** assumption is that the supplied value is of type
+    'symbol' however, unless allowOnlySymbols is set to true, false will
+    be returned for any non-symbol values.
+*   `allowOnlySymbols` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if an error should be thrown
+    if the supplied value is not of type 'symbol' (optional, default `false`)
+
+Returns **any** true if the symbol is not registered, meaning, any of the
+spec static symbols (`toStringTag`, `iterator`, etc...), and any symbols
+created by passing a value directly to the `Symbol` function, such as
+`Symbol('name')`
+
+Returns **any** true if the `value` in question is both a `symbol` and has
+returns `undefined` if passed to `Symbol.keyFor`
+
+### ArrayPrototypeExtensions
+
+The `ArrayPrototypeExtensions` patch extends the prototype of the built-in
+JavaScript `Array` with additional properties for convenience and improved
+readability. By applying this patch, all array instances gain new getter
+properties `first` and `last`, which provide quick access to the first and
+last elements of the array, respectively. This enhancement simplifies common
+operations on arrays and makes code more expressive and concise.
+
+#### contains
+
+Sometimes defining even a short function for the invocation of `find`
+can be troublesome. This helper function performs that job for you. If
+the specified element is in the array, `true` will be returned.
+
+##### Parameters
+
+*   `value` **any** the value to search for. This value must triple equals
+    the array element in order to return true.
+
+Returns **any** true if the exact element exists in the array, false otherwise
+
+#### findEntry
+
+The `findEntry` function searches the entries of the object and returns
+the `[index, value]` entry array for the first matching value found.
+
+##### Parameters
+
+*   `findFn` **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** a function that takes the element to be checked
+    and returns a boolean value
+
+Returns **any** if `findFn` returns `true`, an array with two elements, the first
+being the index, the second being the value, is returned.
+
+#### first
+
+A getter property that returns the first element of the array. If the
+array is empty, it returns `undefined`. This property is useful for
+scenarios where you need to quickly access the first item of an array
+without the need for additional checks or method calls.
+
+Returns **any** The first element of the array or `undefined` if the array
+is empty.
+
+#### last
+
+A getter property that returns the last element of the array. It
+calculates the last index based on the array's length. If the array is
+empty, it returns `undefined`. This property is beneficial when you need
+to access the last item in an array, improving code readability and
+avoiding manual index calculation.
+
+Returns **any** The last element of the array or `undefined` if the
+array is empty.
+
+### object
+
+An optionally associated object, usually the parent from which
+the descriptor was taken, or undefined if none was able to be
+derived.
+
+Type: [object](#object)
+
+### constructor
+
+Creates a new instance of Descriptor either from another object or
+around the supplied object descriptor value.
+
+#### Parameters
+
+*   `object` **[object](#object)** either an object descriptor or the object
+    from which to get the descriptor
+*   `key` **([symbol](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol) | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** a valid key for accessing the descriptor
+    on the aforesupplied object.
+
+### isAccessor
+
+Detects whether or not this instance is an accessor object descriptor
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if this object has a getter or setter and is not
+a data descriptor
+
+### isData
+
+Detects whether or not this instance is an data object descriptor
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if this object has a value property and is not
+an accessor descriptor
+
+### isDescriptor
+
+Detects whether or not this instance is a valid object descriptor
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if this descriptor store is a valid descriptor
+
+### configurable
+
+Getter around the `configurable` object descriptor property of
+this instance of Descriptor.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** a boolean value or undefined if the internal
+descriptor store is invalid.
+
+### configurable
+
+Sets the `configurable` value of this object. If the internal descriptor
+store store is invalid, the value is thrown away
+
+#### Parameters
+
+*   `value` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** the value to set for the `configurable` descriptor
+    property. If this value is not a `boolean` it will be converted to one
+
+### enumerable
+
+Getter around the `enumerable` object descriptor property of
+this instance of Descriptor.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** a boolean value or undefined if the internal
+descriptor store is invalid.
+
+### enumerable
+
+Sets the `enumerable` value of this object. If the internal descriptor
+store is invalid, the value is thrown away
+
+#### Parameters
+
+*   `value` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** the value to set for the `enumerable` descriptor
+    property. If this value is not a `boolean` it will be converted to one
+
+### writable
+
+Getter around the `writable` object descriptor property of
+this instance of Descriptor.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** a boolean value or undefined if the internal
+descriptor store is invalid.
+
+### writable
+
+Sets the `writable` value of this object. If the internal descriptor
+store is invalid, the value is thrown away
+
+#### Parameters
+
+*   `value` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** the value to set for the `writable` descriptor
+    property. If this value is not a `boolean` it will be converted to one
+
+### value
+
+Getter around the `value` object descriptor property of
+this instance of Descriptor.
+
+Returns **any** any value stored in this descriptor
+
+### value
+
+Sets the `value` value of this object. If the internal descriptor
+store is invalid, the value is thrown away
+
+#### Parameters
+
+*   `value` **any** the value to set for the `value` descriptor
+    property.
+
+### get
+
+Getter around the `get` object descriptor property of
+this instance of Descriptor.
+
+Returns **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** a function if the getter for this descriptor is
+defined or `undefined` if the internal descriptor object or the getter
+is undefined.
+
+### get
+
+Sets the `get` value of this object. If the internal descriptor
+store is invalid, the value is thrown away
+
+#### Parameters
+
+*   `value` **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** the getter function for this descriptor
+
+### boundGet
+
+Retrieves the [get](get) function for this accessor and binds it to
+the object from which the descriptor was derived, if that value is set.
+Otherwise this method is identical to the [get](get) accessor.
+
+Returns **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** the getter if one is defined. If possible this
+getter will be bound the associated and previously set `object`.
+
+### set
+
+Getter around the `set` object descriptor property of
+this instance of Descriptor.
+
+Returns **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** a function if the setter for this descriptor is
+defined or `undefined` if the internal descriptor object or the setter
+is undefined.
+
+### set
+
+Sets the `set` value of this object. If the internal descriptor
+store is invalid, the value is thrown away
+
+#### Parameters
+
+*   `value` **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** the setter function for this descriptor
+
+### boundSet
+
+Retrieves the [set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set) function for this accessor and binds it to
+the object from which the descriptor was derived, if that value is set.
+Otherwise this method is identical to the [set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set) accessor.
+
+Returns **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** the setter if one is defined. If possible this
+setter will be bound the associated and previously set `object`.
+
+### hasObject
+
+The function checks the descriptor's associated object has been set on this
+instance of `Descriptor`.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `true` if the `object` property has been set,
+`false` otherwise
+
+### object
+
+Returns the descriptor's associated `object` value. This is usually the
+parent object from which the descriptor was derived. If the value is preset
+it will be returned. Undefined will be returned otherwise
+
+Returns **[object](#object)** the associated object for this descriptor or undefined
+if it has not yet been set.
+
+### object
+
+Sets the descriptor's associated `object` value. This is usually the
+parent object from which the descriptor was derived.
+
+#### Parameters
+
+*   `value` **[object](#object)** sets the object for which this descriptor is to
+    be associated with.
+
+### for
+
+The function returns a string representation of a descriptor object with
+additional information about its type when used in the NodeJS repl.
+
+#### Parameters
+
+*   `depth` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** The `depth` parameter is used to specify the
+    maximum depth to which nested objects and arrays will be formatted. If
+    the depth is exceeded, the output will be truncated with ellipses.
+*   `options` **[object](#object)** The `options` parameter is an object that
+    contains various configuration options for the `inspect` function.
+    These options can be used to customize the output of the inspection.
+*   `inspect` **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** The `inspect` parameter is a function that
+    is used to convert an object into a string representation. It is
+    typically used for debugging purposes or when displaying an object's
+    properties.
+
+Returns **any** a string that represents a descriptor. The string includes the
+type of the descriptor (either "Accessor" or "Data") and the result of
+inspecting the descriptor object using the provided options and depth.
+
+### applyTo
+
+Take the descriptor defined by this objects values and apply them to
+the specified object using the specified key.
+
+#### Parameters
+
+*   `object` **[object](#object)** the object to apply this descriptor to
+*   `forKey` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [symbol](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol))** the string or symbol for which this
+    descriptor will abe applied
+
+### toPrimitive
+
+Converts this descriptor object into a base representation
+
+#### Parameters
+
+*   `hint` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** one of `string`, `number` or default;
+
+Returns **any** if the hint is 'string', then a string identifying the enum
+and its type is returned. `number` will always be NaN since it is incoret
+
+### toStringTag
+
+Ensures that the constructor of this object instance's name
+is returned if the string tag for this instance is queried
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the class
+
+### for
+
+Shorthand for Object.getOwnPropertyDescriptor()
+
+#### Parameters
+
+*   `object` **[object](#object)** a non-null object instance
+*   `key` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [symbol](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol))** a symbol or string referencing which key on the
+    object to return a descriptor for.
+*   `wrap`   (optional, default `false`)
+
+Returns **any** an object descriptor for the requested field or null
+
+### getData
+
+The function `getData` retrieves the value of a property from an object
+if it exists and is a data property.
+
+#### Parameters
+
+*   `object` **[object](#object)** The "object" parameter is the object from which
+    we want to retrieve data.
+*   `property` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [symbol](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol))** The `property` parameter is the name of
+    the property that you want to retrieve the data from.
+
+Returns **any** either the value of the specified property if it exists and is
+a data property, or undefined if the property does not exist or is not
+a data property.
+
+### getAccessor
+
+The function `getAccessor` checks if an object has a getter/setter accessor
+for a given property and returns the accessor functions if found.
+
+#### Parameters
+
+*   `object`  The `object` parameter is the object from which we want to
+    retrieve the accessor for a specific property.
+*   `property`  The `property` parameter is the name of the property for
+    which we want to get the accessor.
+
+Returns **any** an object that contains the getter and setter functions for the
+specified property of the given object. If the property is an accessor
+property (defined with a getter and/or setter), the returned object will
+also have additional properties such as "accessor" and "descriptor". If
+the property is not found or is not an accessor property, the function
+returns undefined.
+
+### base
+
+The function returns an object with enumerable and configurable properties
+based on the input parameters.
+
+#### Parameters
+
+*   `enumerable`  A boolean value indicating whether the property
+    can be enumerated (listed) when iterating over the object's properties. (optional, default `false`)
+*   `configurable`  The `configurable` parameter determines
+    whether the property can be deleted or its attributes can be modified.
+    If `configurable` is set to `true`, the property can be deleted and its
+    attributes can be changed. If `configurable` is set to `false`, the
+    property cannot be deleted and (optional, default `false`)
+
+Returns **any** An object with the properties `enumerable` and `configurable` is
+being returned. The values of these properties are determined by the
+arguments passed to the `base` function.
+
+### accessor
+
+The function "newAccessor" creates a new property descriptor object with a
+getter and setter function, along with optional enumerable and configurable
+flags.
+
+#### Parameters
+
+*   `getter`  The getter parameter is a function that will be used as the
+    getter for the property. It will be called when the property is accessed.
+*   `setter`  The `setter` parameter is a function that will be used as
+    the setter for the property. It will be called whenever the property is
+    assigned a new value.
+*   `null` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** *   `getter`: A function that will be used as the getter for the
+        property. (optional, default `Descriptor.base()`)
+
+    *   `null.enumerable` &#x20;
+    *   `null.configurable` &#x20;
+
+Returns **any** an object with properties "get", "set", "enumerable", and
+"configurable".
+
+### data
+
+The function "newData" creates a new data object with customizable
+properties.
+
+#### Parameters
+
+*   `value`  The value parameter represents the value that will be
+    assigned to the property.
+*   `writable`  The `writable` parameter determines whether the
+    value of the property can be changed. If `writable` is set to `true`, the
+    value can be changed. If `writable` is set to `false`, the value cannot be
+    changed. (optional, default `true`)
+*   `null` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** *   `value`: The value to be assigned to the property. (optional, default `Descriptor.base()`)
+
+    *   `null.enumerable` &#x20;
+    *   `null.configurable` &#x20;
+
+Returns **any** an object with properties `value`, `enumerable`, `writable`, and
+`configurable`.
+
+### isDescriptor
+
+The function checks if an object is a likely an object descriptor in
+JavaScript. This is determined as an object with some of the known
+descriptor keys (e.g. enumerable, configurable, value, writable, get,
+or set). Technically, any object could serve as a descriptor but this
+function only returns true if known descriptor keys are found.
+
+#### Parameters
+
+*   `object`  The `object` parameter is the object that we want to
+    check if it is a descriptor.
+
+Returns **any** a boolean value.
+
+### isData
+
+The function checks if a given property or descriptor is a data property.
+
+brie
+
+#### Parameters
+
+*   `object_orProp` &#x20;
+*   `property` &#x20;
+*   `descriptor_orProp`  The `descriptor_orProp` parameter can be
+    either a descriptor or a property name.
+*   `object`  The `object` parameter is the object that you want to
+    check for data properties.
+
+Returns **any** a boolean value. It returns `true` if the `descriptor` object
+has any keys that match the `DATA_KEYS` array, otherwise it returns
+`false`.
+
+### isAccessor
+
+The function checks if a given property descriptor or property of an
+object is an accessor.
+
+#### Parameters
+
+*   `object_orProp`  The `descriptor_orProp` parameter can be either a
+    descriptor object or a property name.
+*   `property`  The `object` parameter is the object that you want to
+    check for accessor properties.
+
+Returns **any** a boolean value. It returns true if the descriptor or property
+passed as an argument is an accessor descriptor, and false otherwise.
+
+### flexible
+
+A base descriptor (new for each read) that is both enumerable and
+configurable
+
+Returns **any** The method `flexible` is returning the result of calling the
+`base` method with the arguments `true` and `true`.
+
+### enigmatic
+
+A base descriptor (new for each read) that is not enumerable but is
+configurable
+
+Returns **any** The method `enigmatic` is returning the result of calling
+the `base` method with the arguments `false` and `true`.
+
+### intrinsic
+
+A base descriptor (new for each read) that is neither enumerable
+nor configurable
+
+Returns **any** The code is returning the result of calling the `base` method with
+the arguments `false` and `false`.
+
+### transparent
+
+A base descriptor (new for each read) that enumerable but not configurable
+
+Returns **any** The method is returning the result of calling the `base`
+method with the arguments `true` and `false`.
+
+### SHARED\_KEYS
+
+The function returns an array of shared descriptor keys.
+
+Returns **any** An array containing the strings 'configurable' and 'enumerable'.
+
+### ACCESSOR\_KEYS
+
+The function returns an array of accessor descriptor keys.
+
+Returns **any** An array containing the strings 'get' and 'set' is being returned.
+
+### DATA\_KEYS
+
+The function returns an array of data descriptor keys.
+
+Returns **any** An array containing the strings 'value' and 'writable' is being
+returned.
+
+### maskAs
+
+Transforms an object to mimic a specified prototype, altering its type
+conversion and inspection behaviors. This function is especially useful
+for creating objects that need to behave like different primitive types
+under various operations.
+
+#### Parameters
+
+*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The object to be transformed.
+*   `classPrototype` &#x20;
+*   `options` &#x20;
+*   `prototype` **([Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function) | [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object))** The prototype or
+    class to emulate. If a function is provided, its prototype is used.
+    Defaults to String.prototype. (optional, default `String.prototype`)
+*   `toPrimitive` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** A function
+    defining how the object should be converted to a primitive value. It
+    receives a type hint ('number', 'string', or 'default') and the object,
+    returning the primitive value. (optional, default `(hint,val)=>String(val)`)
+
+Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | null)** The transformed object, or null if neither a class
+nor a prototype could be derived from the provided prototype parameter.
+
+### maskAsString
+
+Masks an object as a string-like object by setting its prototype to
+String and defining how it converts to primitive types. This is
+particularly useful when an object needs to behave like a string in
+certain contexts, such as type coercion or logging.
+
+#### Parameters
+
+*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The object to be masked as a string.
+*   `stringKey` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The object property key used for
+    the string representation. Defaults to 'value'. (optional, default `'value'`)
+*   `toPrimitive` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** Optional custom function for primitive
+    conversion. If omitted, a default function handling various conversion
+    hints is used.
+
+Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | null)** The string-masked object, or null if the object
+doesn't have the specified stringKey property.
+
+### maskAsNumber
+
+Masks an object as a number-like object. This allows the object to
+behave like a number in operations like arithmetic and type coercion.
+It sets the prototype to Number and defines custom conversion behavior.
+
+#### Parameters
+
+*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The object to be masked as a number
+    representation. Defaults to 'value'.
+*   `numberKey` &#x20;
+*   `toPrimitive` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** Optional custom function for primitive
+    conversion. If not provided, a default function handling different
+    conversion hints is used.
+
+Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | null)** The number-masked object, or null if the object
+doesn't have the specified numberKey property.
+
+### GenericMask
+
+Generates options for generic masking of an object, providing defaults for
+prototype and toPrimitive function if not specified.
+
+#### Parameters
+
+*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options object including prototype,
+    targetKey, and toPrimitive function.
+
+    *   `options.prototype` &#x20;
+    *   `options.targetKey`   (optional, default `'value'`)
+    *   `options.toPrimitive` &#x20;
+
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options object with defaults applied as necessary.
+
+### StringMask
+
+Generates options for string masking of an object, providing a default
+toPrimitive function if not specified.
+
+#### Parameters
+
+*   `targetKey` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The object property key for string
+    representation.
+*   `toPrimitive` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Custom function for primitive conversion.
+
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for string masking.
+
+### NumberMask
+
+Generates options for number masking of an object, providing a default
+toPrimitive function if not specified.
+
+#### Parameters
+
+*   `targetKey` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The object property key for number
+    representation.
+*   `toPrimitive` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Custom function for primitive conversion.
+
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for number masking.
+
+### RefSet
+
+**Extends Set**
+
+RefSet class extends the standard Set object to manage a collection of
+WeakRef objects. It provides additional functionality such as objectification
+of values and various utility methods.
+
+Unlike standard Sets or Arrays, RefSet stores weak references to objects,
+allowing them to be garbage-collected if there are no other references to
+them. This behavior is different from Arrays and standard Sets, which
+maintain strong references to their elements.
+
+#### objectifying
+
+Method to control whether the RefSet should objectify its values. When
+objectifying, primitive values (number, string, boolean, bigint) are
+converted to their respective object types, which allows them to be used as
+WeakRef targets.
+
+##### Parameters
+
+*   `setObjectification` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Flag to enable or disable
+    objectification. (optional, default `true`)
+
+Returns **[RefSet](#refset)** The current RefSet instance to allow method chaining.
+
+#### objectifyValues
+
+Returns the state indicating whether or not `RefSet` will attempt to
+convert non-valid primitives into targets that are valid input for
+new `WeakRef` object instances. If this value is `false` then no
+*objectification* will occur.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** The current state of objectifyValues.
+
+#### objectifyValues
+
+Setting this value to true, will cause all added values to the Set to
+be analyzed for validity as a candidate to be wrapped in a `WeakRef`
+object. If true, and if possible, the object will be turned into an
+`Object` variant first. This will also enable less rigid variable
+comparison in the `.has()` method (i.e. `==` instead of `===`).
+
+##### Parameters
+
+*   `value` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** The new state to set for objectifyValues.
+
+#### add
+
+Overrides the add method of Set. Adds a value to the RefSet, converting it
+to a WeakRef. Throws an error if the value is not a valid WeakRef target
+(e.g., null, undefined, or a registered symbol). If `objectifyValues` is
+enabled, an attempt to convert primitives to their object variants will be
+made. These are numbers, strings, boolean values and big integers.
+
+##### Parameters
+
+*   `value` **any** The value to be added to the RefSet.
+
+<!---->
+
+*   Throws **[TypeError](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypeError)** If the value is not a valid WeakRef target.
+
+#### addAll
+
+Adds multiple values to the RefSet. The supplied `values` should be
+iterable and truthy. This function defers to `.add()` for its logic so
+each value from the supplied collection of values will also be subject
+to the criteria of that function.
+
+##### Parameters
+
+*   `values` **[Iterable](#iterable)** An iterable of values to add to the RefSet.
+
+<!---->
+
+*   Throws **[TypeError](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypeError)** If the supplied values are falsey or non-iterable.
+
+#### clean
+
+Removes all elements from the RefSet that have been garbage collected
+(i.e., their WeakRef no longer points to an object).
+
+Returns **[RefSet](#refset)** The current RefSet instance to allow method chaining.
+
+#### entries
+
+Executes a provided function once for each value in the RefSet. The callback
+function receives the dereferenced value, the value again (as RefSet doesn't
+use keys), and the RefSet itself. This method provides a way to iterate over
+and apply operations to the values stored in the RefSet, taking into account
+that they are weak references and may have been garbage-collected.
+
+##### Parameters
+
+*   `forEachFn` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Function to execute for each element. It
+    takes three arguments: element, element (again, as RefSet has no key), and
+    the RefSet itself.
+*   `thisArg` **any** Value to use as `this` when executing `forEachFn`.
+
+#### forEach
+
+Iterate over the items in the set and pass them to the supplied
+function ala `Array.prototype.forEach`. Note however, there are no
+indexes on Sets and as such, the index parameter of the callback
+will always be `NaN`. Subsequently the `array` or third parameter
+will receive the set instance rather than an array.
+
+##### Parameters
+
+*   `forEachFn` **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** the function to use for each element in
+    the set.
+*   `thisArg` **[object](#object)** the `this` argument to be applied to each
+    invocation of the `forEachFn` callback. Note, this value is unable
+    to be applied if the `forEachFn` is a big arrow function
+
+#### values
+
+Returns an iterator for the values in the RefSet. Each value is
+dereferenced from its WeakRef before being returned. This method allows
+iterating over he set's values, similar to how one would iterate over
+values in a standard Set or Array, but with the understanding that the
+values are weakly referenced and may no longer exist (in which case
+they are skipped).
+
+Returns **[Iterator](#iterator)** An iterator for the values.
+
+#### keys
+
+Returns an iterator for the keys of the RefSet. In RefSet, keys and
+values are identical, so this method behaves the same as `values()`. It
+provides compatibility with the standard Set interface and allows use in
+contexts where keys are expected, despite RefSet not differentiating
+between keys and values.
+
+Returns **[Iterator](#iterator)** An iterator for the keys.
+
+#### has
+
+Determines whether an element with the specified value exists in the
+`RefSet`. For non-objectified sets, this method checks if the dereferenced
+values of the set include the specified value.
+
+For objectified sets, it uses the `contains` method which accounts for
+the objectification. This method differs from standard Set `has` in that
+it works with weak references and considers objectification settings.
+
+##### Parameters
+
+*   `value` **any** The value to check for presence in the RefSet.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** True if an element with the specified value exists
+in the RefSet, false otherwise.
+
+#### contains
+
+Checks if the RefSet contains a value that is equal to the specified
+value. This method is used primarily in objectified RefSets to determine
+the presence of a value, taking into account objectification. It differs
+from the `has` method in that it's tailored for sets that have
+transformed their primitive values into objects, whereas `has` is more
+general-purpose.
+
+##### Parameters
+
+*   `value` **any** The value to search for in the RefSet.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** True if the RefSet contains the value, false otherwise.
+
+#### filter
+
+Creates a new array with all elements that pass the test implemented by
+the provided function. This method iterates over each element,
+dereferences it, and applies the filter function. Unlike Array `filter`,
+the callback receives the dereferenced value and not an index or array,
+reflecting the non-indexed nature of RefSet. Useful for selectively
+creating arrays from the set based on certain conditions, especially when
+dealing with weak references.
+
+##### Parameters
+
+*   `filterFn` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Function to test each element of the RefSet.
+    The function receives the dereferenced value.
+*   `thisArg` **any** Value to use as `this` when executing `filterFn`.
+
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** A new array with the elements that pass the test.
+
+#### find
+
+Returns the value of the first element in the RefSet that satisfies the
+provided testing function. Similar to Array `find`, this method iterates
+over the RefSet, dereferencing each value and applying the testing
+function. The non-indexed nature of RefSet is considered, as the
+callback does not receive an index. This method is useful for finding a
+specific element based on a condition.
+
+##### Parameters
+
+*   `findFn` &#x20;
+*   `thisArg` **any** Value to use as this when executing findFn.
+
+Returns **any** The value of the first element in the RefSet that satisfies
+the testing function, or undefined if none found.
+
+Returns **any** the dereferenced value if found, or undefined otherwise
+
+#### map
+
+Creates a new array or `RefSet` with the results of calling a provided
+function on every element in the calling `RefSet`. This method dereferences
+each value, applies the `mapFn`, and collects the results. If `toRefSet` is
+`true`, a new `RefSet` is returned; otherwise, an array. This method
+differs from `Array.map` in handling weak references and the potential to
+return a new `RefSet` instead of an array.
+
+##### Parameters
+
+*   `mapFn` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Function that produces an element of the new
+    array or `RefSet`, taking three arguments.
+*   `thisArg` **any** Value to use as this when executing mapFn.
+*   `toRefSet` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Determines if the output should be a new
+    `RefSet` (`true`) or an array (`false`).
+*   `mirrorObjectification` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** If `true` and `toRefSet` is
+    `true`, the new `RefSet` mirrors the objectification setting of the
+    original.
+
+Returns **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array) | [RefSet](#refset))** A new array or `RefSet` with each element being
+the result of the `mapFn`.
+
+#### toStringTag
+
+Ensures that the constructor of this object instance's name
+is returned if the string tag for this instance is queried
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the class
+
+### RefMap
+
+**Extends Map**
+
+RefMap class extends the standard Map object to manage a collection of
+WeakRef values mapped to strong keys. It provides additional functionality
+such as objectification of values and various utility methods.
+
+Unlike standard Maps or Objects, RefMap stores weak references to objects,
+allowing them to be garbage-collected if there are no other references to
+them. This behavior is different from Maps and standard Objects, which
+maintain strong references to their elements.
+
+#### Parameters
+
+*   `args` **...any**&#x20;
+
+#### objectifying
+
+Method to control whether the RefMap should objectify its values. When
+objectifying, primitive values (number, string, boolean, bigint) are
+converted to their respective object types, which allows them to be used as
+WeakRef targets.
+
+##### Parameters
+
+*   `setObjectification` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Flag to enable or disable
+    objectification. (optional, default `true`)
+
+Returns **[RefMap](#refmap)** The current RefMap instance to allow method chaining.
+
+#### asObject
+
+The function converts a JavaScript Map object into a regular JavaScript
+object, handling invalid keys by converting them to strings.
+
+Returns **[object](#object)** an object; keys that are not either a `String` or a
+`Symbol` will be converted to a string.
+
+#### objectifyValues
+
+Returns the state indicating whether or not `RefMap` will attempt to
+convert non-valid primitives into targets that are valid input for
+new `WeakRef` object instances. If this value is `false` then no
+*objectification* will occur.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** The current state of objectifyValues.
+
+#### objectifyValues
+
+Setting this value to true, will cause all set values to the Map to
+be analyzed for validity as a candidate to be wrapped in a `WeakRef`
+object. If true, and if possible, the object will be turned into an
+`Object` variant first.
+
+##### Parameters
+
+*   `value` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** The new state to set for objectifyValues.
+
+#### get
+
+The `get` function retrieves a value from a map and returns it, or returns a
+default value if the value is null or undefined. The actual retrieved value
+is a dereferenced `WeakRef`. If the result is `undefined` and this is not the
+expected response, it is likely the value has been garbage collected.
+
+##### Parameters
+
+*   `key` **any** The key parameter is the key of the value you want to
+    retrieve from the data structure.
+*   `defaultValue` **any** The `defaultValue` parameter is the value that
+    will be returned if the key does not exist in the map or if the value
+    associated with the key has been garbage collected (i.e., it no longer
+    exists).
+
+Returns **any** The method is returning the value associated with the given key.
+If the value is not found or if it has been garbage collected (deref()
+returns null), then the defaultValue is returned.
+
+#### set
+
+Overrides the set method of `Map`. Adds a value to the `RefMap`,
+converting it to a `WeakRef`. Throws an error if the value is not a
+valid `WeakRef` target (e.g., `null`, `undefined`, or a registered
+`symbol`). If [objectifyValues](objectifyValues) is enabled, an attempt to convert
+primitives to their object variants will be made. These are `numbers`,
+`strings`, `boolean` values and `bigint`s.
+
+##### Parameters
+
+*   `key` **any** The `key` to be set on the `RefMap`
+*   `value` **any** The value to be associated with the `key`
+
+<!---->
+
+*   Throws **[TypeError](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypeError)** If the value is not a valid WeakRef target.
+
+#### setAll
+
+Sets multiple values at a single time. The format is an array of array
+or rather an array of [Object.entries](Object.entries) (for example,
+`[[key1,value1], [key2,value2]]`). For each entry pair, if the length
+is not 2, either missing a key or value, it will be skipped.
+
+##### Parameters
+
+*   `entries` &#x20;
+*   `values` **[Iterable](#iterable)** An iterable of values to add to the RefMap.
+
+<!---->
+
+*   Throws **[TypeError](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypeError)** If the supplied values are falsey or non-iterable.
+
+Returns **RepMap** returns `this` to allow for chaining
+
+#### clean
+
+Removes all elements from the RefMap that have been garbage collected
+(i.e., their WeakRef no longer points to an object).
+
+Returns **[RefMap](#refmap)** The current RefMap instance to allow method chaining.
+
+#### entries
+
+Executes a provided function once for each value in the RefMap. The callback
+function receives the dereferenced value, the value again (as RefMap doesn't
+use keys), and the RefMap itself. This method provides a way to iterate over
+and apply operations to the values stored in the RefMap, taking into account
+that they are weak references and may have been garbage-collected.
+
+##### Parameters
+
+*   `forEachFn` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Function to execute for each element. It
+    takes three arguments: element, element (again, as RefMap has no key), and
+    the RefMap itself.
+*   `thisArg` **any** Value to use as `this` when executing `forEachFn`.
+
+#### forEach
+
+Iterate over the items in the map and pass them to the supplied
+function ala `Map.prototype.forEach`. Note however, there are no
+indexes on Maps and as such, the index parameter of the callback
+will always be the value's key. Subsequently the `array` or third
+parameter will receive the map instance rather than an array.
+
+##### Parameters
+
+*   `forEachFn` **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** the function to use for each element in
+    the set.
+*   `thisArg` **[object](#object)** the `this` argument to be applied to each
+    invocation of the `forEachFn` callback. Note, this value is unable
+    to be applied if the `forEachFn` is a big arrow function
+
+#### values
+
+Returns an iterator for the values in the RefMap. Each value is
+dereferenced from its WeakRef before being returned. This method allows
+iterating over he set's values, similar to how one would iterate over
+values in a standard Map or Array, but with the understanding that the
+values are weakly referenced and may no longer exist (in which case
+they are skipped).
+
+Returns **[Iterator](#iterator)** An iterator for the values.
+
+#### hasValue
+
+Determines whether an element with the specified value exists in the
+`RefMap`. For non-objectified sets, this method checks if the dereferenced
+values of the map include the specified value.
+
+For objectified sets, strict is set to false which uses loose
+equality to allow for things like `Object(5)` to equal `5`. This is important
+because otherwise primitives could not be weakly referenced. In the grand
+scheme of things, this is only useful if the objectified value is the
+one being referenced.
+
+##### Parameters
+
+*   `value` **any** The value to check for presence in the RefMap.
+*   `strict` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** if `true`, the default, then the supplied value
+    is hard compared to the dereferenced value (`===`). If `false`, then a
+    loose comparison is used (`==`) (optional, default `true`)
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** True if an element with the specified value exists
+in the RefMap, false otherwise.
+
+#### filter
+
+The `filter` function filters the entries of a `RefMap` object based on
+a given filter function. The dereferenced entries of the values of the map
+will be passed to the function rather than a `WeakRef` itself.
+
+A new resulting entry set will be generated and a new `RefMap` will be made
+from these entries and returned. Note that this function never returns
+`null`
+
+##### Parameters
+
+*   `filterFn` **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** The `filterFn` parameter is a function that
+    will be used to filter the entries in the `RefMap`. It will be called with
+    three arguments: the value of the current entry, the key of the current
+    entry, and the `RefMap` itself. The function should return `true`
+*   `thisArg` **[object](#object)** The `thisArg` parameter is an optional argument
+    that specifies the value to be used as `this` when executing the
+    `filterFn` function. It allows you to explicitly set the context in which
+    the `filterFn` function is called. If `thisArg` is not provided, \`this
+
+Returns **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** The `filter` method is returning an array of filtered map
+entries
+
+#### find
+
+The `find` function iterates over a map and calls a given function on
+each value, returning the first value for which the function returns
+a truthy value.
+
+The function signature of `findFn` is
+
+    function findFn(value, key, map)
+
+'value' is passed to findFn up to two times; first with the `WeakRef`
+value, second with the result of [WeakRef.deref](WeakRef.deref). If `findFn`
+returns true for either of these the dereferenced value will be
+returned from the call to [RefMap.find](RefMap.find).
+`key` represents the key object that the value is mapped to.
+`map` is simply a reference to `this` map.
+
+##### Parameters
+
+*   `findFn`  `findFn` is a function that will be called for each
+    element in the map. It takes three arguments: `ref`, `key`, and `map`;
+    where `ref` is the value of the current element in the map, `key` is
+    the key of the current element, and `map` is a reference to the instance
+    being searched.
+*   `thisArg`  The `thisArg` parameter is the value to be used as
+    the `this` value when executing the `findFn` function. It allows you
+    to specify the context in which the `findFn` function should be called.
+
+Returns **any** the first dereferenced value that satisfies the condition
+specified by the `findFn` function. If no value satisfies the condition,
+it returns `null`.
+
+#### map
+
+Creates a new array or `RefMap` with the results of calling a provided
+function on every element in the calling `RefMap`. This method dereferences
+each value, applies the `mapFn`, and collects the results. If `toRefMap` is
+`true`, a new `RefMap` is returned; otherwise, an array. This method
+differs from `Array.map` in handling weak references and the potential to
+return a new `RefMap` instead of an array.
+
+##### Parameters
+
+*   `mapFn` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Function that produces an element of the new
+    array or `RefMap`, taking three arguments.
+*   `thisArg` **any** Value to use as this when executing mapFn.
+*   `toRefMap` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Determines if the output should be a new
+    `RefMap` (`true`) or an array (`false`).
+*   `mirrorObjectification` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** If `true` and `toRefMap` is
+    `true`, the new `RefMap` mirrors the objectification setting of the
+    original.
+
+Returns **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array) | [RefMap](#refmap))** A new array or `RefMap` with each element being
+the result of the `mapFn`.
+
+#### iterator
+
+The function returns an iterator that iterates over the entries of an object,
+dereferencing any weak references.
+
+Returns **[Iterator](#iterator)** A new iterator object is being returned.
+
+#### toStringTag
+
+Ensures that the constructor of this object instance's name
+is returned if the string tag for this instance is queried
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the class
+
+### isValidReference
+
+A static method to check if a given value is a valid target for a WeakRef.
+
+#### Parameters
+
+*   `value` **any** The value to check for validity as a WeakRef target.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** True if the value is a valid WeakRef target,
+false otherwise.
+
+### AsyncIterable
+
+The AsyncIterable class extends the concept of Iterable to asynchronous
+operations. It allows creating iterable objects where each element can be
+an asynchronous entity, like a Promise. This class is particularly useful
+when dealing with asynchronous data sources, such as API responses, file
+reading in chunks, or any other data that is not immediately available but
+arrives over time.
+
+#### Parameters
+
+*   `elementsOrFirstElement` **([Iterable](#iterable) | [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise) | any)** An iterable object,
+    a Promise, or the first element.
+*   `moreElements` **...([Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise) | any)** Additional elements if the first
+    argument is not an iterable.
+
+#### asyncIterator
+
+Implements the async iterable protocol. When an instance of AsyncIterable
+is used in a `for await...of` loop, this async generator function is
+invoked. It yields each element as a Promise, allowing asynchronous
+iteration. Elements that are not Promises are automatically wrapped in
+a resolved Promise to ensure consistency.
+
+Returns **AsyncGenerator** An async generator that yields each element as
+a Promise.
+
+#### toStringTag
+
+Ensures that the constructor of this object instance's name
+is returned if the string tag for this instance is queried
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the class
+
+#### isAsyncIterable
+
+Checks if a given value is an async iterable. This method determines if
+the provided value has a `Symbol.asyncIterator` property that is an async
+generator function. It's a precise way to identify if the value conforms
+to the async iterable protocol using an async generator function.
+
+Note: This method specifically checks for async generator functions. Some
+async iterables might use regular async functions that return an async
+iterator, which this method won't identify.
+
+##### Parameters
+
+*   `value` **any** The value to be checked for async iterability.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Returns true if the value is an async iterable
+implemented using an async generator function, false otherwise.
+
+### AsyncIterator
+
+Being able to create a compliant `AsyncIterator` around any type of
+iterable object. This can be wrapped around any type of object that
+has a `[Symbol.asyncIterator]` property assigned to a generator
+function.
+
+#### Parameters
+
+*   `asyncIterable` **[object](#object)** any object that has a
+    `[Symbol.asyncIterable]` property assigned to a generator function.
+
+#### asArray
+
+Returns a new `Array` derived from the iterable this object
+wraps.
+
+Returns **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** a new `Array` generated from the wrapped
+iterable. The method is generated from using an async for of
+loop.
+
+#### asyncIterable
+
+Returns the actual iterable object passed to the constructor that
+created this instance.
+
+Returns **[object](#object)** the object containing the `[Symbol.iterator]`
+
+#### next
+
+The function retrieves the next value in the iterator. If the
+the iterator has run its course, `reset()` can be invoked to
+reset the pointer to the beginning of the iteration.
+
+Returns **any** the next value
+
+#### reset
+
+Resets the async iterator to the beginning allowing it to be
+iterated over again.
+
+#### asyncIterator
+
+The existence of this symbol on the object instances, indicates that
+it can be used in `for(.. of ..)` loops and its values can be
+extracted from calls to `Array.from()`
+
+Returns **[AsyncIterable](#asynciterable)** this is returned since this object is already
+conforming to the expected JavaScript AsyncIterator interface
+
+#### toStringTag
+
+Ensures that the constructor of this object instance's name
+is returned if the string tag for this instance is queried
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the class
+
+### Iterable
+
+The Iterable class is designed to provide a convenient way to create synchronous
+iterable objects. It can be initialized with either an array or individual elements.
+This class implements the iterable protocol, allowing instances to be used with
+`for...of` loops and other standard JavaScript iteration mechanisms.
+
+#### Parameters
+
+*   `elementsOrFirstElement` **([Iterable](#iterable) | any)** An iterable object or the
+    first element.
+*   `moreElements` **...any** Additional elements if the first argument is
+    not an iterable.
+
+#### iterator
+
+Implements the iterable protocol. When an instance of Iterable is used
+in a `for...of` loop or spread syntax, this generator function is invoked
+to yield the elements one by one in a synchronous manner.
+
+Returns **Generator** A generator that yields each element of the iterable.
+
+#### asArray
+
+Provides access to the elements as a standard array. Useful for scenarios
+where array methods and behaviors are needed.
+
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** An array containing all the elements of the iterable.
+
+#### toStringTag
+
+Ensures that the constructor of this object instance's name
+is returned if the string tag for this instance is queried
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the class
+
+#### isIterable
+
+Checks if a given value is an iterable. This method determines if the
+provided value has a `Symbol.iterator` property that is a generator
+function. It's a precise way to identify if the value conforms to the
+iterable protocol using a generator function.
+
+Note: This method specifically checks for generator functions. Some
+iterables might use regular functions that return an iterator, which
+this method won't identify.
+
+##### Parameters
+
+*   `value` **any** The value to be checked for iterability.
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Returns true if the value is an iterable implemented
+using a generator function, false otherwise.
+
+### Iterator
+
+Being able to create a compliant `Iterator` around any type of iterable
+object. This can be wrapped around any type of object that has a
+`[Symbol.iterator]` property assigned to a generator function.
+
+#### Parameters
+
+*   `iterable` **[object](#object)** any object that has a `[Symbol.iterator]`
+    property assigned to a generator function.
+*   `mapEach` **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** when provided `mapEach` is a callback that
+    takes an entry as input and receives one as output.
+
+#### asArray
+
+Returns a new `Array` derived from the iterable this object
+wraps.
+
+Returns **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** a new `Array` generated from the wrapped
+iterable. The method is generated from `Array.from()`
+
+#### iterable
+
+Returns the actual iterable object passed to the constructor that
+created this instance.
+
+Returns **[object](#object)** the object containing the `[Symbol.iterator]`
+
+#### next
+
+The function retrieves the next value in the iterator. If the
+the iterator has run its course, `reset()` can be invoked to
+reset the pointer to the beginning of the iteration.
+
+Returns **any** the next value
+
+#### reset
+
+Resets the iterator to the beginning allowing it to be
+iterated over again.
+
+#### iterator
+
+The existence of this symbol on the object instances, indicates that
+it can be used in `for(.. of ..)` loops and its values can be
+extracted from calls to `Array.from()`
+
+Returns **[Iterator](#iterator)** this is returned since this object is already
+conforming to the expected JavaScript Iterator interface
+
+#### toStringTag
+
+Ensures that the constructor of this object instance's name
+is returned if the string tag for this instance is queried
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the class
+
+### mapEach
+
+A private function that when provided has the following signature:
+`function mapEach(entry) -> entry`. This allows any changes to be made
+to each element, conditionally and programmatically, as needed before
+they are returned to the called code.
 
 ## Contributing