events-ex 2.1.1 → 2.3.0

package/docs/classes/event.Event.md

@@ -1,141 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / [event](../modules/event.md) / Event
-
-# Class: Event
-
-[event](../modules/event.md).Event
-
-## Table of contents
-
-### Constructors
-
-- [constructor](event.Event.md#constructor)
-
-### Properties
-
-- [result](event.Event.md#result)
-- [stopped](event.Event.md#stopped)
-- [target](event.Event.md#target)
-- [type](event.Event.md#type)
-
-### Methods
-
-- [end](event.Event.md#end)
-- [init](event.Event.md#init)
-
-## Constructors
-
-### constructor
-
-• **new Event**(`target`, `type`): [`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.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `target` | [`EventEmitter`](event_emitter.EventEmitter.md) | Who trigger the event |
-| `type` | `any` | - |
-
-#### 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/9c254b2/src/event.js#L8)
-
-## Properties
-
-### result
-
-• **result**: `any`
-
-Keep your event result here if any.
-
-#### Defined in
-
-[src/event.js:38](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event.js#L38)
-
-___
-
-### stopped
-
-• **stopped**: `boolean`
-
-Whether stop the bubbling event
-
-#### Defined in
-
-[src/event.js:32](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event.js#L32)
-
-___
-
-### target
-
-• **target**: `any`
-
-Who trigger the event
-
-#### Defined in
-
-[src/event.js:26](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event.js#L26)
-
-___
-
-### type
-
-• **type**: `string`
-
-The type of the event.
-
-#### Defined in
-
-[src/event.js:44](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event.js#L44)
-
-## Methods
-
-### end
-
-▸ **end**(): `any`
-
-Ends the event and returns the result.
-
-#### Returns
-
-`any`
-
-The result of the event.
-
-#### Defined in
-
-[src/event.js:51](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event.js#L51)
-
-___
-
-### init
-
-▸ **init**(`target`, `type`): `void`
-
-Initializes the event with the target object.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `target` | [`EventEmitter`](event_emitter.EventEmitter.md) | The target object for the event. |
-| `type` | `any` | - |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[src/event.js:20](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event.js#L20)

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

@@ -1,29 +0,0 @@
-[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**(): [`EventEmitter`](event_emitter-1.EventEmitter.md)
-
-#### Returns
-
-[`EventEmitter`](event_emitter-1.EventEmitter.md)
-
-**`Classdesc`**
-
-Class that represents an event emitter.
-
-#### Defined in
-
-[src/event-emitter.js:8](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event-emitter.js#L8)

package/docs/classes/event_emitter.EventEmitter.md

@@ -1,352 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / [event-emitter](../modules/event_emitter.md) / EventEmitter
-
-# Class: EventEmitter
-
-[event-emitter](../modules/event_emitter.md).EventEmitter
-
-Class that represents an event emitter.
-
-## Table of contents
-
-### Constructors
-
-- [constructor](event_emitter.EventEmitter.md#constructor)
-
-### Properties
-
-- [defaultMaxListeners](event_emitter.EventEmitter.md#defaultmaxlisteners)
-
-### Methods
-
-- [emit](event_emitter.EventEmitter.md#emit)
-- [emitAsync](event_emitter.EventEmitter.md#emitasync)
-- [listenerCount](event_emitter.EventEmitter.md#listenercount)
-- [listeners](event_emitter.EventEmitter.md#listeners)
-- [off](event_emitter.EventEmitter.md#off)
-- [on](event_emitter.EventEmitter.md#on)
-- [once](event_emitter.EventEmitter.md#once)
-- [removeAllListeners](event_emitter.EventEmitter.md#removealllisteners)
-- [removeListener](event_emitter.EventEmitter.md#removelistener)
-- [setMaxListeners](event_emitter.EventEmitter.md#setmaxlisteners)
-- [listenerCount](event_emitter.EventEmitter.md#listenercount-1)
-
-## Constructors
-
-### constructor
-
-• **new EventEmitter**(): [`EventEmitter`](event_emitter.EventEmitter.md)
-
-#### Returns
-
-[`EventEmitter`](event_emitter.EventEmitter.md)
-
-## Properties
-
-### defaultMaxListeners
-
-▪ `Static` **defaultMaxListeners**: `number`
-
-#### Defined in
-
-[src/event-emitter.d.ts:7](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event-emitter.d.ts#L7)
-
-## Methods
-
-### emit
-
-▸ **emit**(`eventName`, `...args`): `any`
-
-Emits the specified event type with the given arguments.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` | - |
-| `...args` | `any`[] | The event type followed by any number of arguments to be passed to the listener functions. |
-
-#### Returns
-
-`any`
-
-The result of the event.
-
-#### Defined in
-
-[src/event-emitter.d.ts:48](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event-emitter.d.ts#L48)
-
-___
-
-### emitAsync
-
-▸ **emitAsync**(`eventName`, `...args`): `Promise`\<`any`\>
-
-Asynchronously emits the specified event type with the given arguments.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` | - |
-| `...args` | `any`[] | The event type followed by any number of arguments to be passed to the listener functions. |
-
-#### Returns
-
-`Promise`\<`any`\>
-
-A promise that resolves with the result of the event.
-
-#### Defined in
-
-[src/event-emitter.d.ts:54](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event-emitter.d.ts#L54)
-
-___
-
-### listenerCount
-
-▸ **listenerCount**(`eventName`): `number`
-
-Returns the count of listeners that are registered to listen for the specified event.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `RegExp` | The name of the event to get the listeners for. |
-
-#### Returns
-
-`number`
-
-- the listeners count
-
-#### Defined in
-
-[src/event-emitter.d.ts:83](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event-emitter.d.ts#L83)
-
-___
-
-### listeners
-
-▸ **listeners**(`eventName`): `Function`[]
-
-Returns an array of functions that are registered to listen for the specified event.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `RegExp` | The name of the event to get the listeners for. |
-
-#### Returns
-
-`Function`[]
-
-- An array of functions that are registered to listen for the specified event.
-
-#### Defined in
-
-[src/event-emitter.d.ts:76](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event-emitter.d.ts#L76)
-
-___
-
-### off
-
-▸ **off**(`eventName`, `listener`): [`EventEmitter`](event_emitter.EventEmitter.md)
-
-Removes a listener function from the specified event type.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `RegExp` | - |
-| `listener` | `Function` | The listener function to be removed. |
-
-#### Returns
-
-[`EventEmitter`](event_emitter.EventEmitter.md)
-
-The EventEmitter instance to allow chaining.
-
-**`Throws`**
-
-If the listener is not a function.
-
-**`See`**
-
-[removeListener](event_emitter.EventEmitter.md#removelistener)
-
-#### Defined in
-
-[src/event-emitter.d.ts:33](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event-emitter.d.ts#L33)
-
-___
-
-### on
-
-▸ **on**(`eventName`, `listener`): [`EventEmitter`](event_emitter.EventEmitter.md)
-
-Adds a listener function to the specified event type.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `RegExp` | - |
-| `listener` | `Function` | The listener function to be called when the event is emitted. |
-
-#### Returns
-
-[`EventEmitter`](event_emitter.EventEmitter.md)
-
-The EventEmitter instance to allow chaining.
-
-**`Throws`**
-
-If the listener is not a function.
-
-#### Defined in
-
-[src/event-emitter.d.ts:16](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event-emitter.d.ts#L16)
-
-___
-
-### once
-
-▸ **once**(`eventName`, `listener`): [`EventEmitter`](event_emitter.EventEmitter.md)
-
-Adds a one-time listener function to the specified event type.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `RegExp` | - |
-| `listener` | `Function` | The listener function to be called once when the event is emitted. |
-
-#### Returns
-
-[`EventEmitter`](event_emitter.EventEmitter.md)
-
-The EventEmitter instance to allow chaining.
-
-**`Throws`**
-
-If the listener is not a function.
-
-#### Defined in
-
-[src/event-emitter.d.ts:24](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event-emitter.d.ts#L24)
-
-___
-
-### removeAllListeners
-
-▸ **removeAllListeners**(`eventName?`): [`EventEmitter`](event_emitter.EventEmitter.md)
-
-Removes all listeners for a specific event or all events from an event emitter.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName?` | `string` \| `RegExp` | The event to remove listeners for. If not provided, all listeners for all events will be removed. |
-
-#### Returns
-
-[`EventEmitter`](event_emitter.EventEmitter.md)
-
-- The event emitter with all listeners removed.
-
-#### Defined in
-
-[src/event-emitter.d.ts:61](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event-emitter.d.ts#L61)
-
-___
-
-### removeListener
-
-▸ **removeListener**(`eventName`, `listener`): [`EventEmitter`](event_emitter.EventEmitter.md)
-
-Removes a listener function from the specified event type.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `RegExp` | - |
-| `listener` | `Function` | The listener function to be removed. |
-
-#### Returns
-
-[`EventEmitter`](event_emitter.EventEmitter.md)
-
-The EventEmitter instance to allow chaining.
-
-**`Throws`**
-
-If the listener is not a function.
-
-**`See`**
-
-[off](event_emitter.EventEmitter.md#off)
-
-#### Defined in
-
-[src/event-emitter.d.ts:42](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event-emitter.d.ts#L42)
-
-___
-
-### setMaxListeners
-
-▸ **setMaxListeners**(`n`): [`EventEmitter`](event_emitter.EventEmitter.md)
-
-Sets the maximum number of listeners allowed for the event emitter.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `n` | `number` | The maximum number of listeners to set. Must be a positive integer. |
-
-#### Returns
-
-[`EventEmitter`](event_emitter.EventEmitter.md)
-
-The [EventEmitter](event_emitter.EventEmitter.md) instance for method chaining.
-
-**`Throws`**
-
-If `n` is not a positive integer.
-
-#### Defined in
-
-[src/event-emitter.d.ts:69](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event-emitter.d.ts#L69)
-
-___
-
-### listenerCount
-
-▸ **listenerCount**(`emitter`, `eventName`): `number`
-
-Returns the count of listeners that are registered to listen for the specified event.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `emitter` | [`EventEmitter`](event_emitter.EventEmitter.md) |
-| `eventName` | `string` \| `RegExp` |
-
-#### Returns
-
-`number`
-
-**`Deprecated`**
-
-use emitter.listenerCount instead
-
-#### Defined in
-
-[src/event-emitter.d.ts:91](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/event-emitter.d.ts#L91)

package/docs/modules/all_off.md

@@ -1,44 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / all-off
-
-# Module: all-off
-
-## Table of contents
-
-### References
-
-- [default](all_off.md#default)
-
-### Functions
-
-- [allOff](all_off.md#alloff)
-
-## References
-
-### default
-
-Renames and re-exports [allOff](all_off.md#alloff)
-
-## Functions
-
-### allOff
-
-▸ **allOff**(`emitter`, `type?`): [`EventEmitter`](../classes/event_emitter.EventEmitter.md)
-
-Removes all listeners for a specific event or all events from an event emitter.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `emitter` | [`EventEmitter`](../classes/event_emitter.EventEmitter.md) | The event emitter to remove listeners from. |
-| `type?` | `string` | The event to remove listeners for. If not provided, all listeners for all events will be removed. |
-
-#### Returns
-
-[`EventEmitter`](../classes/event_emitter.EventEmitter.md)
-
-- The event emitter with all listeners removed.
-
-#### Defined in
-
-[src/all-off.js:12](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/all-off.js#L12)

package/docs/modules/consts.md

@@ -1,39 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / consts
-
-# Module: consts
-
-## Table of contents
-
-### Variables
-
-- [RegExpEventSymbol](consts.md#regexpeventsymbol)
-- [states](consts.md#states)
-
-## Variables
-
-### RegExpEventSymbol
-
-• `Const` **RegExpEventSymbol**: `symbol` \| ``"@@RegExpEvent"``
-
-#### Defined in
-
-[src/consts.js:13](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/consts.js#L13)
-
-___
-
-### states
-
-• `Const` **states**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `ABORT` | `number` |
-| `CONTINUE` | `any` |
-| `DONE` | `number` |
-| `STOPPED` | `number` |
-
-#### Defined in
-
-[src/consts.js:6](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/consts.js#L6)

package/docs/modules/default_methods.md

@@ -1,51 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / default-methods
-
-# Module: default-methods
-
-## Table of contents
-
-### References
-
-- [default](default_methods.md#default)
-
-### Functions
-
-- [getEventableMethods](default_methods.md#geteventablemethods)
-
-## References
-
-### default
-
-Renames and re-exports [getEventableMethods](default_methods.md#geteventablemethods)
-
-## Functions
-
-### getEventableMethods
-
-▸ **getEventableMethods**(`aClass`): `Object`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `aClass` | `any` |
-
-#### Returns
-
-`Object`
-
-| Name | Type |
-| :------ | :------ |
-| `emit` | (...`args`: `any`) => `any` |
-| `emitAsync` | (...`args`: `any`) => `Promise`\<`any`\> |
-| `listenerCount` | (`emitter`: `any`, `type`: `any`) => `number` |
-| `listeners` | (`type`: `any`) => `any` |
-| `off` | (`type`: `string` \| `RegExp`, `listener`: `Function`) => [`EventEmitter`](../classes/event_emitter.EventEmitter.md) |
-| `on` | (`type`: `string` \| `RegExp`, `listener`: `Function`, `index?`: `number`) => [`EventEmitter`](../classes/event_emitter.EventEmitter.md) |
-| `once` | (`type`: `string` \| `RegExp`, `listener`: `Function`, `index?`: `number`) => [`EventEmitter`](../classes/event_emitter.EventEmitter.md) |
-| `removeAllListeners` | (`type`: `string` \| `RegExp`) => [`EventEmitter`](../classes/event_emitter.EventEmitter.md) |
-| `setMaxListeners` | (`n`: `any`) => \{ on(type: string \| RegExp, listener: Function, index?: number): EventEmitter; once(type: string \| RegExp, listener: Function, index?: number): EventEmitter; ... 6 more ...; removeAllListeners(type: string \| RegExp): EventEmitter; } |
-
-#### Defined in
-
-[src/default-methods.js:14](https://github.com/snowyu/events-ex.js/blob/9c254b2/src/default-methods.js#L14)

package/docs/modules/event.md

@@ -1,19 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / event
-
-# Module: event
-
-## Table of contents
-
-### References
-
-- [default](event.md#default)
-
-### Classes
-
-- [Event](../classes/event.Event.md)
-
-## References
-
-### default
-
-Renames and re-exports [Event](../classes/event.Event.md)

package/docs/modules/event_emitter-1.md

@@ -1,19 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / event-emitter
-
-# Module: event-emitter
-
-## Table of contents
-
-### References
-
-- [default](event_emitter-1.md#default)
-
-### Classes
-
-- [EventEmitter](../classes/event_emitter-1.EventEmitter.md)
-
-## References
-
-### default
-
-Renames and re-exports [EventEmitter](../classes/event_emitter-1.EventEmitter.md)

package/docs/modules/event_emitter.md

@@ -1,19 +0,0 @@
-[events-ex](../README.md) / [Exports](../modules.md) / event-emitter
-
-# Module: event-emitter
-
-## Table of contents
-
-### References
-
-- [default](event_emitter.md#default)
-
-### Classes
-
-- [EventEmitter](../classes/event_emitter.EventEmitter.md)
-
-## References
-
-### default
-
-Renames and re-exports [EventEmitter](../classes/event_emitter.EventEmitter.md)