Skip to content

Verify

[<Interface>]
type Verify =
    abstract member Duplex: DuplexConstructor with get, set
    abstract member EventEmitter: EventEmitterConstructor with get, set
    abstract member EventEmitterAsyncResource: EventEmitterAsyncResourceConstructor with get, set
    abstract member PassThrough: PassThroughConstructor with get, set
    abstract member Readable: ReadableConstructor with get, set
    abstract member Stream: StreamConstructor with get, set
    abstract member Transform: TransformConstructor with get, set
    abstract member Writable: WritableConstructor with get, set
    abstract member captureRejectionSymbol: Symbol
    abstract member captureRejections: bool with get, set
    abstract member defaultMaxListeners: float with get, set
    abstract member errorMonitor: Symbol
    abstract member finished: Finished with get, set
    abstract member pipeline: Pipeline with get, set
    abstract member promises: Promises with get, set
    abstract member ``end`` (chunk: obj, encoding: BufferEncoding, ?cb: (unit -> unit)) : Verify
    abstract member ``end`` (chunk: obj, ?cb: (unit -> unit)) : Verify
    abstract member ``end`` (?cb: (unit -> unit)) : Verify
    static member addAbortListener (signal: AbortSignal, resource: Event -> unit) : Disposable
    static member addAbortSignal<'T when 'T :> Stream> (signal: AbortSignal, stream: 'T) : 'T
    abstract member addListener (event: U2<string,Symbol>, listener: obj array -> unit) : Verify
    abstract member addListenerClose (listener: unit -> unit) : Verify
    abstract member addListenerDrain (listener: unit -> unit) : Verify
    abstract member addListenerError (listener: exn -> unit) : Verify
    abstract member addListenerFinish (listener: unit -> unit) : Verify
    abstract member addListenerPipe (listener: Readable -> unit) : Verify
    abstract member addListenerUnpipe (listener: Readable -> unit) : Verify
    abstract member compose<'T when 'T :> ReadableStream> (stream: U4<'T,AsyncIterable<'T,obj,obj>,(obj -> unit),Iterable<'T,obj,obj>>, ?options: Options) : 'T
    abstract member destroy (?error: exn) : Verify
    static member duplexPair (?options: DuplexOptions<Duplex>) : Duplex * Duplex
    static member fromWeb (writableStream: WritableStream<obj>, ?options: Options) : Writable
    static member getDefaultHighWaterMark (objectMode: bool) : float
    static member getEventListeners (emitter: U2<EventEmitter<unit array>,EventTarget>, name: U2<string,Symbol>) : Function array
    static member getMaxListeners (emitter: U2<EventEmitter<unit array>,EventTarget>) : float
    static member isErrored (stream: U4<Readable,ReadableStream,Writable,WritableStream>) : bool
    static member isReadable (stream: U2<Readable,ReadableStream>) : bool option
    static member isWritable (stream: U2<Writable,WritableStream>) : bool option
    static member listenerCount (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>) : float
    abstract member off (eventName: U2<string,Symbol>, listener: obj array -> unit) : Verify
    static member on (emitter: EventTarget, eventName: string, ?options: StaticEventEmitterIteratorOptions) : AsyncIterator<obj array,obj,obj>
    static member on (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>, ?options: StaticEventEmitterIteratorOptions) : AsyncIterator<obj array,obj,obj>
    abstract member on (event: U2<string,Symbol>, listener: obj array -> unit) : Verify
    abstract member onClose (listener: unit -> unit) : Verify
    abstract member onDrain (listener: unit -> unit) : Verify
    abstract member onError (listener: exn -> unit) : Verify
    abstract member onFinish (listener: unit -> unit) : Verify
    abstract member onPipe (listener: Readable -> unit) : Verify
    abstract member onUnpipe (listener: Readable -> unit) : Verify
    static member once (emitter: EventTarget, eventName: string, ?options: StaticEventEmitterOptions) : Promise<obj array>
    static member once (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>, ?options: StaticEventEmitterOptions) : Promise<obj array>
    abstract member once (event: U2<string,Symbol>, listener: obj array -> unit) : Verify
    abstract member onceClose (listener: unit -> unit) : Verify
    abstract member onceDrain (listener: unit -> unit) : Verify
    abstract member onceError (listener: exn -> unit) : Verify
    abstract member onceFinish (listener: unit -> unit) : Verify
    abstract member oncePipe (listener: Readable -> unit) : Verify
    abstract member onceUnpipe (listener: Readable -> unit) : Verify
    abstract member pipe<'T when 'T :> WritableStream> (destination: 'T, ?options: Options) : 'T
    abstract member prependListener (event: U2<string,Symbol>, listener: obj array -> unit) : Verify
    abstract member prependListenerClose (listener: unit -> unit) : Verify
    abstract member prependListenerDrain (listener: unit -> unit) : Verify
    abstract member prependListenerError (listener: exn -> unit) : Verify
    abstract member prependListenerFinish (listener: unit -> unit) : Verify
    abstract member prependListenerPipe (listener: Readable -> unit) : Verify
    abstract member prependListenerUnpipe (listener: Readable -> unit) : Verify
    abstract member prependOnceListener (event: U2<string,Symbol>, listener: obj array -> unit) : Verify
    abstract member prependOnceListenerClose (listener: unit -> unit) : Verify
    abstract member prependOnceListenerDrain (listener: unit -> unit) : Verify
    abstract member prependOnceListenerError (listener: exn -> unit) : Verify
    abstract member prependOnceListenerFinish (listener: unit -> unit) : Verify
    abstract member prependOnceListenerPipe (listener: Readable -> unit) : Verify
    abstract member prependOnceListenerUnpipe (listener: Readable -> unit) : Verify
    abstract member removeAllListeners (?eventName: U2<string,Symbol>) : Verify
    abstract member removeListener (event: U2<string,Symbol>, listener: obj array -> unit) : Verify
    abstract member removeListenerClose (listener: unit -> unit) : Verify
    abstract member removeListenerDrain (listener: unit -> unit) : Verify
    abstract member removeListenerError (listener: exn -> unit) : Verify
    abstract member removeListenerFinish (listener: unit -> unit) : Verify
    abstract member removeListenerPipe (listener: Readable -> unit) : Verify
    abstract member removeListenerUnpipe (listener: Readable -> unit) : Verify
    abstract member setDefaultEncoding (encoding: BufferEncoding) : Verify
    static member setDefaultHighWaterMark (objectMode: bool, value: float) : unit
    static member setMaxListeners (n: float option, eventTargets: U2<EventEmitter<unit array>,EventTarget> array) : unit
    abstract member setMaxListeners (n: float) : Verify
    static member toWeb (streamWritable: Writable) : WritableStream<obj>
    abstract member update (data: string, inputEncoding: Encoding) : Verify
    abstract member update (data: BinaryLike) : Verify
    abstract member verify (object: U6<string,Buffer<U2<ArrayBuffer,SharedArrayBuffer>>,KeyObject,VerifyJsonWebKeyInput,VerifyKeyObjectInput,VerifyPublicKeyInput>, signature: string, ?signature_format: BinaryToTextEncoding) : bool
    abstract member verify (object: U6<string,Buffer<U2<ArrayBuffer,SharedArrayBuffer>>,KeyObject,VerifyJsonWebKeyInput,VerifyKeyObjectInput,VerifyPublicKeyInput>, signature: U12<BigInt64Array<U2<ArrayBuffer,SharedArrayBuffer>>,BigUint64Array<U2<ArrayBuffer,SharedArrayBuffer>>,DataView<U2<ArrayBuffer,SharedArrayBuffer>>,Float32Array<U2<ArrayBuffer,SharedArrayBuffer>>,Float64Array<U2<ArrayBuffer,SharedArrayBuffer>>,Int16Array<U2<ArrayBuffer,SharedArrayBuffer>>,Int32Array<U2<ArrayBuffer,SharedArrayBuffer>>,Int8Array<U2<ArrayBuffer,SharedArrayBuffer>>,Uint16Array<U2<ArrayBuffer,SharedArrayBuffer>>,Uint32Array<U2<ArrayBuffer,SharedArrayBuffer>>,Uint8Array<U2<ArrayBuffer,SharedArrayBuffer>>,Uint8ClampedArray<U2<ArrayBuffer,SharedArrayBuffer>>>) : bool
AssemblyXantham.Fable.Node
ImplementsWritable
Attributes[<Interface>] [<Import>]

The Verify class is a utility for verifying signatures. It can be used in one of two ways:

  • As a writable stream where written data is used to validate against the supplied signature, or
  • Using the verify.update() and verify.verify() methods to verify the signature.

The createVerify method is used to create Verify instances. Verify objects are not to be created directly using the new keyword.

See Sign for examples.

@since v0.1.92

Declared inside

Callback
Compose
Pipe

Properties

abstract member Duplex: DuplexConstructor with get, set

Duplex streams are streams that implement both the Readable and Writable interfaces.

Examples of Duplex streams include:

  • TCP sockets
  • zlib streams
  • crypto streams

@since v0.9.4

abstract member EventEmitter: EventEmitterConstructor with get, set
abstract member EventEmitterAsyncResource: EventEmitterAsyncResourceConstructor with get, set

Integrates EventEmitter with AsyncResource for EventEmitters that require manual async tracking. Specifically, all events emitted by instances of events.EventEmitterAsyncResource will run within its async context.

import { EventEmitterAsyncResource, EventEmitter } from 'node:events';
import { notStrictEqual, strictEqual } from 'node:assert';
import { executionAsyncId, triggerAsyncId } from 'node:async_hooks';

// Async tracking tooling will identify this as 'Q'.
const ee1 = new EventEmitterAsyncResource({ name: 'Q' });

// 'foo' listeners will run in the EventEmitters async context.
ee1.on('foo', () => {
strictEqual(executionAsyncId(), ee1.asyncId);
strictEqual(triggerAsyncId(), ee1.triggerAsyncId);
});

const ee2 = new EventEmitter();

// 'foo' listeners on ordinary EventEmitters that do not track async
// context, however, run in the same async context as the emit().
ee2.on('foo', () => {
notStrictEqual(executionAsyncId(), ee2.asyncId);
notStrictEqual(triggerAsyncId(), ee2.triggerAsyncId);
});

Promise.resolve().then(() => {
ee1.emit('foo');
ee2.emit('foo');
});

The EventEmitterAsyncResource class has the same methods and takes the same options as EventEmitter and AsyncResource themselves.

@since v17.4.0, v16.14.0

abstract member PassThrough: PassThroughConstructor with get, set

The stream.PassThrough class is a trivial implementation of a Transform stream that simply passes the input bytes across to the output. Its purpose is primarily for examples and testing, but there are some use cases where stream.PassThrough is useful as a building block for novel sorts of streams.

abstract member Readable: ReadableConstructor with get, set

@since v0.9.4

abstract member Stream: StreamConstructor with get, set
abstract member Transform: TransformConstructor with get, set

Transform streams are Duplex streams where the output is in some way related to the input. Like all Duplex streams, Transform streams implement both the Readable and Writable interfaces.

Examples of Transform streams include:

  • zlib streams
  • crypto streams

@since v0.9.4

abstract member Writable: WritableConstructor with get, set

@since v0.9.4

abstract member captureRejectionSymbol: Symbol

Value: Symbol.for('nodejs.rejection')

See how to write a custom rejection handler.

@since v13.4.0, v12.16.0

abstract member captureRejections: bool with get, set

Value: boolean

Change the default captureRejections option on all new EventEmitter objects.

@since v13.4.0, v12.16.0

abstract member defaultMaxListeners: float with get, set

By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property can be used. If this value is not a positive number, a RangeError is thrown.

Take caution when setting the events.defaultMaxListeners because the change affects all EventEmitter instances, including those created before the change is made. However, calling emitter.setMaxListeners(n) still has precedence over events.defaultMaxListeners.

This is not a hard limit. The EventEmitter instance will allow more listeners to be added but will output a trace warning to stderr indicating that a "possible EventEmitter memory leak" has been detected. For any single EventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners() methods can be used to temporarily avoid this warning:

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
// do stuff
emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});

The --trace-warnings command-line flag can be used to display the stack trace for such warnings.

The emitted warning can be inspected with process.on('warning') and will have the additional emitter, type, and count properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

@since v0.11.2

abstract member errorMonitor: Symbol

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.

@since v13.6.0, v12.17.0

abstract member finished: Finished with get, set

A readable and/or writable stream/webstream.

A function to get notified when a stream is no longer readable, writable or has experienced an error or a premature close event.

import { finished } from 'node:stream';
import fs from 'node:fs';

const rs = fs.createReadStream('archive.tar');

finished(rs, (err) => {
if (err) {
console.error('Stream failed.', err);
} else {
console.log('Stream is done reading.');
}
});

rs.resume(); // Drain the stream.

Especially useful in error handling scenarios where a stream is destroyed prematurely (like an aborted HTTP request), and will not emit 'end' or 'finish'.

The finished API provides promise version.

stream.finished() leaves dangling event listeners (in particular 'error', 'end', 'finish' and 'close') after callback has been invoked. The reason for this is so that unexpected 'error' events (due to incorrect stream implementations) do not cause unexpected crashes. If this is unwanted behavior then the returned cleanup function needs to be invoked in the callback:

const cleanup = finished(rs, (err) => {
cleanup();
// ...
});

@since v10.0.0

Parameter
streamA readable and/or writable stream.
callbackA callback function that takes an optional error argument.

Returns. A cleanup function which removes all registered listeners.

abstract member pipeline: Pipeline with get, set

A module method to pipe between streams and generators forwarding errors and properly cleaning up and provide a callback when the pipeline is complete.

import { pipeline } from 'node:stream';
import fs from 'node:fs';
import zlib from 'node:zlib';

// Use the pipeline API to easily pipe a series of streams
// together and get notified when the pipeline is fully done.

// A pipeline to gzip a potentially huge tar file efficiently:

pipeline(
fs.createReadStream('archive.tar'),
zlib.createGzip(),
fs.createWriteStream('archive.tar.gz'),
(err) => {
if (err) {
console.error('Pipeline failed.', err);
} else {
console.log('Pipeline succeeded.');
}
},
);

The pipeline API provides a promise version.

stream.pipeline() will call stream.destroy(err) on all streams except:

  • Readable streams which have emitted 'end' or 'close'.
  • Writable streams which have emitted 'finish' or 'close'.

stream.pipeline() leaves dangling event listeners on the streams after the callback has been invoked. In the case of reuse of streams after failure, this can cause event listener leaks and swallowed errors. If the last stream is readable, dangling event listeners will be removed so that the last stream can be consumed later.

stream.pipeline() closes all the streams when an error is raised. The IncomingRequest usage with pipeline could lead to an unexpected behavior once it would destroy the socket without sending the expected response. See the example below:

import fs from 'node:fs';
import http from 'node:http';
import { pipeline } from 'node:stream';

const server = http.createServer((req, res) => {
const fileStream = fs.createReadStream('./fileNotExist.txt');
pipeline(fileStream, res, (err) => {
if (err) {
console.log(err); // No such file
// this message can't be sent once `pipeline` already destroyed the socket
return res.end('error!!!');
}
});
});

@since v10.0.0

Parameter
callbackCalled when the pipeline is fully done.
abstract member promises: Promises with get, set

Methods

abstract member ``end`` (chunk: obj, encoding: BufferEncoding, ?cb: (unit -> unit)) : Verify

Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

Calling the write method after calling end will raise an error.

// Write 'hello, ' and then end with 'world!'.
import fs from 'node:fs';
const file = fs.createWriteStream('example.txt');
file.write('hello, ');
file.end('world!');
// Writing more now is not allowed!

Signals that no more data will be written, with one final chunk of data.

@since v0.9.4

Parameter
cbCallback for when the stream is finished.
chunkOptional data to write. For streams not operating in object mode, chunk must be a , , or . For object mode streams, chunk may be any JavaScript value other than null.
cbCallback for when the stream is finished.
chunkOptional data to write. For streams not operating in object mode, chunk must be a , , or . For object mode streams, chunk may be any JavaScript value other than null.
encodingThe encoding if chunk is a string
cbCallback for when the stream is finished.
abstract member ``end`` (chunk: obj, ?cb: (unit -> unit)) : Verify

Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

Calling the write method after calling end will raise an error.

// Write 'hello, ' and then end with 'world!'.
import fs from 'node:fs';
const file = fs.createWriteStream('example.txt');
file.write('hello, ');
file.end('world!');
// Writing more now is not allowed!

Signals that no more data will be written, with one final chunk of data.

@since v0.9.4

Parameter
cbCallback for when the stream is finished.
chunkOptional data to write. For streams not operating in object mode, chunk must be a , , or . For object mode streams, chunk may be any JavaScript value other than null.
cbCallback for when the stream is finished.
chunkOptional data to write. For streams not operating in object mode, chunk must be a , , or . For object mode streams, chunk may be any JavaScript value other than null.
encodingThe encoding if chunk is a string
cbCallback for when the stream is finished.
abstract member ``end`` (?cb: (unit -> unit)) : Verify

Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

Calling the write method after calling end will raise an error.

// Write 'hello, ' and then end with 'world!'.
import fs from 'node:fs';
const file = fs.createWriteStream('example.txt');
file.write('hello, ');
file.end('world!');
// Writing more now is not allowed!

Signals that no more data will be written, with one final chunk of data.

@since v0.9.4

Parameter
cbCallback for when the stream is finished.
chunkOptional data to write. For streams not operating in object mode, chunk must be a , , or . For object mode streams, chunk may be any JavaScript value other than null.
cbCallback for when the stream is finished.
chunkOptional data to write. For streams not operating in object mode, chunk must be a , , or . For object mode streams, chunk may be any JavaScript value other than null.
encodingThe encoding if chunk is a string
cbCallback for when the stream is finished.
static member addAbortListener (signal: AbortSignal, resource: Event -> unit) : 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]();
}
}

@since v20.5.0

Returns. Disposable that removes the abort listener.

static member addAbortSignal<'T when 'T :> Stream> (signal: AbortSignal, stream: 'T) : 'T

A stream to attach a signal to.

Attaches an AbortSignal to a readable or writeable stream. This lets code control stream destruction using an AbortController.

Calling abort on the AbortController corresponding to the passed AbortSignal will behave the same way as calling .destroy(new AbortError()) on the stream, and controller.error(new AbortError()) for webstreams.

import fs from 'node:fs';

const controller = new AbortController();
const read = addAbortSignal(
controller.signal,
fs.createReadStream(('object.json')),
);
// Later, abort the operation closing the stream
controller.abort();

Or using an AbortSignal with a readable stream as an async iterable:

const controller = new AbortController();
setTimeout(() => controller.abort(), 10_000); // set a timeout
const stream = addAbortSignal(
controller.signal,
fs.createReadStream(('object.json')),
);
(async () => {
try {
for await (const chunk of stream) {
await process(chunk);
}
} catch (e) {
if (e.name === 'AbortError') {
// The operation was cancelled
} else {
throw e;
}
}
})();

Or using an AbortSignal with a ReadableStream:

const controller = new AbortController();
const rs = new ReadableStream({
start(controller) {
controller.enqueue('hello');
controller.enqueue('world');
controller.close();
},
});

addAbortSignal(controller.signal, rs);

finished(rs, (err) => {
if (err) {
if (err.name === 'AbortError') {
// The operation was cancelled
}
}
});

const reader = rs.getReader();

reader.read().then(({ value, done }) => {
console.log(value); // hello
console.log(done); // false
controller.abort();
});

@since v15.4.0

Parameter
signalA signal representing possible cancellation
streamA stream to attach a signal to.
abstract member addListener (event: U2<string,Symbol>, listener: obj array -> unit) : Verify

Event emitter The defined events on documents including:

  1. close
  2. drain
  3. error
  4. finish
  5. pipe
  6. unpipe
abstract member addListenerClose (listener: unit -> unit) : Verify

Event emitter The defined events on documents including:

  1. close
  2. drain
  3. error
  4. finish
  5. pipe
  6. unpipe
addListener(event: "close", listener: () => void): this
abstract member addListenerDrain (listener: unit -> unit) : Verify
addListener(event: "drain", listener: () => void): this
abstract member addListenerError (listener: exn -> unit) : Verify
addListener(event: "error", listener: (err: Error) => void): this
abstract member addListenerFinish (listener: unit -> unit) : Verify
addListener(event: "finish", listener: () => void): this
abstract member addListenerPipe (listener: Readable -> unit) : Verify
addListener(event: "pipe", listener: (src: Readable) => void): this
abstract member addListenerUnpipe (listener: Readable -> unit) : Verify
addListener(event: "unpipe", listener: (src: Readable) => void): this
abstract member compose<'T when 'T :> ReadableStream> (stream: U4<'T,AsyncIterable<'T,obj,obj>,(obj -> unit),Iterable<'T,obj,obj>>, ?options: Options) : 'T
abstract member destroy (?error: exn) : Verify

Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the writable stream has ended and subsequent calls to write() or end() will result in an ERR_STREAM_DESTROYED error. This is a destructive and immediate way to destroy a stream. Previous calls to write() may not have drained, and may trigger an ERR_STREAM_DESTROYED error. Use end() instead of destroy if data should flush before close, or wait for the 'drain' event before destroying the stream.

Once destroy() has been called any further calls will be a no-op and no further errors except from _destroy() may be emitted as 'error'.

Implementors should not override this method, but instead implement writable._destroy().

@since v8.0.0

Parameter
errorOptional, an error to emit with 'error' event.
static member duplexPair (?options: DuplexOptions<Duplex>) : Duplex * Duplex

The utility function duplexPair returns an Array with two items, each being a Duplex stream connected to the other side:

const [ sideA, sideB ] = duplexPair();

Whatever is written to one stream is made readable on the other. It provides behavior analogous to a network connection, where the data written by the client becomes readable by the server, and vice-versa.

The Duplex streams are symmetrical; one or the other may be used without any difference in behavior.

@since v22.6.0

Parameter
optionsA value to pass to both {@link Duplex} constructors, to set options such as buffering.
static member fromWeb (writableStream: WritableStream<obj>, ?options: Options) : Writable

A utility method for creating a Writable from a web WritableStream.

@since v17.0.0

static member getDefaultHighWaterMark (objectMode: bool) : float

Returns the default highWaterMark used by streams. Defaults to 65536 (64 KiB), or 16 for objectMode.

@since v19.9.0

static member getEventListeners (emitter: U2<EventEmitter<unit array>,EventTarget>, name: U2<string,Symbol>) : Function array

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

For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

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

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

@since v15.2.0, v14.17.0

static member getMaxListeners (emitter: U2<EventEmitter<unit array>,EventTarget>) : float

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
}

@since v19.9.0

static member isErrored (stream: U4<Readable,ReadableStream,Writable,WritableStream>) : bool

Returns whether the stream has encountered an error.

@since v17.3.0, v16.14.0

static member isReadable (stream: U2<Readable,ReadableStream>) : bool option

Returns whether the stream is readable.

@since v17.4.0, v16.14.0

Returns. Only returns null if stream is not a valid Readable, Duplex or ReadableStream.

static member isWritable (stream: U2<Writable,WritableStream>) : bool option

Returns whether the stream is writable.

@since v20.0.0

Returns. Only returns null if stream is not a valid Writable, Duplex or WritableStream.

static member listenerCount (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>) : float

A class method that returns the number of listeners for the given eventName registered on the given emitter.

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

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

@since v0.9.12

Parameter
emitterThe emitter to query
eventNameThe event name
abstract member off (eventName: U2<string,Symbol>, listener: obj array -> unit) : Verify

Alias for emitter.removeListener().

@since v10.0.0

static member on (emitter: EventTarget, eventName: string, ?options: StaticEventEmitterIteratorOptions) : AsyncIterator<obj array,obj,obj>
import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

An AbortSignal can be used to cancel waiting on events:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ac = new AbortController();

(async () => {
const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo', { signal: ac.signal })) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();

process.nextTick(() => ac.abort());

Use the close option to specify an array of event names that will end the iteration:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
ee.emit('close');
});

for await (const event of on(ee, 'foo', { close: ['close'] })) {
console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'

@since v13.6.0, v12.16.0

Returns. An AsyncIterator that iterates eventName events emitted by the emitter

static member on (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>, ?options: StaticEventEmitterIteratorOptions) : AsyncIterator<obj array,obj,obj>
import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

An AbortSignal can be used to cancel waiting on events:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ac = new AbortController();

(async () => {
const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo', { signal: ac.signal })) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();

process.nextTick(() => ac.abort());

Use the close option to specify an array of event names that will end the iteration:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
ee.emit('close');
});

for await (const event of on(ee, 'foo', { close: ['close'] })) {
console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'

@since v13.6.0, v12.16.0

Returns. An AsyncIterator that iterates eventName events emitted by the emitter

abstract member on (event: U2<string,Symbol>, listener: obj array -> unit) : Verify

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.

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.

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
abstract member onClose (listener: unit -> unit) : Verify
on(event: "close", listener: () => void): this
abstract member onDrain (listener: unit -> unit) : Verify
on(event: "drain", listener: () => void): this
abstract member onError (listener: exn -> unit) : Verify
on(event: "error", listener: (err: Error) => void): this
abstract member onFinish (listener: unit -> unit) : Verify
on(event: "finish", listener: () => void): this
abstract member onPipe (listener: Readable -> unit) : Verify
on(event: "pipe", listener: (src: Readable) => void): this
abstract member onUnpipe (listener: Readable -> unit) : Verify
on(event: "unpipe", listener: (src: Readable) => void): this
static member once (emitter: EventTarget, eventName: string, ?options: StaticEventEmitterOptions) : Promise<obj array>

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

import { once, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

process.nextTick(() => {
ee.emit('myevent', 42);
});

const [value] = await once(ee, 'myevent');
console.log(value);

const err = new Error('kaboom');
process.nextTick(() => {
ee.emit('error', err);
});

try {
await once(ee, 'myevent');
} catch (err) {
console.error('error happened', err);
}

The special handling of the 'error' event is only used when events.once() is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

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

const ee = new EventEmitter();

once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.error('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

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

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

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

@since v11.13.0, v10.16.0

static member once (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>, ?options: StaticEventEmitterOptions) : Promise<obj array>

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

import { once, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

process.nextTick(() => {
ee.emit('myevent', 42);
});

const [value] = await once(ee, 'myevent');
console.log(value);

const err = new Error('kaboom');
process.nextTick(() => {
ee.emit('error', err);
});

try {
await once(ee, 'myevent');
} catch (err) {
console.error('error happened', err);
}

The special handling of the 'error' event is only used when events.once() is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

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

const ee = new EventEmitter();

once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.error('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

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

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

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

@since v11.13.0, v10.16.0

abstract member once (event: U2<string,Symbol>, listener: obj array -> unit) : Verify

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

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a
abstract member onceClose (listener: unit -> unit) : Verify
once(event: "close", listener: () => void): this
abstract member onceDrain (listener: unit -> unit) : Verify
once(event: "drain", listener: () => void): this
abstract member onceError (listener: exn -> unit) : Verify
once(event: "error", listener: (err: Error) => void): this
abstract member onceFinish (listener: unit -> unit) : Verify
once(event: "finish", listener: () => void): this
abstract member oncePipe (listener: Readable -> unit) : Verify
once(event: "pipe", listener: (src: Readable) => void): this
abstract member onceUnpipe (listener: Readable -> unit) : Verify
once(event: "unpipe", listener: (src: Readable) => void): this
abstract member pipe<'T when 'T :> WritableStream> (destination: 'T, ?options: Options) : 'T
abstract member prependListener (event: U2<string,Symbol>, listener: obj array -> unit) : Verify

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

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

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

abstract member prependListenerClose (listener: unit -> unit) : Verify
prependListener(event: "close", listener: () => void): this
abstract member prependListenerDrain (listener: unit -> unit) : Verify
prependListener(event: "drain", listener: () => void): this
abstract member prependListenerError (listener: exn -> unit) : Verify
prependListener(event: "error", listener: (err: Error) => void): this
abstract member prependListenerFinish (listener: unit -> unit) : Verify
prependListener(event: "finish", listener: () => void): this
abstract member prependListenerPipe (listener: Readable -> unit) : Verify
prependListener(event: "pipe", listener: (src: Readable) => void): this
abstract member prependListenerUnpipe (listener: Readable -> unit) : Verify
prependListener(event: "unpipe", listener: (src: Readable) => void): this
abstract member prependOnceListener (event: U2<string,Symbol>, listener: obj array -> unit) : Verify

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.

abstract member prependOnceListenerClose (listener: unit -> unit) : Verify
prependOnceListener(event: "close", listener: () => void): this
abstract member prependOnceListenerDrain (listener: unit -> unit) : Verify
prependOnceListener(event: "drain", listener: () => void): this
abstract member prependOnceListenerError (listener: exn -> unit) : Verify
prependOnceListener(event: "error", listener: (err: Error) => void): this
abstract member prependOnceListenerFinish (listener: unit -> unit) : Verify
prependOnceListener(event: "finish", listener: () => void): this
abstract member prependOnceListenerPipe (listener: Readable -> unit) : Verify
prependOnceListener(event: "pipe", listener: (src: Readable) => void): this
abstract member prependOnceListenerUnpipe (listener: Readable -> unit) : Verify
prependOnceListener(event: "unpipe", listener: (src: Readable) => void): this
abstract member removeAllListeners (?eventName: U2<string,Symbol>) : Verify

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

abstract member removeListener (event: U2<string,Symbol>, listener: obj array -> unit) : Verify

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

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

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

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

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

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

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

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

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

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

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

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

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

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

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

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

abstract member removeListenerClose (listener: unit -> unit) : Verify
removeListener(event: "close", listener: () => void): this
abstract member removeListenerDrain (listener: unit -> unit) : Verify
removeListener(event: "drain", listener: () => void): this
abstract member removeListenerError (listener: exn -> unit) : Verify
removeListener(event: "error", listener: (err: Error) => void): this
abstract member removeListenerFinish (listener: unit -> unit) : Verify
removeListener(event: "finish", listener: () => void): this
abstract member removeListenerPipe (listener: Readable -> unit) : Verify
removeListener(event: "pipe", listener: (src: Readable) => void): this
abstract member removeListenerUnpipe (listener: Readable -> unit) : Verify
removeListener(event: "unpipe", listener: (src: Readable) => void): this
abstract member setDefaultEncoding (encoding: BufferEncoding) : Verify

The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

@since v0.11.15

Parameter
encodingThe new default encoding
static member setDefaultHighWaterMark (objectMode: bool, value: float) : unit

Sets the default highWaterMark used by streams.

@since v19.9.0

Parameter
valuehighWaterMark value
static member setMaxListeners (n: float option, eventTargets: U2<EventEmitter<unit array>,EventTarget> array) : unit
import { setMaxListeners, EventEmitter } from 'node:events';

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

setMaxListeners(5, target, emitter);

@since v15.4.0

Parameter
nA non-negative number. The maximum number of listeners per EventTarget event.
eventTargetsZero or more or instances. If none are specified, n is set as the default max for all newly created and objects.
abstract member setMaxListeners (n: float) : Verify

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.

@since v0.3.5

static member toWeb (streamWritable: Writable) : WritableStream<obj>

A utility method for creating a web WritableStream from a Writable.

@since v17.0.0

abstract member update (data: string, inputEncoding: Encoding) : Verify

Updates the Verify content with the given data, the encoding of which is given in inputEncoding. If inputEncoding is not provided, and the data is a string, an encoding of 'utf8' is enforced. If data is a Buffer, TypedArray, or DataView, then inputEncoding is ignored.

This can be called many times with new data as it is streamed.

@since v0.1.92

Parameter
inputEncodingThe encoding of the data string.
abstract member update (data: BinaryLike) : Verify

Updates the Verify content with the given data, the encoding of which is given in inputEncoding. If inputEncoding is not provided, and the data is a string, an encoding of 'utf8' is enforced. If data is a Buffer, TypedArray, or DataView, then inputEncoding is ignored.

This can be called many times with new data as it is streamed.

@since v0.1.92

Parameter
inputEncodingThe encoding of the data string.
abstract member verify (object: U6<string,Buffer<U2<ArrayBuffer,SharedArrayBuffer>>,KeyObject,VerifyJsonWebKeyInput,VerifyKeyObjectInput,VerifyPublicKeyInput>, signature: string, ?signature_format: BinaryToTextEncoding) : bool

Verifies the provided data using the given object and signature.

If object is not a KeyObject, this function behaves as if object had been passed to createPublicKey. If it is an object, the following additional properties can be passed:

The signature argument is the previously calculated signature for the data, in the signatureEncoding. If a signatureEncoding is specified, the signature is expected to be a string; otherwise signature is expected to be a Buffer, TypedArray, or DataView.

The verify object can not be used again after verify.verify() has been called. Multiple calls to verify.verify() will result in an error being thrown.

Because public keys can be derived from private keys, a private key may be passed instead of a public key.

@since v0.1.92

abstract member verify (object: U6<string,Buffer<U2<ArrayBuffer,SharedArrayBuffer>>,KeyObject,VerifyJsonWebKeyInput,VerifyKeyObjectInput,VerifyPublicKeyInput>, signature: U12<BigInt64Array<U2<ArrayBuffer,SharedArrayBuffer>>,BigUint64Array<U2<ArrayBuffer,SharedArrayBuffer>>,DataView<U2<ArrayBuffer,SharedArrayBuffer>>,Float32Array<U2<ArrayBuffer,SharedArrayBuffer>>,Float64Array<U2<ArrayBuffer,SharedArrayBuffer>>,Int16Array<U2<ArrayBuffer,SharedArrayBuffer>>,Int32Array<U2<ArrayBuffer,SharedArrayBuffer>>,Int8Array<U2<ArrayBuffer,SharedArrayBuffer>>,Uint16Array<U2<ArrayBuffer,SharedArrayBuffer>>,Uint32Array<U2<ArrayBuffer,SharedArrayBuffer>>,Uint8Array<U2<ArrayBuffer,SharedArrayBuffer>>,Uint8ClampedArray<U2<ArrayBuffer,SharedArrayBuffer>>>) : bool

Verifies the provided data using the given object and signature.

If object is not a KeyObject, this function behaves as if object had been passed to createPublicKey. If it is an object, the following additional properties can be passed:

The signature argument is the previously calculated signature for the data, in the signatureEncoding. If a signatureEncoding is specified, the signature is expected to be a string; otherwise signature is expected to be a Buffer, TypedArray, or DataView.

The verify object can not be used again after verify.verify() has been called. Multiple calls to verify.verify() will result in an error being thrown.

Because public keys can be derived from private keys, a private key may be passed instead of a public key.

@since v0.1.92