events-ex 2.3.1 → 2.4.1

package/docs/event/classes/Event.md

@@ -6,7 +6,7 @@
 
 # Class: Event
 
-Defined in: [src/event.js:8](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event.js#L8)
+Defined in: [src/event.js:8](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event.js#L8)
 
 Creates a new Event object instance that contains information about the event, such as the target element and the return value of the event.
 
@@ -24,7 +24,7 @@ Who trigger the event
 
 > **new Event**(`target`, `type`): `Event`
 
-Defined in: [src/event.js:8](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event.js#L8)
+Defined in: [src/event.js:8](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event.js#L8)
 
 Creates a new Event object instance that contains information about the event, such as the target element and the return value of the event.
 
@@ -52,11 +52,21 @@ Event Object that contains information about the event, such as the target eleme
 
 ## Properties
 
+### aborted
+
+> **aborted**: `boolean` \| `undefined`
+
+Defined in: [src/event.js:38](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event.js#L38)
+
+Whether the event emission was aborted via AbortSignal.
+
+***
+
 ### resolved
 
-> **resolved**: `boolean`
+> **resolved**: `boolean` \| `undefined`
 
-Defined in: [src/event.js:38](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event.js#L38)
+Defined in: [src/event.js:44](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event.js#L44)
 
 Whether a result has been resolved (for 'first' result mode)
 
@@ -66,7 +76,7 @@ Whether a result has been resolved (for 'first' result mode)
 
 > **result**: `any`
 
-Defined in: [src/event.js:44](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event.js#L44)
+Defined in: [src/event.js:50](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event.js#L50)
 
 Keep your event result here if any.
 
@@ -74,9 +84,9 @@ Keep your event result here if any.
 
 ### stopped
 
-> **stopped**: `boolean`
+> **stopped**: `boolean` \| `undefined`
 
-Defined in: [src/event.js:32](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event.js#L32)
+Defined in: [src/event.js:32](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event.js#L32)
 
 Whether stop the bubbling event
 
@@ -84,9 +94,9 @@ Whether stop the bubbling event
 
 ### target
 
-> **target**: `any`
+> **target**: `Object` \| `undefined`
 
-Defined in: [src/event.js:26](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event.js#L26)
+Defined in: [src/event.js:26](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event.js#L26)
 
 Who trigger the event
 
@@ -94,9 +104,9 @@ Who trigger the event
 
 ### type
 
-> **type**: `string`
+> **type**: `string` \| `undefined`
 
-Defined in: [src/event.js:50](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event.js#L50)
+Defined in: [src/event.js:56](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event.js#L56)
 
 The type of the event.
 
@@ -106,7 +116,7 @@ The type of the event.
 
 > **end**(): `any`
 
-Defined in: [src/event.js:57](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event.js#L57)
+Defined in: [src/event.js:63](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event.js#L63)
 
 Ends the event and returns the result.
 
@@ -122,7 +132,7 @@ The result of the event.
 
 > **init**(`target`, `type`): `void`
 
-Defined in: [src/event.js:20](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event.js#L20)
+Defined in: [src/event.js:20](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event.js#L20)
 
 Initializes the event with the target object.
 

package/docs/event-emitter/classes/EventEmitter-1.md

@@ -6,7 +6,7 @@
 
 # Class: EventEmitter
 
-Defined in: [src/event-emitter.js:8](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.js#L8)
+Defined in: [src/event-emitter.js:8](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.js#L8)
 
 ## Classdesc
 
@@ -18,7 +18,7 @@ Class that represents an event emitter.
 
 > **new EventEmitter**(): `EventEmitter`
 
-Defined in: [src/event-emitter.js:8](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.js#L8)
+Defined in: [src/event-emitter.js:8](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.js#L8)
 
 #### Returns
 

package/docs/event-emitter/classes/EventEmitter.md

@@ -6,7 +6,7 @@
 
 # Class: EventEmitter
 
-Defined in: [src/event-emitter.d.ts:6](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.d.ts#L6)
+Defined in: [src/event-emitter.d.ts:6](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.d.ts#L6)
 
 Class that represents an event emitter.
 
@@ -26,7 +26,7 @@ Class that represents an event emitter.
 
 > `static` **defaultMaxListeners**: `number`
 
-Defined in: [src/event-emitter.d.ts:7](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.d.ts#L7)
+Defined in: [src/event-emitter.d.ts:7](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.d.ts#L7)
 
 ## Methods
 
@@ -34,7 +34,7 @@ Defined in: [src/event-emitter.d.ts:7](https://github.com/snowyu/events-ex.js/bl
 
 > **emit**(`eventName`, ...`args`): `any`
 
-Defined in: [src/event-emitter.d.ts:58](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.d.ts#L58)
+Defined in: [src/event-emitter.d.ts:58](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.d.ts#L58)
 
 Emits the specified event type with the given arguments.
 
@@ -62,7 +62,7 @@ The result of the event.
 
 > **emitAsync**(`eventName`, ...`args`): `Promise`\<`any`\>
 
-Defined in: [src/event-emitter.d.ts:64](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.d.ts#L64)
+Defined in: [src/event-emitter.d.ts:64](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.d.ts#L64)
 
 Asynchronously emits the specified event type with the given arguments.
 
@@ -90,7 +90,7 @@ A promise that resolves with the result of the event.
 
 > **listenerCount**(`eventName`): `number`
 
-Defined in: [src/event-emitter.d.ts:93](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.d.ts#L93)
+Defined in: [src/event-emitter.d.ts:93](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.d.ts#L93)
 
 Returns the count of listeners that are registered to listen for the specified event.
 
@@ -98,9 +98,9 @@ Returns the count of listeners that are registered to listen for the specified e
 
 ##### eventName
 
-The name of the event to get the listeners for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name of the event to get the listeners for.
 
 #### Returns
 
@@ -114,7 +114,7 @@ The name of the event to get the listeners for.
 
 > **listeners**(`eventName`): `Function`[]
 
-Defined in: [src/event-emitter.d.ts:86](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.d.ts#L86)
+Defined in: [src/event-emitter.d.ts:86](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.d.ts#L86)
 
 Returns an array of functions that are registered to listen for the specified event.
 
@@ -122,9 +122,9 @@ Returns an array of functions that are registered to listen for the specified ev
 
 ##### eventName
 
-The name of the event to get the listeners for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name of the event to get the listeners for.
 
 #### Returns
 
@@ -138,7 +138,7 @@ The name of the event to get the listeners for.
 
 > **off**(`eventName`, `listener`): `EventEmitter`
 
-Defined in: [src/event-emitter.d.ts:43](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.d.ts#L43)
+Defined in: [src/event-emitter.d.ts:43](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.d.ts#L43)
 
 Removes a listener function from the specified event type.
 
@@ -146,7 +146,7 @@ Removes a listener function from the specified event type.
 
 ##### eventName
 
-`string` | `RegExp`
+`string` \| `RegExp`
 
 ##### listener
 
@@ -174,7 +174,7 @@ If the listener is not a function.
 
 > **on**(`eventName`, `listener`, `index?`): `EventEmitter`
 
-Defined in: [src/event-emitter.d.ts:21](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.d.ts#L21)
+Defined in: [src/event-emitter.d.ts:21](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.d.ts#L21)
 
 Adds a listener function to the specified event type.
 
@@ -182,7 +182,7 @@ Adds a listener function to the specified event type.
 
 ##### eventName
 
-`string` | `RegExp`
+`string` \| `RegExp`
 
 ##### listener
 
@@ -192,14 +192,14 @@ The listener function to be called when the event is emitted.
 
 ##### index?
 
+`number` \| `"first"` \| `"last"`
+
 The index at which to insert the listener.
        - 'first' or -Infinity: adds to the beginning of the listeners (stay at the front).
        - 'last' or Infinity: adds to the end of the listeners (stay at the back).
        - number: inserts at the specified index within the normal listeners zone.
        If not specified, the listener will be added at the end of the normal listeners.
 
-`number` | `"first"` | `"last"`
-
 #### Returns
 
 `EventEmitter`
@@ -216,7 +216,7 @@ If the listener is not a function.
 
 > **once**(`eventName`, `listener`, `index?`): `EventEmitter`
 
-Defined in: [src/event-emitter.d.ts:34](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.d.ts#L34)
+Defined in: [src/event-emitter.d.ts:34](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.d.ts#L34)
 
 Adds a one-time listener function to the specified event type.
 
@@ -224,7 +224,7 @@ Adds a one-time listener function to the specified event type.
 
 ##### eventName
 
-`string` | `RegExp`
+`string` \| `RegExp`
 
 ##### listener
 
@@ -234,14 +234,14 @@ The listener function to be called once when the event is emitted.
 
 ##### index?
 
+`number` \| `"first"` \| `"last"`
+
 The index at which to insert the listener.
        - 'first' or -Infinity: adds to the beginning of the listeners (stay at the front).
        - 'last' or Infinity: adds to the end of the listeners (stay at the back).
        - number: inserts at the specified index within the normal listeners zone.
        If not specified, the listener will be added at the end of the normal listeners.
 
-`number` | `"first"` | `"last"`
-
 #### Returns
 
 `EventEmitter`
@@ -258,7 +258,7 @@ If the listener is not a function.
 
 > **removeAllListeners**(`eventName?`): `EventEmitter`
 
-Defined in: [src/event-emitter.d.ts:71](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.d.ts#L71)
+Defined in: [src/event-emitter.d.ts:71](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.d.ts#L71)
 
 Removes all listeners for a specific event or all events from an event emitter.
 
@@ -266,9 +266,9 @@ Removes all listeners for a specific event or all events from an event emitter.
 
 ##### eventName?
 
-The event to remove listeners for. If not provided, all listeners for all events will be removed.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The event to remove listeners for. If not provided, all listeners for all events will be removed.
 
 #### Returns
 
@@ -282,7 +282,7 @@ The event to remove listeners for. If not provided, all listeners for all events
 
 > **removeListener**(`eventName`, `listener`): `EventEmitter`
 
-Defined in: [src/event-emitter.d.ts:52](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.d.ts#L52)
+Defined in: [src/event-emitter.d.ts:52](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.d.ts#L52)
 
 Removes a listener function from the specified event type.
 
@@ -290,7 +290,7 @@ Removes a listener function from the specified event type.
 
 ##### eventName
 
-`string` | `RegExp`
+`string` \| `RegExp`
 
 ##### listener
 
@@ -318,7 +318,7 @@ If the listener is not a function.
 
 > **setMaxListeners**(`n`): `EventEmitter`
 
-Defined in: [src/event-emitter.d.ts:79](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.d.ts#L79)
+Defined in: [src/event-emitter.d.ts:79](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.d.ts#L79)
 
 Sets the maximum number of listeners allowed for the event emitter.
 
@@ -346,7 +346,7 @@ If `n` is not a positive integer.
 
 > `static` **listenerCount**(`emitter`, `eventName`): `number`
 
-Defined in: [src/event-emitter.d.ts:101](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/event-emitter.d.ts#L101)
+Defined in: [src/event-emitter.d.ts:101](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/event-emitter.d.ts#L101)
 
 Returns the count of listeners that are registered to listen for the specified event.
 
@@ -358,7 +358,7 @@ Returns the count of listeners that are registered to listen for the specified e
 
 ##### eventName
 
-`string` | `RegExp`
+`string` \| `RegExp`
 
 #### Returns
 

package/docs/eventable/functions/eventable.md

@@ -8,7 +8,7 @@
 
 > **eventable**\<`T`\>(`targetClass?`, `options?`): `EnhancedClass`\<`T`, (`aClass?`) => `Function`\>
 
-Defined in: [src/eventable.js:89](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/eventable.js#L89)
+Defined in: [src/eventable.js:89](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/eventable.js#L89)
 
 Adds event-emitting capabilities to a class by injecting necessary methods and properties.
 

package/docs/has-listeners/functions/hasListeners.md

@@ -8,7 +8,7 @@
 
 > **hasListeners**(`obj`, `type?`): `boolean`
 
-Defined in: [src/has-listeners.js:20](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/has-listeners.js#L20)
+Defined in: [src/has-listeners.js:20](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/has-listeners.js#L20)
 
 Checks if an object has event listeners.
 
@@ -16,7 +16,7 @@ Checks if an object has event listeners.
 
 ### obj
 
-`any`
+`Object`
 
 The object to check. Must not be null or undefined.
 

package/docs/index/README.md

@@ -14,6 +14,12 @@ Re-exports [allOff](../all-off/functions/allOff.md)
 
 ***
 
+### createAbortError
+
+Re-exports [createAbortError](../consts/functions/createAbortError.md)
+
+***
+
 ### default
 
 Renames and re-exports [EventEmitter](../event-emitter/classes/EventEmitter.md)
@@ -50,6 +56,12 @@ Re-exports [methods](../wrap-event-emitter/variables/methods.md)
 
 ***
 
+### oncePromise
+
+Re-exports [oncePromise](../once-promise/functions/oncePromise.md)
+
+***
+
 ### pipe
 
 Re-exports [pipe](../pipe/functions/pipe.md)

package/docs/modules.md

@@ -15,6 +15,7 @@
 - [eventable](eventable/README.md)
 - [has-listeners](has-listeners/README.md)
 - [index](index/README.md)
+- [once-promise](once-promise/README.md)
 - [pipe](pipe/README.md)
 - [pipe-async](pipe-async/README.md)
 - [unify](unify/README.md)

package/docs/once-promise/README.md

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

package/docs/once-promise/functions/oncePromise.md

@@ -0,0 +1,60 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / [once-promise](../README.md) / oncePromise
+
+# Function: oncePromise()
+
+> **oncePromise**(`emitter`, `type`, `options?`): `Promise`\<[`Event`](../../event/classes/Event.md)\>
+
+Defined in: [src/once-promise.js:23](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/once-promise.js#L23)
+
+Returns a Promise that resolves with the Event object when the specified event is emitted on the given emitter.
+If an 'error' event is emitted (and the waiting event is not 'error'), the promise rejects by default.
+If the provided AbortSignal is aborted, the promise rejects with an AbortError.
+
+Note: The resolved Event object's `result` field may not be the final value if other listeners have not yet run.
+For the definitive emit return value, use `emit()` or `emitAsync()` directly.
+
+## Parameters
+
+### emitter
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+The event emitter to listen on.
+
+### type
+
+`string` \| `RegExp`
+
+The event type to wait for.
+
+### options?
+
+Optional configuration.
+
+#### raiseError?
+
+`boolean` \| `null`
+
+Controls behavior when an 'error' event is emitted:
+  - `true` / `undefined` (default): The promise rejects with the error.
+  - `false`: The promise resolves with the error object instead of rejecting.
+
+#### signal?
+
+`any`
+
+An AbortSignal to cancel the wait.
+
+## Returns
+
+`Promise`\<[`Event`](../../event/classes/Event.md)\>
+
+- A promise that resolves with the Event object.
+
+## Throws
+
+- If emitter is not a valid event emitter object.

package/docs/pipe/functions/pipe.md

@@ -6,9 +6,9 @@
 
 # Function: pipe()
 
-> **pipe**(`e1`, `e2`, ...`args`): `any`
+> **pipe**(`e1`, `e2`, ...`args`): `Object`
 
-Defined in: [src/pipe.js:21](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/pipe.js#L21)
+Defined in: [src/pipe.js:21](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/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.
 
@@ -32,7 +32,7 @@ The second event emitter.
 
 ## Returns
 
-`any`
+`Object`
 
 - An object with a `close` method that removes the pipeline between the two event emitters.
 

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

@@ -6,9 +6,9 @@
 
 # Function: pipeAsync()
 
-> **pipeAsync**(`e1`, `e2`, ...`args`): `any`
+> **pipeAsync**(`e1`, `e2`, ...`args`): `Object`
 
-Defined in: [src/pipe-async.js:24](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/pipe-async.js#L24)
+Defined in: [src/pipe-async.js:26](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/pipe-async.js#L26)
 
 Creates a pipeline between two event emitters, so that any events emitted by the first emitter are also emitted by the second emitter.
 
@@ -32,7 +32,7 @@ The second event emitter.
 
 ## Returns
 
-`any`
+`Object`
 
 - An object with a `close` method that removes the pipeline between the two event emitters.
 

package/docs/unify/functions/unify.md

@@ -8,7 +8,7 @@
 
 > **unify**(`e1`, `e2`): `void`
 
-Defined in: [src/unify.js:17](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/unify.js#L17)
+Defined in: [src/unify.js:17](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/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.
 

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

@@ -8,7 +8,7 @@
 
 > **remove**(...`args`): `void`
 
-Defined in: [src/util/array-remove.js:5](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/util/array-remove.js#L5)
+Defined in: [src/util/array-remove.js:5](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/util/array-remove.js#L5)
 
 ## Parameters
 

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

@@ -8,7 +8,7 @@
 
 > **forEach**(`obj`, `cb`, ...`args`): `void`
 
-Defined in: [src/util/object-for-each.js:6](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/util/object-for-each.js#L6)
+Defined in: [src/util/object-for-each.js:6](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/util/object-for-each.js#L6)
 
 ## Parameters
 

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

@@ -8,7 +8,7 @@
 
 > **pad**(`fill`, ...`args`): `string`
 
-Defined in: [src/util/string-pad.js:8](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/util/string-pad.js#L8)
+Defined in: [src/util/string-pad.js:8](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/util/string-pad.js#L8)
 
 ## Parameters
 

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

@@ -8,7 +8,7 @@
 
 > **toInt**(`value`): `any`
 
-Defined in: [src/util/to-int.js:2](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/util/to-int.js#L2)
+Defined in: [src/util/to-int.js:2](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/util/to-int.js#L2)
 
 ## Parameters
 

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

@@ -8,7 +8,7 @@
 
 > **validCallable**(`fn`): `any`
 
-Defined in: [src/util/valid-callable.js:1](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/util/valid-callable.js#L1)
+Defined in: [src/util/valid-callable.js:1](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/util/valid-callable.js#L1)
 
 ## Parameters
 

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

@@ -8,7 +8,7 @@
 
 > **validObject**(`value`): `any`
 
-Defined in: [src/util/valid-object.js:3](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/util/valid-object.js#L3)
+Defined in: [src/util/valid-object.js:3](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/util/valid-object.js#L3)
 
 ## Parameters
 

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

@@ -8,7 +8,7 @@
 
 > **wrapEventEmitter**(`o?`, `options?`): `any`
 
-Defined in: [src/wrap-event-emitter.js:37](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/wrap-event-emitter.js#L37)
+Defined in: [src/wrap-event-emitter.js:37](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/wrap-event-emitter.js#L37)
 
 Create or inject the eventable instance into the object
 
@@ -16,13 +16,13 @@ Create or inject the eventable instance into the object
 
 ### o?
 
-`any`
+`Object`
 
 the optional instance to eventable
 
 ### options?
 
-`any`
+`Object`
 
 optional configuration for the emitter
 

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

@@ -8,4 +8,4 @@
 
 > `const` **methods**: `any`
 
-Defined in: [src/wrap-event-emitter.js:7](https://github.com/snowyu/events-ex.js/blob/f6c44157ffda17957fad5ad2e0aedbb8ec521be7/src/wrap-event-emitter.js#L7)
+Defined in: [src/wrap-event-emitter.js:7](https://github.com/snowyu/events-ex.js/blob/4b0e5c2237202c2cc8b9e9244905d2c668799451/src/wrap-event-emitter.js#L7)

package/lib/all-off.mjs

@@ -0,0 +1,16 @@
+import eventable from './eventable.mjs'
+
+const removeAllListeners = eventable().methods.removeAllListeners;
+
+/**
+ * Removes all listeners for a specific event or all events from an event emitter.
+ *
+ * @param {import('./event-emitter').EventEmitter} emitter - The event emitter to remove listeners from.
+ * @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, type) {
+  return removeAllListeners.call(emitter, type);
+};
+
+export default allOff;