events-ex 2.1.1 → 2.3.0

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/9c254b2/src/has-listeners.js#L20)

package/docs/modules/index.md

@@ -1,99 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / index
-
-# Module: index
-
-## Table of contents
-
-### References
-
-- [Event](index.md#event)
-- [EventEmitter](index.md#eventemitter)
-- [RegExpEventSymbol](index.md#regexpeventsymbol)
-- [allOff](index.md#alloff)
-- [default](index.md#default)
-- [eventable](index.md#eventable)
-- [hasListeners](index.md#haslisteners)
-- [methods](index.md#methods)
-- [pipe](index.md#pipe)
-- [pipeAsync](index.md#pipeasync)
-- [states](index.md#states)
-- [unify](index.md#unify)
-- [wrapEventEmitter](index.md#wrapeventemitter)
-
-## References
-
-### Event
-
-Re-exports [Event](../classes/event.Event.md)
-
-___
-
-### EventEmitter
-
-Re-exports [EventEmitter](../classes/event_emitter.EventEmitter.md)
-
-___
-
-### RegExpEventSymbol
-
-Re-exports [RegExpEventSymbol](consts.md#regexpeventsymbol)
-
-___
-
-### allOff
-
-Re-exports [allOff](all_off.md#alloff)
-
-___
-
-### default
-
-Renames and re-exports [EventEmitter](../classes/event_emitter.EventEmitter.md)
-
-___
-
-### eventable
-
-Re-exports [eventable](eventable.md#eventable)
-
-___
-
-### hasListeners
-
-Re-exports [hasListeners](has_listeners.md#haslisteners)
-
-___
-
-### methods
-
-Re-exports [methods](wrap_event_emitter.md#methods)
-
-___
-
-### pipe
-
-Re-exports [pipe](pipe.md#pipe)
-
-___
-
-### pipeAsync
-
-Re-exports [pipeAsync](pipe_async.md#pipeasync)
-
-___
-
-### states
-
-Re-exports [states](consts.md#states)
-
-___
-
-### unify
-
-Re-exports [unify](unify.md#unify)
-
-___
-
-### wrapEventEmitter
-
-Re-exports [wrapEventEmitter](wrap_event_emitter.md#wrapeventemitter)

package/docs/modules/pipe.md

@@ -1,49 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / pipe
-
-# Module: pipe
-
-## Table of contents
-
-### References
-
-- [default](pipe.md#default)
-
-### Functions
-
-- [pipe](pipe.md#pipe)
-
-## References
-
-### default
-
-Renames and re-exports [pipe](pipe.md#pipe)
-
-## Functions
-
-### pipe
-
-▸ **pipe**(`e1`, `e2`, `...args`): `any`
-
-Creates a pipeline between two event emitters, so that any events emitted by the first emitter are also emitted by the second emitter.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `e1` | [`EventEmitter`](../classes/event_emitter.EventEmitter.md) | The first event emitter. |
-| `e2` | [`EventEmitter`](../classes/event_emitter.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.
-
-#### Defined in
-
-[src/pipe.js:21](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/pipe.js#L21)

package/docs/modules/pipe_async.md

@@ -1,49 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / pipe-async
-
-# Module: pipe-async
-
-## Table of contents
-
-### References
-
-- [default](pipe_async.md#default)
-
-### Functions
-
-- [pipeAsync](pipe_async.md#pipeasync)
-
-## References
-
-### default
-
-Renames and re-exports [pipeAsync](pipe_async.md#pipeasync)
-
-## Functions
-
-### pipeAsync
-
-▸ **pipeAsync**(`e1`, `e2`, `...args`): `any`
-
-Creates a pipeline between two event emitters, so that any events emitted by the first emitter are also emitted by the second emitter.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `e1` | [`EventEmitter`](../classes/event_emitter.EventEmitter.md) | The first event emitter. |
-| `e2` | [`EventEmitter`](../classes/event_emitter.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.
-
-#### Defined in
-
-[src/pipe-async.js:21](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/pipe-async.js#L21)

package/docs/modules/unify.md

@@ -1,46 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / unify
-
-# Module: unify
-
-## Table of contents
-
-### References
-
-- [default](unify.md#default)
-
-### Functions
-
-- [unify](unify.md#unify)
-
-## References
-
-### default
-
-Renames and re-exports [unify](unify.md#unify)
-
-## Functions
-
-### unify
-
-▸ **unify**(`e1`, `e2`): `void`
-
-Unifies the event listeners of two event emitter objects so that they share the same set of listeners for each event.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `e1` | [`EventEmitter`](../classes/event_emitter.EventEmitter.md) | The first event emitter object. |
-| `e2` | [`EventEmitter`](../classes/event_emitter.EventEmitter.md) | The second event emitter object. |
-
-#### Returns
-
-`void`
-
-**`Throws`**
-
-- If either of the arguments is not an event emitter object.
-
-#### Defined in
-
-[src/unify.js:17](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/unify.js#L17)

package/docs/modules/util_array_remove.md

@@ -1,39 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / util/array-remove
-
-# Module: util/array-remove
-
-## Table of contents
-
-### References
-
-- [default](util_array_remove.md#default)
-
-### Functions
-
-- [remove](util_array_remove.md#remove)
-
-## References
-
-### default
-
-Renames and re-exports [remove](util_array_remove.md#remove)
-
-## Functions
-
-### remove
-
-▸ **remove**(`...args`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `...args` | `any` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[src/util/array-remove.js:5](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/util/array-remove.js#L5)

package/docs/modules/util_object_for_each.md

@@ -1,41 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / util/object-for-each
-
-# Module: util/object-for-each
-
-## Table of contents
-
-### References
-
-- [default](util_object_for_each.md#default)
-
-### Functions
-
-- [forEach](util_object_for_each.md#foreach)
-
-## References
-
-### default
-
-Renames and re-exports [forEach](util_object_for_each.md#foreach)
-
-## Functions
-
-### forEach
-
-▸ **forEach**(`obj`, `cb`, `...args`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `obj` | `any` |
-| `cb` | `any` |
-| `...args` | `any` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[src/util/object-for-each.js:6](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/util/object-for-each.js#L6)

package/docs/modules/util_string_pad.md

@@ -1,40 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / util/string-pad
-
-# Module: util/string-pad
-
-## Table of contents
-
-### References
-
-- [default](util_string_pad.md#default)
-
-### Functions
-
-- [pad](util_string_pad.md#pad)
-
-## References
-
-### default
-
-Renames and re-exports [pad](util_string_pad.md#pad)
-
-## Functions
-
-### pad
-
-▸ **pad**(`fill`, `...args`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `fill` | `any` |
-| `...args` | `any` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/util/string-pad.js:8](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/util/string-pad.js#L8)

package/docs/modules/util_to_int.md

@@ -1,39 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / util/to-int
-
-# Module: util/to-int
-
-## Table of contents
-
-### References
-
-- [default](util_to_int.md#default)
-
-### Functions
-
-- [toInt](util_to_int.md#toint)
-
-## References
-
-### default
-
-Renames and re-exports [toInt](util_to_int.md#toint)
-
-## Functions
-
-### toInt
-
-▸ **toInt**(`value`): `any`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `any` |
-
-#### Returns
-
-`any`
-
-#### Defined in
-
-[src/util/to-int.js:2](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/util/to-int.js#L2)

package/docs/modules/util_valid_callable.md

@@ -1,39 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / util/valid-callable
-
-# Module: util/valid-callable
-
-## Table of contents
-
-### References
-
-- [default](util_valid_callable.md#default)
-
-### Functions
-
-- [validCallable](util_valid_callable.md#validcallable)
-
-## References
-
-### default
-
-Renames and re-exports [validCallable](util_valid_callable.md#validcallable)
-
-## Functions
-
-### validCallable
-
-▸ **validCallable**(`fn`): `any`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `fn` | `any` |
-
-#### Returns
-
-`any`
-
-#### Defined in
-
-[src/util/valid-callable.js:1](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/util/valid-callable.js#L1)

package/docs/modules/util_valid_object.md

@@ -1,39 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / util/valid-object
-
-# Module: util/valid-object
-
-## Table of contents
-
-### References
-
-- [default](util_valid_object.md#default)
-
-### Functions
-
-- [validObject](util_valid_object.md#validobject)
-
-## References
-
-### default
-
-Renames and re-exports [validObject](util_valid_object.md#validobject)
-
-## Functions
-
-### validObject
-
-▸ **validObject**(`value`): `any`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `any` |
-
-#### Returns
-
-`any`
-
-#### Defined in
-
-[src/util/valid-object.js:3](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/util/valid-object.js#L3)

package/docs/modules/wrap_event_emitter.md

@@ -1,57 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / wrap-event-emitter
-
-# Module: wrap-event-emitter
-
-## Table of contents
-
-### References
-
-- [default](wrap_event_emitter.md#default)
-
-### Variables
-
-- [methods](wrap_event_emitter.md#methods)
-
-### Functions
-
-- [wrapEventEmitter](wrap_event_emitter.md#wrapeventemitter)
-
-## References
-
-### default
-
-Renames and re-exports [wrapEventEmitter](wrap_event_emitter.md#wrapeventemitter)
-
-## Variables
-
-### methods
-
-• `Const` **methods**: `any`
-
-#### Defined in
-
-[src/wrap-event-emitter.js:7](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/wrap-event-emitter.js#L7)
-
-## Functions
-
-### wrapEventEmitter
-
-▸ **wrapEventEmitter**(`o?`): `any`
-
-Create or inject the eventable instance into the object
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `o?` | `any` | the optional instance to eventable |
-
-#### Returns
-
-`any`
-
-o or new Event instance
-
-#### Defined in
-
-[src/wrap-event-emitter.js:34](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/wrap-event-emitter.js#L34)