default

Source: Downloader.ts:145

The main orchestrator service for managing HLS stream acquisition.

Author: Nur Rony<pro.nmrony@gmail.com>

Constructors

`new default(options: DownloaderOptions): default`

Parameters

options (DownloaderOptions) — Configuration object.

Returns

default

Hierarchy

EventEmitter
default

Methods

`[captureRejectionSymbol]( error: Error, event: string | symbol, ...args: any[], ): void`

events.d.ts:87

Inherited from [captureRejectionSymbol]

The Symbol.for('nodejs.rejection') method is called in case a promise rejection happens when emitting an event and captureRejections is enabled on the emitter. It is possible to use events.captureRejectionSymbol in place of Symbol.for('nodejs.rejection').

CODE

import { EventEmitter, captureRejectionSymbol } from 'node:events';

class MyClass extends EventEmitter {
  constructor() {
    super({ captureRejections: true });
  }

  [captureRejectionSymbol](err, event, ...args) {
    console.log('rejection happened for', event, 'with', err, ...args);
    this.destroy(err);
  }

  destroy(err) {
    // Tear the resource down here.
  }
}

Parameters

error (Error)
event (string | symbol)
args (any[])

Returns

void

Since: v13.4.0, v12.16.0

`addListener< E extends string | symbol, >( eventName: string | symbol, listener: (args: any[]) => void, ): this`

events.d.ts:92

Inherited from addListener

Alias for emitter.on(eventName, listener).

Type Parameters

E extends string | symbol

Parameters

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

Returns

this

Since: v0.1.26

`emit(event: string | symbol, ...args: any[]): boolean`

Downloader.ts:251

Overrides emit

[override description]

Parameters

event (string | symbol) — {string|symbol} event to emit
args (any[]) — evemt arguments

Returns

boolean — event success or failed as boolen

`eventNames(): (string | symbol)[]`

events.d.ts:154

Inherited from eventNames

Returns an array listing the events for which the emitter has registered listeners.

CODE

import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns

(string | symbol)[]

Since: v6.0.0

`getMaxListeners(): number`

events.d.ts:161

Inherited from getMaxListeners

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

Returns

number

Since: v1.0.0

`listenerCount< E extends string | symbol, >( eventName: string | symbol, listener?: (args: any[]) => void, ): number`

events.d.ts:170

Inherited from listenerCount

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Type Parameters

E extends string | symbol

Parameters

eventName (string | symbol) — The name of the event being listened for
listener ((args: any[]) => void, optional) — The event handler function

Returns

number

Since: v3.2.0

`listeners< E extends string | symbol, >( eventName: string | symbol, ): ((args: any[]) => void)[]`

events.d.ts:186

Inherited from listeners

Returns a copy of the array of listeners for the event named eventName.

CODE

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Type Parameters

E extends string | symbol

Parameters

eventName (string | symbol)

Returns

((args: any[]) => void)[]

Since: v0.1.26

`off< E extends string | symbol, >( eventName: string | symbol, listener: (args: any[]) => void, ): this`

events.d.ts:191

Inherited from off

Alias for emitter.removeListener().

Type Parameters

E extends string | symbol

Parameters

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

Returns

this

Since: v10.0.0

`on< E extends string | symbol, >( eventName: string | symbol, listener: (args: any[]) => void, ): this`

events.d.ts:225

Inherited from on

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 eventName and listener will result in the listener being added, and called, multiple times.

CODE

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. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

CODE

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters

E extends string | symbol

Parameters

eventName (string | symbol) — The name of the event.
listener ((args: any[]) => void) — The callback function

Returns

this

Since: v0.1.101

`once< E extends string | symbol, >( eventName: string | symbol, listener: (args: any[]) => void, ): this`

events.d.ts:256

Inherited from once

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

CODE

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

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

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

CODE

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters

E extends string | symbol

Parameters

eventName (string | symbol) — The name of the event.
listener ((args: any[]) => void) — The callback function

Returns

this

Since: v0.3.0

`prependListener< E extends string | symbol, >( eventName: string | symbol, listener: (args: any[]) => void, ): this`

events.d.ts:275

Inherited from prependListener

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

CODE

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

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

Type Parameters

E extends string | symbol

Parameters

eventName (string | symbol) — The name of the event.
listener ((args: any[]) => void) — The callback function

Returns

this

Since: v6.0.0

`prependOnceListener< E extends string | symbol, >( eventName: string | symbol, listener: (args: any[]) => void, ): this`

events.d.ts:292

Inherited from prependOnceListener

Adds a one-time listener 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.

CODE

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

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

Type Parameters

E extends string | symbol

Parameters

eventName (string | symbol) — The name of the event.
listener ((args: any[]) => void) — The callback function

Returns

this

Since: v6.0.0

`rawListeners< E extends string | symbol, >( eventName: string | symbol, ): ((args: any[]) => void)[]`

events.d.ts:326

Inherited from rawListeners

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

CODE

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Type Parameters

E extends string | symbol

Parameters

eventName (string | symbol)

Returns

((args: any[]) => void)[]

Since: v9.4.0

`removeAllListeners< E extends string | symbol, >( eventName?: string | symbol, ): this`

events.d.ts:338

Inherited from removeAllListeners

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.

Type Parameters

E extends string | symbol

Parameters

eventName (string | symbol, optional)

Returns

this

Since: v0.1.26

`removeListener< E extends string | symbol, >( eventName: string | symbol, listener: (args: any[]) => void, ): this`

events.d.ts:425

Inherited from removeListener

Removes the specified listener from the listener array for the event named eventName.

CODE

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

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events behave as expected.

CODE

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indexes 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:

CODE

import { EventEmitter } from 'node:events';
const ee = new EventEmitter();

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

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

Type Parameters

E extends string | symbol

Parameters

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

Returns

this

Since: v0.1.26

`setMaxListeners(n: number): this`

events.d.ts:436

Inherited from setMaxListeners

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

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

Parameters

n (number)

Returns

this

Since: v0.3.5

`startDownload(): Promise<DownloadSummary>`

async

Downloader.ts:199

Initiates the download lifecycle.

Returns

Promise<DownloadSummary>

Author: Nur Rony<pro.nmrony@gmail.com>