@fuel-ts/account v0.97.0 • Docs
Name
FuelConnector
Wallet Connector is a interface that represents a Wallet Connector and all the methods that should be implemented to be compatible with the Fuel SDK.
FuelSdk new Fuel(
config):Fuel
• config: FuelConfig = Fuel.defaultConfig
packages/account/src/connectors/fuel.ts:93
connected:
boolean=false
packages/account/src/connectors/fuel-connector.ts:91
events: typeof
FuelConnectorEventTypes=FuelConnectorEventTypes
packages/account/src/connectors/fuel-connector.ts:94
external:
boolean=true
packages/account/src/connectors/fuel-connector.ts:93
installed:
boolean=false
packages/account/src/connectors/fuel-connector.ts:92
metadata:
ConnectorMetadata
packages/account/src/connectors/fuel-connector.ts:90
name:
string=''
packages/account/src/connectors/fuel-connector.ts:89
staticSTORAGE_KEY:string='fuel-current-connector'
packages/account/src/connectors/fuel.ts:82
readonlystaticcaptureRejectionSymbol: typeofcaptureRejectionSymbol
Value: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
v13.4.0, v12.16.0
FuelConnector .captureRejectionSymbol
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:452
staticcaptureRejections:boolean
Value: boolean
Change the default captureRejections option on all new EventEmitter objects.
v13.4.0, v12.16.0
FuelConnector .captureRejections
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:459
staticdefaultConfig:FuelConfig={}
packages/account/src/connectors/fuel.ts:83
staticdefaultMaxListeners:number
By default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for allEventEmitter instances, the events.defaultMaxListeners property
can be used. If this value is not a positive number, a RangeError is thrown.
Take caution when setting the events.defaultMaxListeners because the
change affects all EventEmitter instances, including those created before
the change is made. However, calling emitter.setMaxListeners(n) still has
precedence over events.defaultMaxListeners.
This is not a hard limit. The EventEmitter instance will allow
more listeners to be added but will output a trace warning to stderr indicating
that a "possible EventEmitter memory leak" has been detected. For any single
EventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners() methods can be used to
temporarily avoid this warning:
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
// do stuff
emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
}); The --trace-warnings command-line flag can be used to display the
stack trace for such warnings.
The emitted warning can be inspected with process.on('warning') and will
have the additional emitter, type, and count properties, referring to
the event emitter instance, the event's name and the number of attached
listeners, respectively.
Its name property is set to 'MaxListenersExceededWarning'.
v0.11.2
FuelConnector .defaultMaxListeners
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:498
readonlystaticerrorMonitor: typeoferrorMonitor
This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no
regular 'error' listener is installed.
v13.6.0, v12.17.0
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:445
optional[captureRejectionSymbol]<K>(error,event, ...args):void
• K
• error: Error
• event: string | symbol
• ...args: AnyRest
void
FuelConnector .[captureRejectionSymbol]
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:136
accounts():
Promise<string[]>
Should return all the accounts authorized for the current connection.
Promise<string[]>
The accounts addresses strings
packages/account/src/connectors/fuel-connector.ts:132
addABI(
_contractId,_abi):Promise<boolean>
Should add the ABI to the connector and return true if the ABI was added successfully.
• _contractId: string
• _abi: JsonAbi
Promise<boolean>
Return true if the ABI was added successfully.
packages/account/src/connectors/fuel-connector.ts:303
addAsset(
_asset):Promise<boolean>
Emits
Should add the asset metadata to the connector and return true if the asset was added successfully.
If the asset already exists it should throw an error.
assets
• _asset: Asset
Promise<boolean>
True if the asset was added successfully
Error if the asset already exists
packages/account/src/connectors/fuel-connector.ts:241
addAssets(
_assets):Promise<boolean>
Emits
Should add the assets metadata to the connector and return true if the asset was added successfully.
If the asset already exists it should throw an error.
assets
• _assets: Asset []
Promise<boolean>
True if the asset was added successfully
Error if the asset already exists
packages/account/src/connectors/fuel-connector.ts:226
addListener<
K>(eventName,listener):this
Alias for emitter.on(eventName, listener).
• K
• eventName: string | symbol
• listener
this
v0.1.26
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:597
addNetwork(
_networkUrl):Promise<boolean>
Emits
Should start the add network process and return true if the network was added successfully.
networks
• _networkUrl: string
Promise<boolean>
Return true if the network was added successfully
Error if the network already exists
packages/account/src/connectors/fuel-connector.ts:262
assets():
Promise<Asset[]>
Should return all the assets added to the connector. If a connection is already established.
Promise<Asset []>
Array of assets metadata from the connector vinculated to the all accounts from a specific Wallet.
packages/account/src/connectors/fuel-connector.ts:250
clean():
Promise<void>
Clean all the data from the storage.
Promise<void>
FuelSdk.clean
packages/account/src/connectors/fuel.ts:490
connect():
Promise<boolean>
Emits
Should start the connection process and return true if the account authorize the connection.
and return false if the user reject the connection.
accounts
Promise<boolean>
boolean - connection status.
packages/account/src/connectors/fuel-connector.ts:145
connectors():
Promise<FuelConnector[]>
Return the list of connectors with the status of installed and connected.
Promise<FuelConnector []>
FuelSdk.connectors
packages/account/src/connectors/fuel.ts:352
currentAccount():
Promise<null|string>
Should return the current account selected inside the connector, if the account is authorized for the connection.
If the account is not authorized it should return null.
Promise<null | string>
The current account selected otherwise null.
packages/account/src/connectors/fuel-connector.ts:211
currentConnector():
undefined|null|FuelConnector
Return the current selected connector.
undefined | null | FuelConnector
FuelSdk.currentConnector
packages/account/src/connectors/fuel.ts:394
currentNetwork():
Promise<Network>
Should return the current network selected inside the connector. Even if the connection is not established.
Promise<Network >
Return the current network selected inside the connector.
packages/account/src/connectors/fuel-connector.ts:292
destroy():
Promise<void>
Removes all listeners and cleans the storage.
Promise<void>
FuelSdk.destroy
packages/account/src/connectors/fuel.ts:497
disconnect():
Promise<boolean>
Emits
Should disconnect the current connection and return false if the disconnection was successful.
assets connection
Promise<boolean>
The connection status.
packages/account/src/connectors/fuel-connector.ts:156
emit<
K>(eventName, ...args):boolean
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
to each.
Returns true if the event had listeners, false otherwise.
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener• K
• eventName: string | symbol
• ...args: AnyRest
boolean
v0.1.26
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:859
eventNames(): (
string|symbol)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or Symbols.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ] (string | symbol)[]
v6.0.0
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:922
getABI(
_id):Promise<null|JsonAbi>
Should return the ABI from the connector vinculated to the all accounts from a specific Wallet.
• _id: string
Promise<null | JsonAbi>
The ABI if it exists, otherwise return null.
packages/account/src/connectors/fuel-connector.ts:313
getConnector(
connector):null|FuelConnector
Get a connector from the list of connectors.
• connector: string | FuelConnector
null | FuelConnector
FuelSdk.getConnector
packages/account/src/connectors/fuel.ts:343
getMaxListeners():
number
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners .
number
v1.0.0
FuelConnector .getMaxListeners
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:774
getProvider(
providerOrNetwork?):Promise<Provider>
Return a Fuel Provider instance with extends features to work with connectors.
• providerOrNetwork?: Provider | Network
Promise<Provider >
getProvider is deprecated and is going to be removed in the future, use getWallet instead.
packages/account/src/connectors/fuel.ts:431
getWallet(
address,providerOrNetwork?):Promise<Account>
Return a Fuel Wallet Locked instance with extends features to work with connectors.
• address: string | AbstractAddress
• providerOrNetwork?: Provider | Network
Promise<Account >
FuelSdk.getWallet
packages/account/src/connectors/fuel.ts:467
hasABI(
_id):Promise<boolean>
Should return true if the abi exists in the connector vinculated to the all accounts from a specific Wallet.
• _id: string
Promise<boolean>
Returns true if the abi exists or false if not.
packages/account/src/connectors/fuel-connector.ts:323
hasConnector():
Promise<boolean>
Return true if any connector is available.
Promise<boolean>
FuelSdk.hasConnector
packages/account/src/connectors/fuel.ts:401
hasWallet():
Promise<boolean>
Promise<boolean>
FuelSdk.hasWallet
packages/account/src/connectors/fuel.ts:421
init():
Promise<Fuel>
Promise<Fuel >
packages/account/src/connectors/fuel.ts:118
isConnected():
Promise<boolean>
Should return true if the connector is connected to any of the accounts available.
Promise<boolean>
The connection status.
packages/account/src/connectors/fuel-connector.ts:122
listenerCount<
K>(eventName,listener?):number
Returns the number of listeners listening for the event named eventName.
If listener is provided, it will return how many times the listener is found
in the list of the listeners of the event.
• K
• eventName: string | symbol
The name of the event being listened for
• listener?: Function
The event handler function
number
v3.2.0
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:868
listeners<
K>(eventName):Function[]
Returns a copy of the array of listeners for the event named eventName.
server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]• K
• eventName: string | symbol
Function[]
v0.1.26
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:787
networks():
Promise<Network[]>
Should return all the networks available from the connector. If the connection is already established.
Promise<Network []>
Return all the networks added to the connector.
packages/account/src/connectors/fuel-connector.ts:283
off<
K>(eventName,listener):this
Alias for emitter.removeListener().
• K
• eventName: string | symbol
• listener
this
v10.0.0
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:747
on<
E,D>(eventName,listener):this
Event listener for the connector.
• E extends connectors | currentConnector | connection | accounts | currentAccount | networks | currentNetwork | assets
• D extends never
• eventName: E
The event name to listen
• listener
The listener function
this
packages/account/src/connectors/fuel-connector.ts:333
once<
K>(eventName,listener):this
Adds a one-time listener function for the event named eventName. The
next time eventName is triggered, this listener is removed and then invoked.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
}); Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the
event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a• K
• eventName: string | symbol
The name of the event.
• listener
The callback function
this
v0.3.0
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:659
ping():
Promise<boolean>
Should return true if the connector is loaded in less then one second.
Promise<boolean>
Always true.
packages/account/src/connectors/fuel-connector.ts:102
prependListener<
K>(eventName,listener):this
Adds the listener function to the beginning of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventName
and listener will result in the listener being added, and called, multiple times.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
}); Returns a reference to the EventEmitter, so that calls can be chained.
• K
• eventName: string | symbol
The name of the event.
• listener
The callback function
this
v6.0.0
FuelConnector .prependListener
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:886
prependOnceListener<
K>(eventName,listener):this
Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this
listener is removed, and then invoked.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
}); Returns a reference to the EventEmitter, so that calls can be chained.
• K
• eventName: string | symbol
The name of the event.
• listener
The callback function
this
v6.0.0
FuelConnector .prependOnceListener
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:902
rawListeners<
K>(eventName):Function[]
Returns a copy of the array of listeners for the event named eventName,
including any wrappers (such as those created by .once()).
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));
// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];
// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();
// Logs "log once" to the console and removes the listener
logFnWrapper();
emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');
// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');• K
• eventName: string | symbol
Function[]
v9.4.0
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:818
removeAllListeners(
eventName?):this
Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter, so that calls can be chained.
• eventName?: string | symbol
this
v0.1.26
FuelConnector .removeAllListeners
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:758
removeListener<
K>(eventName,listener):this
Removes the specified listener from the listener array for the event named eventName.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback); removeListener() will remove, at most, one instance of a listener from the
listener array. If any single listener has been added multiple times to the
listener array for the specified eventName, then removeListener() must be
called multiple times to remove each instance.
Once an event is emitted, all listeners attached to it at the
time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution
will not remove them fromemit() in progress. Subsequent events behave as expected.
import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};
const callbackB = () => {
console.log('B');
};
myEmitter.on('event', callbackA);
myEmitter.on('event', callbackB);
// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
// A
// B
// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
// A Because listeners are managed using an internal array, calling this will
change the position indices of any listener registered after the listener
being removed. This will not impact the order in which listeners are called,
but it means that any copies of the listener array as returned by
the emitter.listeners() method will need to be recreated.
When a single function has been added as a handler multiple times for a single
event (as in the example below), removeListener() will remove the most
recently added instance. In the example the once('ping') listener is removed:
import { EventEmitter } from 'node:events';
const ee = new EventEmitter();
function pong() {
console.log('pong');
}
ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);
ee.emit('ping');
ee.emit('ping'); Returns a reference to the EventEmitter, so that calls can be chained.
• K
• eventName: string | symbol
• listener
this
v0.1.26
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:742
selectConnector(
connectorName,options):Promise<boolean>
Set the current connector to be used.
• connectorName: string
• options: FuelConnectorSelectOptions = ...
Promise<boolean>
FuelSdk.selectConnector
packages/account/src/connectors/fuel.ts:360
selectNetwork(
_network):Promise<boolean>
Emits
Should start the select network process and return true if the network has change successfully.
networks
• _network: SelectNetworkArguments
Promise<boolean>
Return true if the network was added successfully
Error if the network already exists
packages/account/src/connectors/fuel-connector.ts:274
sendTransaction(
_address,_transaction):Promise<string>
Should start the send transaction process and return the transaction id submitted to the network.
If the network is not available for the connection it should throw an error to avoid the transaction to be sent to the wrong network and lost.
• _address: string
• _transaction: TransactionRequestLike
Promise<string>
The transaction id
FuelConnector .sendTransaction
packages/account/src/connectors/fuel-connector.ts:199
setMaxListeners(
n):this
By default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners() method allows the limit to be
modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
• n: number
this
v0.3.5
FuelConnector .setMaxListeners
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:768
signMessage(
_address,_message):Promise<string>
Should start the sign message process and return the signed message.
• _address: string
• _message: string
Promise<string>
Message signature
packages/account/src/connectors/fuel-connector.ts:169
signTransaction(
_address,_transaction):Promise<string>
Should start the sign transaction process and return the signed transaction.
• _address: string
• _transaction: TransactionRequestLike
Promise<string>
Transaction signature
FuelConnector .signTransaction
packages/account/src/connectors/fuel-connector.ts:182
unsubscribe():
void
Remove all open listeners this is useful when you want to remove the Fuel instance and avoid memory leaks.
void
FuelSdk.unsubscribe
packages/account/src/connectors/fuel.ts:479
version():
Promise<Version>
Should return the current version of the connector and the network version that is compatible.
Promise<Version >
boolean - connection status.
packages/account/src/connectors/fuel-connector.ts:112
staticaddAbortListener(signal,resource):Disposable
Experimental
Listens once to the abort event on the provided signal.
Listening to the abort event on abort signals is unsafe and may
lead to resource leaks since another third party with the signal can
call e.stopImmediatePropagation(). Unfortunately Node.js cannot change
this since it would violate the web standard. Additionally, the original
API makes it easy to forget to remove listeners.
This API allows safely using AbortSignals in Node.js APIs by solving these
two issues by listening to the event such that stopImmediatePropagation does
not prevent the listener from running.
Returns a disposable so that it may be unsubscribed from more easily.
import { addAbortListener } from 'node:events';
function example(signal) {
let disposable;
try {
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
disposable = addAbortListener(signal, (e) => {
// Do something when signal is aborted.
});
} finally {
disposable?.[Symbol.dispose]();
}
} • signal: AbortSignal
• resource
Disposable
Disposable that removes the abort listener.
v20.5.0
FuelConnector .addAbortListener
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:437
staticgetEventListeners(emitter,name):Function[]
Returns a copy of the array of listeners for the event named eventName.
For EventEmitters this behaves exactly the same as calling .listeners on
the emitter.
For EventTargets this is the only way to get the event listeners for the
event target. This is useful for debugging and diagnostic purposes.
import { getEventListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
const listener = () => console.log('Events are fun');
ee.on('foo', listener);
console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
const et = new EventTarget();
const listener = () => console.log('Events are fun');
et.addEventListener('foo', listener);
console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
} • emitter: EventTarget | EventEmitter<DefaultEventMap>
• name: string | symbol
Function[]
v15.2.0, v14.17.0
FuelConnector .getEventListeners
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:358
staticgetMaxListeners(emitter):number
Returns the currently set max amount of listeners.
For EventEmitters this behaves exactly the same as calling .getMaxListeners on
the emitter.
For EventTargets this is the only way to get the max event listeners for the
event target. If the number of event handlers on a single EventTarget exceeds
the max set, the EventTarget will print a warning.
import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
console.log(getMaxListeners(ee)); // 10
setMaxListeners(11, ee);
console.log(getMaxListeners(ee)); // 11
}
{
const et = new EventTarget();
console.log(getMaxListeners(et)); // 10
setMaxListeners(11, et);
console.log(getMaxListeners(et)); // 11
} • emitter: EventTarget | EventEmitter<DefaultEventMap>
number
v19.9.0
FuelConnector .getMaxListeners
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:387
staticlistenerCount(emitter,eventName):number
A class method that returns the number of listeners for the given eventName registered on the given emitter.
import { EventEmitter, listenerCount } from 'node:events';
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2 • emitter: EventEmitter<DefaultEventMap>
The emitter to query
• eventName: string | symbol
The event name
number
v0.9.12
Since v3.2.0 - Use listenerCount instead.
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:330
staticon(emitter,eventName,options?):AsyncIterableIterator<any[],any,any>
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here Returns an AsyncIterator that iterates eventName events. It will throw
if the EventEmitter emits 'error'. It removes all listeners when
exiting the loop. The value returned by each iteration is an array
composed of the emitted event arguments.
An AbortSignal can be used to cancel waiting on events:
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ac = new AbortController();
(async () => {
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo', { signal: ac.signal })) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();
process.nextTick(() => ac.abort()); Use the close option to specify an array of event names that will end the iteration:
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
ee.emit('close');
});
for await (const event of on(ee, 'foo', { close: ['close'] })) {
console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done' • emitter: EventEmitter<DefaultEventMap>
• eventName: string | symbol
• options?: StaticEventEmitterIteratorOptions
AsyncIterableIterator<any[], any, any>
An AsyncIterator that iterates eventName events emitted by the emitter
v13.6.0, v12.16.0
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:303
staticon(emitter,eventName,options?):AsyncIterableIterator<any[],any,any>
• emitter: EventTarget
• eventName: string
• options?: StaticEventEmitterIteratorOptions
AsyncIterableIterator<any[], any, any>
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:308
staticonce(emitter,eventName,options?):Promise<any[]>
Creates a Promise that is fulfilled when the EventEmitter emits the given
event or that is rejected if the EventEmitter emits 'error' while waiting.
The Promise will resolve with an array of all the arguments emitted to the
given event.
This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event
semantics and does not listen to the 'error' event.
import { once, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
process.nextTick(() => {
ee.emit('myevent', 42);
});
const [value] = await once(ee, 'myevent');
console.log(value);
const err = new Error('kaboom');
process.nextTick(() => {
ee.emit('error', err);
});
try {
await once(ee, 'myevent');
} catch (err) {
console.error('error happened', err);
} The special handling of the 'error' event is only used when events.once() is used to wait for another event. If events.once() is used to wait for the
'error' event itself, then it is treated as any other kind of event without
special handling:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.error('error', err.message));
ee.emit('error', new Error('boom'));
// Prints: ok boom An AbortSignal can be used to cancel waiting for the event:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
const ac = new AbortController();
async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}
foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled! • emitter: EventEmitter<DefaultEventMap>
• eventName: string | symbol
• options?: StaticEventEmitterOptions
Promise<any[]>
v11.13.0, v10.16.0
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:217
staticonce(emitter,eventName,options?):Promise<any[]>
• emitter: EventTarget
• eventName: string
• options?: StaticEventEmitterOptions
Promise<any[]>
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:222
staticsetMaxListeners(n?, ...eventTargets?):void
import { setMaxListeners, EventEmitter } from 'node:events';
const target = new EventTarget();
const emitter = new EventEmitter();
setMaxListeners(5, target, emitter); • n?: number
A non-negative number. The maximum number of listeners per EventTarget event.
• ...eventTargets?: (EventTarget | EventEmitter<DefaultEventMap>)[]
void
v15.4.0
FuelConnector .setMaxListeners
node_modules/.pnpm/@types+node@22.5.5/node_modules/@types/node/events.d.ts:402