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.

Inherited from

BalenaS3SourceBase.errorMonitor

Defined in

node_modules/@types/node/events.d.ts:404

imageExtensions

▪ Static Readonly imageExtensions: string[]

Inherited from

BalenaS3SourceBase.imageExtensions

Defined in

lib/source-destination/source-destination.ts:295

mimetype

▪ Static Optional Readonly mimetype: string

Inherited from

BalenaS3SourceBase.mimetype

Defined in

lib/source-destination/source-destination.ts:307

Accessors

imageSuffix

• Protected get imageSuffix(): string

Returns

string

Inherited from

BalenaS3SourceBase.imageSuffix

Defined in

lib/source-destination/balena-s3-source.ts:106

Methods

[captureRejectionSymbol]

▸ Optional [captureRejectionSymbol](error, event, ...args): void

Parameters

Name	Type
`error`	`Error`
`event`	`string`
`...args`	`any`[]

Returns

void

Inherited from

BalenaS3SourceBase.[captureRejectionSymbol]

Defined in

node_modules/@types/node/events.d.ts:115

_close

▸ Protected _close(): Promise<void>

Returns

Promise<void>

Overrides

BalenaS3SourceBase._close

Defined in

lib/source-destination/balena-s3-source.ts:224

_getMetadata

▸ Protected _getMetadata(): Promise<Metadata>

Returns

Promise<Metadata>

Overrides

BalenaS3SourceBase._getMetadata

Defined in

lib/source-destination/balena-s3-source.ts:204

_open

▸ Protected _open(): Promise<void>

Returns

Promise<void>

Overrides

BalenaS3SourceBase._open

Defined in

lib/source-destination/balena-s3-source.ts:208

addListener

▸ addListener(eventName, listener): BalenaS3Source

Alias for emitter.on(eventName, listener).

Parameters

Name	Type
`eventName`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns

BalenaS3Source

Since

v0.1.26

Inherited from

BalenaS3SourceBase.addListener

Defined in

node_modules/@types/node/events.d.ts:475

canCreateReadStream

▸ canCreateReadStream(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

BalenaS3SourceBase.canCreateReadStream

Defined in

lib/source-destination/balena-s3-source.ts:110

canCreateSparseReadStream

▸ canCreateSparseReadStream(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

BalenaS3SourceBase.canCreateSparseReadStream

Defined in

lib/source-destination/source-destination.ts:335

canCreateSparseWriteStream

▸ canCreateSparseWriteStream(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

BalenaS3SourceBase.canCreateSparseWriteStream

Defined in

lib/source-destination/source-destination.ts:343

canCreateWriteStream

▸ canCreateWriteStream(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

BalenaS3SourceBase.canCreateWriteStream

Defined in

lib/source-destination/source-destination.ts:339

canRead

▸ canRead(): Promise<boolean>

Returns

Promise<boolean>

Overrides

BalenaS3SourceBase.canRead

Defined in

lib/source-destination/balena-s3-source.ts:180

canWrite

▸ canWrite(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

BalenaS3SourceBase.canWrite

Defined in

lib/source-destination/source-destination.ts:327

close

▸ close(): Promise<void>

Returns

Promise<void>

Inherited from

BalenaS3SourceBase.close

Defined in

lib/source-destination/source-destination.ts:411

createReadStream

▸ createReadStream(options?): Promise<ReadableStream>

Parameters

Name	Type
`options`	`CreateReadStreamOptions`

Returns

Promise<ReadableStream>

Overrides

BalenaS3SourceBase.createReadStream

Defined in

lib/source-destination/balena-s3-source.ts:198

createSparseReadStream

▸ createSparseReadStream(_options?): Promise<SparseReadable>

Parameters

Name	Type
`_options?`	`CreateSparseReadStreamOptions`

createSparseWriteStream

▸ createSparseWriteStream(_options?): Promise<SparseWritable>

Parameters

Name	Type
`_options?`	`Object`
`_options.highWaterMark?`	`number`

Returns

Promise<SparseWritable>

Inherited from

BalenaS3SourceBase.createSparseWriteStream

Defined in

lib/source-destination/source-destination.ts:398

createVerifier

▸ createVerifier(checksumOrBlocks, size?): Verifier

Parameters

Name	Type
`checksumOrBlocks`	`string` \| `BlocksWithChecksum`[]
`size?`	`number`

Returns

Verifier

Inherited from

BalenaS3SourceBase.createVerifier

Defined in

lib/source-destination/source-destination.ts:426

createWriteStream

▸ createWriteStream(_options?): Promise<WritableStream>

Parameters

Name	Type
`_options?`	`Object`
`_options.highWaterMark?`	`number`

Returns

Promise<WritableStream>

Inherited from

BalenaS3SourceBase.createWriteStream

Defined in

lib/source-destination/source-destination.ts:392

download

▸ Protected download(path, responseType?): Promise<AxiosResponse<any, any>>

Parameters

Name	Type
`path`	`string`
`responseType?`	`"stream"`

Returns

Promise<AxiosResponse<any, any>>

Inherited from

BalenaS3SourceBase.download

Defined in

lib/source-destination/balena-s3-source.ts:122

emit

▸ emit(eventName, ...args): 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

Parameters

Name	Type
`eventName`	`string` \| `symbol`
`...args`	`any`[]

Returns

boolean

Since

v0.1.26

Inherited from

BalenaS3SourceBase.emit

Defined in

node_modules/@types/node/events.d.ts:731

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

Returns

(string | symbol)[]

Since

v6.0.0

Inherited from

BalenaS3SourceBase.eventNames

Defined in

node_modules/@types/node/events.d.ts:794

getAlignment

▸ getAlignment(): undefined | number

Returns

undefined | number

Inherited from

BalenaS3SourceBase.getAlignment

Defined in

lib/source-destination/source-destination.ts:319

getBlocks

▸ getBlocks(): Promise<BlocksWithChecksum[]>

Returns

Promise<BlocksWithChecksum[]>

Inherited from

BalenaS3SourceBase.getBlocks

Defined in

lib/source-destination/source-destination.ts:388

getInnerSource

▸ getInnerSource(): Promise<SourceDestination>

Returns

Promise<SourceDestination>

Inherited from

BalenaS3SourceBase.getInnerSource

Defined in

lib/source-destination/source-destination.ts:501

getMaxListeners

▸ getMaxListeners(): number

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

Returns

number

Since

v1.0.0

Inherited from

BalenaS3SourceBase.getMaxListeners

Defined in

node_modules/@types/node/events.d.ts:647

getMetadata

▸ getMetadata(): Promise<Metadata>

Returns

Promise<Metadata>

Inherited from

BalenaS3SourceBase.getMetadata

Defined in

lib/source-destination/source-destination.ts:347

getName

▸ Private getName(): Promise<Name>

Returns

Promise<Name>

Defined in

lib/source-destination/balena-s3-source.ts:163

getPartitionTable

▸ getPartitionTable(): Promise<undefined | GetPartitionsResult>

Returns

Promise<undefined | GetPartitionsResult>

Inherited from

BalenaS3SourceBase.getPartitionTable

Defined in

lib/source-destination/source-destination.ts:531

getUrl

▸ Protected getUrl(path): string

Parameters

Name	Type
`path`	`string`

Returns

string

Inherited from

BalenaS3SourceBase.getUrl

Defined in

lib/source-destination/balena-s3-source.ts:126

listenerCount

▸ listenerCount(eventName, listener?): number

Returns the number of listeners listening to 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.

Parameters

Name	Type	Description
`eventName`	`string` \| `symbol`	The name of the event being listened for
`listener?`	`Function`	The event handler function

Returns

number

Since

v3.2.0

Inherited from

BalenaS3SourceBase.listenerCount

Defined in

node_modules/@types/node/events.d.ts:741

listeners

▸ listeners(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] ]

Parameters

Name	Type
`eventName`	`string` \| `symbol`

Returns

Function[]

Since

v0.1.26

Inherited from

BalenaS3SourceBase.listeners

Defined in

node_modules/@types/node/events.d.ts:660

off

▸ off(eventName, listener): BalenaS3Source

Alias for emitter.removeListener().

Parameters

Name	Type
`eventName`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns

BalenaS3Source

Since

v10.0.0

Inherited from

BalenaS3SourceBase.off

Defined in

node_modules/@types/node/events.d.ts:620

on

▸ on(eventName, listener): BalenaS3Source

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

Parameters

Name	Type	Description
`eventName`	`string` \| `symbol`	The name of the event.
`listener`	(...`args`: `any`[]) => `void`	The callback function

Returns

BalenaS3Source

Since

v0.1.101

Inherited from

BalenaS3SourceBase.on

Defined in

node_modules/@types/node/events.d.ts:506

once

▸ once(eventName, listener): BalenaS3Source

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

Parameters

Name	Type	Description
`eventName`	`string` \| `symbol`	The name of the event.
`listener`	(...`args`: `any`[]) => `void`	The callback function

Returns

BalenaS3Source

Since

v0.3.0

Inherited from

BalenaS3SourceBase.once

Defined in

node_modules/@types/node/events.d.ts:535

open

▸ open(): Promise<void>

Returns

Promise<void>

Inherited from

BalenaS3SourceBase.open

Defined in

lib/source-destination/source-destination.ts:404

prependListener

▸ prependListener(eventName, listener): BalenaS3Source

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.

Parameters

Name	Type	Description
`eventName`	`string` \| `symbol`	The name of the event.
`listener`	(...`args`: `any`[]) => `void`	The callback function

Returns

BalenaS3Source

Since

v6.0.0

Inherited from

BalenaS3SourceBase.prependListener

Defined in

node_modules/@types/node/events.d.ts:759

prependOnceListener

▸ prependOnceListener(eventName, listener): BalenaS3Source

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.

Parameters

Name	Type	Description
`eventName`	`string` \| `symbol`	The name of the event.
`listener`	(...`args`: `any`[]) => `void`	The callback function

Returns

BalenaS3Source

Since

v6.0.0

Inherited from

BalenaS3SourceBase.prependOnceListener

Defined in

node_modules/@types/node/events.d.ts:775

rawListeners

▸ rawListeners(eventName): 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');

Parameters

Name	Type
`eventName`	`string` \| `symbol`

Returns

Function[]

Since

v9.4.0

Inherited from

BalenaS3SourceBase.rawListeners

Defined in

node_modules/@types/node/events.d.ts:690

read

▸ read(buffer, bufferOffset, length, sourceOffset): Promise<ReadResult>

Parameters

Name	Type
`buffer`	`Buffer`
`bufferOffset`	`number`
`length`	`number`
`sourceOffset`	`number`

Returns

Promise<ReadResult>

Overrides

BalenaS3SourceBase.read

Defined in

lib/source-destination/balena-s3-source.ts:184

removeAllListeners

▸ removeAllListeners(event?): BalenaS3Source

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.

Parameters

Name	Type
`event?`	`string` \| `symbol`

Returns

BalenaS3Source

Since

v0.1.26

Inherited from

BalenaS3SourceBase.removeAllListeners

Defined in

node_modules/@types/node/events.d.ts:631

removeListener

▸ removeListener(eventName, listener): BalenaS3Source

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.

Parameters

Name	Type
`eventName`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns

BalenaS3Source

Since

v0.1.26

Inherited from

BalenaS3SourceBase.removeListener

Defined in

node_modules/@types/node/events.d.ts:615

setMaxListeners

▸ setMaxListeners(n): BalenaS3Source

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.

Parameters

Name	Type
`n`	`number`

Returns

BalenaS3Source

Since

v0.3.5

Inherited from

BalenaS3SourceBase.setMaxListeners

Defined in

node_modules/@types/node/events.d.ts:641

write

▸ write(_buffer, _bufferOffset, _length, _fileOffset): Promise<WriteResult>

Parameters

Name	Type
`_buffer`	`Buffer`
`_bufferOffset`	`number`
`_length`	`number`
`_fileOffset`	`number`

Returns

Promise<WriteResult>

Inherited from

BalenaS3SourceBase.write

Defined in

lib/source-destination/source-destination.ts:367

addAbortListener

▸ Static addAbortListener(signal, resource): Disposable

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]();
  }
}

Parameters

Name	Type
`signal`	`AbortSignal`
`resource`	(`event`: `Event`) => `void`

Returns

Disposable

Disposable that removes the abort listener.

Since

v18.18.0

Inherited from

BalenaS3SourceBase.addAbortListener

Defined in

node_modules/@types/node/events.d.ts:394

getEventListeners

▸ Static getEventListeners(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.

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]
}

Parameters

Name	Type
`emitter`	`EventEmitter` \| `_DOMEventTarget`
`name`	`string` \| `symbol`

Returns

Function[]

Since

v15.2.0, v14.17.0

Inherited from

BalenaS3SourceBase.getEventListeners

Defined in

node_modules/@types/node/events.d.ts:312

getMaxListeners

▸ Static getMaxListeners(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
}

Parameters

Name	Type
`emitter`	`EventEmitter` \| `_DOMEventTarget`

Returns

number

Since

v18.17.0

Inherited from

BalenaS3SourceBase.getMaxListeners

Defined in

node_modules/@types/node/events.d.ts:341

isESRVersion

▸ Static isESRVersion(buildId): boolean

Parameters

Name	Type
`buildId`	`string`

Returns

boolean

Inherited from

BalenaS3SourceBase.isESRVersion

Defined in

lib/source-destination/balena-s3-source.ts:114

listenerCount

▸ Static listenerCount(emitter, eventName): 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

Parameters

Name	Type	Description
`emitter`	`EventEmitter`	The emitter to query
`eventName`	`string` \| `symbol`	The event name

Returns

number

Since

v0.9.12

Deprecated

Since v3.2.0 - Use listenerCount instead.

Inherited from

BalenaS3SourceBase.listenerCount

Defined in

node_modules/@types/node/events.d.ts:284

on

▸ Static on(emitter, eventName, options?): AsyncIterableIterator<any>

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:

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());

Parameters

Name	Type	Description
`emitter`	`EventEmitter`	-
`eventName`	`string`	The name of the event being listened for
`options?`	`StaticEventEmitterOptions`	-

Returns

AsyncIterableIterator<any>

that iterates eventName events emitted by the emitter

Since

v13.6.0, v12.16.0

Inherited from

BalenaS3SourceBase.on

Defined in

node_modules/@types/node/events.d.ts:263

once

▸ Static once(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.

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!

Parameters

Name	Type
`emitter`	`_NodeEventTarget`
`eventName`	`string` \| `symbol`
`options?`	`StaticEventEmitterOptions`

Returns

Promise<any[]>

Since

v11.13.0, v10.16.0

Inherited from

BalenaS3SourceBase.once

Defined in

node_modules/@types/node/events.d.ts:199

▸ Static once(emitter, eventName, options?): Promise<any[]>

Parameters

Name	Type
`emitter`	`_DOMEventTarget`
`eventName`	`string`
`options?`	`StaticEventEmitterOptions`

Returns

Promise<any[]>

Inherited from

BalenaS3SourceBase.once

Defined in

node_modules/@types/node/events.d.ts:204

register

▸ Static register(Cls): void

Parameters

Name	Type
`Cls`	typeof `SourceSource`

Returns

void

Inherited from

BalenaS3SourceBase.register

Defined in

lib/source-destination/source-destination.ts:313

setMaxListeners

▸ Static setMaxListeners(n?, ...eventTargets): void

const {
  setMaxListeners,
  EventEmitter
} = require('events');

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Parameters

Name	Type	Description
`n?`	`number`	A non-negative number. The maximum number of listeners per `EventTarget` event.
`...eventTargets`	(`EventEmitter` \| `_DOMEventTarget`)[]	-

Returns

void

Since

v15.4.0

Inherited from

BalenaS3SourceBase.setMaxListeners

Defined in

node_modules/@types/node/events.d.ts:359

Files

sourceDestination.BalenaS3Source.md

Latest commit

History

sourceDestination.BalenaS3Source.md

File metadata and controls

Class: BalenaS3Source

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Inherited from

Defined in

Properties

axiosInstance

Inherited from

Defined in

bucket

Inherited from

Defined in

buildId

Inherited from

Defined in

deviceType

Inherited from

Defined in

host

Inherited from

Defined in

imageType

Inherited from

Defined in

name

Defined in

names

Defined in

prefix

Inherited from

Defined in

rawSource

Defined in

release

Inherited from

Defined in

zipSource

Defined in

captureRejectionSymbol

Inherited from

Defined in

captureRejections

Inherited from

Defined in

defaultMaxListeners

Inherited from

Defined in

errorMonitor

Inherited from

Defined in

imageExtensions

Inherited from

Defined in

mimetype

Inherited from

Defined in

Accessors

imageSuffix

Returns

Inherited from

Defined in

Methods

[captureRejectionSymbol]

Parameters

Returns

Inherited from

Defined in