events-ex 2.1.1 → 2.3.0

package/docs/pipe/functions/pipe.md

@@ -0,0 +1,41 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / [pipe](../README.md) / pipe
+
+# Function: pipe()
+
+> **pipe**(`e1`, `e2`, ...`args`): `any`
+
+Defined in: [src/pipe.js:21](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/pipe.js#L21)
+
+Creates a pipeline between two event emitters, so that any events emitted by the first emitter are also emitted by the second emitter.
+
+## Parameters
+
+### e1
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+The first event emitter.
+
+### e2
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+The second event emitter.
+
+### args
+
+...`any`[]
+
+## Returns
+
+`any`
+
+- An object with a `close` method that removes the pipeline between the two event emitters.
+
+## Throws
+
+- If either of the arguments is not an event emitter object.

package/docs/pipe-async/README.md

@@ -0,0 +1,17 @@
+[**events-ex**](../README.md)
+
+***
+
+[events-ex](../modules.md) / pipe-async
+
+# pipe-async
+
+## Functions
+
+- [pipeAsync](functions/pipeAsync.md)
+
+## References
+
+### default
+
+Renames and re-exports [pipeAsync](functions/pipeAsync.md)

package/docs/pipe-async/functions/pipeAsync.md

@@ -0,0 +1,41 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / [pipe-async](../README.md) / pipeAsync
+
+# Function: pipeAsync()
+
+> **pipeAsync**(`e1`, `e2`, ...`args`): `any`
+
+Defined in: [src/pipe-async.js:24](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/pipe-async.js#L24)
+
+Creates a pipeline between two event emitters, so that any events emitted by the first emitter are also emitted by the second emitter.
+
+## Parameters
+
+### e1
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+The first event emitter.
+
+### e2
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+The second event emitter.
+
+### args
+
+...`any`[]
+
+## Returns
+
+`any`
+
+- An object with a `close` method that removes the pipeline between the two event emitters.
+
+## Throws
+
+- If either of the arguments is not an event emitter object.

package/docs/unify/README.md

@@ -0,0 +1,17 @@
+[**events-ex**](../README.md)
+
+***
+
+[events-ex](../modules.md) / unify
+
+# unify
+
+## Functions
+
+- [unify](functions/unify.md)
+
+## References
+
+### default
+
+Renames and re-exports [unify](functions/unify.md)

package/docs/unify/functions/unify.md

@@ -0,0 +1,35 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / [unify](../README.md) / unify
+
+# Function: unify()
+
+> **unify**(`e1`, `e2`): `void`
+
+Defined in: [src/unify.js:17](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/unify.js#L17)
+
+Unifies the event listeners of two event emitter objects so that they share the same set of listeners for each event.
+
+## Parameters
+
+### e1
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+The first event emitter object.
+
+### e2
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+The second event emitter object.
+
+## Returns
+
+`void`
+
+## Throws
+
+- If either of the arguments is not an event emitter object.

package/docs/util/array-remove/README.md

@@ -0,0 +1,17 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / util/array-remove
+
+# util/array-remove
+
+## Functions
+
+- [remove](functions/remove.md)
+
+## References
+
+### default
+
+Renames and re-exports [remove](functions/remove.md)

package/docs/util/array-remove/functions/remove.md

@@ -0,0 +1,21 @@
+[**events-ex**](../../../README.md)
+
+***
+
+[events-ex](../../../modules.md) / [util/array-remove](../README.md) / remove
+
+# Function: remove()
+
+> **remove**(...`args`): `void`
+
+Defined in: [src/util/array-remove.js:5](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/util/array-remove.js#L5)
+
+## Parameters
+
+### args
+
+...`any`[]
+
+## Returns
+
+`void`

package/docs/util/object-for-each/README.md

@@ -0,0 +1,17 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / util/object-for-each
+
+# util/object-for-each
+
+## Functions
+
+- [forEach](functions/forEach.md)
+
+## References
+
+### default
+
+Renames and re-exports [forEach](functions/forEach.md)

package/docs/util/object-for-each/functions/forEach.md

@@ -0,0 +1,29 @@
+[**events-ex**](../../../README.md)
+
+***
+
+[events-ex](../../../modules.md) / [util/object-for-each](../README.md) / forEach
+
+# Function: forEach()
+
+> **forEach**(`obj`, `cb`, ...`args`): `void`
+
+Defined in: [src/util/object-for-each.js:6](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/util/object-for-each.js#L6)
+
+## Parameters
+
+### obj
+
+`any`
+
+### cb
+
+`any`
+
+### args
+
+...`any`[]
+
+## Returns
+
+`void`

package/docs/util/promise-any/README.md

@@ -0,0 +1,11 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / util/promise-any
+
+# util/promise-any
+
+## Variables
+
+- [default](variables/default.md)

package/docs/util/promise-any/variables/default.md

@@ -0,0 +1,9 @@
+[**events-ex**](../../../README.md)
+
+***
+
+[events-ex](../../../modules.md) / [util/promise-any](../README.md) / default
+
+# Variable: default
+
+> **default**: `any`

package/docs/util/string-pad/README.md

@@ -0,0 +1,17 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / util/string-pad
+
+# util/string-pad
+
+## Functions
+
+- [pad](functions/pad.md)
+
+## References
+
+### default
+
+Renames and re-exports [pad](functions/pad.md)

package/docs/util/string-pad/functions/pad.md

@@ -0,0 +1,25 @@
+[**events-ex**](../../../README.md)
+
+***
+
+[events-ex](../../../modules.md) / [util/string-pad](../README.md) / pad
+
+# Function: pad()
+
+> **pad**(`fill`, ...`args`): `string`
+
+Defined in: [src/util/string-pad.js:8](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/util/string-pad.js#L8)
+
+## Parameters
+
+### fill
+
+`any`
+
+### args
+
+...`any`[]
+
+## Returns
+
+`string`

package/docs/util/to-int/README.md

@@ -0,0 +1,17 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / util/to-int
+
+# util/to-int
+
+## Functions
+
+- [toInt](functions/toInt.md)
+
+## References
+
+### default
+
+Renames and re-exports [toInt](functions/toInt.md)

package/docs/util/to-int/functions/toInt.md

@@ -0,0 +1,21 @@
+[**events-ex**](../../../README.md)
+
+***
+
+[events-ex](../../../modules.md) / [util/to-int](../README.md) / toInt
+
+# Function: toInt()
+
+> **toInt**(`value`): `any`
+
+Defined in: [src/util/to-int.js:2](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/util/to-int.js#L2)
+
+## Parameters
+
+### value
+
+`any`
+
+## Returns
+
+`any`

package/docs/util/valid-callable/README.md

@@ -0,0 +1,17 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / util/valid-callable
+
+# util/valid-callable
+
+## Functions
+
+- [validCallable](functions/validCallable.md)
+
+## References
+
+### default
+
+Renames and re-exports [validCallable](functions/validCallable.md)

package/docs/util/valid-callable/functions/validCallable.md

@@ -0,0 +1,21 @@
+[**events-ex**](../../../README.md)
+
+***
+
+[events-ex](../../../modules.md) / [util/valid-callable](../README.md) / validCallable
+
+# Function: validCallable()
+
+> **validCallable**(`fn`): `any`
+
+Defined in: [src/util/valid-callable.js:1](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/util/valid-callable.js#L1)
+
+## Parameters
+
+### fn
+
+`any`
+
+## Returns
+
+`any`

package/docs/util/valid-object/README.md

@@ -0,0 +1,17 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / util/valid-object
+
+# util/valid-object
+
+## Functions
+
+- [validObject](functions/validObject.md)
+
+## References
+
+### default
+
+Renames and re-exports [validObject](functions/validObject.md)

package/docs/util/valid-object/functions/validObject.md

@@ -0,0 +1,21 @@
+[**events-ex**](../../../README.md)
+
+***
+
+[events-ex](../../../modules.md) / [util/valid-object](../README.md) / validObject
+
+# Function: validObject()
+
+> **validObject**(`value`): `any`
+
+Defined in: [src/util/valid-object.js:3](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/util/valid-object.js#L3)
+
+## Parameters
+
+### value
+
+`any`
+
+## Returns
+
+`any`

package/docs/wrap-event-emitter/README.md

@@ -0,0 +1,21 @@
+[**events-ex**](../README.md)
+
+***
+
+[events-ex](../modules.md) / wrap-event-emitter
+
+# wrap-event-emitter
+
+## Variables
+
+- [methods](variables/methods.md)
+
+## Functions
+
+- [wrapEventEmitter](functions/wrapEventEmitter.md)
+
+## References
+
+### default
+
+Renames and re-exports [wrapEventEmitter](functions/wrapEventEmitter.md)

package/docs/wrap-event-emitter/functions/wrapEventEmitter.md

@@ -0,0 +1,33 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / [wrap-event-emitter](../README.md) / wrapEventEmitter
+
+# Function: wrapEventEmitter()
+
+> **wrapEventEmitter**(`o?`, `options?`): `any`
+
+Defined in: [src/wrap-event-emitter.js:37](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/wrap-event-emitter.js#L37)
+
+Create or inject the eventable instance into the object
+
+## Parameters
+
+### o?
+
+`any`
+
+the optional instance to eventable
+
+### options?
+
+`any`
+
+optional configuration for the emitter
+
+## Returns
+
+`any`
+
+o or new Event instance

package/docs/wrap-event-emitter/variables/methods.md

@@ -0,0 +1,11 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / [wrap-event-emitter](../README.md) / methods
+
+# Variable: methods
+
+> `const` **methods**: `any`
+
+Defined in: [src/wrap-event-emitter.js:7](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/wrap-event-emitter.js#L7)

package/lib/all-off.d.ts

@@ -5,5 +5,5 @@
  * @param {string} [type] - The event to remove listeners for. If not provided, all listeners for all events will be removed.
  * @returns {import('./event-emitter').EventEmitter} - The event emitter with all listeners removed.
  */
-export function allOff(emitter: import('./event-emitter').EventEmitter, type?: string): import('./event-emitter').EventEmitter;
+export function allOff(emitter: import("./event-emitter").EventEmitter, type?: string): import("./event-emitter").EventEmitter;
 export default allOff;

package/lib/all-off.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.allOff = allOff;
 exports.default = void 0;
 var _eventable = _interopRequireDefault(require("./eventable"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const removeAllListeners = (0, _eventable.default)().methods.removeAllListeners;
 
 /**

package/lib/default-methods.d.ts

@@ -1,22 +1,53 @@
 export function getEventableMethods(aClass: any): {
+    /**
+     * Configures the event emitter with specified options using a Fluent API.
+     * @param {Object} options - Configuration options for event emission.
+     * @param {string} [options.asyncMode='serial'] - The mode of asynchronous emission ('serial' or 'parallel').
+     * @param {string} [options.resultMode='last'] - The strategy for handling multiple return values ('last', 'first', 'collect').
+     * @returns {import('./event-emitter').EventEmitter} A proxy object representing the configured EventEmitter.
+     */
+    configure(options: {
+        asyncMode?: string;
+        resultMode?: string;
+    }): import("./event-emitter").EventEmitter;
+    /**
+     * A shortcut for parallel configuration.
+     * @param {string} [resultMode='last'] - The strategy for handling multiple return values.
+     * @returns {import('./event-emitter').EventEmitter} A proxy object representing the configured EventEmitter.
+     */
+    parallel(resultMode?: string): import("./event-emitter").EventEmitter;
+    /**
+     * Sets the configuration options for the EventEmitter instance.
+     * @param {Object} options - Configuration options for the emitter (e.g., asyncMode, resultMode, maxListeners).
+     * @returns {import('./event-emitter').EventEmitter} The EventEmitter instance for chaining.
+     */
+    setEmitterOptions(options: any): import("./event-emitter").EventEmitter;
     /**
      * Adds a listener function to the specified event type.
      * @param {string|RegExp} type - The event type to listen for.
      * @param {Function} listener - The listener function to be called when the event is emitted.
-     * @param {number} [index] - The index at which to insert the listener. If not specified, the listener will be added at the end of the listeners array.
+     * @param {number|'first'|'last'} [index] - The index at which to insert the listener.
+     *        - 'first' or -Infinity: Adds to the "Head" zone. The first listener added as 'first' is placed at the very front.
+     *        - 'last' or Infinity: Adds to the "Tail" zone. The first listener added as 'last' will always be the very last one to execute.
+     *        - number: Inserts at the specified index within the "Body" (normal) zone.
+     *        If not specified, the listener is added to the end of the "Body" zone.
      * @returns {import('./event-emitter').EventEmitter} The EventEmitter instance to allow chaining.
      * @throws {TypeError} If the listener is not a function.
      */
-    on(type: string | RegExp, listener: Function, index?: number): import('./event-emitter').EventEmitter;
+    on(type: string | RegExp, listener: Function, index?: number | "first" | "last"): import("./event-emitter").EventEmitter;
     /**
      * Adds a one-time listener function to the specified event type.
      * @param {string|RegExp} type - The event type to listen for.
      * @param {Function} listener - The listener function to be called once when the event is emitted.
-     * @param {number} [index] - The index at which to insert the listener. If not specified, the listener will be added at the end of the listeners array.
+     * @param {number|'first'|'last'} [index] - The index at which to insert the listener.
+     *        - 'first' or -Infinity: Adds to the "Head" zone. The first listener added as 'first' is placed at the very front.
+     *        - 'last' or Infinity: Adds to the "Tail" zone. The first listener added as 'last' will always be the very last one to execute.
+     *        - number: Inserts at the specified index within the "Body" (normal) zone.
+     *        If not specified, the listener is added to the end of the "Body" zone.
      * @returns {import('./event-emitter').EventEmitter} The EventEmitter instance to allow chaining.
      * @throws {TypeError} If the listener is not a function.
      */
-    once(type: string | RegExp, listener: Function, index?: number): import('./event-emitter').EventEmitter;
+    once(type: string | RegExp, listener: Function, index?: number | "first" | "last"): import("./event-emitter").EventEmitter;
     /**
      * Emits the specified event type with the given arguments.
      * @param {...*} args - The event type followed by any number of arguments to be passed to the listener functions.
@@ -29,7 +60,7 @@ export function getEventableMethods(aClass: any): {
      * @returns {Promise<*>} A promise that resolves with the result of the event.
      */
     emitAsync(...args: any[]): Promise<any>;
-    setMaxListeners(n: any): any;
+    setMaxListeners(n: any): /*elided*/ any;
     listeners(type: any): any;
     listenerCount(emitter: any, type: any): number;
     /**
@@ -39,13 +70,13 @@ export function getEventableMethods(aClass: any): {
      * @returns {import('./event-emitter').EventEmitter} The EventEmitter instance to allow chaining.
      * @throws {TypeError} If the listener is not a function.
      */
-    off(type: string | RegExp, listener: Function): import('./event-emitter').EventEmitter;
+    off(type: string | RegExp, listener: Function): import("./event-emitter").EventEmitter;
     /**
      * Removes all listener functions from the specified event type.
      * @param {string|RegExp} type - The event type to remove the listener from.
      * @returns {import('./event-emitter').EventEmitter} The EventEmitter instance to allow chaining.
      * @throws {TypeError} If the listener is not a function.
      */
-    removeAllListeners(type: string | RegExp): import('./event-emitter').EventEmitter;
+    removeAllListeners(type: string | RegExp): import("./event-emitter").EventEmitter;
 };
 export default getEventableMethods;