@isdk/ai-tool 0.5.1 → 0.5.2

package/docs/classes/EventEmitter.md

@@ -1,299 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / EventEmitter
-
-# Class: EventEmitter
-
-Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/event-emitter.d.ts:6
-
-Class that represents an event emitter.
-
-## Constructors
-
-### new EventEmitter()
-
-> **new EventEmitter**(): [`EventEmitter`](EventEmitter.md)
-
-#### Returns
-
-[`EventEmitter`](EventEmitter.md)
-
-## Properties
-
-### defaultMaxListeners
-
-> `static` **defaultMaxListeners**: `number`
-
-Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/event-emitter.d.ts:7
-
-## Methods
-
-### emit()
-
-> **emit**(`eventName`, ...`args`): `any`
-
-Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/event-emitter.d.ts:38
-
-Emits the specified event type with the given arguments.
-
-#### Parameters
-
-##### 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.
-
-***
-
-### emitAsync()
-
-> **emitAsync**(`eventName`, ...`args`): `Promise`\<`any`\>
-
-Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/event-emitter.d.ts:44
-
-Asynchronously emits the specified event type with the given arguments.
-
-#### Parameters
-
-##### 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.
-
-***
-
-### listenerCount()
-
-> **listenerCount**(`eventName`): `number`
-
-Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/event-emitter.d.ts:66
-
-Returns the count of listeners that are registered to listen for the specified event.
-
-#### Parameters
-
-##### eventName
-
-The name of the event to get the listeners for.
-
-`string` | `RegExp`
-
-#### Returns
-
-`number`
-
-- the listeners count
-
-***
-
-### listeners()
-
-> **listeners**(`eventName`): `Function`[]
-
-Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/event-emitter.d.ts:59
-
-Returns an array of functions that are registered to listen for the specified event.
-
-#### Parameters
-
-##### eventName
-
-The name of the event to get the listeners for.
-
-`string` | `RegExp`
-
-#### Returns
-
-`Function`[]
-
-- An array of functions that are registered to listen for the specified event.
-
-***
-
-### off()
-
-> **off**(`eventName`, `listener`): [`EventEmitter`](EventEmitter.md)
-
-Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/event-emitter.d.ts:32
-
-Removes a listener function from the specified event type.
-
-#### Parameters
-
-##### eventName
-
-`string` | `RegExp`
-
-##### listener
-
-`Function`
-
-The listener function to be removed.
-
-#### Returns
-
-[`EventEmitter`](EventEmitter.md)
-
-The EventEmitter instance to allow chaining.
-
-#### Throws
-
-If the listener is not a function.
-
-***
-
-### on()
-
-> **on**(`eventName`, `listener`): [`EventEmitter`](EventEmitter.md)
-
-Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/event-emitter.d.ts:16
-
-Adds a listener function to the specified event type.
-
-#### Parameters
-
-##### eventName
-
-`string` | `RegExp`
-
-##### listener
-
-`Function`
-
-The listener function to be called when the event is emitted.
-
-#### Returns
-
-[`EventEmitter`](EventEmitter.md)
-
-The EventEmitter instance to allow chaining.
-
-#### Throws
-
-If the listener is not a function.
-
-***
-
-### once()
-
-> **once**(`eventName`, `listener`): [`EventEmitter`](EventEmitter.md)
-
-Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/event-emitter.d.ts:24
-
-Adds a one-time listener function to the specified event type.
-
-#### Parameters
-
-##### eventName
-
-`string` | `RegExp`
-
-##### listener
-
-`Function`
-
-The listener function to be called once when the event is emitted.
-
-#### Returns
-
-[`EventEmitter`](EventEmitter.md)
-
-The EventEmitter instance to allow chaining.
-
-#### Throws
-
-If the listener is not a function.
-
-***
-
-### removeAllListeners()
-
-> **removeAllListeners**(`eventName`?): [`EventEmitter`](EventEmitter.md)
-
-Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/event-emitter.d.ts:51
-
-Removes all listeners for a specific event or all events from an event emitter.
-
-#### Parameters
-
-##### eventName?
-
-The event to remove listeners for. If not provided, all listeners for all events will be removed.
-
-`string` | `RegExp`
-
-#### Returns
-
-[`EventEmitter`](EventEmitter.md)
-
-- The event emitter with all listeners removed.
-
-***
-
-### setMaxListeners()
-
-> **setMaxListeners**(`n`): [`EventEmitter`](EventEmitter.md)
-
-Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/event-emitter.d.ts:52
-
-#### Parameters
-
-##### n
-
-`number`
-
-#### Returns
-
-[`EventEmitter`](EventEmitter.md)
-
-***
-
-### ~~listenerCount()~~
-
-> `static` **listenerCount**(`emitter`, `eventName`): `number`
-
-Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/event-emitter.d.ts:74
-
-Returns the count of listeners that are registered to listen for the specified event.
-
-#### Parameters
-
-##### emitter
-
-[`EventEmitter`](EventEmitter.md)
-
-##### eventName
-
-`string` | `RegExp`
-
-#### Returns
-
-`number`
-
-#### Deprecated
-
-use emitter.listenerCount instead