@nejs/basic-extensions 1.7.0 → 1.9.0

package/dist/mjs/functionextensions.js

@@ -1,4 +1,6 @@
 import { Patch } from '@nejs/extension';
+import { ObjectExtensions } from './objectextensions.js';
+const { getStringTag } = ObjectExtensions.patches;
 /**
  * The `FunctionExtensions` class is a patch applied to the built-in JavaScript
  * `Function` constructor. It extends `Function` with additional utility methods
@@ -9,6 +11,68 @@ import { Patch } from '@nejs/extension';
  * capabilities of function handling and introspection in JavaScript.
  */
 export const FunctionExtensions = new Patch(Function, {
+    /**
+     * 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.
+     *
+     * @param {*} value - The value to be checked.
+     * @returns {boolean} Returns `true` if the value is an async function,
+     * otherwise `false`.
+     */
+    isAsync(value) {
+        const stringTag = /(\w+)]/g.exec(Object.prototype.toString.call(value))[1];
+        return (value instanceof Function &&
+            stringTag.includes('Async'));
+    },
+    /**
+     * The function checks if a given value is an async generator function
+     *
+     * @param {any} value - The `value` parameter is the value that we want to
+     * check if it is a generator function.
+     * @returns {boolean} `true` if the value is an instance of a function and
+     * its string tag is 'AsyncGeneratorFunction', otherwise it returns `false`.
+     */
+    isAsyncGenerator(value) {
+        const stringTag = getStringTag(value);
+        return (value instanceof Function &&
+            stringTag == 'AsyncGeneratorFunction');
+    },
+    /**
+     * 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.
+     *
+     * @param {*} value - The value to be checked.
+     * @returns {boolean} Returns `true` if the value is an arrow function,
+     * otherwise `false`.
+     */
+    isBigArrow(value) {
+        return (value instanceof Function &&
+            String(value).includes('=>') &&
+            !String(value).startsWith('bound') &&
+            !Reflect.has(value, 'prototype'));
+    },
+    /**
+     * 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.
+     *
+     * @param {*} value - The value to be checked, typically a function.
+     * @returns {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.
+     */
+    isBound(value) {
+        return (value instanceof Function &&
+            String(value).startsWith('bound') &&
+            !Reflect.has(value, 'prototype'));
+    },
     /**
      * 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
@@ -32,22 +96,43 @@ export const FunctionExtensions = new Patch(Function, {
      * otherwise `false`.
      */
     isFunction(value) {
-        return value instanceof Function;
+        return value instanceof Function && !Function.isClass(value);
     },
+    /**
+     * The function checks if a given value is a generator function
+     *
+     * @param {any} value - The `value` parameter is the value that we want to
+     * check if it is a generator function.
+     * @returns {boolean} `true` if the value is an instance of a function and
+     * its string tag is 'GeneratorFunction', otherwise it returns `false`.
+     */
+    isGenerator(value) {
+        const stringTag = getStringTag(value);
+        return (value instanceof Function &&
+            stringTag == 'GeneratorFunction');
+    },
+});
+export const FunctionPrototypeExtensions = new Patch(Function.prototype, {
     /**
      * 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.
      *
-     * @param {*} value - The value to be checked.
      * @returns {boolean} Returns `true` if the value is an async function,
      * otherwise `false`.
      */
-    isAsync(value) {
-        const stringTag = /(\w+)]/g.exec(Object.prototype.toString.call(value))[1];
-        return (value instanceof Function &&
-            stringTag.includes('Async'));
+    get isAsync() {
+        return Function.isAsync(this);
+    },
+    /**
+     * The function checks if a given value is an async generator function
+     *
+     * @returns {boolean} `true` if the value is an instance of a function and
+     * its string tag is 'AsyncGeneratorFunction', otherwise it returns `false`.
+     */
+    get isAsyncGenerator() {
+        return Function.isAsyncGenerator(this);
     },
     /**
      * Checks if a given value is an arrow function. It verifies if the value is
@@ -55,15 +140,11 @@ export const FunctionExtensions = new Patch(Function, {
      * symbol, and if it lacks a prototype, which is a characteristic of arrow
      * functions in JavaScript.
      *
-     * @param {*} value - The value to be checked.
      * @returns {boolean} Returns `true` if the value is an arrow function,
      * otherwise `false`.
      */
-    isBigArrow(value) {
-        return (value instanceof Function &&
-            String(value).includes('=>') &&
-            !String(value).startsWith('bound') &&
-            !Reflect.has(value, 'prototype'));
+    get isBigArrow() {
+        return Function.isBigArrow(this);
     },
     /**
      * Determines if a given value is a bound function. Bound functions are
@@ -73,15 +154,44 @@ export const FunctionExtensions = new Patch(Function, {
      * 'bound', and if it lacks a `prototype` property. These characteristics
      * are indicative of bound functions in JavaScript.
      *
-     * @param {*} value - The value to be checked, typically a function.
      * @returns {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.
      */
-    isBound(value) {
-        return (value instanceof Function &&
-            String(value).startsWith('bound') &&
-            !Reflect.has(value, 'prototype'));
+    get isBound() {
+        return Function.isBound(this);
+    },
+    /**
+     * 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.
+     *
+     * @returns {boolean} Returns `true` if the value is a class, otherwise
+     * `false`.
+     */
+    get isClass() {
+        return Function.isClass(this);
+    },
+    /**
+     * 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.
+     *
+     * @returns {boolean} Returns `true` if the value is a regular function,
+     * otherwise `false`.
+     */
+    get isFunction() {
+        return Function.isFunction(this);
+    },
+    /**
+     * The function checks if a given value is a generator function
+     *
+     * @returns {boolean} `true` if the value is an instance of a function and
+     * its string tag is 'GeneratorFunction', otherwise it returns `false`.
+     */
+    get isGenerator() {
+        return Function.isGenerator(this);
     },
 });
 //# sourceMappingURL=functionextensions.js.map

package/dist/mjs/functionextensions.js.map

@@ -1 +1 @@
-{"version":3,"file":"functionextensions.js","sourceRoot":"","sources":["../../src/functionextensions.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AAEvC;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,KAAK,CAAC,QAAQ,EAAE;IACpD;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAK;QACX,OAAO,KAAK,YAAY,QAAQ,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IACtE,CAAC;IAED;;;;;;;;OAQG;IACH,UAAU,CAAC,KAAK;QACd,OAAO,KAAK,YAAY,QAAQ,CAAC;IACnC,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAK;QACX,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC1E,OAAO,CACL,KAAK,YAAY,QAAQ;YACzB,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAC5B,CAAA;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,KAAK;QACd,OAAO,CACL,KAAK,YAAY,QAAQ;YACzB,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC5B,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;YAClC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CACjC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,KAAK;QACX,OAAO,CACL,KAAK,YAAY,QAAQ;YACzB,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;YACjC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CACjC,CAAA;IACH,CAAC;CACF,CAAC,CAAA"}
+{"version":3,"file":"functionextensions.js","sourceRoot":"","sources":["../../src/functionextensions.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAExD,MAAM,EAAE,YAAY,EAAE,GAAG,gBAAgB,CAAC,OAAO,CAAA;AAEjD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,KAAK,CAAC,QAAQ,EAAE;IACpD;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAK;QACX,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC1E,OAAO,CACL,KAAK,YAAY,QAAQ;YACzB,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAC5B,CAAA;IACH,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB,CAAC,KAAK;QACpB,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;QAErC,OAAO,CACL,KAAK,YAAY,QAAQ;YACzB,SAAS,IAAI,wBAAwB,CACtC,CAAA;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,KAAK;QACd,OAAO,CACL,KAAK,YAAY,QAAQ;YACzB,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC5B,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;YAClC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CACjC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,KAAK;QACX,OAAO,CACL,KAAK,YAAY,QAAQ;YACzB,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;YACjC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CACjC,CAAA;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAK;QACX,OAAO,KAAK,YAAY,QAAQ,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IACtE,CAAC;IAED;;;;;;;;OAQG;IACH,UAAU,CAAC,KAAK;QACd,OAAO,KAAK,YAAY,QAAQ,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK;QACf,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;QAErC,OAAO,CACL,KAAK,YAAY,QAAQ;YACzB,SAAS,IAAI,mBAAmB,CACjC,CAAA;IACH,CAAC;CACF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE;IACvE;;;;;;;;OAQG;IACH,IAAI,OAAO;QACT,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC;IAED;;;;;OAKG;IACH,IAAI,gBAAgB;QAClB,OAAO,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,UAAU;QACZ,OAAO,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,OAAO;QACT,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,OAAO;QACT,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,UAAU;QACZ,OAAO,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;IAClC,CAAC;IAED;;;;;OAKG;IACH,IAAI,WAAW;QACb,OAAO,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IACnC,CAAC;CACF,CAAC,CAAA"}

package/dist/mjs/index.d.ts

@@ -5,6 +5,9 @@ declare namespace results {
     export { Patches as patches };
     export { all };
 }
-export const Extensions: {};
-export const Patches: Map<Object, import("@nejs/extension").Patch>;
+export namespace Extensions {
+    export { GlobalFunctionsAndProps as global };
+}
+export const Patches: Map<any, any>;
 export const Controls: {};
+import { GlobalFunctionsAndProps } from './globals.js';

package/dist/mjs/index.js

@@ -1,6 +1,7 @@
-import { FunctionExtensions } from './functionextensions.js';
+import { FunctionExtensions, FunctionPrototypeExtensions } from './functionextensions.js';
 import { ObjectExtensions, ObjectPrototypeExtensions } from './objectextensions.js';
 import { MapPrototypeExtensions } from './mapextensions.js';
+import { SetPrototypeExtensions } from './setextensions.js';
 import { ReflectExtensions } from './reflectextensions.js';
 import { StringExtensions } from './stringextensions.js';
 import { SymbolExtensions } from './symbolextensions.js';
@@ -9,27 +10,37 @@ import { DescriptorExtensions, Descriptor } from './newClasses/descriptor.js';
 import { GlobalFunctionsAndProps } from './globals.js';
 import { RefSetExtensions } from './newClasses/refset.js';
 import { RefMapExtensions } from './newClasses/refmap.js';
+import { DeferredExtension } from './newClasses/deferred.js';
 import { AsyncIteratorExtensions, AsyncIterableExtensions } from './newClasses/asyncIterable.js';
 import { IteratorExtensions, IterableExtensions } from './newClasses/iterable.js';
-const Patches = new Map([
+const StaticPatches = [
     [Object, ObjectExtensions],
     [Function, FunctionExtensions],
     [Reflect, ReflectExtensions],
     [String, StringExtensions],
     [Symbol, SymbolExtensions],
+];
+const InstancePatches = [
     [Object.prototype, ObjectPrototypeExtensions],
+    [Function.prototype, FunctionPrototypeExtensions],
     [Array.prototype, ArrayPrototypeExtensions],
     [Map.prototype, MapPrototypeExtensions],
-    [globalThis, GlobalFunctionsAndProps],
+    [Set.prototype, SetPrototypeExtensions],
+];
+const Patches = new Map([
+    ...StaticPatches,
+    ...InstancePatches,
 ]);
 const Extensions = {
-    [DescriptorExtensions.key]: DescriptorExtensions,
+    global: GlobalFunctionsAndProps,
     [AsyncIterableExtensions.key]: AsyncIterableExtensions,
     [AsyncIteratorExtensions.key]: AsyncIteratorExtensions,
+    [DeferredExtension.key]: DeferredExtension,
+    [DescriptorExtensions.key]: DescriptorExtensions,
     [IterableExtensions.key]: IterableExtensions,
     [IteratorExtensions.key]: IteratorExtensions,
-    [RefSetExtensions.key]: RefSetExtensions,
     [RefMapExtensions.key]: RefMapExtensions,
+    [RefSetExtensions.key]: RefSetExtensions,
 };
 const Controls = {};
 Object.assign(Controls, {
@@ -40,16 +51,28 @@ Object.assign(Controls, {
     enablePatches() {
         Patches.forEach((extension) => { extension.apply(); });
     },
+    enableStaticPatches(filter = (extension) => true) {
+        StaticPatches.filter(filter).forEach(extension => extension.apply());
+    },
+    enableInstancePatches(filter = (extension) => true) {
+        InstancePatches.filter(filter).forEach(extension => extension.apply());
+    },
     enableExtensions() {
         Object.values(Extensions).forEach((extension) => { extension.apply(); });
     },
-    disableAll(owners) {
+    disableAll() {
         Controls.disablePatches();
         Controls.disableExtensions();
     },
     disablePatches() {
         Patches.forEach((extension) => { extension.revert(); });
     },
+    disableStaticPatches(filter = (extension) => true) {
+        StaticPatches.filter(filter).forEach(extension => extension.revert());
+    },
+    disableInstancePatches(filter = (extension) => true) {
+        InstancePatches.filter(filter).forEach(extension => extension.revert());
+    },
     disableExtensions() {
         Object.values(Extensions).forEach((extension) => { extension.revert(); });
     },

package/dist/mjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AACnF,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAA;AAC/D,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAC7E,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAA;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAEzD,OAAO,EACL,uBAAuB,EACvB,uBAAuB,EACxB,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,0BAA0B,CAAA;AAEjC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC;IACtB,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAC1B,CAAC,QAAQ,EAAE,kBAAkB,CAAC;IAC9B,CAAC,OAAO,EAAE,iBAAiB,CAAC;IAC5B,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAC1B,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAE1B,CAAC,MAAM,CAAC,SAAS,EAAE,yBAAyB,CAAC;IAC7C,CAAC,KAAK,CAAC,SAAS,EAAE,wBAAwB,CAAC;IAC3C,CAAC,GAAG,CAAC,SAAS,EAAE,sBAAsB,CAAC;IACvC,CAAC,UAAU,EAAE,uBAAuB,CAAC;CACtC,CAAC,CAAA;AAEF,MAAM,UAAU,GAAG;IACjB,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,oBAAoB;IAChD,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAE,uBAAuB;IACtD,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAE,uBAAuB;IACtD,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,kBAAkB;IAC5C,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,kBAAkB;IAC5C,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,gBAAgB;IACxC,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,gBAAgB;CACzC,CAAA;AAED,MAAM,QAAQ,GAAG,EAAE,CAAA;AAEnB,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;IACtB,SAAS;QACP,QAAQ,CAAC,aAAa,EAAE,CAAA;QACxB,QAAQ,CAAC,gBAAgB,EAAE,CAAA;IAC7B,CAAC;IAED,aAAa;QACX,OAAO,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,GAAG,SAAS,CAAC,KAAK,EAAE,CAAA,CAAC,CAAC,CAAC,CAAA;IACvD,CAAC;IAED,gBAAgB;QACd,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,GAAG,SAAS,CAAC,KAAK,EAAE,CAAA,CAAC,CAAC,CAAC,CAAA;IACzE,CAAC;IAED,UAAU,CAAC,MAAM;QACf,QAAQ,CAAC,cAAc,EAAE,CAAA;QACzB,QAAQ,CAAC,iBAAiB,EAAE,CAAA;IAC9B,CAAC;IAED,cAAc;QACZ,OAAO,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,CAAA,CAAC,CAAC,CAAC,CAAA;IACxD,CAAC;IAED,iBAAiB;QACf,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,CAAA,CAAC,CAAC,CAAC,CAAA;IAC1E,CAAC;CACF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,GAAG,EAAE;IACvB,MAAM,UAAU,GAAG;QACjB,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAC/B,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;KACzC,CAAA;IAED,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,SAAS,EAAE,EAAE;QACxD,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;YACxD,MAAM,KAAK,GAAG,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;YAEzC,IAAI,KAAK,CAAC,UAAU;gBAClB,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;;gBAEnD,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAA;YAEnC,OAAO,WAAW,CAAA;QACpB,CAAC,EAAE,WAAW,CAAC,CAAA;QAEf,OAAO,WAAW,CAAA;IACpB,CAAC,EAAE,EAAE,CAAC,CAAA;IAEN,OAAO,IAAI,CAAA;AACb,CAAC,CAAC,EAAE,CAAA;AAEJ,MAAM,OAAO,GAAG;IACd,GAAG,QAAQ;IACX,UAAU,EAAE,UAAU;IACtB,OAAO,EAAE,OAAO;IAChB,GAAG;CACJ,CAAA;AAED,eAAe,OAAO,CAAA;AAEtB,OAAO,EACL,UAAU,EACV,OAAO,EACP,QAAQ,GACT,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAA;AACzF,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AACnF,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAA;AAC/D,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAC7E,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAA;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAE5D,OAAO,EACL,uBAAuB,EACvB,uBAAuB,EACxB,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,0BAA0B,CAAA;AAEjC,MAAM,aAAa,GAAG;IACpB,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAC1B,CAAC,QAAQ,EAAE,kBAAkB,CAAC;IAC9B,CAAC,OAAO,EAAE,iBAAiB,CAAC;IAC5B,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAC1B,CAAC,MAAM,EAAE,gBAAgB,CAAC;CAC3B,CAAA;AAED,MAAM,eAAe,GAAG;IACtB,CAAC,MAAM,CAAC,SAAS,EAAE,yBAAyB,CAAC;IAC7C,CAAC,QAAQ,CAAC,SAAS,EAAE,2BAA2B,CAAC;IACjD,CAAC,KAAK,CAAC,SAAS,EAAE,wBAAwB,CAAC;IAC3C,CAAC,GAAG,CAAC,SAAS,EAAE,sBAAsB,CAAC;IACvC,CAAC,GAAG,CAAC,SAAS,EAAE,sBAAsB,CAAC;CACxC,CAAA;AAED,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC;IACtB,GAAG,aAAa;IAChB,GAAG,eAAe;CACnB,CAAC,CAAA;AAEF,MAAM,UAAU,GAAG;IACjB,MAAM,EAAE,uBAAuB;IAE/B,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAE,uBAAuB;IACtD,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAE,uBAAuB;IACtD,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,iBAAiB;IAC1C,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,oBAAoB;IAChD,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,kBAAkB;IAC5C,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,kBAAkB;IAC5C,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,gBAAgB;IACxC,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,gBAAgB;CACzC,CAAA;AAED,MAAM,QAAQ,GAAG,EAAE,CAAA;AAEnB,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;IACtB,SAAS;QACP,QAAQ,CAAC,aAAa,EAAE,CAAA;QACxB,QAAQ,CAAC,gBAAgB,EAAE,CAAA;IAC7B,CAAC;IAED,aAAa;QACX,OAAO,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,GAAG,SAAS,CAAC,KAAK,EAAE,CAAA,CAAC,CAAC,CAAC,CAAA;IACvD,CAAC;IAED,mBAAmB,CAAC,MAAM,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI;QAC9C,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAA;IACtE,CAAC;IAED,qBAAqB,CAAC,MAAM,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI;QAChD,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAA;IACxE,CAAC;IAED,gBAAgB;QACd,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,GAAG,SAAS,CAAC,KAAK,EAAE,CAAA,CAAC,CAAC,CAAC,CAAA;IACzE,CAAC;IAED,UAAU;QACR,QAAQ,CAAC,cAAc,EAAE,CAAA;QACzB,QAAQ,CAAC,iBAAiB,EAAE,CAAA;IAC9B,CAAC;IAED,cAAc;QACZ,OAAO,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,CAAA,CAAC,CAAC,CAAC,CAAA;IACxD,CAAC;IAED,oBAAoB,CAAC,MAAM,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI;QAC/C,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAA;IACvE,CAAC;IAED,sBAAsB,CAAC,MAAM,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI;QACjD,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAA;IACzE,CAAC;IAED,iBAAiB;QACf,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,CAAA,CAAC,CAAC,CAAC,CAAA;IAC1E,CAAC;CACF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,GAAG,EAAE;IACvB,MAAM,UAAU,GAAG;QACjB,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAC/B,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;KACzC,CAAA;IAED,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,SAAS,EAAE,EAAE;QACxD,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;YACxD,MAAM,KAAK,GAAG,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;YAEzC,IAAI,KAAK,CAAC,UAAU;gBAClB,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;;gBAEnD,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAA;YAEnC,OAAO,WAAW,CAAA;QACpB,CAAC,EAAE,WAAW,CAAC,CAAA;QAEf,OAAO,WAAW,CAAA;IACpB,CAAC,EAAE,EAAE,CAAC,CAAA;IAEN,OAAO,IAAI,CAAA;AACb,CAAC,CAAC,EAAE,CAAA;AAEJ,MAAM,OAAO,GAAG;IACd,GAAG,QAAQ;IACX,UAAU,EAAE,UAAU;IACtB,OAAO,EAAE,OAAO;IAChB,GAAG;CACJ,CAAA;AAED,eAAe,OAAO,CAAA;AAEtB,OAAO,EACL,UAAU,EACV,OAAO,EACP,QAAQ,GACT,CAAA"}

package/dist/mjs/newClasses/deferred.d.ts

@@ -0,0 +1,126 @@
+/**
+ * Deferreds, which were first introduced by jQuery for browsers in the early
+ * 2000s, are a way to manage asynchronous operations. They have been widely
+ * used and replicated by engineers since then. Although the Promise class in
+ * modern JavaScript provides a static method called `withResolvers` that
+ * returns an object with similar properties to a Deferred, it is not directly
+ * supported by Node.js.
+ *
+ * ```
+ * const withResolvers = Promise.withResolvers()
+ * Reflect.has(withResolvers, 'promise') // true
+ * Reflect.has(withResolvers, 'resolve') // true
+ * Reflect.has(withResolvers, 'reject')  // true
+ * ```
+ *
+ * This Deferred class extends the Promise class, allowing it to capture the
+ * value or reason for easy access after resolution, akin to
+ * {@link Promise.withResolvers}. As it extends {@link Promise}, it is
+ * 'thenable' and works with `await` as if it were a native Promise. This
+ * allows seamless integration with code expecting Promise-like objects.
+ */
+export class Deferred extends Promise<any> {
+    /**
+     * A getter for the species symbol which returns a custom DeferredPromise
+     * class. This class extends from Deferred and is used to ensure that the
+     * constructor signature matches that of a Promise. The executor function
+     * passed to the constructor of this class is used to initialize the Deferred
+     * object with resolve and reject functions, similar to how a Promise would
+     * be initialized.
+     *
+     * @returns {DeferredPromise} A DeferredPromise class that extends Deferred.
+     */
+    static get [Symbol.species](): DeferredPromise;
+    /**
+     * The constructor for Deferred instances. By default, a new Deferred will
+     * have three important properties: `promise`, `resolve`, and `reject`.
+     *
+     * The constructor takes an object called `options`. It can have the
+     * following properties:
+     *
+     * ```
+     * interface BaseDeferredOptions {
+     *   // Deferreds store the value or reason. To turn this off, pass true
+     *   // to this option.
+     *   doNotTrackAnswers?: boolean;
+     * }
+     *
+     * interface ResolveDeferredOptions {
+     *   // Passing in an option object with a resolve value will auto resolve
+     *   // the Deferred with your value. An error will be raised if both
+     *   // resolve and reject are supplied at the same time.
+     *   resolve?: (value: any) => void;
+     * }
+     *
+     * interface RejectDeferredOptions {
+     *   // Passing in an option object with a reject reason will auto reject
+     *   // the Deferred with your reason. An error will be raised if both
+     *   // resolve and reject are supplied at the same time.
+     *   reject?: (reason: any) => void;
+     * }
+     *
+     * type DeferredOptions = BaseDeferredOptions &
+     *   (ResolveDeferredOptions | RejectDeferredOptions)
+     * ```
+     *
+     * @param {object} options see above for examples on supported options, but
+     * when supplied, the constructor can take instructions on how to auto
+     * resolve or reject the deferred created here.
+     */
+    constructor(options: object);
+    /**
+     * When the Deferred is settled with {@link Deferred.resolve}, the `value`
+     * passed to that function will be set here as well.
+     *
+     * @type {*}
+     */
+    value: any;
+    /**
+     * When the Deferred is settled with {@link Deferred.reject}, the `reason`
+     * passed to that rejection will also be stored here.
+     *
+     * @type {*}
+     */
+    reason: any;
+    /**
+     * Returns a boolean value that indicates whether or not this Deferred
+     * has been settled (either resolve or reject have been invoked).
+     *
+     * @returns {boolean} `true` if either {@link Deferred.resolve} or
+     * {@link Deferred.reject} have been invoked; `false` otherwise
+     */
+    get settled(): boolean;
+    /**
+     * Accessor for the promise managed by this Deferred instance.
+     *
+     * This getter provides access to the internal promise which is controlled
+     * by the Deferred's resolve and reject methods. It allows external code to
+     * attach callbacks for the resolution or rejection of the Deferred without
+     * the ability to directly resolve or reject it.
+     *
+     * @returns {Promise} The promise controlled by this Deferred instance.
+     */
+    get promise(): Promise<any>;
+    /**
+     * Resolves the Deferred with the given value. If the value is a thenable
+     * (i.e., has a "then" method), the Deferred will "follow" that thenable,
+     * adopting its eventual state; otherwise, the Deferred will be fulfilled
+     * with the value. This function behaves the same as Promise.resolve.
+     *
+     * @param {*} value - The value to resolve the Deferred with.
+     * @returns {Promise} A Promise that is resolved with the given value.
+     */
+    resolve(value: any): Promise<any>;
+    /**
+     * Rejects the Deferred with the given reason. This function behaves the
+     * same as Promise.reject. The Deferred will be rejected with the provided
+     * reason.
+     *
+     * @param {*} reason - The reason to reject the Deferred with.
+     * @returns {Promise} A Promise that is rejected with the given reason.
+     */
+    reject(reason: any): Promise<any>;
+    #private;
+}
+export const DeferredExtension: Extension;
+import { Extension } from '@nejs/extension';

package/dist/mjs/newClasses/deferred.js

@@ -0,0 +1,230 @@
+import { Extension } from '@nejs/extension';
+/**
+ * Deferreds, which were first introduced by jQuery for browsers in the early
+ * 2000s, are a way to manage asynchronous operations. They have been widely
+ * used and replicated by engineers since then. Although the Promise class in
+ * modern JavaScript provides a static method called `withResolvers` that
+ * returns an object with similar properties to a Deferred, it is not directly
+ * supported by Node.js.
+ *
+ * ```
+ * const withResolvers = Promise.withResolvers()
+ * Reflect.has(withResolvers, 'promise') // true
+ * Reflect.has(withResolvers, 'resolve') // true
+ * Reflect.has(withResolvers, 'reject')  // true
+ * ```
+ *
+ * This Deferred class extends the Promise class, allowing it to capture the
+ * value or reason for easy access after resolution, akin to
+ * {@link Promise.withResolvers}. As it extends {@link Promise}, it is
+ * 'thenable' and works with `await` as if it were a native Promise. This
+ * allows seamless integration with code expecting Promise-like objects.
+ */
+export class Deferred extends Promise {
+    /**
+     * The promise backing this deferred object. Created when the constructor
+     * runs, this promise is what all `Promise.prototype` functions are routed
+     * to.
+     *
+     * @type {Promise}
+     */
+    #promise = null;
+    /**
+     * The reject() resolver that will be assigned when a new instance is
+     * created. Invoking this function with or without a `reason` will cause
+     * the deferred's promise to be settled.
+     *
+     * @type {function}
+     */
+    #reject = null;
+    /**
+     * The resolve() resolver that will be assigned when a new instance is
+     * created. Invoking this function with or without a `value` will cause
+     * the deferred's promise to be settled.
+     *
+     * @type {function}
+     */
+    #resolve = null;
+    /**
+     * When the Deferred is settled with {@link Deferred.resolve}, the `value`
+     * passed to that function will be set here as well.
+     *
+     * @type {*}
+     */
+    value = null;
+    /**
+     * When the Deferred is settled with {@link Deferred.reject}, the `reason`
+     * passed to that rejection will also be stored here.
+     *
+     * @type {*}
+     */
+    reason = null;
+    /**
+     * When either {@link Deferred.resolve} or {@link Deferred.reject} are called,
+     * this property is set to `true`. Its current status at any time can be
+     * queried using the {@link Deferred.settled} getter.
+     *
+     * @type {boolean}
+     */
+    #settled = false;
+    /**
+     * The constructor for Deferred instances. By default, a new Deferred will
+     * have three important properties: `promise`, `resolve`, and `reject`.
+     *
+     * The constructor takes an object called `options`. It can have the
+     * following properties:
+     *
+     * ```
+     * interface BaseDeferredOptions {
+     *   // Deferreds store the value or reason. To turn this off, pass true
+     *   // to this option.
+     *   doNotTrackAnswers?: boolean;
+     * }
+     *
+     * interface ResolveDeferredOptions {
+     *   // Passing in an option object with a resolve value will auto resolve
+     *   // the Deferred with your value. An error will be raised if both
+     *   // resolve and reject are supplied at the same time.
+     *   resolve?: (value: any) => void;
+     * }
+     *
+     * interface RejectDeferredOptions {
+     *   // Passing in an option object with a reject reason will auto reject
+     *   // the Deferred with your reason. An error will be raised if both
+     *   // resolve and reject are supplied at the same time.
+     *   reject?: (reason: any) => void;
+     * }
+     *
+     * type DeferredOptions = BaseDeferredOptions &
+     *   (ResolveDeferredOptions | RejectDeferredOptions)
+     * ```
+     *
+     * @param {object} options see above for examples on supported options, but
+     * when supplied, the constructor can take instructions on how to auto
+     * resolve or reject the deferred created here.
+     */
+    constructor(options) {
+        // Check if options is an object, if not, assign an empty object to config
+        const config = (options && typeof (options) === 'object'
+            ? options
+            : {});
+        // Throw an error if both resolve and reject options are provided
+        if (config?.resolve && config?.reject) {
+            throw new TypeError('resolve and reject options cannot be simultaneously provided');
+        }
+        // Create an empty object to store the resolve and reject functions
+        let _resolve, _reject;
+        // Create a new promise and assign its resolve and reject functions to resolvers
+        super((resolve, reject) => {
+            _resolve = resolve;
+            _reject = reject;
+            if (config?.executor && typeof (config?.executor) === 'function') {
+                config?.executor(resolve, reject);
+            }
+        });
+        // Define the resolve function for the Deferred instance
+        this.#resolve = (value) => {
+            // If doNotTrackAnswers is not set to true, store the value
+            if (config?.doNotTrackAnswers !== true) {
+                this.value = value;
+            }
+            // Mark the Deferred instance as settled
+            this.#settled = true;
+            // Resolve the promise with the provided value
+            return _resolve(value);
+        };
+        // Define the reject function for the Deferred instance
+        this.#reject = async (reason) => {
+            // If doNotTrackAnswers is not set to true, store the reason
+            if (config?.doNotTrackAnswers !== true) {
+                this.reason = reason;
+            }
+            // Mark the Deferred instance as settled
+            this.#settled = true;
+            // Reject the promise with the provided reason
+            return _reject(reason);
+        };
+        this.#promise = this;
+        // If a resolve option is provided, resolve the Deferred instance with it
+        if (config?.resolve) {
+            this.#resolve(config?.resolve);
+        }
+        // If a reject option is provided, reject the Deferred instance with it
+        else if (config?.reject) {
+            this.#reject(config?.reject);
+        }
+    }
+    /**
+     * Returns a boolean value that indicates whether or not this Deferred
+     * has been settled (either resolve or reject have been invoked).
+     *
+     * @returns {boolean} `true` if either {@link Deferred.resolve} or
+     * {@link Deferred.reject} have been invoked; `false` otherwise
+     */
+    get settled() {
+        return this.#settled;
+    }
+    /**
+     * Accessor for the promise managed by this Deferred instance.
+     *
+     * This getter provides access to the internal promise which is controlled
+     * by the Deferred's resolve and reject methods. It allows external code to
+     * attach callbacks for the resolution or rejection of the Deferred without
+     * the ability to directly resolve or reject it.
+     *
+     * @returns {Promise} The promise controlled by this Deferred instance.
+     */
+    get promise() {
+        return this.#promise;
+    }
+    /**
+     * Resolves the Deferred with the given value. If the value is a thenable
+     * (i.e., has a "then" method), the Deferred will "follow" that thenable,
+     * adopting its eventual state; otherwise, the Deferred will be fulfilled
+     * with the value. This function behaves the same as Promise.resolve.
+     *
+     * @param {*} value - The value to resolve the Deferred with.
+     * @returns {Promise} A Promise that is resolved with the given value.
+     */
+    resolve(value) {
+        return this.#resolve(value);
+    }
+    /**
+     * Rejects the Deferred with the given reason. This function behaves the
+     * same as Promise.reject. The Deferred will be rejected with the provided
+     * reason.
+     *
+     * @param {*} reason - The reason to reject the Deferred with.
+     * @returns {Promise} A Promise that is rejected with the given reason.
+     */
+    reject(reason) {
+        return this.#reject(reason);
+    }
+    /**
+     * A getter for the species symbol which returns a custom DeferredPromise
+     * class. This class extends from Deferred and is used to ensure that the
+     * constructor signature matches that of a Promise. The executor function
+     * passed to the constructor of this class is used to initialize the Deferred
+     * object with resolve and reject functions, similar to how a Promise would
+     * be initialized.
+     *
+     * @returns {DeferredPromise} A DeferredPromise class that extends Deferred.
+     */
+    static get [Symbol.species]() {
+        return class DeferredPromise extends Deferred {
+            /**
+             * The constructor for the DeferredPromise class.
+             * It takes an executor function which is used to initialize the Deferred.
+             *
+             * @param {Function} executor - A function that is passed with the resolve
+             * and reject functions. The executor is expected to initialize the
+             * Deferred by calling resolve or reject at some point.
+             */
+            constructor(executor) {
+                super({ executor });
+            }
+        };
+    }
+}
+export const DeferredExtension = new Extension(Deferred);
+//# sourceMappingURL=deferred.js.map