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

package/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 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.2](https://github.com/snowyu/events-ex.js/compare/v2.0.0-alpha.1...v2.0.0-alpha.2) (2023-06-13)
+
+
+### ⚠ BREAKING CHANGES
+
+* rename src/event-emitter to src/wrap-event-emitter and extract EventEmitter from index to event-emitter
+
+### Bug Fixes
+
+* **ts:** EventEmitter not found ([9a74862](https://github.com/snowyu/events-ex.js/commit/9a748624e00417f6d7f72ea7c297650e10895d19))
+
+
+### Refactor
+
+* rename src/event-emitter to src/wrap-event-emitter and extract EventEmitter from index to event-emitter ([f06f39f](https://github.com/snowyu/events-ex.js/commit/f06f39fb809006f5e098e31bb23870fff39ec5c8))
+
+## [2.0.0-alpha.1](https://github.com/snowyu/events-ex.js/compare/v2.0.0-alpha.0...v2.0.0-alpha.1) (2023-06-13)
+
+
+### ⚠ BREAKING CHANGES
+
+* remove deprecated files
+
+### Refactor
+
+* remove deprecated files ([d733a5c](https://github.com/snowyu/events-ex.js/commit/d733a5c6a6c554739ecbcb653996f1e546579fa4))
+
 ## [2.0.0-alpha.0](https://github.com/snowyu/events-ex.js/compare/v1.1.7...v2.0.0-alpha.0) (2023-05-25)
 
 

package/README.cn.md

@@ -1,81 +1,78 @@
 ### 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)
 
 
-Browser-friendly enhanced events most compatible with standard node.js and coffee-script. It's modified from [event-emitter](https://github.com/medikoo/event-emitter) mainly. It can add event-able to your class directly.
+浏览器友好的增强的**事件**[能力][Ability]和类。 它主要是从 [event-emitter][event-emitter] 修改而来的。 本库可以为你的任何类添加(注入)**事件**[能力][Ability]。
 
-TODO: 支持异步事件,添加`emitAsync`方法. 没这么简单,因为要支持bubbling,所以必须顺序执行事件.
-干脆,将`bubbling`作为功能选项.如果没有启用,就可以乱发了.
+
+TODO: 异步事件,添加`emitAsync`方法. 没这么简单,因为要支持bubbling,所以必须顺序执行事件.
+将`bubbling`作为功能选项.如果没有启用,就可以乱发了.
 
 当关闭`bubbling`的时候,那么是否还需要用`event`对象传递.
 
-首先完成异步支持.
+首先完成异步支持.已经完成.`emitAsync`方法已经加上.
 
 ### Features
 
-* rewrite the core architecture
-* keep most compatible with [node events](nodejs.org/api/events.html) and [event-emitter](https://github.com/medikoo/event-emitter)
-+ more powerful event-able ability
-* hookable event system
-
-### Differences
-
-* Difference with [node events](https://nodejs.org/api/events.html)
-  + **`broken change`**: The event object bubbling Supports
-    + the event object as listener's "this" object.
-    + return the result property of event object to emitter.
-    + prevent the rest of listener from be excuted if set the stopped property of event object to true
-    * **`broken change`**: the `emit` return the result of listeners's callback function instead of the successful state.
-    * **`broken change`**: the `this` object of listeners' callback function is the `Event` Object instead of the emitter object.
-      * the emitter object is put into the `target` property of the `Event` Object.
-* Difference with [event-emitter](https://github.com/medikoo/event-emitter)
-  + **`broken change`**: The event object bubbling Supports(see above)
-  + add the defaultMaxListeners class property to keep compatible with node events.
-  + add the setMaxListeners method to keep compatible with node events.
-  + add `error`, `newListener` and `removeListener` events to keep compatible with node events.
-  + add listeners() method to keep compatible with node events.
-  + add listenerCount() class method to keep compatible with node events.
-
-
-### Installation
-
-	$ npm install events-ex
-
-To port it to Browser or any other (non CJS) environment, use your favorite CJS bundler. No favorite yet? Try: [Browserify](http://browserify.org/), [Webmake](https://github.com/medikoo/modules-webmake) or [Webpack](http://webpack.github.io/)
-
-### Usage
-
-
-Add the event-able feature to your class directly:
-
-```coffee
+* 重写核心架构
+* 尽最大可能性与[node events][Node Events] and [event-emitter][event-emitter]保持兼容
+* 更强大的 event-able [能力][Ability]
+* 可挂载的事件系统, 用于更好地控制事件处理
+* 支持异步事件通过 `emitAsync` 方法.
+
+### 区别
+
+* 与 [Node 事件模块](https://nodejs.org/api/events.html) 的区别
+  * **`改变`**: 事件支持冒泡机制与中断
+    * 事件对象(`Event Object`)作为监听器的 "this" 对象。
+      * `result` 属性: 可选, 如果设置,则将该结果返回到事件发射器(`Event Emitter`)。
+      * `stopped` 属性: 可选, 如果设置为 `true`，则会阻止剩余的监听器被执行。
+      * `target`属性: 事件发射器对象,原本的`this`
+    * **`改变`**: `emit` 方法返回监听器回调函数的结果而不是成功状态。
+    * **`改变`**: 监听器回调函数的 `this` 对象是 `Event Object` 事件对象而不是事件发射器对象。
+      * 事件发射器对象被放入 `Event` 对象的 `target` 属性中。
+  * 添加了`emitAsync`方法,支持异步事件
+* 与 [event-emitter](https://github.com/medikoo/event-emitter) 的区别
+  * **`改变`**: 事件支持冒泡机制（如上所述）
+  * 添加了默认最大监听器数量的类属性，以保持与 Node 事件模块的兼容性。
+  * 添加了 `setMaxListeners` 方法，以保持与 Node 事件模块的兼容性。
+  * 添加了 `error`、`newListener` 和 `removeListener` 事件，以保持与 Node 事件模块的兼容性。
+  * 添加了 `listeners()` 方法，以保持与 Node 事件模块的兼容性。
+  * 添加了 `listenerCount()` 类方法，以保持与 Node 事件模块的兼容性。
+  * 添加了`emitAsync`方法,支持异步事件
+
+
+### 安装
 
-eventable = require('events-ex/eventable')
+```
+npm install events-ex@alpha
+```
 
-class MyClass
-  # advanced usage see API topic.
-  eventable MyClass
 
-my = new MyClass
+### 用法
 
-my.on 'event', ->
-  console.log 'event occur'
-  # be care: @(this) is the event object. not the `my` instance.
-  # the my instance is @target.
+直接继承使用 `EventEmitter` 类
 
-my.emit 'event'
+```js
+import {EventEmitter} from 'events-ex';
 
+class MyClass extends EventEmitter {}
 ```
 
-the following is javascript:
+直接添加/注入事件(event-able)[能力][Ability] 到你的类:
 
 ```js
-var eventable = require('events-ex/eventable');
+import {eventable} from 'events-ex';
 
-function MyClass() {}
+class MyClass extends MyRoot {}
 
+// inject the eventable ability to MyClass
 eventable(MyClass);
+```
+
+现在,可以在你的类中使用事件了:
 
-var my = new MyClass;
+```js
+const my = new MyClass;
 
 my.on('event', function() {
   console.log('event occur');
@@ -84,53 +81,19 @@ my.on('event', function() {
 my.emit('event');
 ```
 
-Node JS events Usage:
-
-```coffee
-## Coffee-script demo bubbling usage:
-EventEmitter = require('events-ex')
-inherits     = require('inherits-ex')
-ABORT = -1
-DONE = 0
-
-class MyDb
-  inherits MyDb, EventEmitter
-  get: (key)->
-    # Demo the event object bubbling usage:
-    result = @emit 'getting', key
-    if isObject result
-      return if result.state is ABORT
-      return result.result if result.state is DONE
-    _get(key)
-
-db = new MyDb
-db.on 'getting', (key)->
-  result = myGet(key);
-  if result?
-    # get the key succ
-    this.result =
-      state: DONE
-      result: result
-  else if result is null
-    # abort default get key.
-    this.result = state: ABORT;
-    # this.stopped = true # it will skip other listeners if true
-```
+事件冒泡机制的使用:
 
 ```js
-// js demo bubbling usage:
-let EventEmitter = require('events-ex')
-let isObject = require('util-ex/lib/is/type/object')
-const ABORT = -1
-const DONE = 0
+import {EventEmitter, states} from 'events-ex';
+import {isObject} from 'util-ex';
 
 class MyDb extends EventEmitter {
   get(key) {
     // Demo the event object bubbling usage:
     let result = this.emit('getting', key)
     if(isObject(result)) {
-      if (result.state === ABORT) return
-      if (result.state === DONE)  return result.result
+      if (result.state === states.ABORT) return
+      if (result.state === states.DONE)  return result.result
     }
     return _get(key)
   }
@@ -142,12 +105,12 @@ db.on('getting', function(key){
   if (result != null) {
     // get the key succ
     this.result = {
-      state: DONE,
+      state: states.DONE,
       result: result,
     }
   } else if (result === null) {
     // abort default get key.
-    this.result = {state: ABORT};
+    this.result = {state: states.ABORT};
     // this.stopped = true // it will skip other listeners if true
   }
 })
@@ -157,12 +120,13 @@ event-emitter usage:
 
 ```javascript
 
-var ee = require('event-ex/event-emitter');
+import {wrapEventEmitter as ee} from 'events-ex';
 
-var MyClass = function () { /* .. */ };
+class MyClass { /* .. */ };
 ee(MyClass.prototype); // All instances of MyClass will expose event-emitter interface
 
-var emitter = new MyClass(), listener;
+const emitter = new MyClass();
+let listener;
 
 emitter.on('test', listener = function (args) {
   // … react to 'test' event
@@ -186,17 +150,17 @@ emitter.emit('test', arg1, arg2/*…args*/); // No listeners invoked
 Add the event-able ability to the class directly.
 
 * `class`: the class to be injected the ability.
-* `options` *(object)*: optional options
-  * `include` *(string[]|string)*: only these emitter methods will be added to the class
+* `options` _(object)_: optional options
+  * `include` _(string[]|string)_: only these emitter methods will be added to the class
     * **NOTE:** static method should use the prefix '@' with name.
-  * `exclude` *(string[]|string)*: theses emitter methods would not be added to the class
+  * `exclude` _(string[]|string)_: theses emitter methods would not be added to the class
     * **NOTE:** static method should use the prefix '@' with name.
-  * `methods` *(object)*: hooked methods to the class
+  * `methods` _(object)_: hooked methods to the class
     * key: the method name to hook.
     * value: the new method function
       * use `this.super()` to call the original method.
       * `this.self` is the original `this` object.
-  * `classMethods` *(object)*: hooked class methods to the class
+  * `classMethods` _(object)_: hooked class methods to the class
 
 ```coffee
   eventable  = require('events-ex/eventable')
@@ -214,6 +178,7 @@ Add the event-able ability to the class directly.
       console.log "new exec"
       @super() # call the original method
 ```
+
 #### allOff(obj) _(events-ex/all-off)_
 
 **keep compatible only**: the `removeAllListeners` has already been buildin.
@@ -277,4 +242,7 @@ emitter2.emit('test'); // Invoked listener1, listener2, listener3 and listener4
 ```
 
 
-[events]: https://github.com/nodejs/node/blob/main/lib/events.js
+[event-emitter]: https://github.com/medikoo/event-emitter
+[Node Events]: https://nodejs.org/api/events.html
+[Ability]: https://github.com/snowyu/custom-ability.js
+

package/README.md

@@ -1,32 +1,35 @@
 ### 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)
 
 
-Browser-friendly enhanced events most compatible with standard node.js and coffee-script. It's modified from [event-emitter](https://github.com/medikoo/event-emitter) mainly. It can add event-able to your class directly.
+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.
 
 ### Features
 
 * Rewrite of the core architecture for improved performance and more powerful event-able ability
-* keep most compatible with [node events](nodejs.org/api/events.html) and [event-emitter](https://github.com/medikoo/event-emitter)
+* keep most compatible with [node events](nodejs.org/api/events.html) and [event-emitter][event-emitter]
 * Hookable event system for more control over event handling
-* Supports async event emitting
+* Supports async event emitting via `emitAsync` method.
 
 ### Differences
 
 * Difference with [node events](https://nodejs.org/api/events.html)
-  + **`broken change`**: The event object supports bubbling
-    + the event object as listener's "this" object.
-    + return the result property of event object to the emitter.
-    + prevent the rest of listener from be executed if the stopped property of the event object is set to true
+  + **`broken change`**: The event supports bubbling and interruption
+    + the `event object` as listener's "this" object:
+      * `result`: If set, the result is returned to the `Event Emitter`.
+      * `stopped`: If set to `true`, it prevents the remaining listeners from being executed.
+      * `target`: The `Event Emitter` object, which was originally the `this` object.
     * **`broken change`**: The `emit` return the result of listeners's callback function instead of the successful state.
     * **`broken change`**: The `this` object of listeners' callback function is the `Event` Object instead of the emitter object.
       * The emitter object is put into the `target` property of the `Event` Object.
+  * Adds async event emitting via `emitAsync` method.
 * Difference with [event-emitter](https://github.com/medikoo/event-emitter)
-  + **`broken change`**: The event object supports bubbling(see above)
+  + **`broken change`**: The event supports bubbling and interruption(see above)
   + Adds the defaultMaxListeners class property to keep compatibility with node events.
   + Adds the setMaxListeners method to keep compatible with node events.
   + Adds `error`, `newListener` and `removeListener` events to keep compatibility with node events.
   + Adds listeners() method to keep compatibility with node events.
   + Adds listenerCount() class method to keep compatibility with node events.
+  * Adds async event emitting via `emitAsync` method.
 
 
 ### Installation
@@ -37,7 +40,7 @@ npm install events-ex
 
 ### Usage
 
-Extends from `EventEmitter`:
+Extends from `EventEmitter` class:
 
 ```js
 import {EventEmitter} from 'events-ex';
@@ -45,21 +48,21 @@ import {EventEmitter} from 'events-ex';
 class MyClass extends EventEmitter {}
 ```
 
-Add the event-able feature to your class directly:
+Add/Inject the event-able [ability][Ability] to your class directly:
 
 ```js
 import {eventable} from 'events-ex';
 
-class MyClass {}
+class MyClass extends MyRoot {}
 
 // inject the eventable ability to MyClass
 eventable(MyClass);
 ```
 
-Now uses it:
+Now, you can use events in your class:
 
 ```js
-var my = new MyClass;
+const my = new MyClass;
 
 my.on('event', function() {
   console.log('event occur');
@@ -232,3 +235,5 @@ emitter2.emit('test'); // Invoked listener1, listener2, listener3 and listener4
 ```
 
 
+[event-emitter]: https://github.com/medikoo/event-emitter
+[Ability]: https://github.com/snowyu/custom-ability.js

package/ability.js

@@ -1 +1 @@
-module.exports = require('./eventable')
+module.exports = require('./lib/eventable')

package/docs/README.md

@@ -2,32 +2,35 @@ 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)
 
-Browser-friendly enhanced events most compatible with standard node.js and coffee-script. It's modified from [event-emitter](https://github.com/medikoo/event-emitter) mainly. It can add event-able to your class directly.
+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.
 
 ### Features
 
 * Rewrite of the core architecture for improved performance and more powerful event-able ability
-* keep most compatible with [node events](nodejs.org/api/events.html) and [event-emitter](https://github.com/medikoo/event-emitter)
+* keep most compatible with [node events](nodejs.org/api/events.html) and [event-emitter][event-emitter]
 * Hookable event system for more control over event handling
-* Supports async event emitting
+* Supports async event emitting via `emitAsync` method.
 
 ### Differences
 
 * Difference with [node events](https://nodejs.org/api/events.html)
-  + **`broken change`**: The event object supports bubbling
-    + the event object as listener's "this" object.
-    + return the result property of event object to the emitter.
-    + prevent the rest of listener from be executed if the stopped property of the event object is set to true
+  + **`broken change`**: The event supports bubbling and interruption
+    + the `event object` as listener's "this" object:
+      * `result`: If set, the result is returned to the `Event Emitter`.
+      * `stopped`: If set to `true`, it prevents the remaining listeners from being executed.
+      * `target`: The `Event Emitter` object, which was originally the `this` object.
     * **`broken change`**: The `emit` return the result of listeners's callback function instead of the successful state.
     * **`broken change`**: The `this` object of listeners' callback function is the `Event` Object instead of the emitter object.
       * The emitter object is put into the `target` property of the `Event` Object.
+  * Adds async event emitting via `emitAsync` method.
 * Difference with [event-emitter](https://github.com/medikoo/event-emitter)
-  + **`broken change`**: The event object supports bubbling(see above)
+  + **`broken change`**: The event supports bubbling and interruption(see above)
   + Adds the defaultMaxListeners class property to keep compatibility with node events.
   + Adds the setMaxListeners method to keep compatible with node events.
   + Adds `error`, `newListener` and `removeListener` events to keep compatibility with node events.
   + Adds listeners() method to keep compatibility with node events.
   + Adds listenerCount() class method to keep compatibility with node events.
+  * Adds async event emitting via `emitAsync` method.
 
 ### Installation
 
@@ -37,7 +40,7 @@ npm install events-ex
 
 ### Usage
 
-Extends from `EventEmitter`:
+Extends from `EventEmitter` class:
 
 ```js
 import {EventEmitter} from 'events-ex';
@@ -45,21 +48,21 @@ import {EventEmitter} from 'events-ex';
 class MyClass extends EventEmitter {}
 ```
 
-Add the event-able feature to your class directly:
+Add/Inject the event-able [ability][Ability] to your class directly:
 
 ```js
 import {eventable} from 'events-ex';
 
-class MyClass {}
+class MyClass extends MyRoot {}
 
 // inject the eventable ability to MyClass
 eventable(MyClass);
 ```
 
-Now uses it:
+Now, you can use events in your class:
 
 ```js
-var my = new MyClass;
+const my = new MyClass;
 
 my.on('event', function() {
   console.log('event occur');
@@ -230,3 +233,6 @@ emitter2.on('test', listener4 = function () { });
 emitter1.emit('test'); // Invoked listener1, listener2, listener3 and listener4
 emitter2.emit('test'); // Invoked listener1, listener2, listener3 and listener4
 ```
+
+[event-emitter]: https://github.com/medikoo/event-emitter
+[Ability]: https://github.com/snowyu/custom-ability.js

package/docs/classes/event.Event.md

@@ -37,11 +37,11 @@ Event Object that contains information about the event, such as the target eleme
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `target` | `EventEmitter` | Who trigger the event |
+| `target` | [`EventEmitter`](event_emitter.EventEmitter.md) | Who trigger the event |
 
 #### Defined in
 
-[src/event.js:8](https://github.com/snowyu/events-ex.js/blob/b4aaa97/src/event.js#L8)
+[src/event.js:8](https://github.com/snowyu/events-ex.js/blob/25f69f3/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/b4aaa97/src/event.js#L38)
+[src/event.js:38](https://github.com/snowyu/events-ex.js/blob/25f69f3/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/b4aaa97/src/event.js#L32)
+[src/event.js:32](https://github.com/snowyu/events-ex.js/blob/25f69f3/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/b4aaa97/src/event.js#L26)
+[src/event.js:26](https://github.com/snowyu/events-ex.js/blob/25f69f3/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/b4aaa97/src/event.js#L45)
+[src/event.js:45](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event.js#L45)
 
 ___
 
@@ -109,7 +109,7 @@ Initializes the event with the target object.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `target` | `EventEmitter` | The target object for the event. |
+| `target` | [`EventEmitter`](event_emitter.EventEmitter.md) | The target object for the event. |
 
 #### Returns
 
@@ -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/b4aaa97/src/event.js#L20)
+[src/event.js:20](https://github.com/snowyu/events-ex.js/blob/25f69f3/src/event.js#L20)

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

@@ -0,0 +1,25 @@
+[events-ex](../README.md) / [Exports](../modules.md) / [event-emitter](../modules/event_emitter-1.md) / EventEmitter
+
+# Class: EventEmitter
+
+[event-emitter](../modules/event_emitter-1.md).EventEmitter
+
+## Table of contents
+
+### Constructors
+
+- [constructor](event_emitter-1.EventEmitter.md#constructor)
+
+## Constructors
+
+### constructor
+
+• **new EventEmitter**()
+
+**`Classdesc`**
+
+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)