Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Libp2p

property

{Connection} connection

property

{MuxedStream} stream

property

{string} protocol

property

{boolean} [enabled = false]

property

{number} [kBucketSize = 20]

property

{boolean} [clientMode]

property

{import('libp2p-interfaces/src/types').DhtSelectors} [selectors]

property

{import('libp2p-interfaces/src/types').DhtValidators} [validators]

property

{Datastore} [datastore]

property

{boolean} persistence

property

{boolean} enabled

property

{boolean} enabled

property

{boolean} [enabled = true]

property

{import('./circuit').RelayAdvertiseOptions} [advertise]

property

{import('./circuit').HopOptions} [hop]

property

{import('./circuit').AutoRelayOptions} [autoRelay]

property

{DhtOptions} [dht] dht module options

property

{import('./nat-manager').NatManagerOptions} [nat]

property

{Record<string, Object|boolean>} [peerDiscovery]

property

{PubsubLocalOptions & PubsubOptions} [pubsub] pubsub module options

property

{RelayOptions} [relay]

property

{Record<string, Object>} [transport] transport options indexed by transport key

property

{TransportFactory[]} transport

property

{MuxerFactory[]} streamMuxer

property

{Crypto[]} connEncryption

property

{PeerDiscoveryFactory[]} [peerDiscovery]

property

{PeerRoutingModule[]} [peerRouting]

property

{ContentRoutingModule[]} [contentRouting]

property

{Object} [dht]

property

{{new(...args: any[]): Pubsub}} [pubsub]

property

{Protector} [connProtector]

property

{Libp2pModules} modules libp2p modules to use

property

{import('./address-manager').AddressManagerOptions} [addresses]

property

{import('./connection-manager').ConnectionManagerOptions} [connectionManager]

property

{Datastore} [datastore]

property

{import('./dialer').DialerOptions} [dialer]

property

{import('./identify/index').HostProperties} [host] libp2p host

property

{KeychainOptions & import('./keychain/index').KeychainOptions} [keychain]

property

{MetricsOptions & import('./metrics').MetricsOptions} [metrics]

property

{import('./peer-routing').PeerRoutingOptions} [peerRouting]

property

{PeerStoreOptions & PersistentPeerStoreOptions} [peerStore]

property

{import('./transport-manager').TransportManagerOptions} [transportManager]

property

{Libp2pConfig} [config]

property

{PeerId} peerId

property

{PeerId} [peerId]

fires

Libp2p#error Emitted when an error occurs

fires

Libp2p#peer:discovery Emitted when a peer is discovered

Hierarchy

  • EventEmitter
    • Libp2p

Index

Constructors

constructor

Properties

_autodialler

_autodialler: AutoDialler

_config

_config: { dht: { enabled: boolean; kBucketSize: number }; nat: { enabled: boolean; externalIp: null; gateway: null; keepAlive: boolean; pmp: { enabled: boolean }; ttl: number }; peerDiscovery: { autoDial: boolean }; protocolPrefix: string; pubsub: { enabled: boolean }; relay: { advertise: { bootDelay: number; enabled: boolean; ttl: number }; autoRelay: { enabled: boolean; maxListeners: number }; enabled: boolean; hop: { active: boolean; enabled: boolean } }; transport: {} } & Libp2pConfig

_dht

_dht: any

_discovery

_discovery: Map<any, any>

_isStarted

_isStarted: undefined | boolean

_modules

_modules: Libp2pModules

_options

_options: { addresses: { announce: never[]; announceFilter: (multiaddrs: Multiaddr[]) => Multiaddr[]; listen: never[]; noAnnounce: never[] }; config: { dht: { enabled: boolean; kBucketSize: number }; nat: { enabled: boolean; externalIp: null; gateway: null; keepAlive: boolean; pmp: { enabled: boolean }; ttl: number }; peerDiscovery: { autoDial: boolean }; protocolPrefix: string; pubsub: { enabled: boolean }; relay: { advertise: { bootDelay: number; enabled: boolean; ttl: number }; autoRelay: { enabled: boolean; maxListeners: number }; enabled: boolean; hop: { active: boolean; enabled: boolean } }; transport: {} }; connectionManager: { minConnections: number }; dialer: { addressSorter: (addresses: Address[]) => Address[]; dialTimeout: number; maxDialsPerPeer: number; maxParallelDials: number; resolvers: { dnsaddr: any } }; host: { agentVersion: string }; metrics: { enabled: boolean }; peerRouting: { refreshManager: { bootDelay: number; enabled: boolean; interval: number } }; peerStore: { persistence: boolean; threshold: number }; transportManager: { faultTolerance: number } } & Libp2pOptions & constructorOptions

_transport

_transport: any[]

addressManager

addressManager: AddressManager

addresses

addresses: { announce: never[]; announceFilter: (multiaddrs: Multiaddr[]) => Multiaddr[]; listen: never[]; noAnnounce: never[] } & AddressManagerOptions

connectionManager

connectionManager: ConnectionManager

contentRouting

contentRouting: ContentRouting

datastore

datastore: undefined | Datastore

dialer

dialer: Dialer

identifyService

identifyService: undefined | IdentifyService

keychain

keychain: undefined | Keychain

metrics

metrics: undefined | Metrics

natManager

natManager: NatManager

peerId

peerId: PeerId

peerRouting

peerRouting: PeerRouting

peerStore

peerStore: PeerStore

pubsub

pubsub: PubsubBaseProtocol

registrar

registrar: Registrar

relay

relay: undefined | Relay

transportManager

transportManager: TransportManager

upgrader

upgrader: Upgrader

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

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.

Accessors

connections

  • get connections(): Map<string, Connection[]>
  • Gets a Map of the current connections. The keys are the stringified PeerId of the peer. The value is an array of Connections to that peer.

    Returns Map<string, Connection[]>

multiaddrs

  • get multiaddrs(): Multiaddr[]
  • Get a deduplicated list of peer advertising multiaddrs by concatenating the listen addresses used by transports with any configured announce addresses as well as observed addresses reported by peers.

    If Announce addrs are specified, configured listen addresses will be ignored though observed addresses will still be included.

    Returns Multiaddr[]

Methods

_dial

  • _dial(peer: string | Multiaddr | PeerId, options: undefined | object): Promise<Connection>
  • async

    Parameters

    • peer: string | Multiaddr | PeerId

      The peer to dial

    • options: undefined | object

    Returns Promise<Connection>

Private _maybeConnect

  • _maybeConnect(peerId: PeerId): Promise<void>
  • Will dial to the given peerId if the current number of connected peers is less than the configured ConnectionManager minConnections.

    Parameters

    • peerId: PeerId

    Returns Promise<void>

Private _onDidStart

  • _onDidStart(): Promise<void>
  • Called when libp2p has started and before it returns

    Returns Promise<void>

Private _onDiscoveryPeer

  • _onDiscoveryPeer(peer: { id: PeerId; multiaddrs: Multiaddr[]; protocols: string[] }): void
  • Called whenever peer discovery services emit peer events. Known peers may be emitted.

    Parameters

    • peer: { id: PeerId; multiaddrs: Multiaddr[]; protocols: string[] }
      • id: PeerId
      • multiaddrs: Multiaddr[]
      • protocols: string[]

    Returns void

_onStarting

  • _onStarting(): Promise<void>

Private _setupPeerDiscovery

  • _setupPeerDiscovery(): Promise<void>
  • Initializes and starts peer discovery services

    async

    Returns Promise<void>

addListener

  • addListener(eventName: string | symbol, listener: (...args: any[]) => void): Libp2p
  • Alias for emitter.on(eventName, listener).

    since

    v0.1.26

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Libp2p

dial

  • dial(peer: string | Multiaddr | PeerId, options: undefined | { signal: undefined | AbortSignal }): Promise<Connection>
  • Dials to the provided peer. If successful, the known metadata of the peer will be added to the nodes peerStore

    Parameters

    • peer: string | Multiaddr | PeerId

      The peer to dial

    • options: undefined | { signal: undefined | AbortSignal }

    Returns Promise<Connection>

dialProtocol

  • dialProtocol(peer: string | Multiaddr | PeerId, protocols: string | string[], options: undefined | { signal: undefined | AbortSignal }): Promise<{ protocol: string; stream: MuxedStream }>
  • Dials to the provided peer and tries to handshake with the given protocols in order. If successful, the known metadata of the peer will be added to the nodes peerStore, and the MuxedStream will be returned together with the successful negotiated protocol.

    async

    Parameters

    • peer: string | Multiaddr | PeerId

      The peer to dial

    • protocols: string | string[]
    • options: undefined | { signal: undefined | AbortSignal }

    Returns Promise<{ protocol: string; stream: MuxedStream }>

emit

  • emit(eventName: string, ...args: any[]): boolean
  • Overrides EventEmitter.emit to conditionally emit errors if there is a handler. If not, errors will be logged.

    Parameters

    • eventName: string
    • Rest ...args: any[]

    Returns boolean

eventNames

  • 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.

    const EventEmitter = require('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) ]
    
    since

    v6.0.0

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    since

    v1.0.0

    Returns number

handle

  • handle(protocols: string | string[], handler: (props: HandlerProps) => void): void

hangUp

  • hangUp(peer: string | Multiaddr | PeerId): Promise<void>
  • Disconnects all connections to the given peer

    Parameters

    • peer: string | Multiaddr | PeerId

      the peer to close connections to

    Returns Promise<void>

isStarted

  • isStarted(): undefined | boolean

listenerCount

  • listenerCount(eventName: string | symbol): number
  • Returns the number of listeners listening to the event named eventName.

    since

    v3.2.0

    Parameters

    • eventName: string | symbol

      The name of the event being listened for

    Returns number

listeners

  • listeners(eventName: string | symbol): 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] ]
    
    since

    v0.1.26

    Parameters

    • eventName: string | symbol

    Returns Function[]

loadKeychain

  • loadKeychain(): Promise<void>
  • Load keychain keys from the datastore. Imports the private key as 'self', if needed.

    async

    Returns Promise<void>

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): Libp2p
  • Alias for emitter.removeListener().

    since

    v10.0.0

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Libp2p

on

  • on(eventName: string | symbol, listener: (...args: any[]) => void): Libp2p
  • Adds the listener function to the end 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 eventNameand listener will result in the listener being added, and called, multiple times.

    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    

    Returns a reference to the EventEmitter, so that calls can be chained.

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
    
    since

    v0.1.101

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: (...args: any[]) => void

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Libp2p

once

  • once(eventName: string | symbol, listener: (...args: any[]) => void): Libp2p
  • Adds a one-timelistener 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. Theemitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
    
    since

    v0.3.0

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: (...args: any[]) => void

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Libp2p

ping

  • ping(peer: string | Multiaddr | PeerId): Promise<number>
  • Pings the given peer in order to obtain the operation latency.

    Parameters

    • peer: string | Multiaddr | PeerId

      The peer to ping

    Returns Promise<number>

prependListener

  • prependListener(eventName: string | symbol, listener: (...args: any[]) => void): Libp2p
  • 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 eventNameand 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.

    since

    v6.0.0

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: (...args: any[]) => void

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Libp2p

prependOnceListener

  • prependOnceListener(eventName: string | symbol, listener: (...args: any[]) => void): Libp2p
  • 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.

    since

    v6.0.0

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: (...args: any[]) => void

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Libp2p

rawListeners

  • rawListeners(eventName: string | symbol): Function[]
  • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

    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');
    
    since

    v9.4.0

    Parameters

    • eventName: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): Libp2p
  • 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.

    since

    v0.1.26

    Parameters

    • Optional event: string | symbol

    Returns Libp2p

removeListener

  • removeListener(eventName: string | symbol, listener: (...args: any[]) => void): Libp2p
  • Removes the specified listener from the listener array for the event namedeventName.

    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 anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

    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:

    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.

    since

    v0.1.26

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Libp2p

setMaxListeners

  • setMaxListeners(n: number): Libp2p
  • 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 toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    since

    v0.3.5

    Parameters

    • n: number

    Returns Libp2p

start

  • start(): Promise<void>
  • Starts the libp2p node and all its subsystems

    Returns Promise<void>

stop

  • stop(): Promise<void>
  • Stop the libp2p node by closing its listeners and open connections

    async

    Returns Promise<void>

unhandle

  • unhandle(protocols: string | string[]): void
  • Removes the handler for each protocol. The protocol will no longer be supported on streams.

    Parameters

    • protocols: string | string[]

    Returns void

Static create

  • Like new Libp2p(options) except it will create a PeerId instance if one is not provided in options.

    Parameters

    Returns Promise<Libp2p>

Static getEventListeners

  • getEventListeners(emitter: DOMEventTarget | EventEmitter, name: string | symbol): 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.

    const { getEventListeners, EventEmitter } = require('events');
    
    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
    
    since

    v15.2.0

    Parameters

    • emitter: DOMEventTarget | EventEmitter
    • name: string | symbol

    Returns Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, eventName: string | symbol): number
  • A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
    
    since

    v0.9.12

    deprecated

    Since v3.2.0 - Use listenerCount instead.

    Parameters

    • emitter: EventEmitter

      The emitter to query

    • eventName: string | symbol

      The event name

    Returns number

Static on

  • on(emitter: EventEmitter, eventName: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • ```js const { on, EventEmitter } = require('events');

    (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')) { // 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:
    
    ```js
    const { on, EventEmitter } = require('events');
    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());
    
    since

    v13.6.0, v12.16.0

    Parameters

    • emitter: EventEmitter
    • eventName: string

      The name of the event being listened for

    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

Static once

  • once(emitter: NodeEventTarget, eventName: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, eventName: string, options?: StaticEventEmitterOptions): 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.

    const { once, EventEmitter } = require('events');
    
    async function run() {
      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.log('error happened', err);
      }
    }
    
    run();
    

    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:

    const { EventEmitter, once } = require('events');
    
    const ee = new EventEmitter();
    
    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));
    
    ee.emit('error', new Error('boom'));
    
    // Prints: ok boom
    

    An AbortSignal can be used to cancel waiting for the event:

    const { EventEmitter, once } = require('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!
    
    since

    v11.13.0, v10.16.0

    Parameters

    • emitter: NodeEventTarget
    • eventName: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • eventName: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>