From 6d85aa1f8ad38f2819e97898b72c790ddca653e4 Mon Sep 17 00:00:00 2001 From: bot Date: Sat, 4 Sep 2021 04:29:30 +0000 Subject: [PATCH] update --- classes/gpio.GPIO.html | 684 +++++++++++++++++++++++--- interfaces/Device.ReadableDevice.html | 2 +- interfaces/Device.WritableDevice.html | 2 +- modules/ads1015.html | 2 +- modules/adt7410.html | 4 +- modules/adxl345.html | 4 +- modules/gp2y0e03.html | 4 +- modules/gpio.html | 4 +- modules/i2c.html | 2 +- modules/mpr121.html | 4 +- modules/paj7620.html | 2 +- modules/pca9685.html | 2 +- modules/s11059.html | 4 +- modules/sht30.html | 8 +- modules/ssd1306.html | 2 +- modules/ssd1308.html | 2 +- modules/tsl2561.html | 4 +- modules/veml6070.html | 4 +- modules/vl53l0x.html | 6 +- 19 files changed, 651 insertions(+), 95 deletions(-) diff --git a/classes/gpio.GPIO.html b/classes/gpio.GPIO.html index e3a7742..c465d14 100644 --- a/classes/gpio.GPIO.html +++ b/classes/gpio.GPIO.html @@ -133,7 +133,7 @@
  • setMaxListeners
  • unexport
  • write
  • -
  • getEventListener
  • +
  • getEventListeners
  • listenerCount
  • on
  • once
  • @@ -189,7 +189,7 @@ @@ -200,7 +200,7 @@
    @@ -216,7 +216,7 @@ @@ -227,7 +227,7 @@
    @@ -336,20 +336,30 @@

    addListener

      -
    • addListener(event: string | symbol, listener: (...args: any[]) => void): GPIO
    • +
    • addListener(eventName: string | symbol, listener: (...args: any[]) => void): GPIO
    • +
      +
      +

      Alias for emitter.on(eventName, listener).

      +
      +
      +
      since
      +

      v0.1.26

      +
      +
      +

      Parameters

      • -
        event: string | symbol
        +
        eventName: string | symbol
      • listener: (...args: any[]) => void
        @@ -381,20 +391,63 @@

        emit

          -
        • emit(event: string | symbol, ...args: any[]): boolean
        • +
        • emit(eventName: string | symbol, ...args: any[]): boolean
        • +
          +
          +

          Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments + to each.

          +
          +

          Returns true if the event had listeners, false otherwise.

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

          v0.1.26

          +
          +
          +

          Parameters

          • -
            event: string | symbol
            +
            eventName: string | symbol
          • Rest ...args: any[]
            @@ -415,9 +468,31 @@ +
            +
            +

            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)[]

          @@ -457,9 +532,20 @@ +
          +
          +

          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

        @@ -468,20 +554,33 @@

        listenerCount

          -
        • listenerCount(event: string | symbol): number
        • +
        • listenerCount(eventName: string | symbol): number
        • +
          +
          +

          Returns the number of listeners listening to the event named eventName.

          +
          +
          +
          since
          +

          v3.2.0

          +
          +
          +

          Parameters

          • -
            event: string | symbol
            +
            eventName: string | symbol
            +
            +

            The name of the event being listened for

            +

          Returns number

          @@ -492,20 +591,36 @@

          listeners

            -
          • listeners(event: string | symbol): Function[]
          • +
          • 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

            • -
              event: string | symbol
              +
              eventName: string | symbol

            Returns Function[]

            @@ -516,20 +631,30 @@

            off

              -
            • off(event: string | symbol, listener: (...args: any[]) => void): GPIO
            • +
            • off(eventName: string | symbol, listener: (...args: any[]) => void): GPIO
            • +
              +
              +

              Alias for emitter.removeListener().

              +
              +
              +
              since
              +

              v10.0.0

              +
              +
              +

              Parameters

              • -
                event: string | symbol
                +
                eventName: string | symbol
              • listener: (...args: any[]) => void
                @@ -561,23 +686,57 @@

                on

                  -
                • on(event: string | symbol, listener: (...args: any[]) => void): GPIO
                • +
                • on(eventName: string | symbol, listener: (...args: any[]) => void): GPIO
                • +
                  +
                  +

                  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

                  • -
                    event: string | symbol
                    +
                    eventName: string | symbol
                    +
                    +

                    The name of the event.

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

                    The callback function

                    +
                      • @@ -606,23 +765,55 @@

                        once

                          -
                        • once(event: string | symbol, listener: (...args: any[]) => void): GPIO
                        • +
                        • once(eventName: string | symbol, listener: (...args: any[]) => void): GPIO
                        • +
                          +
                          +

                          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

                          • -
                            event: string | symbol
                            +
                            eventName: string | symbol
                            +
                            +

                            The name of the event.

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

                            The callback function

                            +
                              • @@ -651,23 +842,47 @@

                                prependListener

                                  -
                                • prependListener(event: string | symbol, listener: (...args: any[]) => void): GPIO
                                • +
                                • prependListener(eventName: string | symbol, listener: (...args: any[]) => void): GPIO
                                • +
                                  +
                                  +

                                  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

                                  • -
                                    event: string | symbol
                                    +
                                    eventName: string | symbol
                                    +
                                    +

                                    The name of the event.

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

                                    The callback function

                                    +
                                      • @@ -696,23 +911,45 @@

                                        prependOnceListener

                                          -
                                        • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): GPIO
                                        • +
                                        • prependOnceListener(eventName: string | symbol, listener: (...args: any[]) => void): GPIO
                                        • +
                                          +
                                          +

                                          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

                                          • -
                                            event: string | symbol
                                            +
                                            eventName: string | symbol
                                            +
                                            +

                                            The name of the event.

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

                                            The callback function

                                            +
                                              • @@ -741,20 +978,53 @@

                                                rawListeners

                                                  -
                                                • rawListeners(event: string | symbol): Function[]
                                                • +
                                                • 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

                                                  • -
                                                    event: string | symbol
                                                    +
                                                    eventName: string | symbol

                                                  Returns Function[]

                                                  @@ -772,7 +1042,7 @@

                                                  Returns Promise<GPIOValue>

                                                  @@ -790,9 +1060,23 @@ +
                                                  +
                                                  +

                                                  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

                                                  • @@ -807,20 +1091,94 @@

                                                    removeListener

                                                      -
                                                    • removeListener(event: string | symbol, listener: (...args: any[]) => void): GPIO
                                                    • +
                                                    • removeListener(eventName: string | symbol, listener: (...args: any[]) => void): GPIO
                                                    • +
                                                      +
                                                      +

                                                      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

                                                      • -
                                                        event: string | symbol
                                                        +
                                                        eventName: string | symbol
                                                      • listener: (...args: any[]) => void
                                                        @@ -859,9 +1217,23 @@ +
                                                        +
                                                        +

                                                        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

                                                        - -

                                                        Static getEventListener

                                                        + +

                                                        Static getEventListeners

                                                          -
                                                        • getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]
                                                        • +
                                                        • getEventListeners(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]
                                                        • -

                                                          Returns a list listener for a specific emitter event name.

                                                          +

                                                          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

                                                            @@ -950,20 +1346,33 @@

                                                            Static listenerCount

                                                              -
                                                            • listenerCount(emitter: EventEmitter, event: string | symbol): number
                                                            • +
                                                            • 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 v4.0.0

                                                              +

                                                              Since v3.2.0 - Use listenerCount instead.

                                                              @@ -971,9 +1380,15 @@
                                                              • emitter: EventEmitter
                                                                +
                                                                +

                                                                The emitter to query

                                                                +
                                                              • -
                                                                event: string | symbol
                                                                +
                                                                eventName: string | symbol
                                                                +
                                                                +

                                                                The event name

                                                                +

                                                              Returns number

                                                              @@ -984,29 +1399,91 @@

                                                              Static on

                                                                -
                                                              • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
                                                              • +
                                                              • 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
                                                                • -
                                                                  event: string
                                                                  +
                                                                  eventName: string
                                                                  +
                                                                  +

                                                                  The name of the event being listened for

                                                                  +
                                                                • Optional options: StaticEventEmitterOptions

                                                                Returns AsyncIterableIterator<any>

                                                                +

                                                                that iterates eventName events emitted by the emitter

                                                        @@ -1014,24 +1491,103 @@

                                                        Static once

                                                          -
                                                        • once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
                                                        • -
                                                        • once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>
                                                        • +
                                                        • 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 platformEventTarget 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
                                                          • -
                                                            event: string | symbol
                                                            +
                                                            eventName: string | symbol
                                                          • Optional options: StaticEventEmitterOptions
                                                            @@ -1043,7 +1599,7 @@

                                                            Parameters

                                                            @@ -1052,7 +1608,7 @@
                                                            emitter: DOMEventTarget
                                                          • -
                                                            event: string
                                                            +
                                                            eventName: string
                                                          • Optional options: StaticEventEmitterOptions
                                                            @@ -1227,7 +1783,7 @@ write
                                                          • - getEventListener + getEventListeners
                                                          • listenerCount diff --git a/interfaces/Device.ReadableDevice.html b/interfaces/Device.ReadableDevice.html index 6f52018..8a96696 100644 --- a/interfaces/Device.ReadableDevice.html +++ b/interfaces/Device.ReadableDevice.html @@ -109,7 +109,7 @@
                                                          • Returns Promise<T>

                                                            diff --git a/interfaces/Device.WritableDevice.html b/interfaces/Device.WritableDevice.html index 6eec671..15ca254 100644 --- a/interfaces/Device.WritableDevice.html +++ b/interfaces/Device.WritableDevice.html @@ -109,7 +109,7 @@
                                                          • Parameters

                                                            diff --git a/modules/ads1015.html b/modules/ads1015.html index f2109a2..b37f748 100644 --- a/modules/ads1015.html +++ b/modules/ads1015.html @@ -104,7 +104,7 @@
                                                          • Parameters

                                                            diff --git a/modules/adt7410.html b/modules/adt7410.html index 4c7c05c..1c96e29 100644 --- a/modules/adt7410.html +++ b/modules/adt7410.html @@ -106,7 +106,7 @@
                                                            Temperature: number
                                                            @@ -128,7 +128,7 @@
                                                          • Parameters

                                                            diff --git a/modules/adxl345.html b/modules/adxl345.html index b9485c1..f3e7db9 100644 --- a/modules/adxl345.html +++ b/modules/adxl345.html @@ -106,7 +106,7 @@
                                                            Acceleration: [number, number, number]
                                                            @@ -128,7 +128,7 @@
                                                          • Parameters

                                                            diff --git a/modules/gp2y0e03.html b/modules/gp2y0e03.html index 25d3b90..af1170d 100644 --- a/modules/gp2y0e03.html +++ b/modules/gp2y0e03.html @@ -106,7 +106,7 @@
                                                            Distance: number
                                                            @@ -128,7 +128,7 @@
                                                          • Parameters

                                                            diff --git a/modules/gpio.html b/modules/gpio.html index a633be2..47c49ae 100644 --- a/modules/gpio.html +++ b/modules/gpio.html @@ -115,7 +115,7 @@
                                                            GPIOValue: 0 | 1
                                                            @@ -132,7 +132,7 @@
                                                          • Parameters

                                                            diff --git a/modules/i2c.html b/modules/i2c.html index 64ffff8..2b1dceb 100644 --- a/modules/i2c.html +++ b/modules/i2c.html @@ -117,7 +117,7 @@
                                                          • Parameters

                                                            diff --git a/modules/mpr121.html b/modules/mpr121.html index 5507f90..980fb00 100644 --- a/modules/mpr121.html +++ b/modules/mpr121.html @@ -106,7 +106,7 @@
                                                            Touched: [boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean]
                                                            @@ -128,7 +128,7 @@
                                                          • Parameters

                                                            diff --git a/modules/paj7620.html b/modules/paj7620.html index bb87c44..a606782 100644 --- a/modules/paj7620.html +++ b/modules/paj7620.html @@ -104,7 +104,7 @@
                                                          • Parameters

                                                            diff --git a/modules/pca9685.html b/modules/pca9685.html index e06bc9c..9fb014e 100644 --- a/modules/pca9685.html +++ b/modules/pca9685.html @@ -104,7 +104,7 @@
                                                          • Parameters

                                                            diff --git a/modules/s11059.html b/modules/s11059.html index 9c595ad..d1b8964 100644 --- a/modules/s11059.html +++ b/modules/s11059.html @@ -106,7 +106,7 @@
                                                            RGB: [number, number, number]
                                                            @@ -128,7 +128,7 @@
                                                          • Parameters

                                                            diff --git a/modules/sht30.html b/modules/sht30.html index 595bc28..0ebc3a2 100644 --- a/modules/sht30.html +++ b/modules/sht30.html @@ -108,7 +108,7 @@
                                                            Humidity: number
                                                            @@ -123,7 +123,7 @@
                                                            Temperature: number
                                                            @@ -138,7 +138,7 @@
                                                            Values: { humidity: Humidity; temperature: Temperature }
                                                            @@ -171,7 +171,7 @@
                                                          • Parameters

                                                            diff --git a/modules/ssd1306.html b/modules/ssd1306.html index b2ea1d4..f5ea8e4 100644 --- a/modules/ssd1306.html +++ b/modules/ssd1306.html @@ -104,7 +104,7 @@
                                                          • Parameters

                                                            diff --git a/modules/ssd1308.html b/modules/ssd1308.html index c0bdfaf..db1f9e3 100644 --- a/modules/ssd1308.html +++ b/modules/ssd1308.html @@ -104,7 +104,7 @@
                                                          • Parameters

                                                            diff --git a/modules/tsl2561.html b/modules/tsl2561.html index fb18ed2..759d90d 100644 --- a/modules/tsl2561.html +++ b/modules/tsl2561.html @@ -106,7 +106,7 @@
                                                            Illuminance: number
                                                            @@ -128,7 +128,7 @@
                                                          • Parameters

                                                            diff --git a/modules/veml6070.html b/modules/veml6070.html index 93e013b..ce154f5 100644 --- a/modules/veml6070.html +++ b/modules/veml6070.html @@ -106,7 +106,7 @@
                                                            UVA: number
                                                            @@ -128,7 +128,7 @@
                                                          • diff --git a/modules/vl53l0x.html b/modules/vl53l0x.html index dc15c0f..e08fbda 100644 --- a/modules/vl53l0x.html +++ b/modules/vl53l0x.html @@ -107,7 +107,7 @@
                                                            Distance: number
                                                            @@ -122,7 +122,7 @@
                                                            EnableLongRangeMode: Boolean
                                                            @@ -144,7 +144,7 @@