@morojs/moro / HttpRequest

Interface: HttpRequest

Defined in: src/types/http.ts:4

Extends

IncomingMessage

Extended by

ValidatedRequest

Indexable

[key: string]: any

Properties

aborted

aborted: boolean

Defined in: node_modules/@types/node/http.d.ts:1206

The message.aborted property will be true if the request has been aborted.

Since

v10.1.0

Deprecated

Since v17.0.0,v16.12.0 - Check message.destroyed from stream.Readable.

Inherited from

IncomingMessage.aborted

body

body: any

Defined in: src/types/http.ts:7

closed

readonly closed: boolean

Defined in: node_modules/@types/node/stream.d.ts:157

Is true after 'close' has been emitted.

Since

v18.0.0

Inherited from

IncomingMessage.closed

complete

complete: boolean

Defined in: node_modules/@types/node/http.d.ts:1241

The message.complete property will be true if a complete HTTP message has been received and successfully parsed.

This property is particularly useful as a means of determining if a client or server fully transmitted a message before a connection was terminated:

const req = http.request({
  host: '127.0.0.1',
  port: 8080,
  method: 'POST',
}, (res) => {
  res.resume();
  res.on('end', () => {
    if (!res.complete)
      console.error(
        'The connection was terminated while the message was still being sent');
  });
});

Since

v0.3.0

Inherited from

IncomingMessage.complete

connection

connection: Socket

Defined in: node_modules/@types/node/http.d.ts:1247

Alias for message.socket.

Since

v0.1.90

Deprecated

Since v16.0.0 - Use socket.

Inherited from

IncomingMessage.connection

cookies?

optional cookies: Record<string, string>

Defined in: src/types/http.ts:12

destroyed

destroyed: boolean

Defined in: node_modules/@types/node/stream.d.ts:152

Is true after readable.destroy() has been called.

Since

v8.0.0

Inherited from

IncomingMessage.destroyed

errored

readonly errored: null | Error

Defined in: node_modules/@types/node/stream.d.ts:162

Returns error if the stream has been destroyed with an error.

Since

v18.0.0

Inherited from

IncomingMessage.errored

files?

optional files: Record<string, any>

Defined in: src/types/http.ts:13

headers

headers: Record<string, string>

Defined in: src/types/http.ts:9

The request/response headers object.

Key-value pairs of header names and values. Header names are lower-cased.

// Prints something like:
//
// { 'user-agent': 'curl/7.22.0',
//   host: '127.0.0.1:8000',
//   accept: '*' }
console.log(request.headers);

Duplicates in raw headers are handled in the following ways, depending on the header name:

Duplicates of age, authorization, content-length, content-type, etag, expires, from, host, if-modified-since, if-unmodified-since, last-modified, location, max-forwards, proxy-authorization, referer, retry-after, server, or user-agent are discarded. To allow duplicate values of the headers listed above to be joined, use the option joinDuplicateHeaders in request and createServer. See RFC 9110 Section 5.3 for more information.
set-cookie is always an array. Duplicates are added to the array.
For duplicate cookie headers, the values are joined together with ; .
For all other headers, the values are joined together with , .

Since

v0.1.5

Overrides

IncomingMessage.headers

headersDistinct

headersDistinct: Dict<string[]>

Defined in: node_modules/@types/node/http.d.ts:1302

Similar to message.headers, but there is no join logic and the values are always arrays of strings, even for headers received just once.

// Prints something like:
//
// { 'user-agent': ['curl/7.22.0'],
//   host: ['127.0.0.1:8000'],
//   accept: ['*'] }
console.log(request.headersDistinct);

Since

v18.3.0, v16.17.0

Inherited from

IncomingMessage.headersDistinct

httpVersion

httpVersion: string

Defined in: node_modules/@types/node/http.d.ts:1215

In case of server request, the HTTP version sent by the client. In the case of client response, the HTTP version of the connected-to server. Probably either '1.1' or '1.0'.

Also message.httpVersionMajor is the first integer and message.httpVersionMinor is the second.

Since

v0.1.1

Inherited from

IncomingMessage.httpVersion

httpVersionMajor

httpVersionMajor: number

Defined in: node_modules/@types/node/http.d.ts:1216

Inherited from

IncomingMessage.httpVersionMajor

httpVersionMinor

httpVersionMinor: number

Defined in: node_modules/@types/node/http.d.ts:1217

Inherited from

IncomingMessage.httpVersionMinor

ip

ip: string

Defined in: src/types/http.ts:10

method?

optional method: string

Defined in: node_modules/@types/node/http.d.ts:1357

Only valid for request obtained from Server.

The request method as a string. Read only. Examples: 'GET', 'DELETE'.

Since

v0.1.1

Inherited from

IncomingMessage.method

params

params: Record<string, string>

Defined in: src/types/http.ts:5

path

path: string

Defined in: src/types/http.ts:8

query

query: Record<string, string>

Defined in: src/types/http.ts:6

rawHeaders

rawHeaders: string[]

Defined in: node_modules/@types/node/http.d.ts:1327

The raw request/response headers list exactly as they were received.

The keys and values are in the same list. It is not a list of tuples. So, the even-numbered offsets are key values, and the odd-numbered offsets are the associated values.

Header names are not lowercased, and duplicates are not merged.

// Prints something like:
//
// [ 'user-agent',
//   'this is invalid because there can be only one',
//   'User-Agent',
//   'curl/7.22.0',
//   'Host',
//   '127.0.0.1:8000',
//   'ACCEPT',
//   '*' ]
console.log(request.rawHeaders);

Since

v0.11.6

Inherited from

IncomingMessage.rawHeaders

rawTrailers

rawTrailers: string[]

Defined in: node_modules/@types/node/http.d.ts:1345

The raw request/response trailer keys and values exactly as they were received. Only populated at the 'end' event.

Since

v0.11.6

Inherited from

IncomingMessage.rawTrailers

readable

readable: boolean

Defined in: node_modules/@types/node/stream.d.ts:109

Is true if it is safe to call read, which means the stream has not been destroyed or emitted 'error' or 'end'.

Since

v11.4.0

Inherited from

IncomingMessage.readable

readableAborted

readonly readableAborted: boolean

Defined in: node_modules/@types/node/stream.d.ts:103

Returns whether the stream was destroyed or errored before emitting 'end'.

Since

v16.8.0

Inherited from

IncomingMessage.readableAborted

readableDidRead

readonly readableDidRead: boolean

Defined in: node_modules/@types/node/stream.d.ts:114

Returns whether 'data' has been emitted.

Since

v16.7.0, v14.18.0

Inherited from

IncomingMessage.readableDidRead

readableEncoding

readonly readableEncoding: null | BufferEncoding

Defined in: node_modules/@types/node/stream.d.ts:119

Getter for the property encoding of a given Readable stream. The encoding property can be set using the setEncoding method.

Since

v12.7.0

Inherited from

IncomingMessage.readableEncoding

readableEnded

readonly readableEnded: boolean

Defined in: node_modules/@types/node/stream.d.ts:124

Becomes true when 'end' event is emitted.

Since

v12.9.0

Inherited from

IncomingMessage.readableEnded

readableFlowing

readonly readableFlowing: null | boolean

Defined in: node_modules/@types/node/stream.d.ts:130

This property reflects the current state of a Readable stream as described in the Three states section.

Since

v9.4.0

Inherited from

IncomingMessage.readableFlowing

readableHighWaterMark

readonly readableHighWaterMark: number

Defined in: node_modules/@types/node/stream.d.ts:135

Returns the value of highWaterMark passed when creating this Readable.

Since

v9.3.0

Inherited from

IncomingMessage.readableHighWaterMark

readableLength

readonly readableLength: number

Defined in: node_modules/@types/node/stream.d.ts:142

This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the highWaterMark.

Since

v9.4.0

Inherited from

IncomingMessage.readableLength

readableObjectMode

readonly readableObjectMode: boolean

Defined in: node_modules/@types/node/stream.d.ts:147

Getter for the property objectMode of a given Readable stream.

Since

v12.3.0

Inherited from

IncomingMessage.readableObjectMode

requestId

requestId: string

Defined in: src/types/http.ts:11

socket

socket: Socket

Defined in: node_modules/@types/node/http.d.ts:1259

The net.Socket object associated with the connection.

With HTTPS support, use request.socket.getPeerCertificate() to obtain the client's authentication details.

This property is guaranteed to be an instance of the net.Socket class, a subclass of stream.Duplex, unless the user specified a socket type other than net.Socket or internally nulled.

Since

v0.3.0

Inherited from

IncomingMessage.socket

statusCode?

optional statusCode: number

Defined in: node_modules/@types/node/http.d.ts:1407

Only valid for response obtained from ClientRequest.

The 3-digit HTTP response status code. E.G. 404.

Since

v0.1.1

Inherited from

IncomingMessage.statusCode

statusMessage?

optional statusMessage: string

Defined in: node_modules/@types/node/http.d.ts:1414

Only valid for response obtained from ClientRequest.

The HTTP response status message (reason phrase). E.G. OK or Internal Server Error.

Since

v0.11.10

Inherited from

IncomingMessage.statusMessage

trailers

trailers: Dict<string>

Defined in: node_modules/@types/node/http.d.ts:1332

The request/response trailers object. Only populated at the 'end' event.

Since

v0.3.0

Inherited from

IncomingMessage.trailers

trailersDistinct

trailersDistinct: Dict<string[]>

Defined in: node_modules/@types/node/http.d.ts:1339

Similar to message.trailers, but there is no join logic and the values are always arrays of strings, even for headers received just once. Only populated at the 'end' event.

Since

v18.3.0, v16.17.0

Inherited from

IncomingMessage.trailersDistinct

url?

optional url: string

Defined in: node_modules/@types/node/http.d.ts:1400

Only valid for request obtained from Server.

Request URL string. This contains only the URL that is present in the actual HTTP request. Take the following request:

GET /status?name=ryan HTTP/1.1
Accept: text/plain

To parse the URL into its parts:

new URL(`http://${process.env.HOST ?? 'localhost'}${request.url}`);

When request.url is '/status?name=ryan' and process.env.HOST is undefined:

$ node
> new URL(`http://${process.env.HOST ?? 'localhost'}${request.url}`);
URL {
  href: 'http://localhost/status?name=ryan',
  origin: 'http://localhost',
  protocol: 'http:',
  username: '',
  password: '',
  host: 'localhost',
  hostname: 'localhost',
  port: '',
  pathname: '/status',
  search: '?name=ryan',
  searchParams: URLSearchParams { 'name' => 'ryan' },
  hash: ''
}

Ensure that you set process.env.HOST to the server's host name, or consider replacing this part entirely. If using req.headers.host, ensure proper validation is used, as clients may specify a custom Host header.

Since

v0.1.90

Inherited from

IncomingMessage.url

Methods

_construct()?

optional _construct(callback): void

Defined in: node_modules/@types/node/stream.d.ts:164

Parameters

callback

(error?) => void

Returns

void

Inherited from

IncomingMessage._construct

_destroy()

_destroy(error, callback): void

Defined in: node_modules/@types/node/stream.d.ts:605

Parameters

error

null | Error

callback

(error?) => void

Returns

void

Inherited from

IncomingMessage._destroy

_read()

_read(size): void

Defined in: node_modules/@types/node/stream.d.ts:165

Parameters

size

number

Returns

void

Inherited from

IncomingMessage._read

[asyncDispose]()

[asyncDispose](): Promise<void>

Defined in: node_modules/@types/node/stream.d.ts:628

Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

Returns

Promise<void>

Since

v20.4.0

Inherited from

IncomingMessage.[asyncDispose]

[asyncIterator]()

[asyncIterator](): AsyncIterator<any>

Defined in: node_modules/@types/node/stream.d.ts:622

Returns

AsyncIterator<any>

AsyncIterator to fully consume the stream.

Since

v10.0.0

Inherited from

IncomingMessage.[asyncIterator]

[captureRejectionSymbol]()?

optional [captureRejectionSymbol]<K>(error, event, ...args): void

Defined in: node_modules/@types/node/events.d.ts:136

Type Parameters

K

K

Parameters

error

Error

event

string | symbol

args

...AnyRest

Returns

void

Inherited from

IncomingMessage.[captureRejectionSymbol]

addListener()

Call Signature

addListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:640

Event emitter The defined events on documents including:

close
data
end
error
pause
readable
resume

Parameters

event

"close"

listener

() => void

Returns

this

Inherited from

IncomingMessage.addListener

Call Signature

addListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:641

Event emitter The defined events on documents including:

close
data
end
error
pause
readable
resume

Parameters

event

"data"

listener

(chunk) => void

Returns

this

Inherited from

IncomingMessage.addListener

Call Signature

addListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:642

Event emitter The defined events on documents including:

close
data
end
error
pause
readable
resume

Parameters

event

"end"

listener

() => void

Returns

this

Inherited from

IncomingMessage.addListener

Call Signature

addListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:643

Event emitter The defined events on documents including:

close
data
end
error
pause
readable
resume

Parameters

event

"error"

listener

(err) => void

Returns

this

Inherited from

IncomingMessage.addListener

Call Signature

addListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:644

Event emitter The defined events on documents including:

close
data
end
error
pause
readable
resume

Parameters

event

"pause"

listener

() => void

Returns

this

Inherited from

IncomingMessage.addListener

Call Signature

addListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:645

Event emitter The defined events on documents including:

close
data
end
error
pause
readable
resume

Parameters

event

"readable"

listener

() => void

Returns

this

Inherited from

IncomingMessage.addListener

Call Signature

addListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:646

Event emitter The defined events on documents including:

close
data
end
error
pause
readable
resume

Parameters

event

"resume"

listener

() => void

Returns

this

Inherited from

IncomingMessage.addListener

Call Signature

addListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:647

Event emitter The defined events on documents including:

close
data
end
error
pause
readable
resume

Parameters

event

string | symbol

listener

(...args) => void

Returns

this

Inherited from

IncomingMessage.addListener

asIndexedPairs()

asIndexedPairs(options?): Readable

Defined in: node_modules/@types/node/stream.d.ts:580

This method returns a new stream with chunks of the underlying stream paired with a counter in the form [index, chunk]. The first index value is 0 and it increases by 1 for each chunk produced.

Parameters

options?

Pick<ArrayOptions, "signal">

Returns

Readable

a stream of indexed pairs.

Since

v17.5.0

Inherited from

IncomingMessage.asIndexedPairs

compose()

compose<T>(stream, options?): T

Defined in: node_modules/@types/node/stream.d.ts:35

Type Parameters

T

T extends ReadableStream

Parameters

stream

ComposeFnParam | T | Iterable<T, any, any> | AsyncIterable<T, any, any>

options?

signal

AbortSignal

Returns

T

Inherited from

IncomingMessage.compose

destroy()

destroy(error?): this

Defined in: node_modules/@types/node/http.d.ts:1420

Calls destroy() on the socket that received the IncomingMessage. If error is provided, an 'error' event is emitted on the socket and error is passed as an argument to any listeners on the event.

Parameters

error?

Error

Returns

this

Since

v0.3.0

Inherited from

IncomingMessage.destroy

drop()

drop(limit, options?): Readable

Defined in: node_modules/@types/node/stream.d.ts:566

This method returns a new stream with the first limit chunks dropped from the start.

Parameters

limit

number

the number of chunks to drop from the readable.

options?

Pick<ArrayOptions, "signal">

Returns

Readable

a stream with limit chunks dropped from the start.

Since

v17.5.0

Inherited from

IncomingMessage.drop

emit()

Call Signature

emit(event): boolean

Defined in: node_modules/@types/node/stream.d.ts:648

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

Returns true if the event had listeners, false otherwise.

import { EventEmitter } from 'node: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

event

"close"

Returns

boolean

Since

v0.1.26

Inherited from

IncomingMessage.emit

Call Signature

emit(event, chunk): boolean

Defined in: node_modules/@types/node/stream.d.ts:649

Parameters

event

"data"

chunk

any

Returns

boolean

Inherited from

IncomingMessage.emit

Call Signature

emit(event): boolean

Defined in: node_modules/@types/node/stream.d.ts:650

Parameters

event

"end"

Returns

boolean

Inherited from

IncomingMessage.emit

Call Signature

emit(event, err): boolean

Defined in: node_modules/@types/node/stream.d.ts:651

Parameters

event

"error"

err

Error

Returns

boolean

Inherited from

IncomingMessage.emit

Call Signature

emit(event): boolean

Defined in: node_modules/@types/node/stream.d.ts:652

Parameters

event

"pause"

Returns

boolean

Inherited from

IncomingMessage.emit

Call Signature

emit(event): boolean

Defined in: node_modules/@types/node/stream.d.ts:653

Parameters

event

"readable"

Returns

boolean

Inherited from

IncomingMessage.emit

Call Signature

emit(event): boolean

Defined in: node_modules/@types/node/stream.d.ts:654

Parameters

event

"resume"

Returns

boolean

Inherited from

IncomingMessage.emit

Call Signature

emit(event, ...args): boolean

Defined in: node_modules/@types/node/stream.d.ts:655

Parameters

event

string | symbol

args

...any[]

Returns

boolean

Inherited from

IncomingMessage.emit

eventNames()

eventNames(): (string | symbol)[]

Defined in: node_modules/@types/node/events.d.ts:921

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

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

Inherited from

IncomingMessage.eventNames

every()

every(fn, options?): Promise<boolean>

Defined in: node_modules/@types/node/stream.d.ts:545

This method is similar to Array.prototype.every and calls fn on each chunk in the stream to check if all awaited return values are truthy value for fn. Once an fn call on a chunk awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

Parameters

fn

(data, options?) => boolean | Promise<boolean>

a function to call on each chunk of the stream. Async or not.

options?

ArrayOptions

Returns

Promise<boolean>

a promise evaluating to true if fn returned a truthy value for every one of the chunks.

Since

v17.5.0

Inherited from

IncomingMessage.every

filter()

filter(fn, options?): Readable

Defined in: node_modules/@types/node/stream.d.ts:473

This method allows filtering the stream. For each chunk in the stream the fn function will be called and if it returns a truthy value, the chunk will be passed to the result stream. If the fn function returns a promise - that promise will be awaited.

Parameters

fn

(data, options?) => boolean | Promise<boolean>

a function to filter chunks from the stream. Async or not.

options?

ArrayOptions

Returns

Readable

a stream filtered with the predicate fn.

Since

v17.4.0, v16.14.0

Inherited from

IncomingMessage.filter

find()

Call Signature

find<T>(fn, options?): Promise<undefined | T>

Defined in: node_modules/@types/node/stream.d.ts:528

This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

Type Parameters

T

T

Parameters

fn

(data, options?) => data is T

a function to call on each chunk of the stream. Async or not.

options?

ArrayOptions

Returns

Promise<undefined | T>

a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

Since

v17.5.0

Inherited from

IncomingMessage.find

Call Signature

find(fn, options?): Promise<any>

Defined in: node_modules/@types/node/stream.d.ts:532

Parameters

fn

(data, options?) => boolean | Promise<boolean>

a function to call on each chunk of the stream. Async or not.

options?

ArrayOptions

Returns

Promise<any>

a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

Since

v17.5.0

Inherited from

IncomingMessage.find

flatMap()

flatMap(fn, options?): Readable

Defined in: node_modules/@types/node/stream.d.ts:559

This method returns a new stream by applying the given callback to each chunk of the stream and then flattening the result.

It is possible to return a stream or another iterable or async iterable from fn and the result streams will be merged (flattened) into the returned stream.

Parameters

fn

(data, options?) => any

a function to map over every chunk in the stream. May be async. May be a stream or generator.

options?

ArrayOptions

Returns

Readable

a stream flat-mapped with the function fn.

Since

v17.5.0

Inherited from

IncomingMessage.flatMap

forEach()

forEach(fn, options?): Promise<void>

Defined in: node_modules/@types/node/stream.d.ts:492

This method allows iterating a stream. For each chunk in the stream the fn function will be called. If the fn function returns a promise - that promise will be awaited.

This method is different from for await...of loops in that it can optionally process chunks concurrently. In addition, a forEach iteration can only be stopped by having passed a signal option and aborting the related AbortController while for await...of can be stopped with break or return. In either case the stream will be destroyed.

This method is different from listening to the 'data' event in that it uses the readable event in the underlying machinary and can limit the number of concurrent fn calls.

Parameters

fn

(data, options?) => void | Promise<void>

a function to call on each chunk of the stream. Async or not.

options?

ArrayOptions

Returns

Promise<void>

a promise for when the stream has finished.

Since

v17.5.0

Inherited from

IncomingMessage.forEach

getMaxListeners()

getMaxListeners(): number

Defined in: node_modules/@types/node/events.d.ts:773

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

Returns

number

Since

v1.0.0

Inherited from

IncomingMessage.getMaxListeners

isPaused()

isPaused(): boolean

Defined in: node_modules/@types/node/stream.d.ts:326

The readable.isPaused() method returns the current operating state of the Readable. This is used primarily by the mechanism that underlies the readable.pipe() method. In most typical cases, there will be no reason to use this method directly.

const readable = new stream.Readable();

readable.isPaused(); // === false
readable.pause();
readable.isPaused(); // === true
readable.resume();
readable.isPaused(); // === false

Returns

boolean

Since

v0.11.14

Inherited from

IncomingMessage.isPaused

iterator()

iterator(options?): AsyncIterator<any>

Defined in: node_modules/@types/node/stream.d.ts:456

The iterator created by this method gives users the option to cancel the destruction of the stream if the for await...of loop is exited by return, break, or throw, or if the iterator should destroy the stream if the stream emitted an error during iteration.

Parameters

options?

destroyOnReturn?

boolean

When set to false, calling return on the async iterator, or exiting a for await...of iteration using a break, return, or throw will not destroy the stream. Default: true.

Returns

AsyncIterator<any>

Since

v16.3.0

Inherited from

IncomingMessage.iterator

listenerCount()

listenerCount<K>(eventName, listener?): number

Defined in: node_modules/@types/node/events.d.ts:867

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

K

K

Parameters

eventName

The name of the event being listened for

string | symbol

listener?

Function

The event handler function

Returns

number

Since

v3.2.0

Inherited from

IncomingMessage.listenerCount

listeners()

listeners<K>(eventName): Function[]

Defined in: node_modules/@types/node/events.d.ts:786

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

Type Parameters

K

K

Parameters

eventName

string | symbol

Returns

Function[]

Since

v0.1.26

Inherited from

IncomingMessage.listeners

map()

map(fn, options?): Readable

Defined in: node_modules/@types/node/stream.d.ts:464

This method allows mapping over the stream. The fn function will be called for every chunk in the stream. If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

Parameters

fn

(data, options?) => any

a function to map over every chunk in the stream. Async or not.

options?

ArrayOptions

Returns

Readable

a stream mapped with the function fn.

Since

v17.4.0, v16.14.0

Inherited from

IncomingMessage.map

off()

off<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:746

Alias for emitter.removeListener().

Type Parameters

K

K

Parameters

eventName

string | symbol

listener

(...args) => void

Returns

this

Since

v10.0.0

Inherited from

IncomingMessage.off

on()

Call Signature

on(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:656

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

Parameters

event

"close"

listener

() => void

The callback function

Returns

this

Since

v0.1.101

Inherited from

IncomingMessage.on

Call Signature

on(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:657

Parameters

event

"data"

listener

(chunk) => void

Returns

this

Inherited from

IncomingMessage.on

Call Signature

on(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:658

Parameters

event

"end"

listener

() => void

Returns

this

Inherited from

IncomingMessage.on

Call Signature

on(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:659

Parameters

event

"error"

listener

(err) => void

Returns

this

Inherited from

IncomingMessage.on

Call Signature

on(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:660

Parameters

event

"pause"

listener

() => void

Returns

this

Inherited from

IncomingMessage.on

Call Signature

on(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:661

Parameters

event

"readable"

listener

() => void

Returns

this

Inherited from

IncomingMessage.on

Call Signature

on(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:662

Parameters

event

"resume"

listener

() => void

Returns

this

Inherited from

IncomingMessage.on

Call Signature

on(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:663

Parameters

event

string | symbol

listener

(...args) => void

Returns

this

Inherited from

IncomingMessage.on

once()

Call Signature

once(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:664

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

Parameters

event

"close"

listener

() => void

The callback function

Returns

this

Since

v0.3.0

Inherited from

IncomingMessage.once

Call Signature

once(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:665

Parameters

event

"data"

listener

(chunk) => void

Returns

this

Inherited from

IncomingMessage.once

Call Signature

once(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:666

Parameters

event

"end"

listener

() => void

Returns

this

Inherited from

IncomingMessage.once

Call Signature

once(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:667

Parameters

event

"error"

listener

(err) => void

Returns

this

Inherited from

IncomingMessage.once

Call Signature

once(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:668

Parameters

event

"pause"

listener

() => void

Returns

this

Inherited from

IncomingMessage.once

Call Signature

once(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:669

Parameters

event

"readable"

listener

() => void

Returns

this

Inherited from

IncomingMessage.once

Call Signature

once(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:670

Parameters

event

"resume"

listener

() => void

Returns

this

Inherited from

IncomingMessage.once

Call Signature

once(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:671

Parameters

event

string | symbol

listener

(...args) => void

Returns

this

Inherited from

IncomingMessage.once

pause()

pause(): this

Defined in: node_modules/@types/node/stream.d.ts:290

The readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

const readable = getReadableStreamSomehow();
readable.on('data', (chunk) => {
  console.log(`Received ${chunk.length} bytes of data.`);
  readable.pause();
  console.log('There will be no additional data for 1 second.');
  setTimeout(() => {
    console.log('Now data will start flowing again.');
    readable.resume();
  }, 1000);
});

The readable.pause() method has no effect if there is a 'readable' event listener.

Returns

this

Since

v0.9.4

Inherited from

IncomingMessage.pause

pipe()

pipe<T>(destination, options?): T

Defined in: node_modules/@types/node/stream.d.ts:29

Type Parameters

T

T extends WritableStream

Parameters

destination

T

options?

end?

boolean

Returns

T

Inherited from

IncomingMessage.pipe

prependListener()

Call Signature

prependListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:672

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.

Parameters

event

"close"

listener

() => void

The callback function

Returns

this

Since

v6.0.0

Inherited from

IncomingMessage.prependListener

Call Signature

prependListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:673

Parameters

event

"data"

listener

(chunk) => void

Returns

this

Inherited from

IncomingMessage.prependListener

Call Signature

prependListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:674

Parameters

event

"end"

listener

() => void

Returns

this

Inherited from

IncomingMessage.prependListener

Call Signature

prependListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:675

Parameters

event

"error"

listener

(err) => void

Returns

this

Inherited from

IncomingMessage.prependListener

Call Signature

prependListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:676

Parameters

event

"pause"

listener

() => void

Returns

this

Inherited from

IncomingMessage.prependListener

Call Signature

prependListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:677

Parameters

event

"readable"

listener

() => void

Returns

this

Inherited from

IncomingMessage.prependListener

Call Signature

prependListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:678

Parameters

event

"resume"

listener

() => void

Returns

this

Inherited from

IncomingMessage.prependListener

Call Signature

prependListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:679

Parameters

event

string | symbol

listener

(...args) => void

Returns

this

Inherited from

IncomingMessage.prependListener

prependOnceListener()

Call Signature

prependOnceListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:680

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

event

"close"

listener

() => void

The callback function

Returns

this

Since

v6.0.0

Inherited from

IncomingMessage.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:681

Parameters

event

"data"

listener

(chunk) => void

Returns

this

Inherited from

IncomingMessage.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:682

Parameters

event

"end"

listener

() => void

Returns

this

Inherited from

IncomingMessage.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:683

Parameters

event

"error"

listener

(err) => void

Returns

this

Inherited from

IncomingMessage.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:684

Parameters

event

"pause"

listener

() => void

Returns

this

Inherited from

IncomingMessage.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:685

Parameters

event

"readable"

listener

() => void

Returns

this

Inherited from

IncomingMessage.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:686

Parameters

event

"resume"

listener

() => void

Returns

this

Inherited from

IncomingMessage.prependOnceListener

Call Signature

prependOnceListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:687

Parameters

event

string | symbol

listener

(...args) => void

Returns

this

Inherited from

IncomingMessage.prependOnceListener

push()

push(chunk, encoding?): boolean

Defined in: node_modules/@types/node/stream.d.ts:446

Parameters

chunk

any

encoding?

BufferEncoding

Returns

boolean

Inherited from

IncomingMessage.push

rawListeners()

rawListeners<K>(eventName): Function[]

Defined in: node_modules/@types/node/events.d.ts:817

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

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

K

K

Parameters

eventName

string | symbol

Returns

Function[]

Since

v9.4.0

Inherited from

IncomingMessage.rawListeners

read()

read(size?): any

Defined in: node_modules/@types/node/stream.d.ts:243

The readable.read() method reads data out of the internal buffer and returns it. If no data is available to be read, null is returned. By default, the data is returned as a Buffer object unless an encoding has been specified using the readable.setEncoding() method or the stream is operating in object mode.

The optional size argument specifies a specific number of bytes to read. If size bytes are not available to be read, null will be returned unless the stream has ended, in which case all of the data remaining in the internal buffer will be returned.

If the size argument is not specified, all of the data contained in the internal buffer will be returned.

The size argument must be less than or equal to 1 GiB.

The readable.read() method should only be called on Readable streams operating in paused mode. In flowing mode, readable.read() is called automatically until the internal buffer is fully drained.

const readable = getReadableStreamSomehow();

// 'readable' may be triggered multiple times as data is buffered in
readable.on('readable', () => {
  let chunk;
  console.log('Stream is readable (new data received in buffer)');
  // Use a loop to make sure we read all currently available data
  while (null !== (chunk = readable.read())) {
    console.log(`Read ${chunk.length} bytes of data...`);
  }
});

// 'end' will be triggered once when there is no more data available
readable.on('end', () => {
  console.log('Reached end of stream.');
});

Each call to readable.read() returns a chunk of data, or null. The chunks are not concatenated. A while loop is necessary to consume all data currently in the buffer. When reading a large file .read() may return null, having consumed all buffered content so far, but there is still more data to come not yet buffered. In this case a new 'readable' event will be emitted when there is more data in the buffer. Finally the 'end' event will be emitted when there is no more data to come.

Therefore to read a file's whole contents from a readable, it is necessary to collect chunks across multiple 'readable' events:

const chunks = [];

readable.on('readable', () => {
  let chunk;
  while (null !== (chunk = readable.read())) {
    chunks.push(chunk);
  }
});

readable.on('end', () => {
  const content = chunks.join('');
});

A Readable stream in object mode will always return a single item from a call to readable.read(size), regardless of the value of the size argument.

If the readable.read() method returns a chunk of data, a 'data' event will also be emitted.

Calling read after the 'end' event has been emitted will return null. No runtime error will be raised.

Parameters

size?

number

Optional argument to specify how much data to read.

Returns

any

Since

v0.9.4

Inherited from

IncomingMessage.read

reduce()

Call Signature

reduce<T>(fn, initial?, options?): Promise<T>

Defined in: node_modules/@types/node/stream.d.ts:595

This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

If no initial value is supplied the first chunk of the stream is used as the initial value. If the stream is empty, the promise is rejected with a TypeError with the ERR_INVALID_ARGS code property.

The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

Type Parameters

T

T = any

Parameters

fn

(previous, data, options?) => T

a reducer function to call over every chunk in the stream. Async or not.

initial?

undefined

the initial value to use in the reduction.

options?

Pick<ArrayOptions, "signal">

Returns

Promise<T>

a promise for the final value of the reduction.

Since

v17.5.0

Inherited from

IncomingMessage.reduce

Call Signature

reduce<T>(fn, initial, options?): Promise<T>

Defined in: node_modules/@types/node/stream.d.ts:600

This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

Type Parameters

T

T = any

Parameters

fn

(previous, data, options?) => T

a reducer function to call over every chunk in the stream. Async or not.

initial

T

the initial value to use in the reduction.

options?

Pick<ArrayOptions, "signal">

Returns

Promise<T>

a promise for the final value of the reduction.

Since

v17.5.0

Inherited from

IncomingMessage.reduce

removeAllListeners()

removeAllListeners(eventName?): this

Defined in: node_modules/@types/node/events.d.ts:757

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

eventName?

string | symbol

Returns

this

Since

v0.1.26

Inherited from

IncomingMessage.removeAllListeners

removeListener()

Call Signature

removeListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:688

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.

Parameters

event

"close"

listener

() => void

Returns

this

Since

v0.1.26

Inherited from

IncomingMessage.removeListener

Call Signature

removeListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:689

Parameters

event

"data"

listener

(chunk) => void

Returns

this

Inherited from

IncomingMessage.removeListener

Call Signature

removeListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:690

Parameters

event

"end"

listener

() => void

Returns

this

Inherited from

IncomingMessage.removeListener

Call Signature

removeListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:691

Parameters

event

"error"

listener

(err) => void

Returns

this

Inherited from

IncomingMessage.removeListener

Call Signature

removeListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:692

Parameters

event

"pause"

listener

() => void

Returns

this

Inherited from

IncomingMessage.removeListener

Call Signature

removeListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:693

Parameters

event

"readable"

listener

() => void

Returns

this

Inherited from

IncomingMessage.removeListener

Call Signature

removeListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:694

Parameters

event

"resume"

listener

() => void

Returns

this

Inherited from

IncomingMessage.removeListener

Call Signature

removeListener(event, listener): this

Defined in: node_modules/@types/node/stream.d.ts:695

Parameters

event

string | symbol

listener

(...args) => void

Returns

this

Inherited from

IncomingMessage.removeListener

resume()

resume(): this

Defined in: node_modules/@types/node/stream.d.ts:309

The readable.resume() method causes an explicitly paused Readable stream to resume emitting 'data' events, switching the stream into flowing mode.

The readable.resume() method can be used to fully consume the data from a stream without actually processing any of that data:

getReadableStreamSomehow()
  .resume()
  .on('end', () => {
    console.log('Reached the end, but did not read anything.');
  });

The readable.resume() method has no effect if there is a 'readable' event listener.

Returns

this

Since

v0.9.4

Inherited from

IncomingMessage.resume

setEncoding()

setEncoding(encoding): this

Defined in: node_modules/@types/node/stream.d.ts:268

The readable.setEncoding() method sets the character encoding for data read from the Readable stream.

By default, no encoding is assigned and stream data will be returned as Buffer objects. Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Buffer objects. For instance, calling readable.setEncoding('utf8') will cause the output data to be interpreted as UTF-8 data, and passed as strings. Calling readable.setEncoding('hex') will cause the data to be encoded in hexadecimal string format.

The Readable stream will properly handle multi-byte characters delivered through the stream that would otherwise become improperly decoded if simply pulled from the stream as Buffer objects.

const readable = getReadableStreamSomehow();
readable.setEncoding('utf8');
readable.on('data', (chunk) => {
  assert.equal(typeof chunk, 'string');
  console.log('Got %d characters of string data:', chunk.length);
});

Parameters

encoding

BufferEncoding

The encoding to use.

Returns

this

Since

v0.9.4

Inherited from

IncomingMessage.setEncoding

setMaxListeners()

setMaxListeners(n): this

Defined in: node_modules/@types/node/events.d.ts:767

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

Inherited from

IncomingMessage.setMaxListeners

setTimeout()

setTimeout(msecs, callback?): this

Defined in: node_modules/@types/node/http.d.ts:1350

Calls message.socket.setTimeout(msecs, callback).

Parameters

msecs

number

callback?

() => void

Returns

this

Since

v0.5.9

Inherited from

IncomingMessage.setTimeout

some()

some(fn, options?): Promise<boolean>

Defined in: node_modules/@types/node/stream.d.ts:514

This method is similar to Array.prototype.some and calls fn on each chunk in the stream until the awaited return value is true (or any truthy value). Once an fn call on a chunk awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

Parameters

fn

(data, options?) => boolean | Promise<boolean>

a function to call on each chunk of the stream. Async or not.

options?

ArrayOptions

Returns

Promise<boolean>

a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

Since

v17.5.0

Inherited from

IncomingMessage.some

take()

take(limit, options?): Readable

Defined in: node_modules/@types/node/stream.d.ts:573

This method returns a new stream with the first limit chunks.

Parameters

limit

number

the number of chunks to take from the readable.

options?

Pick<ArrayOptions, "signal">

Returns

Readable

a stream with limit chunks taken.

Since

v17.5.0

Inherited from

IncomingMessage.take

toArray()

toArray(options?): Promise<any[]>

Defined in: node_modules/@types/node/stream.d.ts:504

This method allows easily obtaining the contents of a stream.

As this method reads the entire stream into memory, it negates the benefits of streams. It's intended for interoperability and convenience, not as the primary way to consume streams.

Parameters

options?

Pick<ArrayOptions, "signal">

Returns

Promise<any[]>

a promise containing an array with the contents of the stream.

Since

v17.5.0

Inherited from

IncomingMessage.toArray

unpipe()

unpipe(destination?): this

Defined in: node_modules/@types/node/stream.d.ts:353

The readable.unpipe() method detaches a Writable stream previously attached using the pipe method.

If the destination is not specified, then all pipes are detached.

If the destination is specified, but no pipe is set up for it, then the method does nothing.

import fs from 'node:fs';
const readable = getReadableStreamSomehow();
const writable = fs.createWriteStream('file.txt');
// All the data from readable goes into 'file.txt',
// but only for the first second.
readable.pipe(writable);
setTimeout(() => {
  console.log('Stop writing to file.txt.');
  readable.unpipe(writable);
  console.log('Manually close the file stream.');
  writable.end();
}, 1000);

Parameters

destination?

WritableStream

Optional specific stream to unpipe

Returns

this

Since

v0.9.4

Inherited from

IncomingMessage.unpipe

unshift()

unshift(chunk, encoding?): void

Defined in: node_modules/@types/node/stream.d.ts:419

Passing chunk as null signals the end of the stream (EOF) and behaves the same as readable.push(null), after which no more data can be written. The EOF signal is put at the end of the buffer and any buffered data will still be flushed.

The readable.unshift() method pushes a chunk of data back into the internal buffer. This is useful in certain situations where a stream is being consumed by code that needs to "un-consume" some amount of data that it has optimistically pulled out of the source, so that the data can be passed on to some other party.

The stream.unshift(chunk) method cannot be called after the 'end' event has been emitted or a runtime error will be thrown.

Developers using stream.unshift() often should consider switching to use of a Transform stream instead. See the API for stream implementers section for more information.

// Pull off a header delimited by \n\n.
// Use unshift() if we get too much.
// Call the callback with (error, header, stream).
import { StringDecoder } from 'node:string_decoder';
function parseHeader(stream, callback) {
  stream.on('error', callback);
  stream.on('readable', onReadable);
  const decoder = new StringDecoder('utf8');
  let header = '';
  function onReadable() {
    let chunk;
    while (null !== (chunk = stream.read())) {
      const str = decoder.write(chunk);
      if (str.includes('\n\n')) {
        // Found the header boundary.
        const split = str.split(/\n\n/);
        header += split.shift();
        const remaining = split.join('\n\n');
        const buf = Buffer.from(remaining, 'utf8');
        stream.removeListener('error', callback);
        // Remove the 'readable' listener before unshifting.
        stream.removeListener('readable', onReadable);
        if (buf.length)
          stream.unshift(buf);
        // Now the body of the message can be read from the stream.
        callback(null, header, stream);
        return;
      }
      // Still reading the header.
      header += str;
    }
  }
}

Unlike push, stream.unshift(chunk) will not end the reading process by resetting the internal reading state of the stream. This can cause unexpected results if readable.unshift() is called during a read (i.e. from within a _read implementation on a custom stream). Following the call to readable.unshift() with an immediate push will reset the reading state appropriately, however it is best to simply avoid calling readable.unshift() while in the process of performing a read.

Parameters

chunk

any

Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray}, {DataView} or null. For object mode streams, chunk may be any JavaScript value.

encoding?

BufferEncoding

Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

Returns

void

Since

v0.9.11

Inherited from

IncomingMessage.unshift

wrap()

wrap(stream): this

Defined in: node_modules/@types/node/stream.d.ts:445

Prior to Node.js 0.10, streams did not implement the entire node:stream module API as it is currently defined. (See Compatibility for more information.)

When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, the readable.wrap() method can be used to create a Readable stream that uses the old stream as its data source.

It will rarely be necessary to use readable.wrap() but the method has been provided as a convenience for interacting with older Node.js applications and libraries.

import { OldReader } from './old-api-module.js';
import { Readable } from 'node:stream';
const oreader = new OldReader();
const myReader = new Readable().wrap(oreader);

myReader.on('readable', () => {
  myReader.read(); // etc.
});

Parameters

stream

ReadableStream

An "old style" readable stream

Returns

this

Since

v0.9.4

Inherited from

IncomingMessage.wrap

Interface: HttpRequest

Extends

Extended by

Indexable

Properties

~~aborted~~

Since

Deprecated

Inherited from

body

closed

Since

Inherited from

complete

Since

Inherited from

~~connection~~

Since

Deprecated

Inherited from

cookies?

destroyed

Since

Inherited from

errored

Since

Inherited from

files?

headers

Since

Overrides

headersDistinct

Since

Inherited from

httpVersion

Since

Inherited from

httpVersionMajor

Inherited from

httpVersionMinor

Inherited from

ip

method?

Since

Inherited from

params

path

query

rawHeaders

Since

Inherited from

rawTrailers

Since

Inherited from

readable

Since

Inherited from

readableAborted

Since

Inherited from

readableDidRead

Since

Inherited from

readableEncoding

Since

Inherited from

readableEnded

Since

Inherited from

readableFlowing

Since

Inherited from

readableHighWaterMark

Since

Inherited from

readableLength

Since

Inherited from

readableObjectMode

Since

aborted

connection