EventEmitterable
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/utils/events.d.ts:11
An EventEmitterable behaves similar to an EventEmitter except provides async access to its methods.
An EventEmitter implements the observer pattern.
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”Type Parameter |
---|
T |
Methods
Section titled “Methods”addListener()
Section titled “addListener()”addListener(event, listener): Promise<EventEmitterable<T>>;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/utils/events.d.ts:46
Alias for [[on]].
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
event | T |
listener | Listener |
Returns
Section titled “Returns”Promise
<EventEmitterable
<T
>>
emit()
Section titled “emit()”emit(event, ...args): Promise<boolean>;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/utils/events.d.ts:25
Triggers each listener for %%event%% with the %%args%%.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
event | T |
…args | any [] |
Returns
Section titled “Returns”Promise
<boolean
>
listenerCount()
Section titled “listenerCount()”listenerCount(event?): Promise<number>;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/utils/events.d.ts:29
Resolves to the number of listeners for %%event%%.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
event? | T |
Returns
Section titled “Returns”Promise
<number
>
listeners()
Section titled “listeners()”listeners(event?): Promise<Listener[]>;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/utils/events.d.ts:33
Resolves to the listeners for %%event%%.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
event? | T |
Returns
Section titled “Returns”off(event, listener?): Promise<EventEmitterable<T>>;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/utils/events.d.ts:38
Unregister the %%listener%% for %%event%%. If %%listener%% is unspecified, all listeners are unregistered.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
event | T |
listener? | Listener |
Returns
Section titled “Returns”Promise
<EventEmitterable
<T
>>
on(event, listener): Promise<EventEmitterable<T>>;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/utils/events.d.ts:16
Registers a %%listener%% that is called whenever the %%event%% occurs until unregistered.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
event | T |
listener | Listener |
Returns
Section titled “Returns”Promise
<EventEmitterable
<T
>>
once()
Section titled “once()”once(event, listener): Promise<EventEmitterable<T>>;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/utils/events.d.ts:21
Registers a %%listener%% that is called the next time %%event%% occurs.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
event | T |
listener | Listener |
Returns
Section titled “Returns”Promise
<EventEmitterable
<T
>>
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(event?): Promise<EventEmitterable<T>>;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/utils/events.d.ts:42
Unregister all listeners for %%event%%.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
event? | T |
Returns
Section titled “Returns”Promise
<EventEmitterable
<T
>>
removeListener()
Section titled “removeListener()”removeListener(event, listener): Promise<EventEmitterable<T>>;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/utils/events.d.ts:50
Alias for [[off]].
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
event | T |
listener | Listener |
Returns
Section titled “Returns”Promise
<EventEmitterable
<T
>>