-
Notifications
You must be signed in to change notification settings - Fork 0
@ralphschuler.ai function caller.index.<internal>.ClientRequest
index.<internal>.ClientRequest
This object is created internally and returned from request. It
represents an in-progress request whose header has already been queued. The
header is still mutable using the setHeader(name, value),getHeader(name), removeHeader(name) API. The actual header will
be sent along with the first data chunk or when calling request.end().
To get the response, add a listener for 'response' to the request object.'response' will be emitted from the request object when the response
headers have been received. The 'response' event is executed with one
argument which is an instance of IncomingMessage.
During the 'response' event, one can add listeners to the
response object; particularly to listen for the 'data' event.
If no 'response' handler is added, then the response will be
entirely discarded. However, if a 'response' event handler is added,
then the data from the response object must be consumed, either by
calling response.read() whenever there is a 'readable' event, or
by adding a 'data' handler, or by calling the .resume() method.
Until the data is consumed, the 'end' event will not fire. Also, until
the data is read it will consume memory that can eventually lead to a
'process out of memory' error.
For backward compatibility, res will only emit 'error' if there is an'error' listener registered.
Set Content-Length header to limit the response body size.
If response.strictContentLength is set to true, mismatching theContent-Length header value will result in an Error being thrown,
identified by code:``'ERR_HTTP_CONTENT_LENGTH_MISMATCH'.
Content-Length value should be in bytes, not characters. Use Buffer.byteLength() to determine the length of the body in bytes.
Since
v0.1.17
-
↳
ClientRequest
- aborted
- chunkedEncoding
- closed
- connection
- destroyed
- errored
- finished
- headersSent
- host
- maxHeadersCount
- method
- path
- protocol
- req
- reusedSocket
- sendDate
- shouldKeepAlive
- socket
- useChunkedEncodingByDefault
- writable
- writableCorked
- writableEnded
- writableFinished
- writableHighWaterMark
- writableLength
- writableNeedDrain
- writableObjectMode
- captureRejectionSymbol
- captureRejections
- defaultMaxListeners
- errorMonitor
- [captureRejectionSymbol]
- _construct
- _destroy
- _final
- _write
- _writev
- abort
- addListener
- addTrailers
- appendHeader
- compose
- cork
- destroy
- emit
- end
- eventNames
- flushHeaders
- getHeader
- getHeaderNames
- getHeaders
- getMaxListeners
- getRawHeaderNames
- hasHeader
- listenerCount
- listeners
- off
- on
- onSocket
- once
- pipe
- prependListener
- prependOnceListener
- rawListeners
- removeAllListeners
- removeHeader
- removeListener
- setDefaultEncoding
- setHeader
- setMaxListeners
- setNoDelay
- setSocketKeepAlive
- setTimeout
- uncork
- write
- addAbortListener
- fromWeb
- getEventListeners
- getMaxListeners
- listenerCount
- on
- once
- setMaxListeners
- toWeb
• new ClientRequest(url, cb?): ClientRequest
| Name | Type |
|---|---|
url |
string | URL | ClientRequestArgs
|
cb? |
(res: IncomingMessage) => void
|
node_modules/@types/node/http.d.ts:965
• aborted: boolean
The request.aborted property will be true if the request has
been aborted.
Since
v0.11.14
Deprecated
Since v17.0.0,v16.12.0 - Check destroyed instead.
node_modules/@types/node/http.d.ts:899
• chunkedEncoding: boolean
OutgoingMessage.chunkedEncoding
node_modules/@types/node/http.d.ts:547
• Readonly closed: boolean
Is true after 'close' has been emitted.
Since
v18.0.0
node_modules/@types/node/stream.d.ts:704
• Readonly connection: null | Socket
Alias of outgoingMessage.socket.
Since
v0.3.0
Deprecated
Since v15.12.0,v14.17.1 - Use socket instead.
node_modules/@types/node/http.d.ts:565
• destroyed: boolean
Is true after writable.destroy() has been called.
Since
v8.0.0
node_modules/@types/node/stream.d.ts:699
• Readonly errored: null | Error
Returns error if the stream has been destroyed with an error.
Since
v18.0.0
node_modules/@types/node/stream.d.ts:709
• finished: boolean
Deprecated
Use writableEnded instead.
node_modules/@types/node/http.d.ts:554
• Readonly headersSent: boolean
Read-only. true if the headers were sent, otherwise false.
Since
v0.9.3
node_modules/@types/node/http.d.ts:559
• host: string
The request host.
Since
v14.5.0, v12.19.0
node_modules/@types/node/http.d.ts:904
• maxHeadersCount: number
Limits maximum response headers count. If set to 0, no limit will be applied.
node_modules/@types/node/http.d.ts:964
• method: string
The request method.
Since
v0.1.97
node_modules/@types/node/http.d.ts:970
• path: string
The request path.
Since
v0.4.0
node_modules/@types/node/http.d.ts:975
• protocol: string
The request protocol.
Since
v14.5.0, v12.19.0
node_modules/@types/node/http.d.ts:909
• Readonly req: IncomingMessage
node_modules/@types/node/http.d.ts:546
• reusedSocket: boolean
When sending request through a keep-alive enabled agent, the underlying socket might be reused. But if server closes connection at unfortunate time, client may run into a 'ECONNRESET' error.
import http from 'node:http';
// Server has a 5 seconds keep-alive timeout by default
http
.createServer((req, res) => {
res.write('hello\n');
res.end();
})
.listen(3000);
setInterval(() => {
// Adapting a keep-alive agent
http.get('http://localhost:3000', { agent }, (res) => {
res.on('data', (data) => {
// Do nothing
});
});
}, 5000); // Sending request on 5s interval so it's easy to hit idle timeoutBy marking a request whether it reused socket or not, we can do automatic error retry base on it.
import http from 'node:http';
const agent = new http.Agent({ keepAlive: true });
function retriableRequest() {
const req = http
.get('http://localhost:3000', { agent }, (res) => {
// ...
})
.on('error', (err) => {
// Check if retry is needed
if (req.reusedSocket && err.code === 'ECONNRESET') {
retriableRequest();
}
});
}
retriableRequest();Since
v13.0.0, v12.16.0
node_modules/@types/node/http.d.ts:960
• sendDate: boolean
node_modules/@types/node/http.d.ts:550
• shouldKeepAlive: boolean
OutgoingMessage.shouldKeepAlive
node_modules/@types/node/http.d.ts:548
• Readonly socket: null | Socket
Reference to the underlying socket. Usually, users will not want to access this property.
After calling outgoingMessage.end(), this property will be nulled.
Since
v0.3.0
node_modules/@types/node/http.d.ts:573
• useChunkedEncodingByDefault: boolean
OutgoingMessage.useChunkedEncodingByDefault
node_modules/@types/node/http.d.ts:549
• Readonly writable: boolean
Is true if it is safe to call writable.write(), which means
the stream has not been destroyed, errored, or ended.
Since
v11.4.0
node_modules/@types/node/stream.d.ts:660
• Readonly writableCorked: number
Number of times writable.uncork() needs to be
called in order to fully uncork the stream.
Since
v13.2.0, v12.16.0
OutgoingMessage.writableCorked
node_modules/@types/node/stream.d.ts:694
• Readonly writableEnded: boolean
Is true after writable.end() has been called. This property
does not indicate whether the data has been flushed, for this use writable.writableFinished instead.
Since
v12.9.0
node_modules/@types/node/stream.d.ts:666
• Readonly writableFinished: boolean
Is set to true immediately before the 'finish' event is emitted.
Since
v12.6.0
OutgoingMessage.writableFinished
node_modules/@types/node/stream.d.ts:671
• Readonly writableHighWaterMark: number
Return the value of highWaterMark passed when creating this Writable.
Since
v9.3.0
OutgoingMessage.writableHighWaterMark
node_modules/@types/node/stream.d.ts:676
• Readonly writableLength: number
This property contains the number of bytes (or objects) in the queue
ready to be written. The value provides introspection data regarding
the status of the highWaterMark.
Since
v9.4.0
OutgoingMessage.writableLength
node_modules/@types/node/stream.d.ts:683
• Readonly writableNeedDrain: boolean
Is true if the stream's buffer has been full and stream will emit 'drain'.
Since
v15.2.0, v14.17.0
OutgoingMessage.writableNeedDrain
node_modules/@types/node/stream.d.ts:714
• Readonly writableObjectMode: boolean
Getter for the property objectMode of a given Writable stream.
Since
v12.3.0
OutgoingMessage.writableObjectMode
node_modules/@types/node/stream.d.ts:688
▪ Static Readonly captureRejectionSymbol: typeof captureRejectionSymbol
Value: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
Since
v13.4.0, v12.16.0
OutgoingMessage.captureRejectionSymbol
node_modules/@types/node/events.d.ts:402
▪ Static captureRejections: boolean
Value: boolean
Change the default captureRejections option on all new EventEmitter objects.
Since
v13.4.0, v12.16.0
OutgoingMessage.captureRejections
node_modules/@types/node/events.d.ts:409
▪ Static defaultMaxListeners: number
By default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for allEventEmitter instances, the events.defaultMaxListenersproperty can be used. If this value is not a positive number, a RangeErroris thrown.
Take caution when setting the events.defaultMaxListeners because the
change affects allEventEmitter instances, including those created before
the change is made. However, calling emitter.setMaxListeners(n) still has
precedence over events.defaultMaxListeners.
This is not a hard limit. The EventEmitter instance will allow
more listeners to be added but will output a trace warning to stderr indicating
that a "possible EventEmitter memory leak" has been detected. For any singleEventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners()methods can be used to
temporarily avoid this warning:
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
// do stuff
emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});The --trace-warnings command-line flag can be used to display the
stack trace for such warnings.
The emitted warning can be inspected with process.on('warning') and will
have the additional emitter, type, and count properties, referring to
the event emitter instance, the event's name and the number of attached
listeners, respectively.
Its name property is set to 'MaxListenersExceededWarning'.
Since
v0.11.2
OutgoingMessage.defaultMaxListeners
node_modules/@types/node/events.d.ts:446
▪ 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.
Since
v13.6.0, v12.17.0
node_modules/@types/node/events.d.ts:395
▸ [captureRejectionSymbol](error, event, ...args): void
| Name | Type |
|---|---|
error |
Error |
event |
string |
...args |
any[] |
void
OutgoingMessage.[captureRejectionSymbol]
node_modules/@types/node/events.d.ts:112
▸ _construct(callback): void
| Name | Type |
|---|---|
callback |
(error?: null | Error) => void
|
void
node_modules/@types/node/stream.d.ts:724
▸ _destroy(error, callback): void
| Name | Type |
|---|---|
error |
null | Error
|
callback |
(error?: null | Error) => void
|
void
node_modules/@types/node/stream.d.ts:725
▸ _final(callback): void
| Name | Type |
|---|---|
callback |
(error?: null | Error) => void
|
void
node_modules/@types/node/stream.d.ts:726
▸ _write(chunk, encoding, callback): void
| Name | Type |
|---|---|
chunk |
any |
encoding |
BufferEncoding |
callback |
(error?: null | Error) => void
|
void
node_modules/@types/node/stream.d.ts:716
▸ _writev(chunks, callback): void
| Name | Type |
|---|---|
chunks |
{ chunk: any ; encoding: BufferEncoding }[] |
callback |
(error?: null | Error) => void
|
void
node_modules/@types/node/stream.d.ts:717
▸ abort(): void
Marks the request as aborting. Calling this will cause remaining data in the response to be dropped and the socket to be destroyed.
void
Since
v0.3.8
Deprecated
Since v14.1.0,v13.14.0 - Use destroy instead.
node_modules/@types/node/http.d.ts:982
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"abort" |
listener |
() => void
|
Deprecated
node_modules/@types/node/http.d.ts:1018
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"connect" |
listener |
(response: IncomingMessage, socket: Socket, head: Buffer) => void
|
node_modules/@types/node/http.d.ts:1019
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"continue" |
listener |
() => void
|
node_modules/@types/node/http.d.ts:1023
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"information" |
listener |
(info: InformationEvent) => void
|
node_modules/@types/node/http.d.ts:1024
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"response" |
listener |
(response: IncomingMessage) => void
|
node_modules/@types/node/http.d.ts:1025
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"socket" |
listener |
(socket: Socket) => void
|
node_modules/@types/node/http.d.ts:1026
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"timeout" |
listener |
() => void
|
node_modules/@types/node/http.d.ts:1027
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"upgrade" |
listener |
(response: IncomingMessage, socket: Socket, head: Buffer) => void
|
OutgoingMessage.addListener
node_modules/@types/node/http.d.ts:1028
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"close" |
listener |
() => void
|
OutgoingMessage.addListener
node_modules/@types/node/http.d.ts:1032
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"drain" |
listener |
() => void
|
OutgoingMessage.addListener
node_modules/@types/node/http.d.ts:1033
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"error" |
listener |
(err: Error) => void
|
OutgoingMessage.addListener
node_modules/@types/node/http.d.ts:1034
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"finish" |
listener |
() => void
|
OutgoingMessage.addListener
node_modules/@types/node/http.d.ts:1035
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"pipe" |
listener |
(src: Readable) => void
|
OutgoingMessage.addListener
node_modules/@types/node/http.d.ts:1036
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"unpipe" |
listener |
(src: Readable) => void
|
OutgoingMessage.addListener
node_modules/@types/node/http.d.ts:1037
▸ addListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
string | symbol
|
listener |
(...args: any[]) => void
|
OutgoingMessage.addListener
node_modules/@types/node/http.d.ts:1038
▸ addTrailers(headers): void
Adds HTTP trailers (headers but at the end of the message) to the message.
Trailers will only be emitted if the message is chunked encoded. If not, the trailers will be silently discarded.
HTTP requires the Trailer header to be sent to emit trailers,
with a list of header field names in its value, e.g.
message.writeHead(200, { 'Content-Type': 'text/plain',
'Trailer': 'Content-MD5' });
message.write(fileData);
message.addTrailers({ 'Content-MD5': '7895bf4b8828b55ceaf47747b4bca667' });
message.end();Attempting to set a header field name or value that contains invalid characters
will result in a TypeError being thrown.
| Name | Type |
|---|---|
headers |
OutgoingHttpHeaders | readonly [string, string][] |
void
Since
v0.3.0
node_modules/@types/node/http.d.ts:682
▸ appendHeader(name, value): ClientRequest
Append a single header value for the header object.
If the value is an array, this is equivalent of calling this method multiple times.
If there were no previous value for the header, this is equivalent of calling outgoingMessage.setHeader(name, value).
Depending of the value of options.uniqueHeaders when the client request or the
server were created, this will end up in the header being sent multiple times or
a single time with values joined using ; .
| Name | Type | Description |
|---|---|---|
name |
string |
Header name |
value |
string | readonly string[] |
Header value |
Since
v18.3.0, v16.17.0
node_modules/@types/node/http.d.ts:605
▸ compose<T>(stream, options?): T
| Name | Type |
|---|---|
T |
extends ReadableStream
|
| Name | Type |
|---|---|
stream |
ComposeFnParam | T | Iterable<T> | AsyncIterable<T> |
options? |
Object |
options.signal |
AbortSignal |
T
node_modules/@types/node/stream.d.ts:35
▸ cork(): void
The writable.cork() method forces all written data to be buffered in memory.
The buffered data will be flushed when either the uncork or end methods are called.
The primary intent of writable.cork() is to accommodate a situation in which
several small chunks are written to the stream in rapid succession. Instead of
immediately forwarding them to the underlying destination, writable.cork()buffers all the chunks until writable.uncork() is called, which will pass them
all to writable._writev(), if present. This prevents a head-of-line blocking
situation where data is being buffered while waiting for the first small chunk
to be processed. However, use of writable.cork() without implementingwritable._writev() may have an adverse effect on throughput.
See also: writable.uncork(), writable._writev().
void
Since
v0.11.2
node_modules/@types/node/stream.d.ts:830
▸ destroy(error?): ClientRequest
Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the writable
stream has ended and subsequent calls to write() or end() will result in
an ERR_STREAM_DESTROYED error.
This is a destructive and immediate way to destroy a stream. Previous calls towrite() may not have drained, and may trigger an ERR_STREAM_DESTROYED error.
Use end() instead of destroy if data should flush before close, or wait for
the 'drain' event before destroying the stream.
Once destroy() has been called any further calls will be a no-op and no
further errors except from _destroy() may be emitted as 'error'.
Implementors should not override this method,
but instead implement writable._destroy().
| Name | Type | Description |
|---|---|---|
error? |
Error |
Optional, an error to emit with 'error' event. |
Since
v8.0.0
node_modules/@types/node/stream.d.ts:881
▸ emit(event): boolean
Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments
to each.
Returns true if the event had listeners, false otherwise.
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener| Name | Type |
|---|---|
event |
"close" |
boolean
Since
v0.1.26
node_modules/@types/node/stream.d.ts:899
▸ emit(event): boolean
| Name | Type |
|---|---|
event |
"drain" |
boolean
node_modules/@types/node/stream.d.ts:900
▸ emit(event, err): boolean
| Name | Type |
|---|---|
event |
"error" |
err |
Error |
boolean
node_modules/@types/node/stream.d.ts:901
▸ emit(event): boolean
| Name | Type |
|---|---|
event |
"finish" |
boolean
node_modules/@types/node/stream.d.ts:902
▸ emit(event, src): boolean
| Name | Type |
|---|---|
event |
"pipe" |
src |
Readable |
boolean
node_modules/@types/node/stream.d.ts:903
▸ emit(event, src): boolean
| Name | Type |
|---|---|
event |
"unpipe" |
src |
Readable |
boolean
node_modules/@types/node/stream.d.ts:904
▸ emit(event, ...args): boolean
| Name | Type |
|---|---|
event |
string | symbol
|
...args |
any[] |
boolean
node_modules/@types/node/stream.d.ts:905
▸ end(cb?): ClientRequest
Calling the writable.end() method signals that no more data will be written
to the Writable. The optional chunk and encoding arguments allow one
final additional chunk of data to be written immediately before closing the
stream.
Calling the write method after calling end will raise an error.
// Write 'hello, ' and then end with 'world!'.
const fs = require('node:fs');
const file = fs.createWriteStream('example.txt');
file.write('hello, ');
file.end('world!');
// Writing more now is not allowed!| Name | Type |
|---|---|
cb? |
() => void
|
Since
v0.9.4
node_modules/@types/node/stream.d.ts:813
▸ end(chunk, cb?): ClientRequest
| Name | Type |
|---|---|
chunk |
any |
cb? |
() => void
|
node_modules/@types/node/stream.d.ts:814
▸ end(chunk, encoding, cb?): ClientRequest
| Name | Type |
|---|---|
chunk |
any |
encoding |
BufferEncoding |
cb? |
() => void
|
node_modules/@types/node/stream.d.ts:815
▸ 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.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ](string | symbol)[]
Since
v6.0.0
node_modules/@types/node/events.d.ts:870
▸ flushHeaders(): void
Flushes the message headers.
For efficiency reason, Node.js normally buffers the message headers
until outgoingMessage.end() is called or the first chunk of message data
is written. It then tries to pack the headers and data into a single TCP
packet.
It is usually desired (it saves a TCP round-trip), but not when the first
data is not sent until possibly much later. outgoingMessage.flushHeaders()bypasses the optimization and kickstarts the message.
void
Since
v1.6.0
node_modules/@types/node/http.d.ts:695
▸ getHeader(name): undefined | string | number | string[]
Gets the value of the HTTP header with the given name. If that header is not
set, the returned value will be undefined.
| Name | Type | Description |
|---|---|---|
name |
string |
Name of header |
undefined | string | number | string[]
Since
v0.4.0
node_modules/@types/node/http.d.ts:612
▸ getHeaderNames(): string[]
Returns an array containing the unique names of the current outgoing headers. All names are lowercase.
string[]
Since
v7.7.0
OutgoingMessage.getHeaderNames
node_modules/@types/node/http.d.ts:640
▸ getHeaders(): OutgoingHttpHeaders
Returns a shallow copy of the current outgoing headers. Since a shallow copy is used, array values may be mutated without additional calls to various header-related HTTP module methods. The keys of the returned object are the header names and the values are the respective header values. All header names are lowercase.
The object returned by the outgoingMessage.getHeaders() method does
not prototypically inherit from the JavaScript Object. This means that
typical Object methods such as obj.toString(), obj.hasOwnProperty(),
and others are not defined and will not work.
outgoingMessage.setHeader('Foo', 'bar');
outgoingMessage.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']);
const headers = outgoingMessage.getHeaders();
// headers === { foo: 'bar', 'set-cookie': ['foo=bar', 'bar=baz'] }Since
v7.7.0
node_modules/@types/node/http.d.ts:634
▸ getMaxListeners(): number
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.
number
Since
v1.0.0
OutgoingMessage.getMaxListeners
node_modules/@types/node/events.d.ts:722
▸ getRawHeaderNames(): string[]
Returns an array containing the unique names of the current outgoing raw headers. Header names are returned with their exact casing being set.
request.setHeader('Foo', 'bar');
request.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']);
const headerNames = request.getRawHeaderNames();
// headerNames === ['Foo', 'Set-Cookie']string[]
Since
v15.13.0, v14.17.0
node_modules/@types/node/http.d.ts:1014
▸ hasHeader(name): boolean
Returns true if the header identified by name is currently set in the
outgoing headers. The header name is case-insensitive.
const hasContentType = outgoingMessage.hasHeader('content-type');| Name | Type |
|---|---|
name |
string |
boolean
Since
v7.7.0
node_modules/@types/node/http.d.ts:650
▸ listenerCount(eventName, listener?): number
Returns the number of listeners listening for the event named eventName.
If listener is provided, it will return how many times the listener is found
in the list of the listeners of the event.
| Name | Type | Description |
|---|---|---|
eventName |
string | symbol
|
The name of the event being listened for |
listener? |
Function |
The event handler function |
number
Since
v3.2.0
node_modules/@types/node/events.d.ts:816
▸ 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] ]| Name | Type |
|---|---|
eventName |
string | symbol
|
Function[]
Since
v0.1.26
node_modules/@types/node/events.d.ts:735
▸ off(eventName, listener): ClientRequest
Alias for emitter.removeListener().
| Name | Type |
|---|---|
eventName |
string | symbol
|
listener |
(...args: any[]) => void
|
Since
v10.0.0
node_modules/@types/node/events.d.ts:695
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"abort" |
listener |
() => void
|
Deprecated
node_modules/@types/node/http.d.ts:1042
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"connect" |
listener |
(response: IncomingMessage, socket: Socket, head: Buffer) => void
|
node_modules/@types/node/http.d.ts:1043
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"continue" |
listener |
() => void
|
node_modules/@types/node/http.d.ts:1044
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"information" |
listener |
(info: InformationEvent) => void
|
node_modules/@types/node/http.d.ts:1045
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"response" |
listener |
(response: IncomingMessage) => void
|
node_modules/@types/node/http.d.ts:1046
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"socket" |
listener |
(socket: Socket) => void
|
node_modules/@types/node/http.d.ts:1047
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"timeout" |
listener |
() => void
|
node_modules/@types/node/http.d.ts:1048
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"upgrade" |
listener |
(response: IncomingMessage, socket: Socket, head: Buffer) => void
|
OutgoingMessage.on
node_modules/@types/node/http.d.ts:1049
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"close" |
listener |
() => void
|
OutgoingMessage.on
node_modules/@types/node/http.d.ts:1050
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"drain" |
listener |
() => void
|
OutgoingMessage.on
node_modules/@types/node/http.d.ts:1051
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"error" |
listener |
(err: Error) => void
|
OutgoingMessage.on
node_modules/@types/node/http.d.ts:1052
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"finish" |
listener |
() => void
|
OutgoingMessage.on
node_modules/@types/node/http.d.ts:1053
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"pipe" |
listener |
(src: Readable) => void
|
OutgoingMessage.on
node_modules/@types/node/http.d.ts:1054
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"unpipe" |
listener |
(src: Readable) => void
|
OutgoingMessage.on
node_modules/@types/node/http.d.ts:1055
▸ on(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
string | symbol
|
listener |
(...args: any[]) => void
|
OutgoingMessage.on
node_modules/@types/node/http.d.ts:1056
▸ onSocket(socket): void
| Name | Type |
|---|---|
socket |
Socket |
void
node_modules/@types/node/http.d.ts:983
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"abort" |
listener |
() => void
|
Deprecated
node_modules/@types/node/http.d.ts:1060
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"connect" |
listener |
(response: IncomingMessage, socket: Socket, head: Buffer) => void
|
node_modules/@types/node/http.d.ts:1061
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"continue" |
listener |
() => void
|
node_modules/@types/node/http.d.ts:1062
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"information" |
listener |
(info: InformationEvent) => void
|
node_modules/@types/node/http.d.ts:1063
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"response" |
listener |
(response: IncomingMessage) => void
|
node_modules/@types/node/http.d.ts:1064
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"socket" |
listener |
(socket: Socket) => void
|
node_modules/@types/node/http.d.ts:1065
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"timeout" |
listener |
() => void
|
node_modules/@types/node/http.d.ts:1066
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"upgrade" |
listener |
(response: IncomingMessage, socket: Socket, head: Buffer) => void
|
OutgoingMessage.once
node_modules/@types/node/http.d.ts:1067
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"close" |
listener |
() => void
|
OutgoingMessage.once
node_modules/@types/node/http.d.ts:1068
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"drain" |
listener |
() => void
|
OutgoingMessage.once
node_modules/@types/node/http.d.ts:1069
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"error" |
listener |
(err: Error) => void
|
OutgoingMessage.once
node_modules/@types/node/http.d.ts:1070
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"finish" |
listener |
() => void
|
OutgoingMessage.once
node_modules/@types/node/http.d.ts:1071
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"pipe" |
listener |
(src: Readable) => void
|
OutgoingMessage.once
node_modules/@types/node/http.d.ts:1072
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"unpipe" |
listener |
(src: Readable) => void
|
OutgoingMessage.once
node_modules/@types/node/http.d.ts:1073
▸ once(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
string | symbol
|
listener |
(...args: any[]) => void
|
OutgoingMessage.once
node_modules/@types/node/http.d.ts:1074
▸ pipe<T>(destination, options?): T
| Name | Type |
|---|---|
T |
extends WritableStream
|
| Name | Type |
|---|---|
destination |
T |
options? |
Object |
options.end? |
boolean |
T
node_modules/@types/node/stream.d.ts:29
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"abort" |
listener |
() => void
|
Deprecated
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1078
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"connect" |
listener |
(response: IncomingMessage, socket: Socket, head: Buffer) => void
|
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1079
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"continue" |
listener |
() => void
|
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1083
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"information" |
listener |
(info: InformationEvent) => void
|
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1084
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"response" |
listener |
(response: IncomingMessage) => void
|
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1085
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"socket" |
listener |
(socket: Socket) => void
|
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1086
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"timeout" |
listener |
() => void
|
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1087
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"upgrade" |
listener |
(response: IncomingMessage, socket: Socket, head: Buffer) => void
|
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1088
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"close" |
listener |
() => void
|
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1092
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"drain" |
listener |
() => void
|
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1093
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"error" |
listener |
(err: Error) => void
|
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1094
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"finish" |
listener |
() => void
|
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1095
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"pipe" |
listener |
(src: Readable) => void
|
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1096
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"unpipe" |
listener |
(src: Readable) => void
|
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1097
▸ prependListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
string | symbol
|
listener |
(...args: any[]) => void
|
OutgoingMessage.prependListener
node_modules/@types/node/http.d.ts:1098
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"abort" |
listener |
() => void
|
Deprecated
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1102
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"connect" |
listener |
(response: IncomingMessage, socket: Socket, head: Buffer) => void
|
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1103
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"continue" |
listener |
() => void
|
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1107
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"information" |
listener |
(info: InformationEvent) => void
|
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1108
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"response" |
listener |
(response: IncomingMessage) => void
|
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1109
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"socket" |
listener |
(socket: Socket) => void
|
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1110
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"timeout" |
listener |
() => void
|
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1111
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"upgrade" |
listener |
(response: IncomingMessage, socket: Socket, head: Buffer) => void
|
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1112
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"close" |
listener |
() => void
|
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1116
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"drain" |
listener |
() => void
|
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1117
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"error" |
listener |
(err: Error) => void
|
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1118
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"finish" |
listener |
() => void
|
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1119
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"pipe" |
listener |
(src: Readable) => void
|
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1120
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"unpipe" |
listener |
(src: Readable) => void
|
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1121
▸ prependOnceListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
string | symbol
|
listener |
(...args: any[]) => void
|
OutgoingMessage.prependOnceListener
node_modules/@types/node/http.d.ts:1122
▸ 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()).
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));
// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];
// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();
// Logs "log once" to the console and removes the listener
logFnWrapper();
emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');
// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');| Name | Type |
|---|---|
eventName |
string | symbol
|
Function[]
Since
v9.4.0
node_modules/@types/node/events.d.ts:766
▸ removeAllListeners(event?): ClientRequest
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.
| Name | Type |
|---|---|
event? |
string | symbol
|
Since
v0.1.26
OutgoingMessage.removeAllListeners
node_modules/@types/node/events.d.ts:706
▸ removeHeader(name): void
Removes a header that is queued for implicit sending.
outgoingMessage.removeHeader('Content-Encoding');| Name | Type | Description |
|---|---|---|
name |
string |
Header name |
void
Since
v0.4.0
node_modules/@types/node/http.d.ts:660
▸ removeListener(event, listener): ClientRequest
Removes the specified listener from the listener array for the event namedeventName.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);removeListener() will remove, at most, one instance of a listener from the
listener array. If any single listener has been added multiple times to the
listener array for the specified eventName, then removeListener() must be
called multiple times to remove each instance.
Once an event is emitted, all listeners attached to it at the
time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and before the last listener finishes execution
will not remove them fromemit() in progress. Subsequent events behave as expected.
import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};
const callbackB = () => {
console.log('B');
};
myEmitter.on('event', callbackA);
myEmitter.on('event', callbackB);
// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
// A
// B
// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
// ABecause listeners are managed using an internal array, calling this will
change the position indices of any listener registered after the listener
being removed. This will not impact the order in which listeners are called,
but it means that any copies of the listener array as returned by
the emitter.listeners() method will need to be recreated.
When a single function has been added as a handler multiple times for a single
event (as in the example below), removeListener() will remove the most
recently added instance. In the example the once('ping')listener is removed:
import { EventEmitter } from 'node:events';
const ee = new EventEmitter();
function pong() {
console.log('pong');
}
ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);
ee.emit('ping');
ee.emit('ping');Returns a reference to the EventEmitter, so that calls can be chained.
| Name | Type |
|---|---|
event |
"close" |
listener |
() => void
|
Since
v0.1.26
OutgoingMessage.removeListener
node_modules/@types/node/stream.d.ts:934
▸ removeListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"drain" |
listener |
() => void
|
OutgoingMessage.removeListener
node_modules/@types/node/stream.d.ts:935
▸ removeListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"error" |
listener |
(err: Error) => void
|
OutgoingMessage.removeListener
node_modules/@types/node/stream.d.ts:936
▸ removeListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"finish" |
listener |
() => void
|
OutgoingMessage.removeListener
node_modules/@types/node/stream.d.ts:937
▸ removeListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"pipe" |
listener |
(src: Readable) => void
|
OutgoingMessage.removeListener
node_modules/@types/node/stream.d.ts:938
▸ removeListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
"unpipe" |
listener |
(src: Readable) => void
|
OutgoingMessage.removeListener
node_modules/@types/node/stream.d.ts:939
▸ removeListener(event, listener): ClientRequest
| Name | Type |
|---|---|
event |
string | symbol
|
listener |
(...args: any[]) => void
|
OutgoingMessage.removeListener
node_modules/@types/node/stream.d.ts:940
▸ setDefaultEncoding(encoding): ClientRequest
The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.
| Name | Type | Description |
|---|---|---|
encoding |
BufferEncoding |
The new default encoding |
Since
v0.11.15
OutgoingMessage.setDefaultEncoding
node_modules/@types/node/stream.d.ts:790
▸ setHeader(name, value): ClientRequest
Sets a single header value. If the header already exists in the to-be-sent headers, its value will be replaced. Use an array of strings to send multiple headers with the same name.
| Name | Type | Description |
|---|---|---|
name |
string |
Header name |
value |
string | number | readonly string[] |
Header value |
Since
v0.4.0
node_modules/@types/node/http.d.ts:589
▸ setMaxListeners(n): ClientRequest
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.
| Name | Type |
|---|---|
n |
number |
Since
v0.3.5
OutgoingMessage.setMaxListeners
node_modules/@types/node/events.d.ts:716
▸ setNoDelay(noDelay?): void
Once a socket is assigned to this request and is connected socket.setNoDelay() will be called.
| Name | Type |
|---|---|
noDelay? |
boolean |
void
Since
v0.5.9
node_modules/@types/node/http.d.ts:995
▸ setSocketKeepAlive(enable?, initialDelay?): void
Once a socket is assigned to this request and is connected socket.setKeepAlive() will be called.
| Name | Type |
|---|---|
enable? |
boolean |
initialDelay? |
number |
void
Since
v0.5.9
node_modules/@types/node/http.d.ts:1000
▸ setTimeout(timeout, callback?): ClientRequest
Once a socket is assigned to this request and is connected socket.setTimeout() will be called.
| Name | Type | Description |
|---|---|---|
timeout |
number |
Milliseconds before a request times out. |
callback? |
() => void
|
Optional function to be called when a timeout occurs. Same as binding to the 'timeout' event. |
Since
v0.5.9
node_modules/@types/node/http.d.ts:990
▸ uncork(): void
The writable.uncork() method flushes all data buffered since cork was called.
When using writable.cork() and writable.uncork() to manage the buffering
of writes to a stream, defer calls to writable.uncork() usingprocess.nextTick(). Doing so allows batching of allwritable.write() calls that occur within a given Node.js event
loop phase.
stream.cork();
stream.write('some ');
stream.write('data ');
process.nextTick(() => stream.uncork());If the writable.cork() method is called multiple times on a stream, the
same number of calls to writable.uncork() must be called to flush the buffered
data.
stream.cork();
stream.write('some ');
stream.cork();
stream.write('data ');
process.nextTick(() => {
stream.uncork();
// The data will not be flushed until uncork() is called a second time.
stream.uncork();
});See also: writable.cork().
void
Since
v0.11.2
node_modules/@types/node/stream.d.ts:864
▸ write(chunk, callback?): boolean
The writable.write() method writes some data to the stream, and calls the
supplied callback once the data has been fully handled. If an error
occurs, the callback will be called with the error as its
first argument. The callback is called asynchronously and before 'error' is
emitted.
The return value is true if the internal buffer is less than thehighWaterMark configured when the stream was created after admitting chunk.
If false is returned, further attempts to write data to the stream should
stop until the 'drain' event is emitted.
While a stream is not draining, calls to write() will buffer chunk, and
return false. Once all currently buffered chunks are drained (accepted for
delivery by the operating system), the 'drain' event will be emitted.
Once write() returns false, do not write more chunks
until the 'drain' event is emitted. While calling write() on a stream that
is not draining is allowed, Node.js will buffer all written chunks until
maximum memory usage occurs, at which point it will abort unconditionally.
Even before it aborts, high memory usage will cause poor garbage collector
performance and high RSS (which is not typically released back to the system,
even after the memory is no longer required). Since TCP sockets may never
drain if the remote peer does not read the data, writing a socket that is
not draining may lead to a remotely exploitable vulnerability.
Writing data while the stream is not draining is particularly
problematic for a Transform, because the Transform streams are paused
by default until they are piped or a 'data' or 'readable' event handler
is added.
If the data to be written can be generated or fetched on demand, it is
recommended to encapsulate the logic into a Readable and use pipe. However, if calling write() is preferred, it is
possible to respect backpressure and avoid memory issues using the 'drain' event:
function write(data, cb) {
if (!stream.write(data)) {
stream.once('drain', cb);
} else {
process.nextTick(cb);
}
}
// Wait for cb to be called before doing any other write.
write('hello', () => {
console.log('Write completed, do more writes now.');
});A Writable stream in object mode will always ignore the encoding argument.
| Name | Type | Description |
|---|---|---|
chunk |
any |
Optional data to write. For streams not operating in object mode, chunk must be a string, Buffer or Uint8Array. For object mode streams, chunk may be any JavaScript value other than null. |
callback? |
(error: undefined | null | Error) => void
|
Callback for when this chunk of data is flushed. |
boolean
false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.
Since
v0.9.4
node_modules/@types/node/stream.d.ts:783
▸ write(chunk, encoding, callback?): boolean
| Name | Type |
|---|---|
chunk |
any |
encoding |
BufferEncoding |
callback? |
(error: undefined | null | Error) => void
|
boolean
node_modules/@types/node/stream.d.ts:784
▸ addAbortListener(signal, resource): Disposable
Listens once to the abort event on the provided signal.
Listening to the abort event on abort signals is unsafe and may
lead to resource leaks since another third party with the signal can
call e.stopImmediatePropagation(). Unfortunately Node.js cannot change
this since it would violate the web standard. Additionally, the original
API makes it easy to forget to remove listeners.
This API allows safely using AbortSignals in Node.js APIs by solving these
two issues by listening to the event such that stopImmediatePropagation does
not prevent the listener from running.
Returns a disposable so that it may be unsubscribed from more easily.
import { addAbortListener } from 'node:events';
function example(signal) {
let disposable;
try {
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
disposable = addAbortListener(signal, (e) => {
// Do something when signal is aborted.
});
} finally {
disposable?.[Symbol.dispose]();
}
}| Name | Type |
|---|---|
signal |
AbortSignal |
resource |
(event: Event) => void
|
Disposable
Disposable that removes the abort listener.
Since
v20.5.0
OutgoingMessage.addAbortListener
node_modules/@types/node/events.d.ts:387
▸ fromWeb(writableStream, options?): Writable
A utility method for creating a Writable from a web WritableStream.
| Name | Type |
|---|---|
writableStream |
WritableStream<any> |
options? |
Pick<WritableOptions, "signal" | "highWaterMark" | "objectMode" | "decodeStrings"> |
Since
v17.0.0
node_modules/@types/node/stream.d.ts:1006
▸ 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.
import { getEventListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
const listener = () => console.log('Events are fun');
ee.on('foo', listener);
console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
const et = new EventTarget();
const listener = () => console.log('Events are fun');
et.addEventListener('foo', listener);
console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
}| Name | Type |
|---|---|
emitter |
EventEmitter | _DOMEventTarget
|
name |
string | symbol
|
Function[]
Since
v15.2.0, v14.17.0
OutgoingMessage.getEventListeners
node_modules/@types/node/events.d.ts:308
▸ getMaxListeners(emitter): number
Returns the currently set max amount of listeners.
For EventEmitters this behaves exactly the same as calling .getMaxListeners on
the emitter.
For EventTargets this is the only way to get the max event listeners for the
event target. If the number of event handlers on a single EventTarget exceeds
the max set, the EventTarget will print a warning.
import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
console.log(getMaxListeners(ee)); // 10
setMaxListeners(11, ee);
console.log(getMaxListeners(ee)); // 11
}
{
const et = new EventTarget();
console.log(getMaxListeners(et)); // 10
setMaxListeners(11, et);
console.log(getMaxListeners(et)); // 11
}| Name | Type |
|---|---|
emitter |
EventEmitter | _DOMEventTarget
|
number
Since
v19.9.0
OutgoingMessage.getMaxListeners
node_modules/@types/node/events.d.ts:337
▸ listenerCount(emitter, eventName): number
A class method that returns the number of listeners for the given eventNameregistered on the given emitter.
import { EventEmitter, listenerCount } from 'node:events';
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2| Name | Type | Description |
|---|---|---|
emitter |
EventEmitter |
The emitter to query |
eventName |
string | symbol
|
The event name |
number
Since
v0.9.12
Deprecated
Since v3.2.0 - Use listenerCount instead.
node_modules/@types/node/events.d.ts:280
▸ on(emitter, eventName, options?): AsyncIterableIterator<any>
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable hereReturns an AsyncIterator that iterates eventName events. It will throw
if the EventEmitter emits 'error'. It removes all listeners when
exiting the loop. The value returned by each iteration is an array
composed of the emitted event arguments.
An AbortSignal can be used to cancel waiting on events:
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ac = new AbortController();
(async () => {
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo', { signal: ac.signal })) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();
process.nextTick(() => ac.abort());| Name | Type | Description |
|---|---|---|
emitter |
EventEmitter |
- |
eventName |
string |
The name of the event being listened for |
options? |
StaticEventEmitterOptions |
- |
that iterates eventName events emitted by the emitter
Since
v13.6.0, v12.16.0
node_modules/@types/node/events.d.ts:258
▸ 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.
import { once, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
process.nextTick(() => {
ee.emit('myevent', 42);
});
const [value] = await once(ee, 'myevent');
console.log(value);
const err = new Error('kaboom');
process.nextTick(() => {
ee.emit('error', err);
});
try {
await once(ee, 'myevent');
} catch (err) {
console.error('error happened', err);
}The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the
'error' event itself, then it is treated as any other kind of event without
special handling:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.error('error', err.message));
ee.emit('error', new Error('boom'));
// Prints: ok boomAn AbortSignal can be used to cancel waiting for the event:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
const ac = new AbortController();
async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}
foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!| Name | Type |
|---|---|
emitter |
_NodeEventTarget |
eventName |
string | symbol
|
options? |
StaticEventEmitterOptions |
Promise<any[]>
Since
v11.13.0, v10.16.0
node_modules/@types/node/events.d.ts:193
▸ once(emitter, eventName, options?): Promise<any[]>
| Name | Type |
|---|---|
emitter |
_DOMEventTarget |
eventName |
string |
options? |
StaticEventEmitterOptions |
Promise<any[]>
node_modules/@types/node/events.d.ts:198
▸ setMaxListeners(n?, ...eventTargets): void
import { setMaxListeners, EventEmitter } from 'node:events';
const target = new EventTarget();
const emitter = new EventEmitter();
setMaxListeners(5, target, emitter);| Name | Type | Description |
|---|---|---|
n? |
number |
A non-negative number. The maximum number of listeners per EventTarget event. |
...eventTargets |
(EventEmitter | _DOMEventTarget)[] |
- |
void
Since
v15.4.0
OutgoingMessage.setMaxListeners
node_modules/@types/node/events.d.ts:352
▸ toWeb(streamWritable): WritableStream<any>
A utility method for creating a web WritableStream from a Writable.
| Name | Type |
|---|---|
streamWritable |
Writable |
WritableStream<any>
Since
v17.0.0
node_modules/@types/node/stream.d.ts:1015
- @ralphschuler/ai-function-caller
- index
- types/AIFunction
- types/Message
- @ralphschuler/assert
- assert
- assert
- assert
- assert
- assert
- assert
- assert
- assert
- assert
- assert
- assert
- assert
- assert
- error
- index
- util
- @ralphschuler/better-map
- @ralphschuler/better-set
- @ralphschuler/binary-serializer
- @ralphschuler/bit-mask
- @ralphschuler/complex-compare
- @ralphschuler/i811n
- @ralphschuler/logger
- Color
- ColorMap
- Logger
- animations/BallonAnimation
- animations/BaseAnimation
- animations/BombAnimation
- animations/BouncingBallAnimation
- animations/ClockAnimation
- animations/DotsAnimation
- animations/HorizontalBarAnimation
- animations/PongAnimation
- animations/ProgressAnimation
- animations/ProgressBarAnimation
- animations/SpinnerAnimation
- animations/VerticalBarAnimation
- enums/LogLevel
- index
- interfaces/IColor
- interfaces/IMessage
- types/ColorName
- types/Colors
- @ralphschuler/lsystem
- @ralphschuler/mixin-class-factory
- @ralphschuler/neuronal-network
- @ralphschuler/parser-combinator
- index
- inputTypes
- parser
- unicode
- @ralphschuler/prom-metrics-decorator
- @ralphschuler/prom-metrics-parser
- @ralphschuler/random
- PseudoRandomItemSelector
- PseudoRandomNumberGenerator
- Seed
- index
- strategies
- strategy
- strategy
- strategy
- strategy
- strategy
- strategy
- types
- type
- type
- type
- @ralphschuler/safe-array
- @ralphschuler/slot-mashine
- @ralphschuler/state-store
- StateStore
- index
- type
- type
- type
- type
- type
- type
- type
- type
- util
- @ralphschuler/stats-tracker
- @ralphschuler/ts-error
- error
- index
- type
- util
- util
- util
- util
- @ralphschuler/webgl-sand-engine
- index
- pixel-renderer
- @ralphschuler/webgl-shader-factory
- "node:stream/consumers"
- "node:stream/promises"
- ChatCompletionSnapshot
- Choice
- Message
- ToolCall
- EventEmitter
- FormData
- OpenAI
- OpenAI
- Audio
- Speech
- Transcriptions
- Translations
- Beta
- Assistants
- Assistant
- AssistantCreateParams
- AssistantUpdateParams
- Files
- Chat
- Threads
- Messages
- Files
- MessageContentImageFile
- MessageContentText
- Text
- FileCitation
- FilePath
- Runs
- RequiredActionFunctionToolCall
- Run
- RequiredAction
- RunCreateParams
- RunSubmitToolOutputsParams
- Steps
- CodeToolCall
- CodeInterpreter
- Image
- FunctionToolCall
- MessageCreationStepDetails
- RunStep
- ThreadCreateAndRunParams
- Thread
- ThreadCreateParams
- Chat
- Completions
- ChatCompletion
- ChatCompletionAssistantMessageParam
- ChatCompletionChunk
- Choice
- Delta
- ToolCall
- ChatCompletionContentPartImage
- ChatCompletionCreateParams
- ChatCompletionMessage
- ChatCompletionMessageToolCall
- ChatCompletionNamedToolChoice
- Completions
- CompletionChoice
- CompletionCreateParams
- Edits
- Edit
- Embeddings
- CreateEmbeddingResponse
- Files
- FineTunes
- FineTune
- FineTuneCreateParams
- FineTuneListEventsParams
- FineTuning
- Jobs
- FineTuningJob
- JobCreateParams
- Images
- Models
- Moderations
- Moderation
- internal
- finished
- pipeline
- "node:stream/consumers"
- "node:stream/promises"
- EventEmitter
- internal
- finished
- pipeline
- Counter
- Gauge
- Histogram
- Summary