events-ex 2.0.0 → 2.0.1

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [2.0.1](https://github.com/snowyu/events-ex.js/compare/v2.0.0...v2.0.1) (2025-03-08)
+
+
+### Refactor
+
+* hasListeners for performance ([3e49967](https://github.com/snowyu/events-ex.js/commit/3e49967296cb1d75291091f82232212d5f63af78))
+
 ## [2.0.0](https://github.com/snowyu/events-ex.js/compare/v2.0.0-alpha.15...v2.0.0) (2024-08-29)
 
 ## [2.0.0-alpha.15](https://github.com/snowyu/events-ex.js/compare/v2.0.0-alpha.14...v2.0.0-alpha.15) (2024-04-05)

package/README.cn.md

@@ -1,4 +1,4 @@
-### events-ex [![Build Status](https://img.shields.io/travis/snowyu/events-ex.js/master.png)](http://travis-ci.org/snowyu/events-ex.js) [![npm](https://img.shields.io/npm/v/events-ex.svg)](https://npmjs.org/package/events-ex) [![downloads](https://img.shields.io/npm/dm/events-ex.svg)](https://npmjs.org/package/events-ex) [![license](https://img.shields.io/npm/l/events-ex.svg)](https://npmjs.org/package/events-ex)
+### events-ex [![npm](https://img.shields.io/npm/v/events-ex.svg)](https://npmjs.org/package/events-ex) [![downloads](https://img.shields.io/npm/dm/events-ex.svg)](https://npmjs.org/package/events-ex) [![license](https://img.shields.io/npm/l/events-ex.svg)](https://npmjs.org/package/events-ex)
 
 
 浏览器友好的增强的**事件**[能力][Ability]和类。 它主要是从 [event-emitter][event-emitter] 修改而来的。 本库可以为你的任何类添加(注入)**事件**[能力][Ability]。

package/README.md

@@ -1,4 +1,4 @@
-### events-ex [![Build Status](https://img.shields.io/travis/snowyu/events-ex.js/master.png)](http://travis-ci.org/snowyu/events-ex.js) [![npm](https://img.shields.io/npm/v/events-ex.svg)](https://npmjs.org/package/events-ex) [![downloads](https://img.shields.io/npm/dm/events-ex.svg)](https://npmjs.org/package/events-ex) [![license](https://img.shields.io/npm/l/events-ex.svg)](https://npmjs.org/package/events-ex)
+### events-ex [![npm](https://img.shields.io/npm/v/events-ex.svg)](https://npmjs.org/package/events-ex) [![downloads](https://img.shields.io/npm/dm/events-ex.svg)](https://npmjs.org/package/events-ex) [![license](https://img.shields.io/npm/l/events-ex.svg)](https://npmjs.org/package/events-ex)
 
 
 Browser-friendly enhanced event emitter [ability][Ability] and class. It's modified from [event-emitter][event-emitter] mainly. It can add/inject the event-able [ability][Ability] to your any class.

package/docs/README.md

@@ -1,6 +1,6 @@
 events-ex / [Exports](modules.md)
 
-### events-ex [![Build Status](https://img.shields.io/travis/snowyu/events-ex.js/master.png)](http://travis-ci.org/snowyu/events-ex.js) [![npm](https://img.shields.io/npm/v/events-ex.svg)](https://npmjs.org/package/events-ex) [![downloads](https://img.shields.io/npm/dm/events-ex.svg)](https://npmjs.org/package/events-ex) [![license](https://img.shields.io/npm/l/events-ex.svg)](https://npmjs.org/package/events-ex)
+### events-ex [![npm](https://img.shields.io/npm/v/events-ex.svg)](https://npmjs.org/package/events-ex) [![downloads](https://img.shields.io/npm/dm/events-ex.svg)](https://npmjs.org/package/events-ex) [![license](https://img.shields.io/npm/l/events-ex.svg)](https://npmjs.org/package/events-ex)
 
 Browser-friendly enhanced event emitter [ability][Ability] and class. It's modified from [event-emitter][event-emitter] mainly. It can add/inject the event-able [ability][Ability] to your any class.
 

package/docs/classes/event.Event.md

@@ -49,7 +49,7 @@ Event Object that contains information about the event, such as the target eleme
 
 #### Defined in
 
-[src/event.js:8](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event.js#L8)
+[src/event.js:8](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event.js#L8)
 
 ## Properties
 
@@ -61,7 +61,7 @@ Keep your event result here if any.
 
 #### Defined in
 
-[src/event.js:38](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event.js#L38)
+[src/event.js:38](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event.js#L38)
 
 ___
 
@@ -73,7 +73,7 @@ Whether stop the bubbling event
 
 #### Defined in
 
-[src/event.js:32](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event.js#L32)
+[src/event.js:32](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event.js#L32)
 
 ___
 
@@ -85,7 +85,7 @@ Who trigger the event
 
 #### Defined in
 
-[src/event.js:26](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event.js#L26)
+[src/event.js:26](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event.js#L26)
 
 ___
 
@@ -97,7 +97,7 @@ The type of the event.
 
 #### Defined in
 
-[src/event.js:44](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event.js#L44)
+[src/event.js:44](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event.js#L44)
 
 ## Methods
 
@@ -115,7 +115,7 @@ The result of the event.
 
 #### Defined in
 
-[src/event.js:51](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event.js#L51)
+[src/event.js:51](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event.js#L51)
 
 ___
 
@@ -138,4 +138,4 @@ Initializes the event with the target object.
 
 #### Defined in
 
-[src/event.js:20](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event.js#L20)
+[src/event.js:20](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event.js#L20)

package/docs/classes/event_emitter-1.EventEmitter.md

@@ -26,4 +26,4 @@ Class that represents an event emitter.
 
 #### Defined in
 
-[src/event-emitter.js:8](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event-emitter.js#L8)
+[src/event-emitter.js:8](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event-emitter.js#L8)

package/docs/classes/event_emitter.EventEmitter.md

@@ -47,7 +47,7 @@ Class that represents an event emitter.
 
 #### Defined in
 
-[src/event-emitter.d.ts:7](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event-emitter.d.ts#L7)
+[src/event-emitter.d.ts:7](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event-emitter.d.ts#L7)
 
 ## Methods
 
@@ -72,7 +72,7 @@ The result of the event.
 
 #### Defined in
 
-[src/event-emitter.d.ts:38](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event-emitter.d.ts#L38)
+[src/event-emitter.d.ts:38](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event-emitter.d.ts#L38)
 
 ___
 
@@ -97,7 +97,7 @@ 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/5b9fac0/src/event-emitter.d.ts#L44)
+[src/event-emitter.d.ts:44](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event-emitter.d.ts#L44)
 
 ___
 
@@ -121,7 +121,7 @@ Returns the count of listeners that are registered to listen for the specified e
 
 #### Defined in
 
-[src/event-emitter.d.ts:66](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event-emitter.d.ts#L66)
+[src/event-emitter.d.ts:66](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event-emitter.d.ts#L66)
 
 ___
 
@@ -145,7 +145,7 @@ Returns an array of functions that are registered to listen for the specified ev
 
 #### Defined in
 
-[src/event-emitter.d.ts:59](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event-emitter.d.ts#L59)
+[src/event-emitter.d.ts:59](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event-emitter.d.ts#L59)
 
 ___
 
@@ -174,7 +174,7 @@ If the listener is not a function.
 
 #### Defined in
 
-[src/event-emitter.d.ts:32](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event-emitter.d.ts#L32)
+[src/event-emitter.d.ts:32](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event-emitter.d.ts#L32)
 
 ___
 
@@ -203,7 +203,7 @@ If the listener is not a function.
 
 #### Defined in
 
-[src/event-emitter.d.ts:16](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event-emitter.d.ts#L16)
+[src/event-emitter.d.ts:16](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event-emitter.d.ts#L16)
 
 ___
 
@@ -232,7 +232,7 @@ If the listener is not a function.
 
 #### Defined in
 
-[src/event-emitter.d.ts:24](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event-emitter.d.ts#L24)
+[src/event-emitter.d.ts:24](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event-emitter.d.ts#L24)
 
 ___
 
@@ -256,7 +256,7 @@ Removes all listeners for a specific event or all events from an event emitter.
 
 #### Defined in
 
-[src/event-emitter.d.ts:51](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event-emitter.d.ts#L51)
+[src/event-emitter.d.ts:51](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event-emitter.d.ts#L51)
 
 ___
 
@@ -276,7 +276,7 @@ ___
 
 #### Defined in
 
-[src/event-emitter.d.ts:52](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event-emitter.d.ts#L52)
+[src/event-emitter.d.ts:52](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event-emitter.d.ts#L52)
 
 ___
 
@@ -303,4 +303,4 @@ use emitter.listenerCount instead
 
 #### Defined in
 
-[src/event-emitter.d.ts:74](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/event-emitter.d.ts#L74)
+[src/event-emitter.d.ts:74](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/event-emitter.d.ts#L74)

package/docs/modules/all_off.md

@@ -41,4 +41,4 @@ Removes all listeners for a specific event or all events from an event emitter.
 
 #### Defined in
 
-[src/all-off.js:12](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/all-off.js#L12)
+[src/all-off.js:12](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/all-off.js#L12)

package/docs/modules/consts.md

@@ -17,7 +17,7 @@
 
 #### Defined in
 
-[src/consts.js:13](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/consts.js#L13)
+[src/consts.js:13](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/consts.js#L13)
 
 ___
 
@@ -36,4 +36,4 @@ ___
 
 #### Defined in
 
-[src/consts.js:6](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/consts.js#L6)
+[src/consts.js:6](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/consts.js#L6)

package/docs/modules/default_methods.md

@@ -48,4 +48,4 @@ Renames and re-exports [getEventableMethods](default_methods.md#geteventablemeth
 
 #### Defined in
 
-[src/default-methods.js:14](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/default-methods.js#L14)
+[src/default-methods.js:14](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/default-methods.js#L14)

package/docs/modules/eventable.md

@@ -22,19 +22,71 @@ Renames and re-exports [eventable](eventable.md#eventable)
 
 ### eventable
 
-▸ **eventable**(`targetClass?`, `options?`): `Function`
+▸ **eventable**\<`T`\>(`targetClass?`, `options?`): `EnhancedClass`\<`T`, (`aClass?`: `Function`) => `Function`\>
 
-#### Parameters
+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 |
 | :------ | :------ |
-| `targetClass?` | `Function` |
-| `options?` | `AbilityOptions` |
+| `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
 
-`Function`
+`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:28
+node_modules/custom-ability/lib/custom-ability.d.ts:34

package/docs/modules/has_listeners.md

@@ -22,19 +22,28 @@ Renames and re-exports [hasListeners](has_listeners.md#haslisteners)
 
 ### hasListeners
 
-▸ **hasListeners**(`obj`, `...args`): `boolean`
+▸ **hasListeners**(`obj`, `type?`): `boolean`
+
+Checks if an object has event listeners.
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `obj` | `any` |
-| `...args` | `any` |
+| 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:10](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/has-listeners.js#L10)
+[src/has-listeners.js:20](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/has-listeners.js#L20)

package/docs/modules/pipe.md

@@ -46,4 +46,4 @@ Creates a pipeline between two event emitters, so that any events emitted by the
 
 #### Defined in
 
-[src/pipe.js:21](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/pipe.js#L21)
+[src/pipe.js:21](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/pipe.js#L21)

package/docs/modules/pipe_async.md

@@ -46,4 +46,4 @@ Creates a pipeline between two event emitters, so that any events emitted by the
 
 #### Defined in
 
-[src/pipe-async.js:21](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/pipe-async.js#L21)
+[src/pipe-async.js:21](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/pipe-async.js#L21)

package/docs/modules/unify.md

@@ -43,4 +43,4 @@ Unifies the event listeners of two event emitter objects so that they share the
 
 #### Defined in
 
-[src/unify.js:17](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/unify.js#L17)
+[src/unify.js:17](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/unify.js#L17)

package/docs/modules/util_array_remove.md

@@ -36,4 +36,4 @@ Renames and re-exports [remove](util_array_remove.md#remove)
 
 #### Defined in
 
-[src/util/array-remove.js:5](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/util/array-remove.js#L5)
+[src/util/array-remove.js:5](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/util/array-remove.js#L5)

package/docs/modules/util_object_for_each.md

@@ -38,4 +38,4 @@ Renames and re-exports [forEach](util_object_for_each.md#foreach)
 
 #### Defined in
 
-[src/util/object-for-each.js:6](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/util/object-for-each.js#L6)
+[src/util/object-for-each.js:6](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/util/object-for-each.js#L6)

package/docs/modules/util_string_pad.md

@@ -37,4 +37,4 @@ Renames and re-exports [pad](util_string_pad.md#pad)
 
 #### Defined in
 
-[src/util/string-pad.js:8](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/util/string-pad.js#L8)
+[src/util/string-pad.js:8](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/util/string-pad.js#L8)

package/docs/modules/util_to_int.md

@@ -36,4 +36,4 @@ Renames and re-exports [toInt](util_to_int.md#toint)
 
 #### Defined in
 
-[src/util/to-int.js:2](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/util/to-int.js#L2)
+[src/util/to-int.js:2](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/util/to-int.js#L2)

package/docs/modules/util_valid_callable.md

@@ -36,4 +36,4 @@ Renames and re-exports [validCallable](util_valid_callable.md#validcallable)
 
 #### Defined in
 
-[src/util/valid-callable.js:1](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/util/valid-callable.js#L1)
+[src/util/valid-callable.js:1](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/util/valid-callable.js#L1)

package/docs/modules/util_valid_object.md

@@ -36,4 +36,4 @@ Renames and re-exports [validObject](util_valid_object.md#validobject)
 
 #### Defined in
 
-[src/util/valid-object.js:3](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/util/valid-object.js#L3)
+[src/util/valid-object.js:3](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/util/valid-object.js#L3)

package/docs/modules/wrap_event_emitter.md

@@ -30,7 +30,7 @@ Renames and re-exports [wrapEventEmitter](wrap_event_emitter.md#wrapeventemitter
 
 #### Defined in
 
-[src/wrap-event-emitter.js:7](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/wrap-event-emitter.js#L7)
+[src/wrap-event-emitter.js:7](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/wrap-event-emitter.js#L7)
 
 ## Functions
 
@@ -54,4 +54,4 @@ o or new Event instance
 
 #### Defined in
 
-[src/wrap-event-emitter.js:34](https://github.com/snowyu/events-ex.js/blob/5b9fac0/src/wrap-event-emitter.js#L34)
+[src/wrap-event-emitter.js:34](https://github.com/snowyu/events-ex.js/blob/0aebeb6/src/wrap-event-emitter.js#L34)

package/lib/eventable.d.ts

@@ -1,2 +1,57 @@
-export const eventable: import("custom-ability").AbilityFn;
+/**
+ * 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`.
+ *
+ * @function eventable
+ * @param {Class} [aClass] - The target class to which event capabilities will be injected. if no class is provided, a new class with eventable will be created.
+ * @param {Object} [options] - 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 {Class} The same `aClass` class with event capabilities injected. The return value is the modified `aClass` itself.
+ *
+ * @example
+ * 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
+ * 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
+ *     }
+ *   }
+ * });
+ */
+export const eventable: <T extends Function | (new (...args: any[]) => any)>(targetClass?: T, options?: import("custom-ability").AbilityOptions) => T & typeof getEventableClass & (T extends new (...args: any[]) => any ? InstanceType<T> : T);
 export default eventable;
+/**
+ * Creates an Eventable class with event-emitting capabilities.
+ *
+ * @param {Function} [aClass] - The target class to which event capabilities will be injected.
+ *                              If not provided, a new base class (`Eventable`) is created and used.
+ * @returns {Function} A class with event-emitting capabilities.
+ */
+declare function getEventableClass(aClass?: Function): Function;

package/lib/eventable.js

@@ -8,7 +8,18 @@ var _customAbility = require("custom-ability");
 var _defineProperty = _interopRequireDefault(require("util-ex/lib/defineProperty"));
 var _defaultMethods = _interopRequireDefault(require("./default-methods"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * Creates an Eventable class with event-emitting capabilities.
+ *
+ * @param {Function} [aClass] - The target class to which event capabilities will be injected.
+ *                              If not provided, a new base class (`Eventable`) is created and used.
+ * @returns {Function} A class with event-emitting capabilities.
+ */
 function getEventableClass(aClass) {
+  /**
+   * Base Eventable class that provides event-related functionality.
+   * @class
+   */
   function Eventable() {}
   if (aClass == null) {
     aClass = Eventable;
@@ -31,5 +42,53 @@ function getEventableClass(aClass) {
   return Eventable;
 }
 ;
+
+/**
+ * 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`.
+ *
+ * @function eventable
+ * @param {Class} [aClass] - The target class to which event capabilities will be injected. if no class is provided, a new class with eventable will be created.
+ * @param {Object} [options] - 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 {Class} The same `aClass` class with event capabilities injected. The return value is the modified `aClass` itself.
+ *
+ * @example
+ * 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
+ * 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
+ *     }
+ *   }
+ * });
+ */
 const eventable = exports.eventable = (0, _customAbility.createAbilityInjector)(getEventableClass, true);
 var _default = exports.default = eventable;

package/lib/has-listeners.d.ts

@@ -1,2 +1,12 @@
-export function hasListeners(obj: any, ...args: any[]): boolean;
+/**
+ * Checks if an object has event listeners.
+ *
+ * @param {Object} obj - The object to check. Must not be null or undefined.
+ * @param {string} [type] - 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 {TypeError} Throws a TypeError if `obj` is null or undefined.
+ */
+export function hasListeners(obj: any, type?: string): boolean;
 export default hasListeners;

package/lib/has-listeners.js

@@ -10,15 +10,23 @@ const hasOwnProperty = Object.prototype.hasOwnProperty;
 function isValue(v) {
   return v !== null && v !== undefined;
 }
-function hasListeners(obj /* , type */) {
+
+/**
+ * Checks if an object has event listeners.
+ *
+ * @param {Object} obj - The object to check. Must not be null or undefined.
+ * @param {string} [type] - 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 {TypeError} Throws a TypeError if `obj` is null or undefined.
+ */
+function hasListeners(obj, type) {
   if (!isValue(obj)) {
     throw new TypeError("Cannot use null or undefined");
   }
-  const type = arguments[1];
-  if (arguments.length > 1) {
-    return hasOwnProperty.call(obj, '_events') && Boolean(obj._events[type]);
-  }
-  return obj.hasOwnProperty('_events') && !(0, _utilEx.isEmptyObject)(obj._events);
+  const result = type != null ? hasOwnProperty.call(obj, '_events') && obj._events[type] : obj.hasOwnProperty('_events') && !(0, _utilEx.isEmptyObject)(obj._events);
+  return result;
 }
 ;
 var _default = exports.default = hasListeners;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "events-ex",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Browser-friendly enhanced events most compatible with standard node.js, it's powerful eventable ability.",
   "contributors": [
     {
@@ -37,7 +37,7 @@
   "main": "./lib/index.js",
   "module": "./src/index.js",
   "dependencies": {
-    "custom-ability": "^2.0.0",
+    "custom-ability": "^2.0.1",
     "util-ex": "^2.0.0"
   },
   "devDependencies": {
@@ -51,7 +51,7 @@
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-tsdoc": "^0.2.17",
-    "mocha": "^10.2.0",
+    "mocha": "^10.6.0",
     "prettier": "^3.1.1",
     "typedoc": "^0.25.4",
     "typedoc-plugin-markdown": "^3.17.1",

package/src/eventable.js

@@ -2,7 +2,18 @@ import {createAbilityInjector} from 'custom-ability'
 import defineProperty from 'util-ex/lib/defineProperty'
 import defaultMethods from './default-methods'
 
+/**
+ * Creates an Eventable class with event-emitting capabilities.
+ *
+ * @param {Function} [aClass] - The target class to which event capabilities will be injected.
+ *                              If not provided, a new base class (`Eventable`) is created and used.
+ * @returns {Function} A class with event-emitting capabilities.
+ */
 function getEventableClass(aClass) {
+  /**
+   * Base Eventable class that provides event-related functionality.
+   * @class
+   */
   function Eventable() {}
 
   if (aClass == null) {aClass = Eventable}
@@ -25,5 +36,52 @@ function getEventableClass(aClass) {
   return Eventable;
 };
 
+/**
+ * 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`.
+ *
+ * @function eventable
+ * @param {Class} [aClass] - The target class to which event capabilities will be injected. if no class is provided, a new class with eventable will be created.
+ * @param {Object} [options] - 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 {Class} The same `aClass` class with event capabilities injected. The return value is the modified `aClass` itself.
+ *
+ * @example
+ * 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
+ * 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
+ *     }
+ *   }
+ * });
+ */
 export const eventable = createAbilityInjector(getEventableClass, true);
 export default eventable;

package/src/has-listeners.js

@@ -7,14 +7,21 @@ function isValue(v) {
 	return v!== null && v!== undefined
 }
 
-export function hasListeners(obj/* , type */) {
+/**
+ * Checks if an object has event listeners.
+ *
+ * @param {Object} obj - The object to check. Must not be null or undefined.
+ * @param {string} [type] - 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 {TypeError} Throws a TypeError if `obj` is null or undefined.
+ */
+export function hasListeners(obj, type) {
 	if (!isValue(obj)) {throw new TypeError("Cannot use null or undefined")}
 
-	const type = arguments[1];
-	if (arguments.length > 1) {
-		return hasOwnProperty.call(obj, '_events') && Boolean(obj._events[type]);
-	}
-	return obj.hasOwnProperty('_events') && !isEmptyObject(obj._events);
+	const result = type != null ? hasOwnProperty.call(obj, '_events') && obj._events[type] : obj.hasOwnProperty('_events') && !isEmptyObject(obj._events);
+	return result;
 };
 
 export default hasListeners