Skip to main content

Class: ApiRequest

@sapphire/plugin-api.ApiRequest

Hierarchy

  • IncomingMessage

    ↳ ApiRequest

Constructors

constructor

β€’ new ApiRequest(socket)

Parameters

NameType
socketSocket

Inherited from

IncomingMessage.constructor

Defined in

node_modules/@types/node/http.d.ts:760

Properties

aborted

β€’ aborted: boolean

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

since v10.1.0

Inherited from

IncomingMessage.aborted

Defined in

node_modules/@types/node/http.d.ts:766


auth

β€’ Optional auth: null | AuthData

The authorization information. This field indicates three possible values:

  • undefined: The authorization middleware has not been executed yet.
  • null: The user is not authorized.
  • AuthData: The user is authorized.

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiRequest.ts:27


body

β€’ Optional body: unknown

The body that was sent by the user.

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiRequest.ts:18


complete

β€’ complete: boolean

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

Defined in

node_modules/@types/node/http.d.ts:801


connection

β€’ connection: Socket

Alias for message.socket.

since v0.1.90

deprecated Since v16.0.0 - Use socket.

Inherited from

IncomingMessage.connection

Defined in

node_modules/@types/node/http.d.ts:807


destroyed

β€’ destroyed: boolean

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

since v8.0.0

Inherited from

IncomingMessage.destroyed

Defined in

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


headers

β€’ headers: IncomingHttpHeaders

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.
  • 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

Inherited from

IncomingMessage.headers

Defined in

node_modules/@types/node/http.d.ts:844


httpVersion

β€’ httpVersion: string

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.

since v0.1.1

Inherited from

IncomingMessage.httpVersion

Defined in

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


httpVersionMajor

β€’ httpVersionMajor: number

Inherited from

IncomingMessage.httpVersionMajor

Defined in

node_modules/@types/node/http.d.ts:776


httpVersionMinor

β€’ httpVersionMinor: number

Inherited from

IncomingMessage.httpVersionMinor

Defined in

node_modules/@types/node/http.d.ts:777


method

β€’ Optional method: string

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

Defined in

node_modules/@types/node/http.d.ts:892


params

β€’ params: Record<string, string> = {}

The URI parameters.

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiRequest.ts:13


query

β€’ query: Record<string, string | string[]> = {}

The query parameters.

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiRequest.ts:8


rawHeaders

β€’ rawHeaders: string[]

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

Defined in

node_modules/@types/node/http.d.ts:869


rawTrailers

β€’ rawTrailers: string[]

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

Defined in

node_modules/@types/node/http.d.ts:880


readable

β€’ readable: boolean

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

since v11.4.0

Inherited from

IncomingMessage.readable

Defined in

node_modules/@types/node/stream.d.ts:71


readableAborted

β€’ Readonly readableAborted: boolean

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

since v16.8.0

experimental

Inherited from

IncomingMessage.readableAborted

Defined in

node_modules/@types/node/stream.d.ts:65


readableDidRead

β€’ Readonly readableDidRead: boolean

Returns whether 'data' has been emitted.

since v16.7.0

experimental

Inherited from

IncomingMessage.readableDidRead

Defined in

node_modules/@types/node/stream.d.ts:77


readableEncoding

β€’ Readonly readableEncoding: null | BufferEncoding

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

since v12.7.0

Inherited from

IncomingMessage.readableEncoding

Defined in

node_modules/@types/node/stream.d.ts:82


readableEnded

β€’ Readonly readableEnded: boolean

Becomes true when 'end' event is emitted.

since v12.9.0

Inherited from

IncomingMessage.readableEnded

Defined in

node_modules/@types/node/stream.d.ts:87


readableFlowing

β€’ Readonly readableFlowing: null | boolean

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

Defined in

node_modules/@types/node/stream.d.ts:93


readableHighWaterMark

β€’ Readonly readableHighWaterMark: number

Returns the value of highWaterMark passed when creating this Readable.

since v9.3.0

Inherited from

IncomingMessage.readableHighWaterMark

Defined in

node_modules/@types/node/stream.d.ts:98


readableLength

β€’ Readonly readableLength: number

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

Defined in

node_modules/@types/node/stream.d.ts:105


readableObjectMode

β€’ Readonly readableObjectMode: boolean

Getter for the property objectMode of a given Readable stream.

since v12.3.0

Inherited from

IncomingMessage.readableObjectMode

Defined in

node_modules/@types/node/stream.d.ts:110


socket

β€’ socket: Socket

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.

since v0.3.0

Inherited from

IncomingMessage.socket

Defined in

node_modules/@types/node/http.d.ts:819


statusCode

β€’ Optional statusCode: number

Only valid for response obtained from {@link ClientRequest}.

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

since v0.1.1

Inherited from

IncomingMessage.statusCode

Defined in

node_modules/@types/node/http.d.ts:939


statusMessage

β€’ Optional statusMessage: string

Only valid for response obtained from {@link ClientRequest}.

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

since v0.11.10

Inherited from

IncomingMessage.statusMessage

Defined in

node_modules/@types/node/http.d.ts:946


trailers

β€’ trailers: Dict<string>

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

since v0.3.0

Inherited from

IncomingMessage.trailers

Defined in

node_modules/@types/node/http.d.ts:874


url

β€’ Optional url: string

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(request.url, `http://${request.headers.host}`);

When request.url is '/status?name=ryan' andrequest.headers.host is 'localhost:3000':

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

since v0.1.90

Inherited from

IncomingMessage.url

Defined in

node_modules/@types/node/http.d.ts:932


captureRejectionSymbol

β–ͺ Static Readonly captureRejectionSymbol: typeof captureRejectionSymbol

Inherited from

IncomingMessage.captureRejectionSymbol

Defined in

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


captureRejections

β–ͺ Static captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Inherited from

IncomingMessage.captureRejections

Defined in

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


defaultMaxListeners

β–ͺ Static defaultMaxListeners: number

Inherited from

IncomingMessage.defaultMaxListeners

Defined in

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


errorMonitor

β–ͺ Static Readonly errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Inherited from

IncomingMessage.errorMonitor

Defined in

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

Methods

[asyncIterator]

β–Έ [asyncIterator](): AsyncIterableIterator<any>

Returns

AsyncIterableIterator<any>

Inherited from

IncomingMessage.__@asyncIterator@867101

Defined in

node_modules/@types/node/stream.d.ts:479


_construct

β–Έ Optional _construct(callback): void

Parameters

NameType
callback(error?: null | Error) => void

Returns

void

Inherited from

IncomingMessage._construct

Defined in

node_modules/@types/node/stream.d.ts:117


_destroy

β–Έ _destroy(error, callback): void

Parameters

NameType
errornull | Error
callback(error?: null | Error) => void

Returns

void

Inherited from

IncomingMessage._destroy

Defined in

node_modules/@types/node/stream.d.ts:399


_read

β–Έ _read(size): void

Parameters

NameType
sizenumber

Returns

void

Inherited from

IncomingMessage._read

Defined in

node_modules/@types/node/stream.d.ts:118


addListener

β–Έ addListener(event, listener): ApiRequest

Event emitter The defined events on documents including:

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

Parameters

NameType
event"close"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.addListener

Defined in

node_modules/@types/node/stream.d.ts:423

β–Έ addListener(event, listener): ApiRequest

Parameters

NameType
event"data"
listener(chunk: any) => void

Returns

ApiRequest

Inherited from

IncomingMessage.addListener

Defined in

node_modules/@types/node/stream.d.ts:424

β–Έ addListener(event, listener): ApiRequest

Parameters

NameType
event"end"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.addListener

Defined in

node_modules/@types/node/stream.d.ts:425

β–Έ addListener(event, listener): ApiRequest

Parameters

NameType
event"error"
listener(err: Error) => void

Returns

ApiRequest

Inherited from

IncomingMessage.addListener

Defined in

node_modules/@types/node/stream.d.ts:426

β–Έ addListener(event, listener): ApiRequest

Parameters

NameType
event"pause"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.addListener

Defined in

node_modules/@types/node/stream.d.ts:427

β–Έ addListener(event, listener): ApiRequest

Parameters

NameType
event"readable"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.addListener

Defined in

node_modules/@types/node/stream.d.ts:428

β–Έ addListener(event, listener): ApiRequest

Parameters

NameType
event"resume"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.addListener

Defined in

node_modules/@types/node/stream.d.ts:429

β–Έ addListener(event, listener): ApiRequest

Parameters

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns

ApiRequest

Inherited from

IncomingMessage.addListener

Defined in

node_modules/@types/node/stream.d.ts:430


destroy

β–Έ destroy(error?): void

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.

since v0.3.0

Parameters

NameType
error?Error

Returns

void

Inherited from

IncomingMessage.destroy

Defined in

node_modules/@types/node/http.d.ts:952


emit

β–Έ emit(event): boolean

Parameters

NameType
event"close"

Returns

boolean

Inherited from

IncomingMessage.emit

Defined in

node_modules/@types/node/stream.d.ts:431

β–Έ emit(event, chunk): boolean

Parameters

NameType
event"data"
chunkany

Returns

boolean

Inherited from

IncomingMessage.emit

Defined in

node_modules/@types/node/stream.d.ts:432

β–Έ emit(event): boolean

Parameters

NameType
event"end"

Returns

boolean

Inherited from

IncomingMessage.emit

Defined in

node_modules/@types/node/stream.d.ts:433

β–Έ emit(event, err): boolean

Parameters

NameType
event"error"
errError

Returns

boolean

Inherited from

IncomingMessage.emit

Defined in

node_modules/@types/node/stream.d.ts:434

β–Έ emit(event): boolean

Parameters

NameType
event"pause"

Returns

boolean

Inherited from

IncomingMessage.emit

Defined in

node_modules/@types/node/stream.d.ts:435

β–Έ emit(event): boolean

Parameters

NameType
event"readable"

Returns

boolean

Inherited from

IncomingMessage.emit

Defined in

node_modules/@types/node/stream.d.ts:436

β–Έ emit(event): boolean

Parameters

NameType
event"resume"

Returns

boolean

Inherited from

IncomingMessage.emit

Defined in

node_modules/@types/node/stream.d.ts:437

β–Έ emit(event, ...args): boolean

Parameters

NameType
eventstring | symbol
...argsany[]

Returns

boolean

Inherited from

IncomingMessage.emit

Defined in

node_modules/@types/node/stream.d.ts:438


eventNames

β–Έ eventNames(): (string | symbol)[]

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

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

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

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

since v6.0.0

Returns

(string | symbol)[]

Inherited from

IncomingMessage.eventNames

Defined in

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


getMaxListeners

β–Έ getMaxListeners(): number

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

since v1.0.0

Returns

number

Inherited from

IncomingMessage.getMaxListeners

Defined in

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


isPaused

β–Έ isPaused(): boolean

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

since v0.11.14

Returns

boolean

Inherited from

IncomingMessage.isPaused

Defined in

node_modules/@types/node/stream.d.ts:278


listenerCount

β–Έ listenerCount(eventName): number

Returns the number of listeners listening to the event named eventName.

since v3.2.0

Parameters

NameTypeDescription
eventNamestring | symbolThe name of the event being listened for

Returns

number

Inherited from

IncomingMessage.listenerCount

Defined in

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


listeners

β–Έ listeners(eventName): Function[]

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

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

since v0.1.26

Parameters

NameType
eventNamestring | symbol

Returns

Function[]

Inherited from

IncomingMessage.listeners

Defined in

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


off

β–Έ off(eventName, listener): ApiRequest

Alias for emitter.removeListener().

since v10.0.0

Parameters

NameType
eventNamestring | symbol
listener(...args: any[]) => void

Returns

ApiRequest

Inherited from

IncomingMessage.off

Defined in

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


on

β–Έ on(event, listener): ApiRequest

Parameters

NameType
event"close"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.on

Defined in

node_modules/@types/node/stream.d.ts:439

β–Έ on(event, listener): ApiRequest

Parameters

NameType
event"data"
listener(chunk: any) => void

Returns

ApiRequest

Inherited from

IncomingMessage.on

Defined in

node_modules/@types/node/stream.d.ts:440

β–Έ on(event, listener): ApiRequest

Parameters

NameType
event"end"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.on

Defined in

node_modules/@types/node/stream.d.ts:441

β–Έ on(event, listener): ApiRequest

Parameters

NameType
event"error"
listener(err: Error) => void

Returns

ApiRequest

Inherited from

IncomingMessage.on

Defined in

node_modules/@types/node/stream.d.ts:442

β–Έ on(event, listener): ApiRequest

Parameters

NameType
event"pause"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.on

Defined in

node_modules/@types/node/stream.d.ts:443

β–Έ on(event, listener): ApiRequest

Parameters

NameType
event"readable"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.on

Defined in

node_modules/@types/node/stream.d.ts:444

β–Έ on(event, listener): ApiRequest

Parameters

NameType
event"resume"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.on

Defined in

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

β–Έ on(event, listener): ApiRequest

Parameters

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns

ApiRequest

Inherited from

IncomingMessage.on

Defined in

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


once

β–Έ once(event, listener): ApiRequest

Parameters

NameType
event"close"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.once

Defined in

node_modules/@types/node/stream.d.ts:447

β–Έ once(event, listener): ApiRequest

Parameters

NameType
event"data"
listener(chunk: any) => void

Returns

ApiRequest

Inherited from

IncomingMessage.once

Defined in

node_modules/@types/node/stream.d.ts:448

β–Έ once(event, listener): ApiRequest

Parameters

NameType
event"end"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.once

Defined in

node_modules/@types/node/stream.d.ts:449

β–Έ once(event, listener): ApiRequest

Parameters

NameType
event"error"
listener(err: Error) => void

Returns

ApiRequest

Inherited from

IncomingMessage.once

Defined in

node_modules/@types/node/stream.d.ts:450

β–Έ once(event, listener): ApiRequest

Parameters

NameType
event"pause"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.once

Defined in

node_modules/@types/node/stream.d.ts:451

β–Έ once(event, listener): ApiRequest

Parameters

NameType
event"readable"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.once

Defined in

node_modules/@types/node/stream.d.ts:452

β–Έ once(event, listener): ApiRequest

Parameters

NameType
event"resume"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.once

Defined in

node_modules/@types/node/stream.d.ts:453

β–Έ once(event, listener): ApiRequest

Parameters

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns

ApiRequest

Inherited from

IncomingMessage.once

Defined in

node_modules/@types/node/stream.d.ts:454


pause

β–Έ pause(): ApiRequest

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.

since v0.9.4

Returns

ApiRequest

Inherited from

IncomingMessage.pause

Defined in

node_modules/@types/node/stream.d.ts:242


pipe

β–Έ pipe<T>(destination, options?): T

Type parameters

NameType
Textends WritableStream<T>

Parameters

NameType
destinationT
options?Object
options.end?boolean

Returns

T

Inherited from

IncomingMessage.pipe

Defined in

node_modules/@types/node/stream.d.ts:24


prependListener

β–Έ prependListener(event, listener): ApiRequest

Parameters

NameType
event"close"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependListener

Defined in

node_modules/@types/node/stream.d.ts:455

β–Έ prependListener(event, listener): ApiRequest

Parameters

NameType
event"data"
listener(chunk: any) => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependListener

Defined in

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

β–Έ prependListener(event, listener): ApiRequest

Parameters

NameType
event"end"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependListener

Defined in

node_modules/@types/node/stream.d.ts:457

β–Έ prependListener(event, listener): ApiRequest

Parameters

NameType
event"error"
listener(err: Error) => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependListener

Defined in

node_modules/@types/node/stream.d.ts:458

β–Έ prependListener(event, listener): ApiRequest

Parameters

NameType
event"pause"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependListener

Defined in

node_modules/@types/node/stream.d.ts:459

β–Έ prependListener(event, listener): ApiRequest

Parameters

NameType
event"readable"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependListener

Defined in

node_modules/@types/node/stream.d.ts:460

β–Έ prependListener(event, listener): ApiRequest

Parameters

NameType
event"resume"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependListener

Defined in

node_modules/@types/node/stream.d.ts:461

β–Έ prependListener(event, listener): ApiRequest

Parameters

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependListener

Defined in

node_modules/@types/node/stream.d.ts:462


prependOnceListener

β–Έ prependOnceListener(event, listener): ApiRequest

Parameters

NameType
event"close"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependOnceListener

Defined in

node_modules/@types/node/stream.d.ts:463

β–Έ prependOnceListener(event, listener): ApiRequest

Parameters

NameType
event"data"
listener(chunk: any) => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependOnceListener

Defined in

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

β–Έ prependOnceListener(event, listener): ApiRequest

Parameters

NameType
event"end"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependOnceListener

Defined in

node_modules/@types/node/stream.d.ts:465

β–Έ prependOnceListener(event, listener): ApiRequest

Parameters

NameType
event"error"
listener(err: Error) => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependOnceListener

Defined in

node_modules/@types/node/stream.d.ts:466

β–Έ prependOnceListener(event, listener): ApiRequest

Parameters

NameType
event"pause"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependOnceListener

Defined in

node_modules/@types/node/stream.d.ts:467

β–Έ prependOnceListener(event, listener): ApiRequest

Parameters

NameType
event"readable"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependOnceListener

Defined in

node_modules/@types/node/stream.d.ts:468

β–Έ prependOnceListener(event, listener): ApiRequest

Parameters

NameType
event"resume"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependOnceListener

Defined in

node_modules/@types/node/stream.d.ts:469

β–Έ prependOnceListener(event, listener): ApiRequest

Parameters

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns

ApiRequest

Inherited from

IncomingMessage.prependOnceListener

Defined in

node_modules/@types/node/stream.d.ts:470


push

β–Έ push(chunk, encoding?): boolean

Parameters

NameType
chunkany
encoding?BufferEncoding

Returns

boolean

Inherited from

IncomingMessage.push

Defined in

node_modules/@types/node/stream.d.ts:398


rawListeners

β–Έ rawListeners(eventName): Function[]

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

const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

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

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

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

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

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

since v9.4.0

Parameters

NameType
eventNamestring | symbol

Returns

Function[]

Inherited from

IncomingMessage.rawListeners

Defined in

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


read

β–Έ read(size?): any

The readable.read() method pulls some data out of the internal buffer and returns it. If no data available to be read, null is returned. By default, the data will be 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.

since v0.9.4

Parameters

NameTypeDescription
size?numberOptional argument to specify how much data to read.

Returns

any

Inherited from

IncomingMessage.read

Defined in

node_modules/@types/node/stream.d.ts:195


removeAllListeners

β–Έ removeAllListeners(event?): ApiRequest

Removes all listeners, or those of the specified eventName.

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

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

since v0.1.26

Parameters

NameType
event?string | symbol

Returns

ApiRequest

Inherited from

IncomingMessage.removeAllListeners

Defined in

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


removeListener

β–Έ removeListener(event, listener): ApiRequest

Parameters

NameType
event"close"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.removeListener

Defined in

node_modules/@types/node/stream.d.ts:471

β–Έ removeListener(event, listener): ApiRequest

Parameters

NameType
event"data"
listener(chunk: any) => void

Returns

ApiRequest

Inherited from

IncomingMessage.removeListener

Defined in

node_modules/@types/node/stream.d.ts:472

β–Έ removeListener(event, listener): ApiRequest

Parameters

NameType
event"end"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.removeListener

Defined in

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

β–Έ removeListener(event, listener): ApiRequest

Parameters

NameType
event"error"
listener(err: Error) => void

Returns

ApiRequest

Inherited from

IncomingMessage.removeListener

Defined in

node_modules/@types/node/stream.d.ts:474

β–Έ removeListener(event, listener): ApiRequest

Parameters

NameType
event"pause"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.removeListener

Defined in

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

β–Έ removeListener(event, listener): ApiRequest

Parameters

NameType
event"readable"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.removeListener

Defined in

node_modules/@types/node/stream.d.ts:476

β–Έ removeListener(event, listener): ApiRequest

Parameters

NameType
event"resume"
listener() => void

Returns

ApiRequest

Inherited from

IncomingMessage.removeListener

Defined in

node_modules/@types/node/stream.d.ts:477

β–Έ removeListener(event, listener): ApiRequest

Parameters

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns

ApiRequest

Inherited from

IncomingMessage.removeListener

Defined in

node_modules/@types/node/stream.d.ts:478


resume

β–Έ resume(): ApiRequest

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.

since v0.9.4

Returns

ApiRequest

Inherited from

IncomingMessage.resume

Defined in

node_modules/@types/node/stream.d.ts:261


setEncoding

β–Έ setEncoding(encoding): ApiRequest

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

since v0.9.4

Parameters

NameTypeDescription
encodingBufferEncodingThe encoding to use.

Returns

ApiRequest

Inherited from

IncomingMessage.setEncoding

Defined in

node_modules/@types/node/stream.d.ts:220


setMaxListeners

β–Έ setMaxListeners(n): ApiRequest

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.

since v0.3.5

Parameters

NameType
nnumber

Returns

ApiRequest

Inherited from

IncomingMessage.setMaxListeners

Defined in

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


setTimeout

β–Έ setTimeout(msecs, callback?): ApiRequest

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

since v0.5.9

Parameters

NameType
msecsnumber
callback?() => void

Returns

ApiRequest

Inherited from

IncomingMessage.setTimeout

Defined in

node_modules/@types/node/http.d.ts:885


unpipe

β–Έ unpipe(destination?): ApiRequest

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

since v0.9.4

Parameters

NameTypeDescription
destination?WritableStreamOptional specific stream to unpipe

Returns

ApiRequest

Inherited from

IncomingMessage.unpipe

Defined in

node_modules/@types/node/stream.d.ts:305


unshift

β–Έ unshift(chunk, encoding?): void

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('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.match(/\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);
} else {
// 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.

since v0.9.11

Parameters

NameTypeDescription
chunkanyChunk 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.
encoding?BufferEncodingEncoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

Returns

void

Inherited from

IncomingMessage.unshift

Defined in

node_modules/@types/node/stream.d.ts:371


wrap

β–Έ wrap(stream): ApiRequest

Prior to Node.js 0.10, streams did not implement the entire 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, 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('stream');
const oreader = new OldReader();
const myReader = new Readable().wrap(oreader);

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

since v0.9.4

Parameters

NameTypeDescription
streamReadableStreamAn "old style" readable stream

Returns

ApiRequest

Inherited from

IncomingMessage.wrap

Defined in

node_modules/@types/node/stream.d.ts:397


from

β–Έ Static from(iterable, options?): Readable

A utility method for creating Readable Streams out of iterators.

Parameters

NameType
iterableIterable<any> | AsyncIterable<any>
options?ReadableOptions

Returns

Readable

Inherited from

IncomingMessage.from

Defined in

node_modules/@types/node/stream.d.ts:54


getEventListeners

β–Έ Static getEventListeners(emitter, name): Function[]

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

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

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

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

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

since v15.2.0

Parameters

NameType
emitterDOMEventTarget | EventEmitter
namestring | symbol

Returns

Function[]

Inherited from

IncomingMessage.getEventListeners

Defined in

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


isDisturbed

β–Έ Static isDisturbed(stream): boolean

Returns whether the stream has been read from or cancelled.

since v16.8.0

Parameters

NameType
streamReadable | ReadableStream

Returns

boolean

Inherited from

IncomingMessage.isDisturbed

Defined in

node_modules/@types/node/stream.d.ts:59


listenerCount

β–Έ Static listenerCount(emitter, eventName): number

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

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

since v0.9.12

deprecated Since v3.2.0 - Use listenerCount instead.

Parameters

NameTypeDescription
emitterEventEmitterThe emitter to query
eventNamestring | symbolThe event name

Returns

number

Inherited from

IncomingMessage.listenerCount

Defined in

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


on

β–Έ Static on(emitter, eventName, options?): AsyncIterableIterator<any>

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

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

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

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

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

An AbortSignal can be used to cancel waiting on events:

const { on, EventEmitter } = require('events');
const ac = new AbortController();

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

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

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

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

since v13.6.0, v12.16.0

Parameters

NameTypeDescription
emitterEventEmitter-
eventNamestringThe name of the event being listened for
options?StaticEventEmitterOptions-

Returns

AsyncIterableIterator<any>

that iterates eventName events emitted by the emitter

Inherited from

IncomingMessage.on

Defined in

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


once

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

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

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

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

async function run() {
const ee = new EventEmitter();

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

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

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

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

run();

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

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

const ee = new EventEmitter();

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

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

// Prints: ok boom

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

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

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

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

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

since v11.13.0, v10.16.0

Parameters

NameType
emitterNodeEventTarget
eventNamestring | symbol
options?StaticEventEmitterOptions

Returns

Promise<any[]>

Inherited from

IncomingMessage.once

Defined in

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

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

Parameters

NameType
emitterDOMEventTarget
eventNamestring
options?StaticEventEmitterOptions

Returns

Promise<any[]>

Inherited from

IncomingMessage.once

Defined in

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