events-ex 2.0.0-alpha.2 → 2.0.0-alpha.3

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.0-alpha.3](https://github.com/snowyu/events-ex.js/compare/v2.0.0-alpha.2...v2.0.0-alpha.3) (2023-08-27)
+
+
+### Features
+
+* add ABORT state constant ([a8b3710](https://github.com/snowyu/events-ex.js/commit/a8b3710ae7f1695263ed0bd9036db31831ed9ae0))
+
 ## [2.0.0-alpha.2](https://github.com/snowyu/events-ex.js/compare/v2.0.0-alpha.1...v2.0.0-alpha.2) (2023-06-13)
 
 

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2012-2015 Mariusz Nowak (www.medikoo.com)
+Copyright (C) 2015-2023 Riceball LEE (snowyu.lee@gmail.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.cn.md

@@ -87,6 +87,7 @@ my.emit('event');
 import {EventEmitter, states} from 'events-ex';
 import {isObject} from 'util-ex';
 
+states.ABORT = -1
 class MyDb extends EventEmitter {
   get(key) {
     // Demo the event object bubbling usage:
@@ -108,8 +109,9 @@ db.on('getting', function(key){
       state: states.DONE,
       result: result,
     }
-  } else if (result === null) {
-    // abort default get key.
+    this.stopped = true // it will skip other listeners if true
+  } else {
+    // you can abort to get key by default.
     this.result = {state: states.ABORT};
     // this.stopped = true // it will skip other listeners if true
   }

package/README.md

@@ -77,6 +77,7 @@ Bubbling event usage:
 import {EventEmitter, states} from 'events-ex';
 import {isObject} from 'util-ex';
 
+states.ABORT = -1
 class MyDb extends EventEmitter {
   get(key) {
     // Demo the event object bubbling usage:
@@ -98,8 +99,9 @@ db.on('getting', function(key){
       state: states.DONE,
       result: result,
     }
-  } else if (result === null) {
-    // abort default get key.
+    this.stopped = true // it will skip other listeners if true
+  } else {
+    // you can abort to get key by default.
     this.result = {state: states.ABORT};
     // this.stopped = true // it will skip other listeners if true
   }

package/docs/README.md

@@ -77,6 +77,7 @@ Bubbling event usage:
 import {EventEmitter, states} from 'events-ex';
 import {isObject} from 'util-ex';
 
+states.ABORT = -1
 class MyDb extends EventEmitter {
   get(key) {
     // Demo the event object bubbling usage:
@@ -98,8 +99,9 @@ db.on('getting', function(key){
       state: states.DONE,
       result: result,
     }
-  } else if (result === null) {
-    // abort default get key.
+    this.stopped = true // it will skip other listeners if true
+  } else {
+    // you can abort to get key by default.
     this.result = {state: states.ABORT};
     // this.stopped = true // it will skip other listeners if true
   }

package/docs/classes/event.Event.md

@@ -41,7 +41,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/25f69f3/src/event.js#L8)
+[src/event.js:8](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L8)
 
 ## Properties
 
@@ -53,7 +53,7 @@ Keep your event result here if any.
 
 #### Defined in
 
-[src/event.js:38](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event.js#L38)
+[src/event.js:38](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L38)
 
 ___
 
@@ -65,7 +65,7 @@ Whether stop the bubbling event
 
 #### Defined in
 
-[src/event.js:32](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event.js#L32)
+[src/event.js:32](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L32)
 
 ___
 
@@ -77,7 +77,7 @@ Who trigger the event
 
 #### Defined in
 
-[src/event.js:26](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event.js#L26)
+[src/event.js:26](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L26)
 
 ## Methods
 
@@ -95,7 +95,7 @@ The result of the event.
 
 #### Defined in
 
-[src/event.js:45](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event.js#L45)
+[src/event.js:45](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L45)
 
 ___
 
@@ -117,4 +117,4 @@ Initializes the event with the target object.
 
 #### Defined in
 
-[src/event.js:20](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event.js#L20)
+[src/event.js:20](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event.js#L20)

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

@@ -22,4 +22,4 @@ Class that represents an event emitter.
 
 #### Defined in
 
-[src/event-emitter.js:7](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event-emitter.js#L7)
+[src/event-emitter.js:7](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.js#L7)

package/docs/classes/event_emitter.EventEmitter.md

@@ -43,7 +43,7 @@ Class that represents an event emitter.
 
 #### Defined in
 
-[src/event-emitter.d.ts:7](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event-emitter.d.ts#L7)
+[src/event-emitter.d.ts:7](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L7)
 
 ## Methods
 
@@ -68,7 +68,7 @@ The result of the event.
 
 #### Defined in
 
-[src/event-emitter.d.ts:38](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event-emitter.d.ts#L38)
+[src/event-emitter.d.ts:38](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L38)
 
 ___
 
@@ -93,7 +93,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/25f69f3/src/event-emitter.d.ts#L44)
+[src/event-emitter.d.ts:44](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L44)
 
 ___
 
@@ -117,7 +117,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/25f69f3/src/event-emitter.d.ts#L66)
+[src/event-emitter.d.ts:66](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L66)
 
 ___
 
@@ -141,7 +141,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/25f69f3/src/event-emitter.d.ts#L59)
+[src/event-emitter.d.ts:59](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L59)
 
 ___
 
@@ -170,7 +170,7 @@ The EventEmitter instance to allow chaining.
 
 #### Defined in
 
-[src/event-emitter.d.ts:32](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event-emitter.d.ts#L32)
+[src/event-emitter.d.ts:32](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L32)
 
 ___
 
@@ -199,7 +199,7 @@ The EventEmitter instance to allow chaining.
 
 #### Defined in
 
-[src/event-emitter.d.ts:16](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event-emitter.d.ts#L16)
+[src/event-emitter.d.ts:16](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L16)
 
 ___
 
@@ -228,7 +228,7 @@ The EventEmitter instance to allow chaining.
 
 #### Defined in
 
-[src/event-emitter.d.ts:24](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event-emitter.d.ts#L24)
+[src/event-emitter.d.ts:24](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L24)
 
 ___
 
@@ -252,7 +252,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/25f69f3/src/event-emitter.d.ts#L51)
+[src/event-emitter.d.ts:51](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L51)
 
 ___
 
@@ -272,7 +272,7 @@ ___
 
 #### Defined in
 
-[src/event-emitter.d.ts:52](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event-emitter.d.ts#L52)
+[src/event-emitter.d.ts:52](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L52)
 
 ___
 
@@ -293,4 +293,4 @@ ___
 
 #### Defined in
 
-[src/event-emitter.d.ts:67](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event-emitter.d.ts#L67)
+[src/event-emitter.d.ts:67](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/event-emitter.d.ts#L67)

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/25f69f3/src/all-off.js#L12)
+[src/all-off.js:12](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/all-off.js#L12)

package/docs/modules/consts.md

@@ -18,10 +18,11 @@
 
 | Name | Type |
 | :------ | :------ |
+| `ABORT` | `number` |
 | `CONTINUE` | `any` |
 | `DONE` | `number` |
 | `STOPPED` | `number` |
 
 #### Defined in
 
-[src/consts.js:5](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/consts.js#L5)
+[src/consts.js:6](https://github.com/snowyu/events-ex.js/blob/2b0a99d/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:8](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/default-methods.js#L8)
+[src/default-methods.js:8](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/default-methods.js#L8)

package/docs/modules/has_listeners.md

@@ -37,4 +37,4 @@ Renames and re-exports [hasListeners](has_listeners.md#haslisteners)
 
 #### Defined in
 
-[src/has-listeners.js:10](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/has-listeners.js#L10)
+[src/has-listeners.js:10](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/has-listeners.js#L10)

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/25f69f3/src/pipe.js#L21)
+[src/pipe.js:21](https://github.com/snowyu/events-ex.js/blob/2b0a99d/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/25f69f3/src/pipe-async.js#L21)
+[src/pipe-async.js:21](https://github.com/snowyu/events-ex.js/blob/2b0a99d/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/25f69f3/src/unify.js#L17)
+[src/unify.js:17](https://github.com/snowyu/events-ex.js/blob/2b0a99d/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/25f69f3/src/util/array-remove.js#L5)
+[src/util/array-remove.js:5](https://github.com/snowyu/events-ex.js/blob/2b0a99d/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/25f69f3/src/util/object-for-each.js#L6)
+[src/util/object-for-each.js:6](https://github.com/snowyu/events-ex.js/blob/2b0a99d/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/25f69f3/src/util/string-pad.js#L8)
+[src/util/string-pad.js:8](https://github.com/snowyu/events-ex.js/blob/2b0a99d/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/25f69f3/src/util/to-int.js#L2)
+[src/util/to-int.js:2](https://github.com/snowyu/events-ex.js/blob/2b0a99d/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/25f69f3/src/util/valid-callable.js#L1)
+[src/util/valid-callable.js:1](https://github.com/snowyu/events-ex.js/blob/2b0a99d/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/25f69f3/src/util/valid-object.js#L3)
+[src/util/valid-object.js:3](https://github.com/snowyu/events-ex.js/blob/2b0a99d/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:6](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/wrap-event-emitter.js#L6)
+[src/wrap-event-emitter.js:6](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/wrap-event-emitter.js#L6)
 
 ## Functions
 
@@ -54,4 +54,4 @@ o or new Event instance
 
 #### Defined in
 
-[src/wrap-event-emitter.js:33](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/wrap-event-emitter.js#L33)
+[src/wrap-event-emitter.js:33](https://github.com/snowyu/events-ex.js/blob/2b0a99d/src/wrap-event-emitter.js#L33)

package/lib/consts.d.ts

@@ -2,8 +2,10 @@ export namespace states {
     export { CONTINUE };
     export { DONE };
     export { STOPPED };
+    export { ABORT };
 }
 declare const CONTINUE: any;
 declare const DONE: 1;
 declare const STOPPED: 2;
+declare const ABORT: -1;
 export {};

package/lib/consts.js

@@ -7,9 +7,11 @@ exports.states = void 0;
 const CONTINUE = undefined;
 const DONE = 1;
 const STOPPED = 2;
+const ABORT = -1;
 const states = {
   CONTINUE,
   DONE,
-  STOPPED
+  STOPPED,
+  ABORT
 };
 exports.states = states;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "events-ex",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.3",
   "description": "Browser-friendly enhanced events most compatible with standard node.js, it's powerful eventable ability.",
   "contributors": [
     {

package/src/consts.js

@@ -1,9 +1,11 @@
 const CONTINUE = undefined
 const DONE = 1
 const STOPPED = 2
+const ABORT = -1
 
 export const states = {
   CONTINUE,
   DONE,
   STOPPED,
+  ABORT,
 }

package/test/add-listeners-test.js

@@ -1,42 +0,0 @@
-import {assert} from "chai";
-import {EventEmitter} from '../src'
-
-describe('EventEmitter', () => {
-  it('should add listeners', () => {
-    var e = new EventEmitter();
-
-    var events_new_listener_emited = [];
-    var listeners_new_listener_emited = [];
-    var times_hello_emited = 0;
-
-    // sanity check
-    assert.equal(e.addListener, e.on);
-
-    e.on('newListener', function(event, listener) {
-      events_new_listener_emited.push(event);
-      listeners_new_listener_emited.push(listener);
-    });
-
-    function hello(a, b) {
-      times_hello_emited += 1;
-      assert.equal('a', a);
-      assert.equal('b', b);
-    }
-    e.on('hello', hello);
-
-    var foo = function foo() {};
-    e.once('foo', foo);
-
-    e.emit('hello', 'a', 'b');
-
-
-    // just make sure that this doesn't throw:
-    var f = new EventEmitter();
-    f.setMaxListeners(0);
-
-
-    assert.deepEqual(['hello', 'foo'], events_new_listener_emited);
-    assert.deepEqual([hello, foo], listeners_new_listener_emited);
-    assert.equal(1, times_hello_emited);
-  });
-});

package/test/all-off-test.js

@@ -1,51 +0,0 @@
-import {assert} from "chai";
-
-import ee from '../src/wrap-event-emitter'
-import allOff from '../src/all-off'
-
-describe('all-off', () => {
-	it('should remove all listeners', () => {
-		var x, count, count2;
-
-		x = ee();
-		count = 0;
-		count2 = 0;
-		x.on('foo', function () {
-			++count;
-		});
-		x.on('foo', function () {
-			++count;
-		});
-		x.on('bar', function () {
-			++count2;
-		});
-		x.on('bar', function () {
-			++count2;
-		});
-		allOff(x, 'foo');
-		x.emit('foo');
-		x.emit('bar');
-		assert.equal(count, 0, "foo off: type");
-		assert.equal(count2, 2, "foo off: ohter type");
-
-		count = 0;
-		count2 = 0;
-		x.on('foo', function () {
-			++count;
-		});
-		x.on('foo', function () {
-			++count;
-		});
-		x.on('bar', function () {
-			++count2;
-		});
-		x.on('bar', function () {
-			++count2;
-		});
-		allOff(x);
-		x.emit('foo');
-		x.emit('bar');
-		assert.equal(count, 0, "All off: type");
-		assert.equal(count2, 0, "All off: other type");
-	});
-});

package/test/check-listener-leaks-test.js

@@ -1,76 +0,0 @@
-import {assert} from "chai";
-import {EventEmitter} from '../src'
-
-describe('EventEmitter', () => {
-  it('should check listener leaks', () => {
-    var oldError = console.error;
-    var oldTrace = console.trace;
-    console.error = function(){};
-    console.trace = function(){};
-
-    var e = new EventEmitter();
-
-    // default
-    for (var i = 0; i < 10; i++) {
-      e.on('default', function() {});
-    }
-    assert.ok(!e._events['default'].hasOwnProperty('warned'));
-    e.on('default', function() {});
-    assert.ok(e._events['default'].warned, 'should warned on default event');
-
-    // specific
-    e.setMaxListeners(5);
-    for (var i = 0; i < 5; i++) {
-      e.on('specific', function() {});
-    }
-    assert.ok(!e._events['specific'].hasOwnProperty('warned'));
-    e.on('specific', function() {});
-    assert.ok(e._events['specific'].warned, 'should warned on specific event');
-
-    // only one
-    e.setMaxListeners(1);
-    e.on('only one', function() {});
-    assert.ok(!e._events['only one'].hasOwnProperty('warned'));
-    e.on('only one', function() {});
-    assert.ok(e._events['only one'].hasOwnProperty('warned'), 'should warned on only one event');
-
-    // unlimited
-    e.setMaxListeners(0);
-    for (var i = 0; i < 1000; i++) {
-      e.on('unlimited', function() {});
-    }
-    assert.ok(!e._events['unlimited'].hasOwnProperty('warned'), 'should not warned on unlimited');
-
-    // process-wide
-    EventEmitter.defaultMaxListeners = 42;
-    e = new EventEmitter();
-
-    for (var i = 0; i < 42; ++i) {
-      e.on('fortytwo', function() {});
-    }
-    assert.ok(!e._events['fortytwo'].hasOwnProperty('warned'));
-    e.on('fortytwo', function() {});
-    assert.ok(e._events['fortytwo'].hasOwnProperty('warned'));
-    delete e._events['fortytwo'].warned;
-
-    EventEmitter.defaultMaxListeners = 44;
-    e.on('fortytwo', function() {});
-    assert.ok(!e._events['fortytwo'].hasOwnProperty('warned'));
-    e.on('fortytwo', function() {});
-    assert.ok(e._events['fortytwo'].hasOwnProperty('warned'));
-
-    // but _maxListeners still has precedence over defaultMaxListeners
-    EventEmitter.defaultMaxListeners = 42;
-    e = new EventEmitter();
-    e.setMaxListeners(1);
-    e.on('uno', function() {});
-    assert.ok(!e._events['uno'].hasOwnProperty('warned'));
-    e.on('uno', function() {});
-    assert.ok(e._events['uno'].hasOwnProperty('warned'), 'should warned on uno event');
-
-    // chainable
-    assert.strictEqual(e, e.setMaxListeners(1), 'setMaxListeners chainable');
-    console.error = oldError;
-    console.trace = oldTrace;
-  });
-});

package/test/emitter-method-names-test.js

@@ -1,11 +0,0 @@
-import {assert} from "chai";
-import {EventEmitter} from '../src'
-
-describe('EventEmitter', () => {
-  it('should test method names', () => {
-    var E = EventEmitter.prototype;
-    assert.equal(E.constructor.name, 'EventEmitter');
-    assert.equal(E.on, E.addListener);  // Same method.
-    assert.equal(E.off, E.removeListener);  // Same method.
-  });
-})