Skip to main content
Skip to main content

MedusaRequest

Properties​

abortedbooleanRequired
The message.aborted property will be true if the request has been aborted.
allowedPropertiesstring[]Required
closedbooleanRequired
Is true after 'close' has been emitted.
completebooleanRequired
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: js 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'); }); });
connectionSocketRequired
Alias for message.socket.
destroyedbooleanRequired
Is true after readable.destroy() has been called.
errorednull | ErrorRequired
Returns error if the stream has been destroyed with an error.
errorsstring[]Required
filterableFieldsRecord<string, unknown>Required
headersIncomingHttpHeadersRequired
The request/response headers object. Key-value pairs of header names and values. Header names are lower-cased. js // 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 , .
headersDistinctDict<string[]>Required
Similar to message.headers, but there is no join logic and the values are always arrays of strings, even for headers received just once. js // Prints something like: // // { 'user-agent': ['curl/7.22.0'], // host: ['127.0.0.1:8000'], // accept: ['*'] } console.log(request.headersDistinct);
httpVersionstringRequired
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 andmessage.httpVersionMinor is the second.
httpVersionMajornumberRequired
httpVersionMinornumberRequired
includesRecord<string, boolean>
listConfigFindConfig<unknown>Required
rawHeadersstring[]Required
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. js // 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);
rawTrailersstring[]Required
The raw request/response trailer keys and values exactly as they were received. Only populated at the 'end' event.
readablebooleanRequired
Is true if it is safe to call readable.read(), which means the stream has not been destroyed or emitted 'error' or 'end'.
readableAbortedbooleanRequired
Returns whether the stream was destroyed or errored before emitting 'end'.
readableDidReadbooleanRequired
Returns whether 'data' has been emitted.
readableEncodingnull | BufferEncodingRequired
Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.
readableEndedbooleanRequired
Becomes true when 'end' event is emitted.
readableFlowingnull | booleanRequired
This property reflects the current state of a Readable stream as described in the Three states section.
readableHighWaterMarknumberRequired
Returns the value of highWaterMark passed when creating this Readable.
readableLengthnumberRequired
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.
readableObjectModebooleanRequired
Getter for the property objectMode of a given Readable stream.
retrieveConfigFindConfig<unknown>Required
scopeMedusaContainerRequired
socketSocketRequired
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.
statusCodenumber
Only valid for response obtained from ClientRequest. The 3-digit HTTP response status code. E.G. 404.
statusMessagestring
Only valid for response obtained from ClientRequest. The HTTP response status message (reason phrase). E.G. OK or Internal Server Error.
trailersDict<string>Required
The request/response trailers object. Only populated at the 'end' event.
trailersDistinctDict<string[]>Required
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.
userObject
validatedBodyunknownRequired
validatedQueryRequestQueryFields & Record<string, unknown>Required

Methods​

[asyncDispose]​

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

Returns​

PromisePromise<void>Required

Since​

v20.4.0

[asyncIterator]​

Returns​

AsyncIterableIteratorAsyncIterableIterator<any>Required

[captureRejectionSymbol]​

Parameters​

errorErrorRequired
eventstringRequired
argsany[]Required

Returns​

voidvoid

_construct​

Parameters​

callback(error?: null | Error) => voidRequired

Returns​

voidvoid

_destroy​

Parameters​

errornull | ErrorRequired
callback(error?: null | Error) => voidRequired

Returns​

voidvoid

_read​

Parameters​

sizenumberRequired

Returns​

voidvoid

addListener​

**addListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Event emitter The defined events on documents including:

  1. close
  2. data
  3. end
  4. error
  5. pause
  6. readable
  7. resume

Parameters​

event"close"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**addListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"data"Required
listener(chunk: any) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**addListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"end"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**addListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"error"Required
listener(err: Error) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**addListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"pause"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**addListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"readable"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**addListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"resume"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**addListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

eventstring | symbolRequired
listener(...args: any[]) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

asIndexedPairs​

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​

optionsPick<ArrayOptions, "signal">

Returns​

ReadableReadableRequired
a stream of indexed pairs.

Since​

v17.5.0

compose​

Parameters​

streamT | ComposeFnParam | Iterable<T> | AsyncIterable<T>Required
optionsobject
options.signalAbortSignalRequired

Returns​

destroy​

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

Parameters​

errorError

Returns​

MedusaRequestMedusaRequestRequired

Since​

v0.3.0

drop​

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

Parameters​

limitnumberRequired
the number of chunks to drop from the readable.
optionsPick<ArrayOptions, "signal">

Returns​

ReadableReadableRequired
a stream with limit chunks dropped from the start.

Since​

v17.5.0

emit​

**emit**(event): boolean

Parameters​

event"close"Required

Returns​

booleanboolean

**emit**(event, chunk): boolean

Parameters​

event"data"Required
chunkanyRequired

Returns​

booleanboolean

**emit**(event): boolean

Parameters​

event"end"Required

Returns​

booleanboolean

**emit**(event, err): boolean

Parameters​

event"error"Required
errErrorRequired

Returns​

booleanboolean

**emit**(event): boolean

Parameters​

event"pause"Required

Returns​

booleanboolean

**emit**(event): boolean

Parameters​

event"readable"Required

Returns​

booleanboolean

**emit**(event): boolean

Parameters​

event"resume"Required

Returns​

booleanboolean

**emit**(event, ...args): boolean

Parameters​

eventstring | symbolRequired
argsany[]Required

Returns​

booleanboolean

eventNames​

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)[](string | symbol)[]Required

Since​

v6.0.0

every​

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: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>Required
a function to call on each chunk of the stream. Async or not.
optionsArrayOptions

Returns​

PromisePromise<boolean>Required
a promise evaluating to true if fn returned a truthy value for every one of the chunks.

Since​

v17.5.0

filter​

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: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>Required
a function to filter chunks from the stream. Async or not.
optionsArrayOptions

Returns​

ReadableReadableRequired
a stream filtered with the predicate fn.

Since​

v17.4.0, v16.14.0

find​

**find**<TypeParameter T>(fn, options?): Promise&#60;undefined \| T&#62;

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.

Parameters​

fn(data: any, options?: Pick<ArrayOptions, "signal">) => data is TRequired
a function to call on each chunk of the stream. Async or not.
optionsArrayOptions

Returns​

PromisePromise<undefined | T>Required
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

**find**(fn, options?): Promise&#60;any&#62;

Parameters​

fn(data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>Required
optionsArrayOptions

Returns​

PromisePromise<any>Required

flatMap​

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: any, options?: Pick<ArrayOptions, "signal">) => anyRequired
a function to map over every chunk in the stream. May be async. May be a stream or generator.
optionsArrayOptions

Returns​

ReadableReadableRequired
a stream flat-mapped with the function fn.

Since​

v17.5.0

forEach​

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: any, options?: Pick<ArrayOptions, "signal">) => void | Promise<void>Required
a function to call on each chunk of the stream. Async or not.
optionsArrayOptions

Returns​

PromisePromise<void>Required
a promise for when the stream has finished.

Since​

v17.5.0

getMaxListeners​

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

Returns​

numbernumber

Since​

v1.0.0

isPaused​

The readable.isPaused() method returns the current operating state of theReadable. This is used primarily by the mechanism that underlies thereadable.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​

booleanboolean

Since​

v0.11.14

iterator​

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​

optionsobject
options.destroyOnReturnboolean
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​

AsyncIterableIteratorAsyncIterableIterator<any>Required

Since​

v16.3.0

listenerCount​

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

Parameters​

eventNamestring | symbolRequired
The name of the event being listened for
listenerFunction
The event handler function

Returns​

numbernumber

Since​

v3.2.0

listeners​

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

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

Parameters​

eventNamestring | symbolRequired

Returns​

Function[]Function[]Required

Since​

v0.1.26

map​

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: any, options?: Pick<ArrayOptions, "signal">) => anyRequired
a function to map over every chunk in the stream. Async or not.
optionsArrayOptions

Returns​

ReadableReadableRequired
a stream mapped with the function fn.

Since​

v17.4.0, v16.14.0

off​

Alias for emitter.removeListener().

Parameters​

eventNamestring | symbolRequired
listener(...args: any[]) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

Since​

v10.0.0

on​

**on**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"close"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**on**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"data"Required
listener(chunk: any) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**on**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"end"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**on**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"error"Required
listener(err: Error) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**on**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"pause"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**on**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"readable"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**on**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"resume"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**on**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

eventstring | symbolRequired
listener(...args: any[]) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

once​

**once**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"close"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**once**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"data"Required
listener(chunk: any) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**once**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"end"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**once**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"error"Required
listener(err: Error) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**once**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"pause"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**once**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"readable"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**once**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"resume"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**once**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

eventstring | symbolRequired
listener(...args: any[]) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

pause​

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​

MedusaRequestMedusaRequestRequired

Since​

v0.9.4

pipe​

Parameters​

destinationTRequired
optionsobject
options.endboolean

Returns​

prependListener​

**prependListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"close"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**prependListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"data"Required
listener(chunk: any) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**prependListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"end"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**prependListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"error"Required
listener(err: Error) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**prependListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"pause"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**prependListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"readable"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**prependListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"resume"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**prependListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

eventstring | symbolRequired
listener(...args: any[]) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

prependOnceListener​

**prependOnceListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"close"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**prependOnceListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"data"Required
listener(chunk: any) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**prependOnceListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"end"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**prependOnceListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"error"Required
listener(err: Error) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**prependOnceListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"pause"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**prependOnceListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"readable"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**prependOnceListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"resume"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**prependOnceListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

eventstring | symbolRequired
listener(...args: any[]) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

push​

Parameters​

chunkanyRequired
encodingBufferEncoding

Returns​

booleanboolean

rawListeners​

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

Parameters​

eventNamestring | symbolRequired

Returns​

Function[]Function[]Required

Since​

v9.4.0

read​

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. Ifsize 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 thesize 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​

sizenumber
Optional argument to specify how much data to read.

Returns​

anyany

Since​

v0.9.4

reduce​

**reduce**<TypeParameter T>(fn, initial?, options?): Promise&#60;T&#62;

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.

Parameters​

fn(previous: any, data: any, options?: Pick<ArrayOptions, "signal">) => TRequired
a reducer function to call over every chunk in the stream. Async or not.
initialundefined
the initial value to use in the reduction.
optionsPick<ArrayOptions, "signal">

Returns​

PromisePromise<T>Required
a promise for the final value of the reduction.

Since​

v17.5.0

**reduce**<TypeParameter T>(fn, initial, options?): Promise&#60;T&#62;

Parameters​

fn(previous: T, data: any, options?: Pick<ArrayOptions, "signal">) => TRequired
initialTRequired
optionsPick<ArrayOptions, "signal">

Returns​

PromisePromise<T>Required

removeAllListeners​

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

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

Parameters​

eventstring | symbol

Returns​

MedusaRequestMedusaRequestRequired

Since​

v0.1.26

removeListener​

**removeListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"close"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**removeListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"data"Required
listener(chunk: any) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**removeListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"end"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**removeListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"error"Required
listener(err: Error) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**removeListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"pause"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**removeListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"readable"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**removeListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

event"resume"Required
listener() => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

**removeListener**(event, listener): [MedusaRequest](/references/js-client/internal/interfaces/internal.internal.MedusaRequest)

Parameters​

eventstring | symbolRequired
listener(...args: any[]) => voidRequired

Returns​

MedusaRequestMedusaRequestRequired

resume​

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​

MedusaRequestMedusaRequestRequired

Since​

v0.9.4

setEncoding​

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 asBuffer objects. Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Bufferobjects. For instance, calling readable.setEncoding('utf8') will cause the output data to be interpreted as UTF-8 data, and passed as strings. Callingreadable.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​

encodingBufferEncodingRequired
The encoding to use.

Returns​

MedusaRequestMedusaRequestRequired

Since​

v0.9.4

setMaxListeners​

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

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

Parameters​

nnumberRequired

Returns​

MedusaRequestMedusaRequestRequired

Since​

v0.3.5

setTimeout​

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

Parameters​

msecsnumberRequired
callback() => void

Returns​

MedusaRequestMedusaRequestRequired

Since​

v0.5.9

some​

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: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>Required
a function to call on each chunk of the stream. Async or not.
optionsArrayOptions

Returns​

PromisePromise<boolean>Required
a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

Since​

v17.5.0

take​

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

Parameters​

limitnumberRequired
the number of chunks to take from the readable.
optionsPick<ArrayOptions, "signal">

Returns​

ReadableReadableRequired
a stream with limit chunks taken.

Since​

v17.5.0

toArray​

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​

optionsPick<ArrayOptions, "signal">

Returns​

PromisePromise<any[]>Required
a promise containing an array with the contents of the stream.

Since​

v17.5.0

unpipe​

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.

const fs = require('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​

destinationWritableStream
Optional specific stream to unpipe

Returns​

MedusaRequestMedusaRequestRequired

Since​

v0.9.4

unshift​

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).
const { StringDecoder } = require('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​

chunkanyRequired
Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a string, Buffer, Uint8Array, or null. For object mode streams, chunk may be any JavaScript value.
encodingBufferEncoding
Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

Returns​

voidvoid

Since​

v0.9.11

wrap​

Prior to Node.js 0.10, streams did not implement the entire node:streammodule 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, thereadable.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.

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

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

Parameters​

streamReadableStreamRequired
An "old style" readable stream

Returns​

MedusaRequestMedusaRequestRequired

Since​

v0.9.4

Was this section helpful?
© 2023 Medusa, Inc. All rights reserved.