events-ex 2.1.0 → 2.2.0

package/docs/classes/event_emitter.EventEmitter.md

@@ -1,306 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / [event-emitter](../modules/event_emitter.md) / EventEmitter
-
-# Class: EventEmitter
-
-[event-emitter](../modules/event_emitter.md).EventEmitter
-
-Class that represents an event emitter.
-
-## Table of contents
-
-### Constructors
-
-- [constructor](event_emitter.EventEmitter.md#constructor)
-
-### Properties
-
-- [defaultMaxListeners](event_emitter.EventEmitter.md#defaultmaxlisteners)
-
-### Methods
-
-- [emit](event_emitter.EventEmitter.md#emit)
-- [emitAsync](event_emitter.EventEmitter.md#emitasync)
-- [listenerCount](event_emitter.EventEmitter.md#listenercount)
-- [listeners](event_emitter.EventEmitter.md#listeners)
-- [off](event_emitter.EventEmitter.md#off)
-- [on](event_emitter.EventEmitter.md#on)
-- [once](event_emitter.EventEmitter.md#once)
-- [removeAllListeners](event_emitter.EventEmitter.md#removealllisteners)
-- [setMaxListeners](event_emitter.EventEmitter.md#setmaxlisteners)
-- [listenerCount](event_emitter.EventEmitter.md#listenercount-1)
-
-## Constructors
-
-### constructor
-
-• **new EventEmitter**(): [`EventEmitter`](event_emitter.EventEmitter.md)
-
-#### Returns
-
-[`EventEmitter`](event_emitter.EventEmitter.md)
-
-## Properties
-
-### defaultMaxListeners
-
-▪ `Static` **defaultMaxListeners**: `number`
-
-#### Defined in
-
-[src/event-emitter.d.ts:7](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/event-emitter.d.ts#L7)
-
-## Methods
-
-### emit
-
-▸ **emit**(`eventName`, `...args`): `any`
-
-Emits the specified event type with the given arguments.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` | - |
-| `...args` | `any`[] | The event type followed by any number of arguments to be passed to the listener functions. |
-
-#### Returns
-
-`any`
-
-The result of the event.
-
-#### Defined in
-
-[src/event-emitter.d.ts:38](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/event-emitter.d.ts#L38)
-
-___
-
-### emitAsync
-
-▸ **emitAsync**(`eventName`, `...args`): `Promise`\<`any`\>
-
-Asynchronously emits the specified event type with the given arguments.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` | - |
-| `...args` | `any`[] | The event type followed by any number of arguments to be passed to the listener functions. |
-
-#### Returns
-
-`Promise`\<`any`\>
-
-A promise that resolves with the result of the event.
-
-#### Defined in
-
-[src/event-emitter.d.ts:44](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/event-emitter.d.ts#L44)
-
-___
-
-### listenerCount
-
-▸ **listenerCount**(`eventName`): `number`
-
-Returns the count of listeners that are registered to listen for the specified event.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `RegExp` | The name of the event to get the listeners for. |
-
-#### Returns
-
-`number`
-
-- the listeners count
-
-#### Defined in
-
-[src/event-emitter.d.ts:66](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/event-emitter.d.ts#L66)
-
-___
-
-### listeners
-
-▸ **listeners**(`eventName`): `Function`[]
-
-Returns an array of functions that are registered to listen for the specified event.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `RegExp` | The name of the event to get the listeners for. |
-
-#### Returns
-
-`Function`[]
-
-- An array of functions that are registered to listen for the specified event.
-
-#### Defined in
-
-[src/event-emitter.d.ts:59](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/event-emitter.d.ts#L59)
-
-___
-
-### off
-
-▸ **off**(`eventName`, `listener`): [`EventEmitter`](event_emitter.EventEmitter.md)
-
-Removes a listener function from the specified event type.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `RegExp` | - |
-| `listener` | `Function` | The listener function to be removed. |
-
-#### Returns
-
-[`EventEmitter`](event_emitter.EventEmitter.md)
-
-The EventEmitter instance to allow chaining.
-
-**`Throws`**
-
-If the listener is not a function.
-
-#### Defined in
-
-[src/event-emitter.d.ts:32](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/event-emitter.d.ts#L32)
-
-___
-
-### on
-
-▸ **on**(`eventName`, `listener`): [`EventEmitter`](event_emitter.EventEmitter.md)
-
-Adds a listener function to the specified event type.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `RegExp` | - |
-| `listener` | `Function` | The listener function to be called when the event is emitted. |
-
-#### Returns
-
-[`EventEmitter`](event_emitter.EventEmitter.md)
-
-The EventEmitter instance to allow chaining.
-
-**`Throws`**
-
-If the listener is not a function.
-
-#### Defined in
-
-[src/event-emitter.d.ts:16](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/event-emitter.d.ts#L16)
-
-___
-
-### once
-
-▸ **once**(`eventName`, `listener`): [`EventEmitter`](event_emitter.EventEmitter.md)
-
-Adds a one-time listener function to the specified event type.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `RegExp` | - |
-| `listener` | `Function` | The listener function to be called once when the event is emitted. |
-
-#### Returns
-
-[`EventEmitter`](event_emitter.EventEmitter.md)
-
-The EventEmitter instance to allow chaining.
-
-**`Throws`**
-
-If the listener is not a function.
-
-#### Defined in
-
-[src/event-emitter.d.ts:24](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/event-emitter.d.ts#L24)
-
-___
-
-### removeAllListeners
-
-▸ **removeAllListeners**(`eventName?`): [`EventEmitter`](event_emitter.EventEmitter.md)
-
-Removes all listeners for a specific event or all events from an event emitter.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName?` | `string` \| `RegExp` | The event to remove listeners for. If not provided, all listeners for all events will be removed. |
-
-#### Returns
-
-[`EventEmitter`](event_emitter.EventEmitter.md)
-
-- The event emitter with all listeners removed.
-
-#### Defined in
-
-[src/event-emitter.d.ts:51](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/event-emitter.d.ts#L51)
-
-___
-
-### setMaxListeners
-
-▸ **setMaxListeners**(`n`): [`EventEmitter`](event_emitter.EventEmitter.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `n` | `number` |
-
-#### Returns
-
-[`EventEmitter`](event_emitter.EventEmitter.md)
-
-#### Defined in
-
-[src/event-emitter.d.ts:52](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/event-emitter.d.ts#L52)
-
-___
-
-### listenerCount
-
-▸ **listenerCount**(`emitter`, `eventName`): `number`
-
-Returns the count of listeners that are registered to listen for the specified event.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `emitter` | [`EventEmitter`](event_emitter.EventEmitter.md) |
-| `eventName` | `string` \| `RegExp` |
-
-#### Returns
-
-`number`
-
-**`Deprecated`**
-
-use emitter.listenerCount instead
-
-#### Defined in
-
-[src/event-emitter.d.ts:74](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/event-emitter.d.ts#L74)

package/docs/modules/all_off.md

@@ -1,44 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / all-off
-
-# Module: all-off
-
-## Table of contents
-
-### References
-
-- [default](all_off.md#default)
-
-### Functions
-
-- [allOff](all_off.md#alloff)
-
-## References
-
-### default
-
-Renames and re-exports [allOff](all_off.md#alloff)
-
-## Functions
-
-### allOff
-
-▸ **allOff**(`emitter`, `type?`): [`EventEmitter`](../classes/event_emitter.EventEmitter.md)
-
-Removes all listeners for a specific event or all events from an event emitter.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `emitter` | [`EventEmitter`](../classes/event_emitter.EventEmitter.md) | The event emitter to remove listeners from. |
-| `type?` | `string` | The event to remove listeners for. If not provided, all listeners for all events will be removed. |
-
-#### Returns
-
-[`EventEmitter`](../classes/event_emitter.EventEmitter.md)
-
-- The event emitter with all listeners removed.
-
-#### Defined in
-
-[src/all-off.js:12](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/all-off.js#L12)

package/docs/modules/consts.md

@@ -1,39 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / consts
-
-# Module: consts
-
-## Table of contents
-
-### Variables
-
-- [RegExpEventSymbol](consts.md#regexpeventsymbol)
-- [states](consts.md#states)
-
-## Variables
-
-### RegExpEventSymbol
-
-• `Const` **RegExpEventSymbol**: `symbol` \| ``"@@RegExpEvent"``
-
-#### Defined in
-
-[src/consts.js:13](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/consts.js#L13)
-
-___
-
-### states
-
-• `Const` **states**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `ABORT` | `number` |
-| `CONTINUE` | `any` |
-| `DONE` | `number` |
-| `STOPPED` | `number` |
-
-#### Defined in
-
-[src/consts.js:6](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/consts.js#L6)

package/docs/modules/default_methods.md

@@ -1,51 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / default-methods
-
-# Module: default-methods
-
-## Table of contents
-
-### References
-
-- [default](default_methods.md#default)
-
-### Functions
-
-- [getEventableMethods](default_methods.md#geteventablemethods)
-
-## References
-
-### default
-
-Renames and re-exports [getEventableMethods](default_methods.md#geteventablemethods)
-
-## Functions
-
-### getEventableMethods
-
-▸ **getEventableMethods**(`aClass`): `Object`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `aClass` | `any` |
-
-#### Returns
-
-`Object`
-
-| Name | Type |
-| :------ | :------ |
-| `emit` | (...`args`: `any`) => `any` |
-| `emitAsync` | (...`args`: `any`) => `Promise`\<`any`\> |
-| `listenerCount` | (`emitter`: `any`, `type`: `any`) => `number` |
-| `listeners` | (`type`: `any`) => `any` |
-| `off` | (`type`: `string` \| `RegExp`, `listener`: `Function`) => [`EventEmitter`](../classes/event_emitter.EventEmitter.md) |
-| `on` | (`type`: `string` \| `RegExp`, `listener`: `Function`, `index?`: `number`) => [`EventEmitter`](../classes/event_emitter.EventEmitter.md) |
-| `once` | (`type`: `string` \| `RegExp`, `listener`: `Function`, `index?`: `number`) => [`EventEmitter`](../classes/event_emitter.EventEmitter.md) |
-| `removeAllListeners` | (`type`: `string` \| `RegExp`) => [`EventEmitter`](../classes/event_emitter.EventEmitter.md) |
-| `setMaxListeners` | (`n`: `any`) => \{ on(type: string \| RegExp, listener: Function, index?: number): EventEmitter; once(type: string \| RegExp, listener: Function, index?: number): EventEmitter; ... 6 more ...; removeAllListeners(type: string \| RegExp): EventEmitter; } |
-
-#### Defined in
-
-[src/default-methods.js:14](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/default-methods.js#L14)

package/docs/modules/event.md

@@ -1,19 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / event
-
-# Module: event
-
-## Table of contents
-
-### References
-
-- [default](event.md#default)
-
-### Classes
-
-- [Event](../classes/event.Event.md)
-
-## References
-
-### default
-
-Renames and re-exports [Event](../classes/event.Event.md)

package/docs/modules/event_emitter-1.md

@@ -1,19 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / event-emitter
-
-# Module: event-emitter
-
-## Table of contents
-
-### References
-
-- [default](event_emitter-1.md#default)
-
-### Classes
-
-- [EventEmitter](../classes/event_emitter-1.EventEmitter.md)
-
-## References
-
-### default
-
-Renames and re-exports [EventEmitter](../classes/event_emitter-1.EventEmitter.md)

package/docs/modules/event_emitter.md

@@ -1,19 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / event-emitter
-
-# Module: event-emitter
-
-## Table of contents
-
-### References
-
-- [default](event_emitter.md#default)
-
-### Classes
-
-- [EventEmitter](../classes/event_emitter.EventEmitter.md)
-
-## References
-
-### default
-
-Renames and re-exports [EventEmitter](../classes/event_emitter.EventEmitter.md)

package/docs/modules/eventable.md

@@ -1,92 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / eventable
-
-# Module: eventable
-
-## Table of contents
-
-### References
-
-- [default](eventable.md#default)
-
-### Functions
-
-- [eventable](eventable.md#eventable)
-
-## References
-
-### default
-
-Renames and re-exports [eventable](eventable.md#eventable)
-
-## Functions
-
-### eventable
-
-▸ **eventable**\<`T`\>(`targetClass?`, `options?`): `EnhancedClass`\<`T`, (`aClass?`: `Function`) => `Function`\>
-
-Adds event-emitting capabilities to a class by injecting necessary methods and properties.
-
-This function uses `createAbilityInjector` from `custom-ability` to inject event-related methods
-into the target class. The injected methods include standard EventEmitter functionality such as
-`on`, `off`, `emit`, `emitAsync`, `once`, `listeners`, `@listenerCount` and more. It also ensures compatibility with Node.js `EventEmitter`
-by including methods like `listenerCount`, `setMaxListeners`, `addListener`, `removeListener`, and `removeAllListeners`.
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | extends `ClassEx` |
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `targetClass?` | `T` | - |
-| `options?` | `AbilityOptions` | Optional configuration for the injection process: * `include` (string[]\|string): Specifies which methods should be added. Static methods should use the prefix '@'. * `exclude` (string[]\|string): Specifies which methods should not be added. Static methods should use the prefix '@'. * `methods` (Object): Custom methods to override or extend the default behavior. Use `this.super()` to call the original method and `this.self` to access the original context. * `classMethods` (Object): Custom static methods to be added to the class. |
-
-#### Returns
-
-`EnhancedClass`\<`T`, (`aClass?`: `Function`) => `Function`\>
-
-The same `aClass` class with event capabilities injected. The return value is the modified `aClass` itself.
-
-**`Function`**
-
-eventable
-
-**`Example`**
-
-```ts
-import { eventable } from 'events-ex';
-
-class MyClass {}
-
-// Inject only specific methods: 'on', 'off', 'emit', 'emitAsync', and the static 'listenerCount'
-eventable(MyClass, { include: ['on', 'off', 'emit', 'emitAsync', '@listenerCount'] });
-```
-
-**`Example`**
-
-```ts
-import { eventable } from 'events-ex';
-
-class OtherClass {
-  exec() {
-    console.log("Original exec");
-  }
-}
-
-// Inject event capabilities and override the `exec` method
-eventable(OtherClass, {
-  methods: {
-    exec() {
-      console.log("New exec");
-      this.super(); // Calls the original `exec` method
-    }
-  }
-});
-```
-
-#### Defined in
-
-node_modules/custom-ability/lib/custom-ability.d.ts:34

package/docs/modules/has_listeners.md

@@ -1,49 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / has-listeners
-
-# Module: has-listeners
-
-## Table of contents
-
-### References
-
-- [default](has_listeners.md#default)
-
-### Functions
-
-- [hasListeners](has_listeners.md#haslisteners)
-
-## References
-
-### default
-
-Renames and re-exports [hasListeners](has_listeners.md#haslisteners)
-
-## Functions
-
-### hasListeners
-
-▸ **hasListeners**(`obj`, `type?`): `boolean`
-
-Checks if an object has event listeners.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `obj` | `any` | The object to check. Must not be null or undefined. |
-| `type?` | `string` | Optional parameter specifying the event type. If provided, checks for the existence of listeners for this specific type. |
-
-#### Returns
-
-`boolean`
-
-- If `type` is provided, returns whether listeners for the specified event type exist.
-         - If `type` is not provided, returns whether the object has any event listeners.
-
-**`Throws`**
-
-Throws a TypeError if `obj` is null or undefined.
-
-#### Defined in
-
-[src/has-listeners.js:20](https://github.com/snowyu/events-ex.js/blob/a6cce2d/src/has-listeners.js#L20)