events-ex - npm Package Compare versions

Comparing version 2.0.0-alpha.3 to 2.0.0-alpha.4

CHANGELOG.md

@@ -5,2 +5,9 @@ # Changelog
 
+## [2.0.0-alpha.4](https://github.com/snowyu/events-ex.js/compare/v2.0.0-alpha.3...v2.0.0-alpha.4) (2023-12-31)
+
+
+### Bug Fixes
+
+* add message parameter to Error object if exists ([8b7be69](https://github.com/snowyu/events-ex.js/commit/8b7be691a7ede7772d4150ae24aafe6e2d901ad4))
+
 ## [2.0.0-alpha.3](https://github.com/snowyu/events-ex.js/compare/v2.0.0-alpha.2...v2.0.0-alpha.3) (2023-08-27)
@@ -7,0 +14,0 @@

docs/classes/event_emitter-1.EventEmitter.md

@@ -17,4 +17,8 @@ [events-ex](../README.md) / [Exports](../modules.md) / [event-emitter](../modules/event_emitter-1.md) / EventEmitter
 
-• **new EventEmitter**()
+• **new EventEmitter**(): [`EventEmitter`](event_emitter-1.EventEmitter.md)
 
+#### Returns
+
+[`EventEmitter`](event_emitter-1.EventEmitter.md)
+
 **`Classdesc`**
@@ -26,2 +30,2 @@
 
-[src/event-emitter.js:7](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.js#L7)
+[src/event-emitter.js:7](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event-emitter.js#L7)

docs/classes/event_emitter.EventEmitter.md

@@ -36,4 +36,8 @@ [events-ex](../README.md) / [Exports](../modules.md) / [event-emitter](../modules/event_emitter.md) / EventEmitter
 
-• **new EventEmitter**()
+• **new EventEmitter**(): [`EventEmitter`](event_emitter.EventEmitter.md)
 
+#### Returns
+
+[`EventEmitter`](event_emitter.EventEmitter.md)
+
 ## Properties
@@ -47,3 +51,3 @@
 
-[src/event-emitter.d.ts:7](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L7)
+[src/event-emitter.d.ts:7](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event-emitter.d.ts#L7)
 
@@ -73,3 +77,3 @@ ## Methods
 
-[src/event-emitter.d.ts:38](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L38)
+[src/event-emitter.d.ts:38](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event-emitter.d.ts#L38)
 
@@ -80,3 +84,3 @@ ___
 
-▸ **emitAsync**(`eventName`, `...args`): `Promise`<`any`\>
+▸ **emitAsync**(`eventName`, `...args`): `Promise`\<`any`\>
 
@@ -94,3 +98,3 @@ Asynchronously emits the specified event type with the given arguments.
 
-`Promise`<`any`\>
+`Promise`\<`any`\>
 
@@ -101,3 +105,3 @@ A promise that resolves with the result of the event.
 
-[src/event-emitter.d.ts:44](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L44)
+[src/event-emitter.d.ts:44](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event-emitter.d.ts#L44)
 
@@ -126,3 +130,3 @@ ___
 
-[src/event-emitter.d.ts:66](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L66)
+[src/event-emitter.d.ts:66](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event-emitter.d.ts#L66)
 
@@ -151,3 +155,3 @@ ___
 
-[src/event-emitter.d.ts:59](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L59)
+[src/event-emitter.d.ts:59](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event-emitter.d.ts#L59)
 
@@ -162,6 +166,2 @@ ___
 
-**`Throws`**
-
-If the listener is not a function.
-
 #### Parameters
@@ -180,5 +180,9 @@
 
+**`Throws`**
+
+If the listener is not a function.
+
 #### Defined in
 
-[src/event-emitter.d.ts:32](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L32)
+[src/event-emitter.d.ts:32](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event-emitter.d.ts#L32)
 
@@ -193,6 +197,2 @@ ___
 
-**`Throws`**
-
-If the listener is not a function.
-
 #### Parameters
@@ -211,5 +211,9 @@
 
+**`Throws`**
+
+If the listener is not a function.
+
 #### Defined in
 
-[src/event-emitter.d.ts:16](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L16)
+[src/event-emitter.d.ts:16](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event-emitter.d.ts#L16)
 
@@ -224,6 +228,2 @@ ___
 
-**`Throws`**
-
-If the listener is not a function.
-
 #### Parameters
@@ -242,5 +242,9 @@
 
+**`Throws`**
+
+If the listener is not a function.
+
 #### Defined in
 
-[src/event-emitter.d.ts:24](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L24)
+[src/event-emitter.d.ts:24](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event-emitter.d.ts#L24)
 
@@ -269,3 +273,3 @@ ___
 
-[src/event-emitter.d.ts:51](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L51)
+[src/event-emitter.d.ts:51](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event-emitter.d.ts#L51)
 
@@ -290,3 +294,3 @@ ___
 
-[src/event-emitter.d.ts:52](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L52)
+[src/event-emitter.d.ts:52](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event-emitter.d.ts#L52)
 
@@ -297,3 +301,3 @@ ___
 
-▸ `Static` **listenerCount**(`emitter`, `eventName`): `number`
+▸ **listenerCount**(`emitter`, `eventName`): `number`
 
@@ -313,2 +317,2 @@ #### Parameters
 
-[src/event-emitter.d.ts:67](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L67)
+[src/event-emitter.d.ts:67](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event-emitter.d.ts#L67)

docs/classes/event.Event.md

@@ -28,10 +28,6 @@ [events-ex](../README.md) / [Exports](../modules.md) / [event](../modules/event.md) / Event
 
-• **new Event**(`target`)
+• **new Event**(`target`): [`Event`](event.Event.md)
 
 Creates a new Event object instance that contains information about the event, such as the target element and the return value of the event.
 
-**`Classdesc`**
-
-Event Object that contains information about the event, such as the target element and the return value of the event.
-
 #### Parameters
@@ -43,5 +39,15 @@
 
+#### Returns
+
+[`Event`](event.Event.md)
+
+- The new Event instance.
+
+**`Classdesc`**
+
+Event Object that contains information about the event, such as the target element and the return value of the event.
+
 #### Defined in
 
-[src/event.js:8](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L8)
+[src/event.js:8](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event.js#L8)
 
@@ -58,3 +64,3 @@ ## Properties
 
-[src/event.js:38](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L38)
+[src/event.js:38](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event.js#L38)
 
@@ -71,3 +77,3 @@ ___
 
-[src/event.js:32](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L32)
+[src/event.js:32](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event.js#L32)
 
@@ -84,3 +90,3 @@ ___
 
-[src/event.js:26](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L26)
+[src/event.js:26](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event.js#L26)
 
@@ -103,3 +109,3 @@ ## Methods
 
-[src/event.js:45](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L45)
+[src/event.js:45](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event.js#L45)
 
@@ -126,2 +132,2 @@ ___
 
-[src/event.js:20](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L20)
+[src/event.js:20](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/event.js#L20)

docs/modules/all_off.md

@@ -44,2 +44,2 @@ [events-ex](../README.md) / [Exports](../modules.md) / all-off
 
-[src/all-off.js:12](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/all-off.js#L12)
+[src/all-off.js:12](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/all-off.js#L12)

docs/modules/consts.md

@@ -28,2 +28,2 @@ [events-ex](../README.md) / [Exports](../modules.md) / consts
 
-[src/consts.js:6](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/consts.js#L6)
+[src/consts.js:6](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/consts.js#L6)

docs/modules/default_methods.md

@@ -40,3 +40,3 @@ [events-ex](../README.md) / [Exports](../modules.md) / default-methods
 | `emit` | (...`args`: `any`) => `any` |
-| `emitAsync` | (...`args`: `any`) => `Promise`<`any`\> |
+| `emitAsync` | (...`args`: `any`) => `Promise`\<`any`\> |
 | `listenerCount` | (`emitter`: `any`, `type`: `any`) => `any` |
@@ -48,6 +48,6 @@ | `listeners` | (`type`: `any`) => `any` |
 | `removeAllListeners` | (`type`: `string`) => [`EventEmitter`](../classes/event_emitter.EventEmitter.md) |
-| `setMaxListeners` | (`n`: `any`) => { on(type: string, listener: Function): EventEmitter; once(type: string, listener: Function): EventEmitter; emit(...args: any[]): any; ... 5 more ...; removeAllListeners(type: string): EventEmitter; } |
+| `setMaxListeners` | (`n`: `any`) => \{ on(type: string, listener: Function): EventEmitter; once(type: string, listener: Function): EventEmitter; emit(...args: any[]): any; ... 5 more ...; removeAllListeners(type: string): EventEmitter; } |
 
 #### Defined in
 
-[src/default-methods.js:8](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/default-methods.js#L8)
+[src/default-methods.js:8](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/default-methods.js#L8)

docs/modules/has_listeners.md

@@ -40,2 +40,2 @@ [events-ex](../README.md) / [Exports](../modules.md) / has-listeners
 
-[src/has-listeners.js:10](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/has-listeners.js#L10)
+[src/has-listeners.js:10](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/has-listeners.js#L10)

docs/modules/pipe_async.md

@@ -29,6 +29,2 @@ [events-ex](../README.md) / [Exports](../modules.md) / pipe-async
 
-**`Throws`**
-
-- If either of the arguments is not an event emitter object.
-
 #### Parameters
@@ -48,4 +44,8 @@
 
+**`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/2b0a99d/src/pipe-async.js#L21)
+[src/pipe-async.js:21](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/pipe-async.js#L21)

docs/modules/pipe.md

@@ -29,6 +29,2 @@ [events-ex](../README.md) / [Exports](../modules.md) / pipe
 
-**`Throws`**
-
-- If either of the arguments is not an event emitter object.
-
 #### Parameters
@@ -48,4 +44,8 @@
 
+**`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/2b0a99d/src/pipe.js#L21)
+[src/pipe.js:21](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/pipe.js#L21)

docs/modules/unify.md

@@ -29,6 +29,2 @@ [events-ex](../README.md) / [Exports](../modules.md) / unify
 
-**`Throws`**
-
-- If either of the arguments is not an event emitter object.
-
 #### Parameters
@@ -45,4 +41,8 @@
 
+**`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/2b0a99d/src/unify.js#L17)
+[src/unify.js:17](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/unify.js#L17)

docs/modules/util_array_remove.md

@@ -39,2 +39,2 @@ [events-ex](../README.md) / [Exports](../modules.md) / util/array-remove
 
-[src/util/array-remove.js:5](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/util/array-remove.js#L5)
+[src/util/array-remove.js:5](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/util/array-remove.js#L5)

docs/modules/util_object_for_each.md

@@ -41,2 +41,2 @@ [events-ex](../README.md) / [Exports](../modules.md) / util/object-for-each
 
-[src/util/object-for-each.js:6](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/util/object-for-each.js#L6)
+[src/util/object-for-each.js:6](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/util/object-for-each.js#L6)

docs/modules/util_string_pad.md

@@ -40,2 +40,2 @@ [events-ex](../README.md) / [Exports](../modules.md) / util/string-pad
 
-[src/util/string-pad.js:8](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/util/string-pad.js#L8)
+[src/util/string-pad.js:8](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/util/string-pad.js#L8)

docs/modules/util_to_int.md

@@ -39,2 +39,2 @@ [events-ex](../README.md) / [Exports](../modules.md) / util/to-int
 
-[src/util/to-int.js:2](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/util/to-int.js#L2)
+[src/util/to-int.js:2](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/util/to-int.js#L2)

docs/modules/util_valid_callable.md

@@ -39,2 +39,2 @@ [events-ex](../README.md) / [Exports](../modules.md) / util/valid-callable
 
-[src/util/valid-callable.js:1](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/util/valid-callable.js#L1)
+[src/util/valid-callable.js:1](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/util/valid-callable.js#L1)

docs/modules/util_valid_object.md

@@ -39,2 +39,2 @@ [events-ex](../README.md) / [Exports](../modules.md) / util/valid-object
 
-[src/util/valid-object.js:3](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/util/valid-object.js#L3)
+[src/util/valid-object.js:3](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/util/valid-object.js#L3)

docs/modules/wrap_event_emitter.md

@@ -33,3 +33,3 @@ [events-ex](../README.md) / [Exports](../modules.md) / wrap-event-emitter
 
-[src/wrap-event-emitter.js:6](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/wrap-event-emitter.js#L6)
+[src/wrap-event-emitter.js:6](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/wrap-event-emitter.js#L6)
 
@@ -58,2 +58,2 @@ ## Functions
 
-[src/wrap-event-emitter.js:33](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/wrap-event-emitter.js#L33)
+[src/wrap-event-emitter.js:33](https://github.com/snowyu/events-ex.js/blob/8b7be69/src/wrap-event-emitter.js#L33)

lib/all-off.js

@@ -23,3 +23,2 @@ "use strict";
 ;
-var _default = allOff;
-exports.default = _default;
+var _default = exports.default = allOff;

lib/consts.js

@@ -11,3 +11,3 @@ "use strict";
 const ABORT = -1;
-const states = {
+const states = exports.states = {
   CONTINUE,
@@ -17,3 +17,2 @@ DONE,
   ABORT
-};
-exports.states = states;
+};

lib/default-methods.js

@@ -272,4 +272,3 @@ "use strict";
 }
-var _default = getEventableMethods;
-exports.default = _default;
+var _default = exports.default = getEventableMethods;
 function _emit(type, msg) {
@@ -293,3 +292,3 @@ const data = this._events;
     if (!(msg instanceof Error)) {
-      msg = new Error(UnCAUGHT_ERR);
+      msg = new Error(msg ? UnCAUGHT_ERR + msg : UnCAUGHT_ERR);
     }
@@ -296,0 +295,0 @@ throw msg;

lib/event-emitter.js

@@ -15,3 +15,2 @@ "use strict";
 (0, _eventable.eventable)(EventEmitter);
-var _default = EventEmitter;
-exports.default = _default;
+var _default = exports.default = EventEmitter;

lib/event.js

@@ -55,3 +55,2 @@ "use strict";
 };
-var _default = Event;
-exports.default = _default;
+var _default = exports.default = Event;

lib/eventable.js

@@ -34,5 +34,3 @@ "use strict";
 ;
-const eventable = (0, _customAbility.createAbilityInjector)(getEventableClass, true);
-exports.eventable = eventable;
-var _default = eventable;
-exports.default = _default;
+const eventable = exports.eventable = (0, _customAbility.createAbilityInjector)(getEventableClass, true);
+var _default = exports.default = eventable;

lib/has-listeners.js

@@ -24,3 +24,2 @@ "use strict";
 ;
-var _default = hasListeners;
-exports.default = _default;
+var _default = exports.default = hasListeners;

lib/index.js

@@ -128,3 +128,2 @@ "use strict";
 });
-var _default = _eventEmitter.EventEmitter;
-exports.default = _default;
+var _default = exports.default = _eventEmitter.EventEmitter;

lib/pipe-async.js

@@ -61,3 +61,2 @@ "use strict";
 ;
-var _default = pipeAsync;
-exports.default = _default;
+var _default = exports.default = pipeAsync;

lib/pipe.js

@@ -61,3 +61,2 @@ "use strict";
 ;
-var _default = pipe;
-exports.default = _default;
+var _default = exports.default = pipe;

lib/unify.js

@@ -71,3 +71,2 @@ "use strict";
 }
-var _default = unify;
-exports.default = _default;
+var _default = exports.default = unify;

lib/util/array-remove.js

@@ -20,3 +20,2 @@ "use strict";
 }
-var _default = remove;
-exports.default = _default;
+var _default = exports.default = remove;

lib/util/object-for-each.js

@@ -24,3 +24,2 @@ "use strict";
 }
-var _default = forEach;
-exports.default = _default;
+var _default = exports.default = forEach;

lib/util/string-pad.js

@@ -25,3 +25,2 @@ "use strict";
 }
-var _default = pad;
-exports.default = _default;
+var _default = exports.default = pad;

lib/util/to-int.js

@@ -19,3 +19,2 @@ "use strict";
 }
-var _default = toInt;
-exports.default = _default;
+var _default = exports.default = toInt;

lib/util/valid-callable.js

@@ -14,3 +14,2 @@ "use strict";
 }
-var _default = validCallable;
-exports.default = _default;
+var _default = exports.default = validCallable;

lib/util/valid-object.js

@@ -15,3 +15,2 @@ "use strict";
 }
-var _default = validObject;
-exports.default = _default;
+var _default = exports.default = validObject;

lib/wrap-event-emitter.js

@@ -12,4 +12,3 @@ "use strict";
 const defineProperties = Object.defineProperties;
-const methods = (0, _eventable.default)().methods;
-exports.methods = methods;
+const methods = exports.methods = (0, _eventable.default)().methods;
 const descriptors = {
@@ -47,3 +46,2 @@ on: {
 ;
-var _default = wrapEventEmitter;
-exports.default = _default;
+var _default = exports.default = wrapEventEmitter;

package.json

 {
   "name": "events-ex",
-  "version": "2.0.0-alpha.3",
+  "version": "2.0.0-alpha.4",
   "description": "Browser-friendly enhanced events most compatible with standard node.js, it's powerful eventable ability.",
@@ -45,17 +45,17 @@ "contributors": [
   "devDependencies": {
-    "@antfu/eslint-config": "^0.39.3",
-    "@babel/cli": "^7.21.5",
-    "@babel/core": "^7.21.8",
+    "@antfu/eslint-config": "^2.6.1",
+    "@babel/cli": "^7.23.4",
+    "@babel/core": "^7.23.7",
     "@babel/plugin-proposal-dynamic-import": "^7.18.6",
-    "@babel/plugin-transform-modules-commonjs": "^7.21.5",
-    "@babel/register": "^7.21.0",
-    "chai": "^4.3.7",
-    "eslint": "^8.38.0",
-    "eslint-config-prettier": "^8.8.0",
+    "@babel/plugin-transform-modules-commonjs": "^7.23.3",
+    "@babel/register": "^7.23.7",
+    "chai": "~4.3.7",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-tsdoc": "^0.2.17",
     "mocha": "^10.2.0",
-    "prettier": "^2.8.8",
-    "typedoc": "^0.24.7",
-    "typedoc-plugin-markdown": "^3.15.3",
-    "typescript": "^5.0.4"
+    "prettier": "^3.1.1",
+    "typedoc": "^0.25.4",
+    "typedoc-plugin-markdown": "^3.17.1",
+    "typescript": "^5.3.3"
   },
@@ -62,0 +62,0 @@ "scripts": {

src/default-methods.js

@@ -267,3 +267,3 @@ import {defineProperty, isArray, isFunction, isNumber, isObject, isUndefined} from 'util-ex'
   if (!listeners && type === 'error') {
-    if (!(msg instanceof Error)) {msg = new Error(UnCAUGHT_ERR)}
+    if (!(msg instanceof Error)) {msg = new Error(msg ? UnCAUGHT_ERR + msg : UnCAUGHT_ERR)}
     throw msg
@@ -270,0 +270,0 @@ }

No alert changes

Improved metrics

Total package byte prevSize

134671

increased by0.34%

Worsened metrics

Lines of code

2100

decreased by-0.94%

No dependency changes