Class: ApiRequest
@sapphire/plugin-api.ApiRequest
Hierarchy
IncomingMessage
↳
ApiRequest
Constructors
constructor
• new ApiRequest(socket
)
Parameters
Name | Type |
---|---|
socket | Socket |
Inherited from
IncomingMessage.constructor
Defined in
node_modules/@types/node/http.d.ts:1050
Properties
aborted
• aborted: boolean
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
Defined in
node_modules/@types/node/http.d.ts:1057
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
closed
• Readonly
closed: boolean
Is true after 'close' has been emitted.
Since
v18.0.0
Inherited from
IncomingMessage.closed
Defined in
node_modules/@types/node/stream.d.ts:144
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:1092
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:1098
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:139
errored
• Readonly
errored: null
| Error
Returns error if the stream has been destroyed with an error.
Since
v18.0.0
Inherited from
IncomingMessage.errored
Defined in
node_modules/@types/node/stream.d.ts:149
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.getHeaders());
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
, oruser-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:1135
headersDistinct
• headersDistinct: Dict
<string
[]>
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
Defined in
node_modules/@types/node/http.d.ts:1149
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:1066
httpVersionMajor
• httpVersionMajor: number
Inherited from
IncomingMessage.httpVersionMajor
Defined in
node_modules/@types/node/http.d.ts:1067
httpVersionMinor
• httpVersionMinor: number
Inherited from
IncomingMessage.httpVersionMinor
Defined in
node_modules/@types/node/http.d.ts:1068
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:1203
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:1174
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:1191
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:95
readableAborted
• Readonly
readableAborted: boolean
Returns whether the stream was destroyed or errored before emitting 'end'
.
Since
v16.8.0
Inherited from
IncomingMessage.readableAborted
Defined in
node_modules/@types/node/stream.d.ts:89
readableDidRead
• Readonly
readableDidRead: boolean
Returns whether 'data'
has been emitted.
Since
v16.7.0, v14.18.0
Inherited from
IncomingMessage.readableDidRead
Defined in
node_modules/@types/node/stream.d.ts:101
readableEncoding
• Readonly
readableEncoding: null
| BufferEncoding
Getter for the property encoding
of a given Readable
stream. The encoding
property 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:106
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:111
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:117
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:122
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:129
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:134
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
or internally nulled.
Since
v0.3.0
Inherited from
IncomingMessage.socket
Defined in
node_modules/@types/node/http.d.ts:1110
statusCode
• Optional
statusCode: number
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
Defined in
node_modules/@types/node/http.d.ts:1250
statusMessage
• Optional
statusMessage: string
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
Defined in
node_modules/@types/node/http.d.ts:1257
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:1179
trailersDistinct
• trailersDistinct: Dict
<string
[]>
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
Defined in
node_modules/@types/node/http.d.ts:1185
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.getHeaders().host}`);
When request.url
is '/status?name=ryan'
andrequest.getHeaders().host
is 'localhost:3000'
:
$ node
> new URL(request.url, `http://${request.getHeaders().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:1243
captureRejectionSymbol
▪ Static
Readonly
captureRejectionSymbol: typeof captureRejectionSymbol
Inherited from
IncomingMessage.captureRejectionSymbol
Defined in
node_modules/@types/node/events.d.ts:357
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:362
defaultMaxListeners
▪ Static
defaultMaxListeners: number
Inherited from
IncomingMessage.defaultMaxListeners
Defined in
node_modules/@types/node/events.d.ts:363
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:356
Methods
[asyncIterator]
▸ [asyncIterator](): AsyncIterableIterator
<any
>
Returns
AsyncIterableIterator
<any
>
Inherited from
IncomingMessage.[asyncIterator]
Defined in
node_modules/@types/node/stream.d.ts:645
_construct
▸ Optional
_construct(callback
): void
Parameters
Name | Type |
---|---|
callback | (error? : null | Error ) => void |
Returns
void
Inherited from
IncomingMessage._construct
Defined in
node_modules/@types/node/stream.d.ts:151
_destroy
▸ _destroy(error
, callback
): void
Parameters
Name | Type |
---|---|
error | null | Error |
callback | (error? : null | Error ) => void |
Returns
void
Inherited from
IncomingMessage._destroy
Defined in
node_modules/@types/node/stream.d.ts:565
_read
▸ _read(size
): void
Parameters
Name | Type |
---|---|
size | number |
Returns
void
Inherited from
IncomingMessage._read
Defined in
node_modules/@types/node/stream.d.ts:152
addListener
▸ addListener(event
, listener
): ApiRequest
Event emitter The defined events on documents including:
- close
- data
- end
- error
- pause
- readable
- resume
Parameters
Name | Type |
---|---|
event | "close" |
listener | () => void |
Returns
Inherited from
IncomingMessage.addListener
Defined in
node_modules/@types/node/stream.d.ts:589
▸ addListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "data" |
listener | (chunk : any ) => void |
Returns
Inherited from
IncomingMessage.addListener
Defined in
node_modules/@types/node/stream.d.ts:590
▸ addListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "end" |
listener | () => void |
Returns
Inherited from
IncomingMessage.addListener
Defined in
node_modules/@types/node/stream.d.ts:591
▸ addListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
Returns
Inherited from
IncomingMessage.addListener
Defined in
node_modules/@types/node/stream.d.ts:592
▸ addListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "pause" |
listener | () => void |
Returns
Inherited from
IncomingMessage.addListener
Defined in
node_modules/@types/node/stream.d.ts:593
▸ addListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "readable" |
listener | () => void |
Returns
Inherited from
IncomingMessage.addListener
Defined in
node_modules/@types/node/stream.d.ts:594
▸ addListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "resume" |
listener | () => void |
Returns
Inherited from
IncomingMessage.addListener
Defined in
node_modules/@types/node/stream.d.ts:595
▸ addListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
Returns
Inherited from
IncomingMessage.addListener
Defined in
node_modules/@types/node/stream.d.ts:596
asIndexedPairs
▸ asIndexedPairs(options?
): Readable
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
Name | Type |
---|---|
options? | Pick <ArrayOptions , "signal" > |
Returns
Readable
a stream of indexed pairs.
Since
v17.5.0
Inherited from
IncomingMessage.asIndexedPairs
Defined in
node_modules/@types/node/stream.d.ts:548
compose
▸ compose<T
>(stream
, options?
): T
Type parameters
Name | Type |
---|---|
T | extends ReadableStream |
Parameters
Name | Type |
---|---|
stream | ComposeFnParam | T | Iterable <T > | AsyncIterable <T > |
options? | Object |
options.signal | AbortSignal |
Returns
T
Inherited from
IncomingMessage.compose
Defined in
node_modules/@types/node/stream.d.ts:35
destroy
▸ destroy(error?
): ApiRequest
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
Name | Type |
---|---|
error? | Error |
Returns
Since
v0.3.0
Inherited from
IncomingMessage.destroy
Defined in
node_modules/@types/node/http.d.ts:1263
drop
▸ drop(limit
, options?
): Readable
This method returns a new stream with the first limit chunks dropped from the start.
Parameters
Name | Type | Description |
---|---|---|
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
Defined in
node_modules/@types/node/stream.d.ts:534
emit
▸ emit(event
): boolean
Parameters
Name | Type |
---|---|
event | "close" |
Returns
boolean
Inherited from
IncomingMessage.emit
Defined in
node_modules/@types/node/stream.d.ts:597
▸ emit(event
, chunk
): boolean
Parameters
Name | Type |
---|---|
event | "data" |
chunk | any |
Returns
boolean
Inherited from
IncomingMessage.emit
Defined in
node_modules/@types/node/stream.d.ts:598
▸ emit(event
): boolean
Parameters
Name | Type |
---|---|
event | "end" |
Returns
boolean
Inherited from
IncomingMessage.emit
Defined in
node_modules/@types/node/stream.d.ts:599
▸ emit(event
, err
): boolean
Parameters
Name | Type |
---|---|
event | "error" |
err | Error |
Returns
boolean
Inherited from
IncomingMessage.emit
Defined in
node_modules/@types/node/stream.d.ts:600
▸ emit(event
): boolean
Parameters
Name | Type |
---|---|
event | "pause" |
Returns
boolean
Inherited from
IncomingMessage.emit
Defined in
node_modules/@types/node/stream.d.ts:601
▸ emit(event
): boolean
Parameters
Name | Type |
---|---|
event | "readable" |
Returns
boolean
Inherited from
IncomingMessage.emit
Defined in
node_modules/@types/node/stream.d.ts:602
▸ emit(event
): boolean
Parameters
Name | Type |
---|---|
event | "resume" |
Returns
boolean
Inherited from
IncomingMessage.emit
Defined in
node_modules/@types/node/stream.d.ts:603
▸ emit(event
, ...args
): boolean
Parameters
Name | Type |
---|---|
event | string | symbol |
...args | any [] |
Returns
boolean
Inherited from
IncomingMessage.emit
Defined in
node_modules/@types/node/stream.d.ts:604
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 Symbol
s.
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) ]
Returns
(string
| symbol
)[]
Since
v6.0.0
Inherited from
IncomingMessage.eventNames
Defined in
node_modules/@types/node/events.d.ts:702
every
▸ every(fn
, options?
): Promise
<boolean
>
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
await
ed 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
Name | Type | Description |
---|---|---|
fn | (data : any , options? : Pick <ArrayOptions , "signal" >) => 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
Defined in
node_modules/@types/node/stream.d.ts:516
filter
▸ filter(fn
, options?
): Readable
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 await
ed.
Parameters
Name | Type | Description |
---|---|---|
fn | (data : any , options? : Pick <ArrayOptions , "signal" >) => 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
Defined in
node_modules/@types/node/stream.d.ts:459
find
▸ find<T
>(fn
, options?
): Promise
<undefined
| T
>
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
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
fn | (data : any , options? : Pick <ArrayOptions , "signal" >) => 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
Defined in
node_modules/@types/node/stream.d.ts:505
▸ find(fn
, options?
): Promise
<any
>
Parameters
Name | Type |
---|---|
fn | (data : any , options? : Pick <ArrayOptions , "signal" >) => boolean | Promise <boolean > |
options? | ArrayOptions |
Returns
Promise
<any
>
Inherited from
IncomingMessage.find
Defined in
node_modules/@types/node/stream.d.ts:506
flatMap
▸ flatMap(fn
, options?
): Readable
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
Name | Type | Description |
---|---|---|
fn | (data : any , options? : Pick <ArrayOptions , "signal" >) => 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
Defined in
node_modules/@types/node/stream.d.ts:527
forEach
▸ forEach(fn
, options?
): Promise
<void
>
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 await
ed.
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
Name | Type | Description |
---|---|---|
fn | (data : any , options? : Pick <ArrayOptions , "signal" >) => 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
Defined in
node_modules/@types/node/stream.d.ts:475
getMaxListeners
▸ getMaxListeners(): number
Returns the current max listener value for the EventEmitter
which is either
set by emitter.setMaxListeners(n)
or defaults to defaultMaxListeners.
Returns
number
Since
v1.0.0
Inherited from
IncomingMessage.getMaxListeners
Defined in
node_modules/@types/node/events.d.ts:555
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
Returns
boolean
Since
v0.11.14
Inherited from
IncomingMessage.isPaused
Defined in
node_modules/@types/node/stream.d.ts:312
iterator
▸ iterator(options?
): AsyncIterableIterator
<any
>
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
Name | Type | Description |
---|---|---|
options? | Object | - |
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
AsyncIterableIterator
<any
>
Since
v16.3.0
Inherited from
IncomingMessage.iterator
Defined in
node_modules/@types/node/stream.d.ts:442
listenerCount
▸ listenerCount(eventName
, listener?
): number
Returns the number of listeners listening to 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
Name | Type | Description |
---|---|---|
eventName | string | symbol | The name of the event being listened for |
listener? | Function | The event handler function |
Returns
number
Since
v3.2.0
Inherited from
IncomingMessage.listenerCount
Defined in
node_modules/@types/node/events.d.ts:649
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] ]
Parameters
Name | Type |
---|---|
eventName | string | symbol |
Returns
Function
[]
Since
v0.1.26
Inherited from
IncomingMessage.listeners
Defined in
node_modules/@types/node/events.d.ts:568
map
▸ map(fn
, options?
): Readable
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 await
ed before being passed to the result stream.
Parameters
Name | Type | Description |
---|---|---|
fn | (data : any , options? : Pick <ArrayOptions , "signal" >) => 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
Defined in
node_modules/@types/node/stream.d.ts:450
off
▸ off(eventName
, listener
): ApiRequest
Alias for emitter.removeListener()
.
Parameters
Name | Type |
---|---|
eventName | string | symbol |
listener | (...args : any []) => void |
Returns
Since
v10.0.0
Inherited from
IncomingMessage.off
Defined in
node_modules/@types/node/events.d.ts:528
on
▸ on(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "close" |
listener | () => void |
Returns
Inherited from
IncomingMessage.on
Defined in
node_modules/@types/node/stream.d.ts:605
▸ on(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "data" |
listener | (chunk : any ) => void |
Returns
Inherited from
IncomingMessage.on
Defined in
node_modules/@types/node/stream.d.ts:606
▸ on(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "end" |
listener | () => void |
Returns
Inherited from
IncomingMessage.on
Defined in
node_modules/@types/node/stream.d.ts:607
▸ on(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
Returns
Inherited from
IncomingMessage.on
Defined in
node_modules/@types/node/stream.d.ts:608
▸ on(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "pause" |
listener | () => void |
Returns
Inherited from
IncomingMessage.on
Defined in
node_modules/@types/node/stream.d.ts:609
▸ on(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "readable" |
listener | () => void |
Returns
Inherited from
IncomingMessage.on
Defined in
node_modules/@types/node/stream.d.ts:610
▸ on(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "resume" |
listener | () => void |
Returns
Inherited from
IncomingMessage.on
Defined in
node_modules/@types/node/stream.d.ts:611
▸ on(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
Returns
Inherited from
IncomingMessage.on
Defined in
node_modules/@types/node/stream.d.ts:612
once
▸ once(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "close" |
listener | () => void |
Returns
Inherited from
IncomingMessage.once
Defined in
node_modules/@types/node/stream.d.ts:613
▸ once(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "data" |
listener | (chunk : any ) => void |
Returns
Inherited from
IncomingMessage.once
Defined in
node_modules/@types/node/stream.d.ts:614
▸ once(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "end" |
listener | () => void |
Returns
Inherited from
IncomingMessage.once
Defined in
node_modules/@types/node/stream.d.ts:615
▸ once(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
Returns
Inherited from
IncomingMessage.once
Defined in
node_modules/@types/node/stream.d.ts:616
▸ once(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "pause" |
listener | () => void |
Returns
Inherited from
IncomingMessage.once
Defined in
node_modules/@types/node/stream.d.ts:617
▸ once(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "readable" |
listener | () => void |
Returns
Inherited from
IncomingMessage.once
Defined in
node_modules/@types/node/stream.d.ts:618
▸ once(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "resume" |
listener | () => void |
Returns
Inherited from
IncomingMessage.once
Defined in
node_modules/@types/node/stream.d.ts:619
▸ once(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
Returns
Inherited from
IncomingMessage.once
Defined in
node_modules/@types/node/stream.d.ts:620
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.
Returns
Since
v0.9.4
Inherited from
IncomingMessage.pause
Defined in
node_modules/@types/node/stream.d.ts:276
pipe
▸ pipe<T
>(destination
, options?
): T
Type parameters
Name | Type |
---|---|
T | extends WritableStream |
Parameters
Name | Type |
---|---|
destination | T |
options? | Object |
options.end? | boolean |
Returns
T
Inherited from
IncomingMessage.pipe
Defined in
node_modules/@types/node/stream.d.ts:29
prependListener
▸ prependListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "close" |
listener | () => void |
Returns
Inherited from
IncomingMessage.prependListener
Defined in
node_modules/@types/node/stream.d.ts:621
▸ prependListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "data" |
listener | (chunk : any ) => void |
Returns
Inherited from
IncomingMessage.prependListener
Defined in
node_modules/@types/node/stream.d.ts:622
▸ prependListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "end" |
listener | () => void |
Returns
Inherited from
IncomingMessage.prependListener
Defined in
node_modules/@types/node/stream.d.ts:623
▸ prependListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
Returns
Inherited from
IncomingMessage.prependListener
Defined in
node_modules/@types/node/stream.d.ts:624
▸ prependListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "pause" |
listener | () => void |
Returns
Inherited from
IncomingMessage.prependListener
Defined in
node_modules/@types/node/stream.d.ts:625
▸ prependListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "readable" |
listener | () => void |
Returns
Inherited from
IncomingMessage.prependListener
Defined in
node_modules/@types/node/stream.d.ts:626
▸ prependListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "resume" |
listener | () => void |
Returns
Inherited from
IncomingMessage.prependListener
Defined in
node_modules/@types/node/stream.d.ts:627
▸ prependListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
Returns
Inherited from
IncomingMessage.prependListener
Defined in
node_modules/@types/node/stream.d.ts:628
prependOnceListener
▸ prependOnceListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "close" |
listener | () => void |
Returns
Inherited from
IncomingMessage.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:629
▸ prependOnceListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "data" |
listener | (chunk : any ) => void |
Returns
Inherited from
IncomingMessage.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:630
▸ prependOnceListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "end" |
listener | () => void |
Returns
Inherited from
IncomingMessage.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:631
▸ prependOnceListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
Returns
Inherited from
IncomingMessage.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:632
▸ prependOnceListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "pause" |
listener | () => void |
Returns
Inherited from
IncomingMessage.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:633
▸ prependOnceListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "readable" |
listener | () => void |
Returns
Inherited from
IncomingMessage.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:634
▸ prependOnceListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "resume" |
listener | () => void |
Returns
Inherited from
IncomingMessage.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:635
▸ prependOnceListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
Returns
Inherited from
IncomingMessage.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:636
push
▸ push(chunk
, encoding?
): boolean
Parameters
Name | Type |
---|---|
chunk | any |
encoding? | BufferEncoding |
Returns
boolean
Inherited from
IncomingMessage.push
Defined in
node_modules/@types/node/stream.d.ts:432
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');
Parameters
Name | Type |
---|---|
eventName | string | symbol |
Returns
Function
[]
Since
v9.4.0
Inherited from
IncomingMessage.rawListeners
Defined in
node_modules/@types/node/events.d.ts:598
read
▸ read(size?
): any
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
Name | Type | Description |
---|---|---|
size? | number | Optional argument to specify how much data to read. |
Returns
any
Since
v0.9.4
Inherited from
IncomingMessage.read
Defined in
node_modules/@types/node/stream.d.ts:229
reduce
▸ reduce<T
>(fn
, initial?
, options?
): Promise
<T
>
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
Name | Type |
---|---|
T | any |
Parameters
Name | Type | Description |
---|---|---|
fn | (previous : any , data : any , options? : Pick <ArrayOptions , "signal" >) => 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
Defined in
node_modules/@types/node/stream.d.ts:563
▸ reduce<T
>(fn
, initial
, options?
): Promise
<T
>
Type parameters
Name | Type |
---|---|
T | any |
Parameters
Name | Type |
---|---|
fn | (previous : T , data : any , options? : Pick <ArrayOptions , "signal" >) => T |
initial | T |
options? | Pick <ArrayOptions , "signal" > |
Returns
Promise
<T
>
Inherited from
IncomingMessage.reduce
Defined in
node_modules/@types/node/stream.d.ts:564
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.
Parameters
Name | Type |
---|---|
event? | string | symbol |
Returns
Since
v0.1.26
Inherited from
IncomingMessage.removeAllListeners
Defined in
node_modules/@types/node/events.d.ts:539
removeListener
▸ removeListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "close" |
listener | () => void |
Returns
Inherited from
IncomingMessage.removeListener
Defined in
node_modules/@types/node/stream.d.ts:637
▸ removeListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "data" |
listener | (chunk : any ) => void |
Returns
Inherited from
IncomingMessage.removeListener
Defined in
node_modules/@types/node/stream.d.ts:638
▸ removeListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "end" |
listener | () => void |
Returns
Inherited from
IncomingMessage.removeListener
Defined in
node_modules/@types/node/stream.d.ts:639
▸ removeListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
Returns
Inherited from
IncomingMessage.removeListener
Defined in
node_modules/@types/node/stream.d.ts:640
▸ removeListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "pause" |
listener | () => void |
Returns
Inherited from
IncomingMessage.removeListener
Defined in
node_modules/@types/node/stream.d.ts:641
▸ removeListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "readable" |
listener | () => void |
Returns
Inherited from
IncomingMessage.removeListener
Defined in
node_modules/@types/node/stream.d.ts:642
▸ removeListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | "resume" |
listener | () => void |
Returns
Inherited from
IncomingMessage.removeListener
Defined in
node_modules/@types/node/stream.d.ts:643
▸ removeListener(event
, listener
): ApiRequest
Parameters
Name | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
Returns
Inherited from
IncomingMessage.removeListener
Defined in
node_modules/@types/node/stream.d.ts:644
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.
Returns
Since
v0.9.4
Inherited from
IncomingMessage.resume
Defined in
node_modules/@types/node/stream.d.ts:295
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 Buffer
objects. 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
Name | Type | Description |
---|---|---|
encoding | BufferEncoding | The encoding to use. |
Returns
Since
v0.9.4
Inherited from
IncomingMessage.setEncoding
Defined in
node_modules/@types/node/stream.d.ts:254
setMaxListeners
▸ setMaxListeners(n
): ApiRequest
By default EventEmitter
s 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
Name | Type |
---|---|
n | number |
Returns
Since
v0.3.5
Inherited from
IncomingMessage.setMaxListeners
Defined in
node_modules/@types/node/events.d.ts:549
setTimeout
▸ setTimeout(msecs
, callback?
): ApiRequest
Calls message.socket.setTimeout(msecs, callback)
.
Parameters
Name | Type |
---|---|
msecs | number |
callback? | () => void |
Returns
Since
v0.5.9
Inherited from
IncomingMessage.setTimeout
Defined in
node_modules/@types/node/http.d.ts:1196
some
▸ some(fn
, options?
): Promise
<boolean
>
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
await
ed 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
Name | Type | Description |
---|---|---|
fn | (data : any , options? : Pick <ArrayOptions , "signal" >) => 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
Defined in
node_modules/@types/node/stream.d.ts:494
take
▸ take(limit
, options?
): Readable
This method returns a new stream with the first limit chunks.
Parameters
Name | Type | Description |
---|---|---|
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
Defined in
node_modules/@types/node/stream.d.ts:541
toArray
▸ toArray(options?
): Promise
<any
[]>
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
Name | Type |
---|---|
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
Defined in
node_modules/@types/node/stream.d.ts:484
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);
Parameters
Name | Type | Description |
---|---|---|
destination? | WritableStream | Optional specific stream to unpipe |
Returns
Since
v0.9.4
Inherited from
IncomingMessage.unpipe
Defined in
node_modules/@types/node/stream.d.ts:339
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.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
Name | Type | Description |
---|---|---|
chunk | any | 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. |
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
Defined in
node_modules/@types/node/stream.d.ts:405
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.
});
Parameters
Name | Type | Description |
---|---|---|
stream | ReadableStream | An "old style" readable stream |
Returns
Since
v0.9.4
Inherited from
IncomingMessage.wrap
Defined in
node_modules/@types/node/stream.d.ts:431
from
▸ Static
from(iterable
, options?
): Readable
A utility method for creating Readable Streams out of iterators.
Parameters
Name | Type |
---|---|
iterable | Iterable <any > | AsyncIterable <any > |
options? | ReadableOptions |
Returns
Readable
Inherited from
IncomingMessage.from
Defined in
node_modules/@types/node/stream.d.ts:66
fromWeb
▸ Static
fromWeb(readableStream
, options?
): Readable
A utility method for creating a Readable
from a web ReadableStream
.
Parameters
Name | Type |
---|---|
readableStream | ReadableStream <any > |
options? | Pick <ReadableOptions , "signal" | "encoding" | "highWaterMark" | "objectMode" > |
Returns
Readable
Since
v17.0.0
Inherited from
IncomingMessage.fromWeb
Defined in
node_modules/@types/node/stream.d.ts:72
getEventListeners
▸ Static
getEventListeners(emitter
, name
): Function
[]
Returns a copy of the array of listeners for the event named eventName
.
For EventEmitter
s this behaves exactly the same as calling .listeners
on
the emitter.
For EventTarget
s 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]
}
Parameters
Name | Type |
---|---|
emitter | EventEmitter | _DOMEventTarget |
name | string | symbol |
Returns
Function
[]
Since
v15.2.0, v14.17.0
Inherited from
IncomingMessage.getEventListeners
Defined in
node_modules/@types/node/events.d.ts:299
getMaxListeners
▸ Static
getMaxListeners(emitter
): number
Returns the currently set max amount of listeners.
For EventEmitter
s this behaves exactly the same as calling .getMaxListeners
on
the emitter.
For EventTarget
s this is the only way to get the max event listeners for the
event target. If the number of event handlers on a single EventTarget exceeds
the max set, the EventTarget will print a warning.
import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
console.log(getMaxListeners(ee)); // 10
setMaxListeners(11, ee);
console.log(getMaxListeners(ee)); // 11
}
{
const et = new EventTarget();
console.log(getMaxListeners(et)); // 10
setMaxListeners(11, et);
console.log(getMaxListeners(et)); // 11
}
Parameters
Name | Type |
---|---|
emitter | EventEmitter | _DOMEventTarget |
Returns
number
Since
v18.17.0
Inherited from
IncomingMessage.getMaxListeners
Defined in
node_modules/@types/node/events.d.ts:328
isDisturbed
▸ Static
isDisturbed(stream
): boolean
Returns whether the stream has been read from or cancelled.
Parameters
Name | Type |
---|---|
stream | ReadableStream | Readable |
Returns
boolean
Since
v16.8.0
Inherited from
IncomingMessage.isDisturbed
Defined in
node_modules/@types/node/stream.d.ts:77
listenerCount
▸ Static
listenerCount(emitter
, eventName
): number
A class method that returns the number of listeners for the given eventName
registered 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
Parameters
Name | Type | Description |
---|---|---|
emitter | EventEmitter | The emitter to query |
eventName | string | symbol | The event name |
Returns
number
Since
v0.9.12
Deprecated
Since v3.2.0 - Use listenerCount
instead.
Inherited from
IncomingMessage.listenerCount
Defined in
node_modules/@types/node/events.d.ts:271
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());
Parameters
Name | Type | Description |
---|---|---|
emitter | EventEmitter | - |
eventName | string | The name of the event being listened for |
options? | StaticEventEmitterOptions | - |
Returns
AsyncIterableIterator
<any
>
that iterates eventName
events emitted by the emitter
Since
v13.6.0, v12.16.0
Inherited from
IncomingMessage.on
Defined in
node_modules/@types/node/events.d.ts:254
▸ Static
on<E
, K
>(eventEmitter
, eventName
): AsyncIterableIterator
<E
extends Client
<boolean
> ? ClientEvents
[K
] : any
>
Type parameters
Name | Type |
---|---|
E | extends __module |
K | extends keyof ClientEvents |
Parameters
Name | Type |
---|---|
eventEmitter | E |
eventName | E extends Client <boolean > ? K : string |
Returns
AsyncIterableIterator
<E
extends Client
<boolean
> ? ClientEvents
[K
] : any
>
Inherited from
IncomingMessage.on
Defined in
node_modules/discord.js/typings/index.d.ts:241
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!
Parameters
Name | Type |
---|---|
emitter | _NodeEventTarget |
eventName | string | symbol |
options? | StaticEventEmitterOptions |
Returns
Promise
<any
[]>
Since
v11.13.0, v10.16.0
Inherited from
IncomingMessage.once
Defined in
node_modules/@types/node/events.d.ts:194
▸ Static
once(emitter
, eventName
, options?
): Promise
<any
[]>
Parameters
Name | Type |
---|---|
emitter | _DOMEventTarget |
eventName | string |
options? | StaticEventEmitterOptions |
Returns
Promise
<any
[]>
Inherited from
IncomingMessage.once
Defined in
node_modules/@types/node/events.d.ts:195
▸ Static
once<E
, K
>(eventEmitter
, eventName
): Promise
<E
extends Client
<boolean
> ? ClientEvents
[K
] : any
[]>
Type parameters
Name | Type |
---|---|
E | extends __module |
K | extends keyof ClientEvents |
Parameters
Name | Type |
---|---|
eventEmitter | E |
eventName | E extends Client <boolean > ? K : string |
Returns
Promise
<E
extends Client
<boolean
> ? ClientEvents
[K
] : any
[]>
Inherited from
IncomingMessage.once
Defined in
node_modules/discord.js/typings/index.d.ts:237
setMaxListeners
▸ Static
setMaxListeners(n?
, ...eventTargets
): void
const {
setMaxListeners,
EventEmitter
} = require('events');
const target = new EventTarget();
const emitter = new EventEmitter();
setMaxListeners(5, target, emitter);
Parameters
Name | Type | Description |
---|---|---|
n? | number | A non-negative number. The maximum number of listeners per EventTarget event. |
...eventTargets | (EventEmitter | _DOMEventTarget )[] | - |
Returns
void
Since
v15.4.0
Inherited from
IncomingMessage.setMaxListeners
Defined in
node_modules/@types/node/events.d.ts:346
toWeb
▸ Static
toWeb(streamReadable
): ReadableStream
<any
>
A utility method for creating a web ReadableStream
from a Readable
.
Parameters
Name | Type |
---|---|
streamReadable | Readable |
Returns
ReadableStream
<any
>
Since
v17.0.0
Inherited from
IncomingMessage.toWeb
Defined in
node_modules/@types/node/stream.d.ts:83