events-ex 2.1.1 → 2.3.0

package/docs/default-methods/functions/getEventableMethods.md

@@ -0,0 +1,309 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / [default-methods](../README.md) / getEventableMethods
+
+# Function: getEventableMethods()
+
+> **getEventableMethods**(`aClass`): `object`
+
+Defined in: [src/default-methods.js:15](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/default-methods.js#L15)
+
+## Parameters
+
+### aClass
+
+`any`
+
+## Returns
+
+### configure()
+
+> **configure**(`options`): [`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+Configures the event emitter with specified options using a Fluent API.
+
+#### Parameters
+
+##### options
+
+Configuration options for event emission.
+
+###### asyncMode?
+
+`string`
+
+The mode of asynchronous emission ('serial' or 'parallel').
+
+###### resultMode?
+
+`string`
+
+The strategy for handling multiple return values ('last', 'first', 'collect').
+
+#### Returns
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+A proxy object representing the configured EventEmitter.
+
+### emit()
+
+> **emit**(...`args`): `any`
+
+Emits the specified event type with the given arguments.
+
+#### Parameters
+
+##### 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.
+
+### emitAsync()
+
+> **emitAsync**(...`args`): `Promise`\<`any`\>
+
+Asynchronously emits the specified event type with the given arguments.
+
+#### Parameters
+
+##### 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.
+
+### listenerCount()
+
+> **listenerCount**(`emitter`, `type`): `number`
+
+#### Parameters
+
+##### emitter
+
+`any`
+
+##### type
+
+`any`
+
+#### Returns
+
+`number`
+
+### listeners()
+
+> **listeners**(`type`): `any`
+
+#### Parameters
+
+##### type
+
+`any`
+
+#### Returns
+
+`any`
+
+### off()
+
+> **off**(`type`, `listener`): [`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+Removes a listener function from the specified event type.
+
+#### Parameters
+
+##### type
+
+The event type to remove the listener from.
+
+`string` | `RegExp`
+
+##### listener
+
+`Function`
+
+The listener function to be removed.
+
+#### Returns
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+The EventEmitter instance to allow chaining.
+
+#### Throws
+
+If the listener is not a function.
+
+### on()
+
+> **on**(`type`, `listener`, `index?`): [`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+Adds a listener function to the specified event type.
+
+#### Parameters
+
+##### type
+
+The event type to listen for.
+
+`string` | `RegExp`
+
+##### listener
+
+`Function`
+
+The listener function to be called when the event is emitted.
+
+##### index?
+
+The index at which to insert the listener. 
+       - 'first' or -Infinity: Adds to the "Head" zone. The first listener added as 'first' is placed at the very front.
+       - 'last' or Infinity: Adds to the "Tail" zone. The first listener added as 'last' will always be the very last one to execute.
+       - number: Inserts at the specified index within the "Body" (normal) zone.
+       If not specified, the listener is added to the end of the "Body" zone.
+
+`number` | `"first"` | `"last"`
+
+#### Returns
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+The EventEmitter instance to allow chaining.
+
+#### Throws
+
+If the listener is not a function.
+
+### once()
+
+> **once**(`type`, `listener`, `index?`): [`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+Adds a one-time listener function to the specified event type.
+
+#### Parameters
+
+##### type
+
+The event type to listen for.
+
+`string` | `RegExp`
+
+##### listener
+
+`Function`
+
+The listener function to be called once when the event is emitted.
+
+##### index?
+
+The index at which to insert the listener.
+       - 'first' or -Infinity: Adds to the "Head" zone. The first listener added as 'first' is placed at the very front.
+       - 'last' or Infinity: Adds to the "Tail" zone. The first listener added as 'last' will always be the very last one to execute.
+       - number: Inserts at the specified index within the "Body" (normal) zone.
+       If not specified, the listener is added to the end of the "Body" zone.
+
+`number` | `"first"` | `"last"`
+
+#### Returns
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+The EventEmitter instance to allow chaining.
+
+#### Throws
+
+If the listener is not a function.
+
+### parallel()
+
+> **parallel**(`resultMode?`): [`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+A shortcut for parallel configuration.
+
+#### Parameters
+
+##### resultMode?
+
+`string`
+
+The strategy for handling multiple return values.
+
+#### Returns
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+A proxy object representing the configured EventEmitter.
+
+### removeAllListeners()
+
+> **removeAllListeners**(`type`): [`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+Removes all listener functions from the specified event type.
+
+#### Parameters
+
+##### type
+
+The event type to remove the listener from.
+
+`string` | `RegExp`
+
+#### Returns
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+The EventEmitter instance to allow chaining.
+
+#### Throws
+
+If the listener is not a function.
+
+### setEmitterOptions()
+
+> **setEmitterOptions**(`options`): [`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+Sets the configuration options for the EventEmitter instance.
+
+#### Parameters
+
+##### options
+
+`any`
+
+Configuration options for the emitter (e.g., asyncMode, resultMode, maxListeners).
+
+#### Returns
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+The EventEmitter instance for chaining.
+
+### setMaxListeners()
+
+> **setMaxListeners**(`n`): \{ configure(options: \{ asyncMode?: string; resultMode?: string; \}): EventEmitter; parallel(resultMode?: string): EventEmitter; setEmitterOptions(options: any): EventEmitter; ... 8 more ...; removeAllListeners(type: string \| RegExp): EventEmitter; \}
+
+#### Parameters
+
+##### n
+
+`any`
+
+#### Returns
+
+\{ configure(options: \{ asyncMode?: string; resultMode?: string; \}): EventEmitter; parallel(resultMode?: string): EventEmitter; setEmitterOptions(options: any): EventEmitter; ... 8 more ...; removeAllListeners(type: string \| RegExp): EventEmitter; \}

package/docs/event/README.md

@@ -0,0 +1,17 @@
+[**events-ex**](../README.md)
+
+***
+
+[events-ex](../modules.md) / event
+
+# event
+
+## Classes
+
+- [Event](classes/Event.md)
+
+## References
+
+### default
+
+Renames and re-exports [Event](classes/Event.md)

package/docs/event/classes/Event.md

@@ -0,0 +1,143 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / [event](../README.md) / Event
+
+# Class: Event
+
+Defined in: [src/event.js:8](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/event.js#L8)
+
+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.
+
+## Param
+
+Who trigger the event
+
+## Constructors
+
+### Constructor
+
+> **new Event**(`target`, `type`): `Event`
+
+Defined in: [src/event.js:8](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/event.js#L8)
+
+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
+
+##### target
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+Who trigger the event
+
+##### type
+
+`any`
+
+#### Returns
+
+`Event`
+
+- 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.
+
+## Properties
+
+### resolved
+
+> **resolved**: `boolean`
+
+Defined in: [src/event.js:38](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/event.js#L38)
+
+Whether a result has been resolved (for 'first' result mode)
+
+***
+
+### result
+
+> **result**: `any`
+
+Defined in: [src/event.js:44](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/event.js#L44)
+
+Keep your event result here if any.
+
+***
+
+### stopped
+
+> **stopped**: `boolean`
+
+Defined in: [src/event.js:32](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/event.js#L32)
+
+Whether stop the bubbling event
+
+***
+
+### target
+
+> **target**: `any`
+
+Defined in: [src/event.js:26](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/event.js#L26)
+
+Who trigger the event
+
+***
+
+### type
+
+> **type**: `string`
+
+Defined in: [src/event.js:50](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/event.js#L50)
+
+The type of the event.
+
+## Methods
+
+### end()
+
+> **end**(): `any`
+
+Defined in: [src/event.js:57](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/event.js#L57)
+
+Ends the event and returns the result.
+
+#### Returns
+
+`any`
+
+The result of the event.
+
+***
+
+### init()
+
+> **init**(`target`, `type`): `void`
+
+Defined in: [src/event.js:20](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/event.js#L20)
+
+Initializes the event with the target object.
+
+#### Parameters
+
+##### target
+
+[`EventEmitter`](../../event-emitter/classes/EventEmitter.md)
+
+The target object for the event.
+
+##### type
+
+`any`
+
+#### Returns
+
+`void`

package/docs/event-emitter/README-1.md

@@ -0,0 +1,17 @@
+[**events-ex**](../README.md)
+
+***
+
+[events-ex](../modules.md) / event-emitter
+
+# event-emitter
+
+## Classes
+
+- [EventEmitter](classes/EventEmitter-1.md)
+
+## References
+
+### default
+
+Renames and re-exports [EventEmitter](classes/EventEmitter-1.md)

package/docs/event-emitter/README.md

@@ -0,0 +1,17 @@
+[**events-ex**](../README.md)
+
+***
+
+[events-ex](../modules.md) / event-emitter
+
+# event-emitter
+
+## Classes
+
+- [EventEmitter](classes/EventEmitter.md)
+
+## References
+
+### default
+
+Renames and re-exports [EventEmitter](classes/EventEmitter.md)

package/docs/event-emitter/classes/EventEmitter-1.md

@@ -0,0 +1,29 @@
+[**events-ex**](../../README.md)
+
+***
+
+[events-ex](../../modules.md) / [event-emitter](../README-1.md) / EventEmitter
+
+# Class: EventEmitter
+
+Defined in: [src/event-emitter.js:8](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/event-emitter.js#L8)
+
+## Classdesc
+
+Class that represents an event emitter.
+
+## Constructors
+
+### Constructor
+
+> **new EventEmitter**(): `EventEmitter`
+
+Defined in: [src/event-emitter.js:8](https://github.com/snowyu/events-ex.js/blob/53cfb5bb3f7229cb549e99d410c0d6d39665eb0a/src/event-emitter.js#L8)
+
+#### Returns
+
+`EventEmitter`
+
+#### Classdesc
+
+Class that represents an event emitter.