-
Notifications
You must be signed in to change notification settings - Fork 0
@ralphschuler.logger.Logger.<internal>.Socket
Logger.<internal>.Socket
This class is an abstraction of a TCP socket or a streaming IPC endpoint
(uses named pipes on Windows, and Unix domain sockets otherwise). It is also
an EventEmitter.
A net.Socket can be created by the user and used directly to interact with
a server. For example, it is returned by createConnection,
so the user can use it to talk to the server.
It can also be created by Node.js and passed to the user when a connection
is received. For example, it is passed to the listeners of a 'connection' event emitted on a Server, so the user can use
it to interact with the client.
Since
v0.3.4
-
↳
Socket↳↳
WriteStream
- allowHalfOpen
- autoSelectFamilyAttemptedAddresses
- bufferSize
- bytesRead
- bytesWritten
- closed
- connecting
- destroyed
- errored
- localAddress
- localFamily
- localPort
- pending
- readable
- readableAborted
- readableDidRead
- readableEncoding
- readableEnded
- readableFlowing
- readableHighWaterMark
- readableLength
- readableObjectMode
- readyState
- remoteAddress
- remoteFamily
- remotePort
- timeout
- writable
- writableCorked
- writableEnded
- writableFinished
- writableHighWaterMark
- writableLength
- writableNeedDrain
- writableObjectMode
- captureRejectionSymbol
- captureRejections
- defaultMaxListeners
- errorMonitor
- [asyncDispose]
- [asyncIterator]
- [captureRejectionSymbol]
- _construct
- _destroy
- _final
- _read
- _write
- _writev
- addListener
- address
- asIndexedPairs
- compose
- connect
- cork
- destroy
- destroySoon
- drop
- emit
- end
- eventNames
- every
- filter
- find
- flatMap
- forEach
- getMaxListeners
- isPaused
- iterator
- listenerCount
- listeners
- map
- off
- on
- once
- pause
- pipe
- prependListener
- prependOnceListener
- push
- rawListeners
- read
- reduce
- ref
- removeAllListeners
- removeListener
- resetAndDestroy
- resume
- setDefaultEncoding
- setEncoding
- setKeepAlive
- setMaxListeners
- setNoDelay
- setTimeout
- some
- take
- toArray
- uncork
- unpipe
- unref
- unshift
- wrap
- write
- addAbortListener
- from
- fromWeb
- getEventListeners
- getMaxListeners
- isDisturbed
- listenerCount
- on
- once
- setMaxListeners
- toWeb
• new Socket(options?): Socket
| Name | Type |
|---|---|
options? |
SocketConstructorOpts |
node_modules/@types/node/net.d.ts:93
• allowHalfOpen: boolean
If false then the stream will automatically end the writable side when the
readable side ends. Set initially by the allowHalfOpen constructor option,
which defaults to true.
This can be changed manually to change the half-open behavior of an existingDuplex stream instance, but must be changed before the 'end' event is
emitted.
Since
v0.9.4
node_modules/@types/node/stream.d.ts:1068
• Readonly autoSelectFamilyAttemptedAddresses: string[]
This property is only present if the family autoselection algorithm is enabled in socket.connect(options)
and it is an array of the addresses that have been attempted.
Each address is a string in the form of $IP:$PORT.
If the connection was successful, then the last address is the one that the socket is currently connected to.
Since
v19.4.0
node_modules/@types/node/net.d.ts:251
• Readonly bufferSize: number
This property shows the number of characters buffered for writing. The buffer may contain strings whose length after encoding is not yet known. So this number is only an approximation of the number of bytes in the buffer.
net.Socket has the property that socket.write() always works. This is to
help users get up and running quickly. The computer cannot always keep up
with the amount of data that is written to a socket. The network connection
simply might be too slow. Node.js will internally queue up the data written to a
socket and send it out over the wire when it is possible.
The consequence of this internal buffering is that memory may grow.
Users who experience large or growing bufferSize should attempt to
"throttle" the data flows in their program with socket.pause() and socket.resume().
Since
v0.3.8
Deprecated
Since v14.6.0 - Use writableLength instead.
node_modules/@types/node/net.d.ts:269
• Readonly bytesRead: number
The amount of received bytes.
Since
v0.5.3
node_modules/@types/node/net.d.ts:274
• Readonly bytesWritten: number
The amount of bytes sent.
Since
v0.5.3
node_modules/@types/node/net.d.ts:279
• Readonly closed: boolean
Is true after 'close' has been emitted.
Since
v18.0.0
node_modules/@types/node/stream.d.ts:1057
• Readonly connecting: boolean
If true,socket.connect(options[, connectListener]) was
called and has not yet finished. It will stay true until the socket becomes
connected, then it is set to false and the 'connect' event is emitted. Note
that the socket.connect(options[, connectListener]) callback is a listener for the 'connect' event.
Since
v6.1.0
node_modules/@types/node/net.d.ts:287
• Readonly destroyed: boolean
See writable.destroyed for further details.
node_modules/@types/node/net.d.ts:297
• 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:1058
• Optional Readonly localAddress: string
The string representation of the local IP address the remote client is
connecting on. For example, in a server listening on '0.0.0.0', if a client
connects on '192.168.1.1', the value of socket.localAddress would be'192.168.1.1'.
Since
v0.9.6
node_modules/@types/node/net.d.ts:304
• Optional Readonly localFamily: string
The string representation of the local IP family. 'IPv4' or 'IPv6'.
Since
v18.8.0, v16.18.0
node_modules/@types/node/net.d.ts:314
• Optional Readonly localPort: number
The numeric representation of the local port. For example, 80 or 21.
Since
v0.9.6
node_modules/@types/node/net.d.ts:309
• Readonly pending: boolean
This is true if the socket is not connected yet, either because .connect()has not yet been called or because it is still in the process of connecting
(see socket.connecting).
Since
v11.2.0, v10.16.0
node_modules/@types/node/net.d.ts:293
• 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
node_modules/@types/node/stream.d.ts:70
• Readonly readableAborted: boolean
Returns whether the stream was destroyed or errored before emitting 'end'.
Since
v16.8.0
node_modules/@types/node/stream.d.ts:64
• Readonly readableDidRead: boolean
Returns whether 'data' has been emitted.
Since
v16.7.0, v14.18.0
node_modules/@types/node/stream.d.ts:76
• Readonly readableEncoding: null | BufferEncoding
Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.
Since
v12.7.0
node_modules/@types/node/stream.d.ts:81
• Readonly readableEnded: boolean
Becomes true when 'end' event is emitted.
Since
v12.9.0
node_modules/@types/node/stream.d.ts:86
• 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
node_modules/@types/node/stream.d.ts:92
• Readonly readableHighWaterMark: number
Returns the value of highWaterMark passed when creating this Readable.
Since
v9.3.0
node_modules/@types/node/stream.d.ts:97
• 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
node_modules/@types/node/stream.d.ts:104
• Readonly readableObjectMode: boolean
Getter for the property objectMode of a given Readable stream.
Since
v12.3.0
node_modules/@types/node/stream.d.ts:109
• Readonly readyState: SocketReadyState
This property represents the state of the connection as a string.
- If the stream is connecting
socket.readyStateisopening. - If the stream is readable and writable, it is
open. - If the stream is readable and not writable, it is
readOnly. - If the stream is not readable and writable, it is
writeOnly.
Since
v0.5.0
node_modules/@types/node/net.d.ts:324
• Optional Readonly remoteAddress: string
The string representation of the remote IP address. For example,'74.125.127.100' or '2001:4860:a005::68'. Value may be undefined if
the socket is destroyed (for example, if the client disconnected).
Since
v0.5.10
node_modules/@types/node/net.d.ts:330
• Optional Readonly remoteFamily: string
The string representation of the remote IP family. 'IPv4' or 'IPv6'. Value may be undefined if
the socket is destroyed (for example, if the client disconnected).
Since
v0.11.14
node_modules/@types/node/net.d.ts:336
• Optional Readonly remotePort: number
The numeric representation of the remote port. For example, 80 or 21. Value may be undefined if
the socket is destroyed (for example, if the client disconnected).
Since
v0.5.10
node_modules/@types/node/net.d.ts:342
• Optional Readonly timeout: number
The socket timeout in milliseconds as set by socket.setTimeout().
It is undefined if a timeout has not been set.
Since
v10.7.0
node_modules/@types/node/net.d.ts:348
• 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:1049
• 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
node_modules/@types/node/stream.d.ts:1055
• 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:1050
• Readonly writableFinished: boolean
Is set to true immediately before the 'finish' event is emitted.
Since
v12.6.0
node_modules/@types/node/stream.d.ts:1051
• Readonly writableHighWaterMark: number
Return the value of highWaterMark passed when creating this Writable.
Since
v9.3.0
node_modules/@types/node/stream.d.ts:1052
• 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
node_modules/@types/node/stream.d.ts:1053
• 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
node_modules/@types/node/stream.d.ts:1056
• Readonly writableObjectMode: boolean
Getter for the property objectMode of a given Writable stream.
Since
v12.3.0
node_modules/@types/node/stream.d.ts:1054
▪ 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
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
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
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
▸ [asyncDispose](): Promise<void>
Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.
Promise<void>
Since
v20.4.0
node_modules/@types/node/stream.d.ts:651
▸ [asyncIterator](): AsyncIterableIterator<any>
node_modules/@types/node/stream.d.ts:646
▸ [captureRejectionSymbol](error, event, ...args): void
| Name | Type |
|---|---|
error |
Error |
event |
string |
...args |
any[] |
void
Duplex.[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:126
▸ _destroy(error, callback): void
| Name | Type |
|---|---|
error |
null | Error
|
callback |
(error: null | Error) => void
|
void
node_modules/@types/node/stream.d.ts:1111
▸ _final(callback): void
| Name | Type |
|---|---|
callback |
(error?: null | Error) => void
|
void
node_modules/@types/node/stream.d.ts:1112
▸ _read(size): void
| Name | Type |
|---|---|
size |
number |
void
node_modules/@types/node/stream.d.ts:127
▸ _write(chunk, encoding, callback): void
| Name | Type |
|---|---|
chunk |
any |
encoding |
BufferEncoding |
callback |
(error?: null | Error) => void
|
void
node_modules/@types/node/stream.d.ts:1103
▸ _writev(chunks, callback): void
| Name | Type |
|---|---|
chunks |
{ chunk: any ; encoding: BufferEncoding }[] |
callback |
(error?: null | Error) => void
|
void
node_modules/@types/node/stream.d.ts:1104
▸ addListener(event, listener): Socket
events.EventEmitter
- close
- connect
- data
- drain
- end
- error
- lookup
- ready
- timeout
| Name | Type |
|---|---|
event |
string |
listener |
(...args: any[]) => void
|
node_modules/@types/node/net.d.ts:374
▸ addListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"close" |
listener |
(hadError: boolean) => void
|
node_modules/@types/node/net.d.ts:375
▸ addListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"connect" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:376
▸ addListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"data" |
listener |
(data: Buffer) => void
|
node_modules/@types/node/net.d.ts:377
▸ addListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"drain" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:378
▸ addListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"end" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:379
▸ addListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"error" |
listener |
(err: Error) => void
|
node_modules/@types/node/net.d.ts:380
▸ addListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"lookup" |
listener |
(err: Error, address: string, family: string | number, host: string) => void
|
node_modules/@types/node/net.d.ts:381
▸ addListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"ready" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:385
▸ addListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"timeout" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:386
▸ address(): {} | AddressInfo
Returns the bound address, the address family name and port of the
socket as reported by the operating system:{ port: 12346, family: 'IPv4', address: '127.0.0.1' }
{} | AddressInfo
Since
v0.1.90
node_modules/@types/node/net.d.ts:228
▸ 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.
| Name | Type |
|---|---|
options? |
Pick<ArrayOptions, "signal"> |
a stream of indexed pairs.
Since
v17.5.0
node_modules/@types/node/stream.d.ts:541
▸ 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
▸ connect(options, connectionListener?): Socket
Initiate a connection on a given socket.
Possible signatures:
socket.connect(options[, connectListener])-
socket.connect(path[, connectListener])forIPCconnections. -
socket.connect(port[, host][, connectListener])for TCP connections. - Returns:
net.SocketThe socket itself.
This function is asynchronous. When the connection is established, the 'connect' event will be emitted. If there is a problem connecting,
instead of a 'connect' event, an 'error' event will be emitted with
the error passed to the 'error' listener.
The last parameter connectListener, if supplied, will be added as a listener
for the 'connect' event once.
This function should only be used for reconnecting a socket after'close' has been emitted or otherwise it may lead to undefined
behavior.
| Name | Type |
|---|---|
options |
SocketConnectOpts |
connectionListener? |
() => void
|
node_modules/@types/node/net.d.ts:136
▸ connect(port, host, connectionListener?): Socket
| Name | Type |
|---|---|
port |
number |
host |
string |
connectionListener? |
() => void
|
node_modules/@types/node/net.d.ts:137
▸ connect(port, connectionListener?): Socket
| Name | Type |
|---|---|
port |
number |
connectionListener? |
() => void
|
node_modules/@types/node/net.d.ts:138
▸ connect(path, connectionListener?): Socket
| Name | Type |
|---|---|
path |
string |
connectionListener? |
() => void
|
node_modules/@types/node/net.d.ts:139
▸ 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:1119
▸ destroy(error?): Socket
Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable
stream will release any internal resources and subsequent calls to push()will be ignored.
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 readable._destroy().
| Name | Type | Description |
|---|---|---|
error? |
Error |
Error which will be passed as payload in 'error' event |
Since
v8.0.0
node_modules/@types/node/stream.d.ts:578
▸ destroySoon(): void
Destroys the socket after all data is written. If the finish event was already emitted the socket is destroyed immediately.
If the socket is still writable it implicitly calls socket.end().
void
Since
v0.3.4
node_modules/@types/node/net.d.ts:99
▸ drop(limit, options?): Readable
This method returns a new stream with the first limit chunks dropped from the start.
| Name | Type | Description |
|---|---|---|
limit |
number |
the number of chunks to drop from the readable. |
options? |
Pick<ArrayOptions, "signal"> |
- |
a stream with limit chunks dropped from the start.
Since
v17.5.0
node_modules/@types/node/stream.d.ts:527
▸ emit(event, ...args): 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 |
string | symbol
|
...args |
any[] |
boolean
Since
v0.1.26
node_modules/@types/node/net.d.ts:387
▸ emit(event, hadError): boolean
| Name | Type |
|---|---|
event |
"close" |
hadError |
boolean |
boolean
node_modules/@types/node/net.d.ts:388
▸ emit(event): boolean
| Name | Type |
|---|---|
event |
"connect" |
boolean
node_modules/@types/node/net.d.ts:389
▸ emit(event, data): boolean
| Name | Type |
|---|---|
event |
"data" |
data |
Buffer |
boolean
node_modules/@types/node/net.d.ts:390
▸ emit(event): boolean
| Name | Type |
|---|---|
event |
"drain" |
boolean
node_modules/@types/node/net.d.ts:391
▸ emit(event): boolean
| Name | Type |
|---|---|
event |
"end" |
boolean
node_modules/@types/node/net.d.ts:392
▸ emit(event, err): boolean
| Name | Type |
|---|---|
event |
"error" |
err |
Error |
boolean
node_modules/@types/node/net.d.ts:393
▸ emit(event, err, address, family, host): boolean
| Name | Type |
|---|---|
event |
"lookup" |
err |
Error |
address |
string |
family |
string | number
|
host |
string |
boolean
node_modules/@types/node/net.d.ts:394
▸ emit(event): boolean
| Name | Type |
|---|---|
event |
"ready" |
boolean
node_modules/@types/node/net.d.ts:395
▸ emit(event): boolean
| Name | Type |
|---|---|
event |
"timeout" |
boolean
node_modules/@types/node/net.d.ts:396
▸ end(callback?): Socket
Half-closes the socket. i.e., it sends a FIN packet. It is possible the server will still send some data.
See writable.end() for further details.
| Name | Type | Description |
|---|---|---|
callback? |
() => void
|
Optional callback for when the socket is finished. |
The socket itself.
Since
v0.1.90
node_modules/@types/node/net.d.ts:359
▸ end(buffer, callback?): Socket
| Name | Type |
|---|---|
buffer |
string | Uint8Array
|
callback? |
() => void
|
node_modules/@types/node/net.d.ts:360
▸ end(str, encoding?, callback?): Socket
| Name | Type |
|---|---|
str |
string | Uint8Array
|
encoding? |
BufferEncoding |
callback? |
() => void
|
node_modules/@types/node/net.d.ts:361
▸ 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
▸ 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
awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false.
If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.
| 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 |
- |
Promise<boolean>
a promise evaluating to true if fn returned a truthy value for every one of the chunks.
Since
v17.5.0
node_modules/@types/node/stream.d.ts:506
▸ 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 awaited.
| 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 |
- |
a stream filtered with the predicate fn.
Since
v17.4.0, v16.14.0
node_modules/@types/node/stream.d.ts:434
▸ 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.
| Name |
|---|
T |
| 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 |
- |
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
node_modules/@types/node/stream.d.ts:489
▸ find(fn, options?): Promise<any>
| Name | Type |
|---|---|
fn |
(data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean> |
options? |
ArrayOptions |
Promise<any>
node_modules/@types/node/stream.d.ts:493
▸ 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.
| 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 |
- |
a stream flat-mapped with the function fn.
Since
v17.5.0
node_modules/@types/node/stream.d.ts:520
▸ 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 awaited.
This method is different from for await...of loops in that it can optionally process chunks concurrently.
In addition, a forEach iteration can only be stopped by having passed a signal option
and aborting the related AbortController while for await...of can be stopped with break or return.
In either case the stream will be destroyed.
This method is different from listening to the 'data' event in that it uses the readable event
in the underlying machinary and can limit the number of concurrent fn calls.
| 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 |
- |
Promise<void>
a promise for when the stream has finished.
Since
v17.5.0
node_modules/@types/node/stream.d.ts:453
▸ 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
node_modules/@types/node/events.d.ts:722
▸ 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(); // === falseboolean
Since
v0.11.14
node_modules/@types/node/stream.d.ts:287
▸ 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.
| 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. |
Since
v16.3.0
node_modules/@types/node/stream.d.ts:417
▸ 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
▸ 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 awaited before being passed to the result stream.
| 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 |
- |
a stream mapped with the function fn.
Since
v17.4.0, v16.14.0
node_modules/@types/node/stream.d.ts:425
▸ off(eventName, listener): Socket
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): Socket
Adds the listener function to the end of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple
times.
server.on('connection', (stream) => {
console.log('someone connected!');
});Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the
event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a| Name | Type | Description |
|---|---|---|
event |
string |
The name of the event. |
listener |
(...args: any[]) => void
|
The callback function |
Since
v0.1.101
node_modules/@types/node/net.d.ts:397
▸ on(event, listener): Socket
| Name | Type |
|---|---|
event |
"close" |
listener |
(hadError: boolean) => void
|
node_modules/@types/node/net.d.ts:398
▸ on(event, listener): Socket
| Name | Type |
|---|---|
event |
"connect" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:399
▸ on(event, listener): Socket
| Name | Type |
|---|---|
event |
"data" |
listener |
(data: Buffer) => void
|
node_modules/@types/node/net.d.ts:400
▸ on(event, listener): Socket
| Name | Type |
|---|---|
event |
"drain" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:401
▸ on(event, listener): Socket
| Name | Type |
|---|---|
event |
"end" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:402
▸ on(event, listener): Socket
| Name | Type |
|---|---|
event |
"error" |
listener |
(err: Error) => void
|
node_modules/@types/node/net.d.ts:403
▸ on(event, listener): Socket
| Name | Type |
|---|---|
event |
"lookup" |
listener |
(err: Error, address: string, family: string | number, host: string) => void
|
node_modules/@types/node/net.d.ts:404
▸ on(event, listener): Socket
| Name | Type |
|---|---|
event |
"ready" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:408
▸ on(event, listener): Socket
| Name | Type |
|---|---|
event |
"timeout" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:409
▸ once(event, listener): Socket
Adds a one-timelistener function for the event named eventName. The
next time eventName is triggered, this listener is removed and then invoked.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the
event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a| Name | Type | Description |
|---|---|---|
event |
string |
The name of the event. |
listener |
(...args: any[]) => void
|
The callback function |
Since
v0.3.0
node_modules/@types/node/net.d.ts:410
▸ once(event, listener): Socket
| Name | Type |
|---|---|
event |
"close" |
listener |
(hadError: boolean) => void
|
node_modules/@types/node/net.d.ts:411
▸ once(event, listener): Socket
| Name | Type |
|---|---|
event |
"connect" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:412
▸ once(event, listener): Socket
| Name | Type |
|---|---|
event |
"data" |
listener |
(data: Buffer) => void
|
node_modules/@types/node/net.d.ts:413
▸ once(event, listener): Socket
| Name | Type |
|---|---|
event |
"drain" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:414
▸ once(event, listener): Socket
| Name | Type |
|---|---|
event |
"end" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:415
▸ once(event, listener): Socket
| Name | Type |
|---|---|
event |
"error" |
listener |
(err: Error) => void
|
node_modules/@types/node/net.d.ts:416
▸ once(event, listener): Socket
| Name | Type |
|---|---|
event |
"lookup" |
listener |
(err: Error, address: string, family: string | number, host: string) => void
|
node_modules/@types/node/net.d.ts:417
▸ once(event, listener): Socket
| Name | Type |
|---|---|
event |
"ready" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:421
▸ once(event, listener): Socket
| Name | Type |
|---|---|
event |
"timeout" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:422
▸ pause(): Socket
Pauses the reading of data. That is, 'data' events will not be emitted.
Useful to throttle back an upload.
The socket itself.
node_modules/@types/node/net.d.ts:151
▸ 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): Socket
Adds the listener function to the beginning of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple
times.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});Returns a reference to the EventEmitter, so that calls can be chained.
| Name | Type | Description |
|---|---|---|
event |
string |
The name of the event. |
listener |
(...args: any[]) => void
|
The callback function |
Since
v6.0.0
node_modules/@types/node/net.d.ts:423
▸ prependListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"close" |
listener |
(hadError: boolean) => void
|
node_modules/@types/node/net.d.ts:424
▸ prependListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"connect" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:425
▸ prependListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"data" |
listener |
(data: Buffer) => void
|
node_modules/@types/node/net.d.ts:426
▸ prependListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"drain" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:427
▸ prependListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"end" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:428
▸ prependListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"error" |
listener |
(err: Error) => void
|
node_modules/@types/node/net.d.ts:429
▸ prependListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"lookup" |
listener |
(err: Error, address: string, family: string | number, host: string) => void
|
node_modules/@types/node/net.d.ts:430
▸ prependListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"ready" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:434
▸ prependListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"timeout" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:435
▸ prependOnceListener(event, listener): Socket
Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this
listener is removed, and then invoked.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});Returns a reference to the EventEmitter, so that calls can be chained.
| Name | Type | Description |
|---|---|---|
event |
string |
The name of the event. |
listener |
(...args: any[]) => void
|
The callback function |
Since
v6.0.0
node_modules/@types/node/net.d.ts:436
▸ prependOnceListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"close" |
listener |
(hadError: boolean) => void
|
node_modules/@types/node/net.d.ts:437
▸ prependOnceListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"connect" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:438
▸ prependOnceListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"data" |
listener |
(data: Buffer) => void
|
node_modules/@types/node/net.d.ts:439
▸ prependOnceListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"drain" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:440
▸ prependOnceListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"end" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:441
▸ prependOnceListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"error" |
listener |
(err: Error) => void
|
node_modules/@types/node/net.d.ts:442
▸ prependOnceListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"lookup" |
listener |
(err: Error, address: string, family: string | number, host: string) => void
|
node_modules/@types/node/net.d.ts:443
▸ prependOnceListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"ready" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:447
▸ prependOnceListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"timeout" |
listener |
() => void
|
node_modules/@types/node/net.d.ts:448
▸ push(chunk, encoding?): boolean
| Name | Type |
|---|---|
chunk |
any |
encoding? |
BufferEncoding |
boolean
node_modules/@types/node/stream.d.ts:407
▸ 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
▸ 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.
| Name | Type | Description |
|---|---|---|
size? |
number |
Optional argument to specify how much data to read. |
any
Since
v0.9.4
node_modules/@types/node/stream.d.ts:204
▸ 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.
| Name | Type |
|---|---|
T |
any |
| 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"> |
- |
Promise<T>
a promise for the final value of the reduction.
Since
v17.5.0
node_modules/@types/node/stream.d.ts:556
▸ reduce<T>(fn, initial, options?): Promise<T>
| Name | Type |
|---|---|
T |
any |
| Name | Type |
|---|---|
fn |
(previous: T, data: any, options?: Pick<ArrayOptions, "signal">) => T
|
initial |
T |
options? |
Pick<ArrayOptions, "signal"> |
Promise<T>
node_modules/@types/node/stream.d.ts:561
▸ ref(): Socket
Opposite of unref(), calling ref() on a previously unrefed socket will not let the program exit if it's the only socket left (the default behavior).
If the socket is refed calling ref again will have no effect.
The socket itself.
Since
v0.9.1
node_modules/@types/node/net.d.ts:242
▸ removeAllListeners(event?): Socket
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
node_modules/@types/node/events.d.ts:706
▸ removeListener(event, listener): Socket
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
node_modules/@types/node/stream.d.ts:1232
▸ removeListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"data" |
listener |
(chunk: any) => void
|
node_modules/@types/node/stream.d.ts:1233
▸ removeListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"drain" |
listener |
() => void
|
node_modules/@types/node/stream.d.ts:1234
▸ removeListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"end" |
listener |
() => void
|
node_modules/@types/node/stream.d.ts:1235
▸ removeListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"error" |
listener |
(err: Error) => void
|
node_modules/@types/node/stream.d.ts:1236
▸ removeListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"finish" |
listener |
() => void
|
node_modules/@types/node/stream.d.ts:1237
▸ removeListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"pause" |
listener |
() => void
|
node_modules/@types/node/stream.d.ts:1238
▸ removeListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"pipe" |
listener |
(src: Readable) => void
|
node_modules/@types/node/stream.d.ts:1239
▸ removeListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"readable" |
listener |
() => void
|
node_modules/@types/node/stream.d.ts:1240
▸ removeListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"resume" |
listener |
() => void
|
node_modules/@types/node/stream.d.ts:1241
▸ removeListener(event, listener): Socket
| Name | Type |
|---|---|
event |
"unpipe" |
listener |
(src: Readable) => void
|
node_modules/@types/node/stream.d.ts:1242
▸ removeListener(event, listener): Socket
| Name | Type |
|---|---|
event |
string | symbol
|
listener |
(...args: any[]) => void
|
node_modules/@types/node/stream.d.ts:1243
▸ resetAndDestroy(): Socket
Close the TCP connection by sending an RST packet and destroy the stream.
If this TCP socket is in connecting status, it will send an RST packet and destroy this TCP socket once it is connected.
Otherwise, it will call socket.destroy with an ERR_SOCKET_CLOSED Error.
If this is not a TCP socket (for example, a pipe), calling this method will immediately throw an ERR_INVALID_HANDLE_TYPE Error.
Since
v18.3.0, v16.17.0
node_modules/@types/node/net.d.ts:159
▸ resume(): Socket
Resumes reading after a call to socket.pause().
The socket itself.
node_modules/@types/node/net.d.ts:164
▸ setDefaultEncoding(encoding): Socket
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
node_modules/@types/node/stream.d.ts:1115
▸ setEncoding(encoding?): Socket
Set the encoding for the socket as a Readable Stream. See readable.setEncoding() for more information.
| Name | Type |
|---|---|
encoding? |
BufferEncoding |
The socket itself.
Since
v0.1.90
node_modules/@types/node/net.d.ts:145
▸ setKeepAlive(enable?, initialDelay?): Socket
Enable/disable keep-alive functionality, and optionally set the initial delay before the first keepalive probe is sent on an idle socket.
Set initialDelay (in milliseconds) to set the delay between the last
data packet received and the first keepalive probe. Setting 0 forinitialDelay will leave the value unchanged from the default
(or previous) setting.
Enabling the keep-alive functionality will set the following socket options:
SO_KEEPALIVE=1TCP_KEEPIDLE=initialDelayTCP_KEEPCNT=10TCP_KEEPINTVL=1
| Name | Type |
|---|---|
enable? |
boolean |
initialDelay? |
number |
The socket itself.
Since
v0.1.92
node_modules/@types/node/net.d.ts:222
▸ setMaxListeners(n): Socket
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
node_modules/@types/node/events.d.ts:716
▸ setNoDelay(noDelay?): Socket
Enable/disable the use of Nagle's algorithm.
When a TCP connection is created, it will have Nagle's algorithm enabled.
Nagle's algorithm delays data before it is sent via the network. It attempts to optimize throughput at the expense of latency.
Passing true for noDelay or not passing an argument will disable Nagle's
algorithm for the socket. Passing false for noDelay will enable Nagle's
algorithm.
| Name | Type |
|---|---|
noDelay? |
boolean |
The socket itself.
Since
v0.1.90
node_modules/@types/node/net.d.ts:202
▸ setTimeout(timeout, callback?): Socket
Sets the socket to timeout after timeout milliseconds of inactivity on
the socket. By default net.Socket do not have a timeout.
When an idle timeout is triggered the socket will receive a 'timeout' event but the connection will not be severed. The user must manually call socket.end() or socket.destroy() to
end the connection.
socket.setTimeout(3000);
socket.on('timeout', () => {
console.log('socket timeout');
socket.end();
});If timeout is 0, then the existing idle timeout is disabled.
The optional callback parameter will be added as a one-time listener for the 'timeout' event.
| Name | Type |
|---|---|
timeout |
number |
callback? |
() => void
|
The socket itself.
Since
v0.1.90
node_modules/@types/node/net.d.ts:186
▸ 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
awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true.
If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.
| 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 |
- |
Promise<boolean>
a promise evaluating to true if fn returned a truthy value for at least one of the chunks.
Since
v17.5.0
node_modules/@types/node/stream.d.ts:475
▸ take(limit, options?): Readable
This method returns a new stream with the first limit chunks.
| Name | Type | Description |
|---|---|---|
limit |
number |
the number of chunks to take from the readable. |
options? |
Pick<ArrayOptions, "signal"> |
- |
a stream with limit chunks taken.
Since
v17.5.0
node_modules/@types/node/stream.d.ts:534
▸ 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.
| Name | Type |
|---|---|
options? |
Pick<ArrayOptions, "signal"> |
Promise<any[]>
a promise containing an array with the contents of the stream.
Since
v17.5.0
node_modules/@types/node/stream.d.ts:465
▸ 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:1120
▸ unpipe(destination?): Socket
The readable.unpipe() method detaches a Writable stream previously attached
using the pipe method.
If the destination is not specified, then all pipes are detached.
If the destination is specified, but no pipe is set up for it, then
the method does nothing.
const fs = require('node:fs');
const readable = getReadableStreamSomehow();
const writable = fs.createWriteStream('file.txt');
// All the data from readable goes into 'file.txt',
// but only for the first second.
readable.pipe(writable);
setTimeout(() => {
console.log('Stop writing to file.txt.');
readable.unpipe(writable);
console.log('Manually close the file stream.');
writable.end();
}, 1000);| Name | Type | Description |
|---|---|---|
destination? |
WritableStream |
Optional specific stream to unpipe |
Since
v0.9.4
node_modules/@types/node/stream.d.ts:314
▸ unref(): Socket
Calling unref() on a socket will allow the program to exit if this is the only
active socket in the event system. If the socket is already unrefed callingunref() again will have no effect.
The socket itself.
Since
v0.9.1
node_modules/@types/node/net.d.ts:235
▸ 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('node:string_decoder');
function parseHeader(stream, callback) {
stream.on('error', callback);
stream.on('readable', onReadable);
const decoder = new StringDecoder('utf8');
let header = '';
function onReadable() {
let chunk;
while (null !== (chunk = stream.read())) {
const str = decoder.write(chunk);
if (str.includes('\n\n')) {
// Found the header boundary.
const split = str.split(/\n\n/);
header += split.shift();
const remaining = split.join('\n\n');
const buf = Buffer.from(remaining, 'utf8');
stream.removeListener('error', callback);
// Remove the 'readable' listener before unshifting.
stream.removeListener('readable', onReadable);
if (buf.length)
stream.unshift(buf);
// Now the body of the message can be read from the stream.
callback(null, header, stream);
return;
}
// Still reading the header.
header += str;
}
}
}Unlike push, stream.unshift(chunk) will not
end the reading process by resetting the internal reading state of the stream.
This can cause unexpected results if readable.unshift() is called during a
read (i.e. from within a _read implementation on a
custom stream). Following the call to readable.unshift() with an immediate push will reset the reading state appropriately,
however it is best to simply avoid calling readable.unshift() while in the
process of performing a read.
| 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'. |
void
Since
v0.9.11
node_modules/@types/node/stream.d.ts:380
▸ wrap(stream): Socket
Prior to Node.js 0.10, streams did not implement the entire node:streammodule API as it is currently defined. (See Compatibility for more
information.)
When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, thereadable.wrap() method can be used to create a Readable
stream that uses
the old stream as its data source.
It will rarely be necessary to use readable.wrap() but the method has been
provided as a convenience for interacting with older Node.js applications and
libraries.
const { OldReader } = require('./old-api-module.js');
const { Readable } = require('node:stream');
const oreader = new OldReader();
const myReader = new Readable().wrap(oreader);
myReader.on('readable', () => {
myReader.read(); // etc.
});| Name | Type | Description |
|---|---|---|
stream |
ReadableStream |
An "old style" readable stream |
Since
v0.9.4
node_modules/@types/node/stream.d.ts:406
▸ write(buffer, cb?): boolean
Sends data on the socket. The second parameter specifies the encoding in the case of a string. It defaults to UTF8 encoding.
Returns true if the entire data was flushed successfully to the kernel
buffer. Returns false if all or part of the data was queued in user memory.'drain' will be emitted when the buffer is again free.
The optional callback parameter will be executed when the data is finally
written out, which may not be immediately.
See Writable stream write() method for more
information.
| Name | Type |
|---|---|
buffer |
string | Uint8Array
|
cb? |
(err?: Error) => void
|
boolean
Since
v0.1.90
node_modules/@types/node/net.d.ts:115
▸ write(str, encoding?, cb?): boolean
| Name | Type |
|---|---|
str |
string | Uint8Array
|
encoding? |
BufferEncoding |
cb? |
(err?: Error) => void
|
boolean
node_modules/@types/node/net.d.ts:116
▸ 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
node_modules/@types/node/events.d.ts:387
▸ from(src): Duplex
A utility method for creating duplex streams.
-
Streamconverts writable stream into writableDuplexand readable stream toDuplex. -
Blobconverts into readableDuplex. -
stringconverts into readableDuplex. -
ArrayBufferconverts into readableDuplex. -
AsyncIterableconverts into a readableDuplex. Cannot yieldnull. -
AsyncGeneratorFunctionconverts into a readable/writable transformDuplex. Must take a sourceAsyncIterableas first parameter. Cannot yieldnull. -
AsyncFunctionconverts into a writableDuplex. Must return eithernullorundefined -
Object ({ writable, readable })convertsreadableandwritableintoStreamand then combines them intoDuplexwhere theDuplexwill write to thewritableand read from thereadable. -
Promiseconverts into readableDuplex. Valuenullis ignored.
| Name | Type |
|---|---|
src |
string | Object | ArrayBuffer | Promise<any> | AsyncGeneratorFunction | Iterable<any> | Stream | Blob | AsyncIterable<any> |
Since
v16.8.0
node_modules/@types/node/stream.d.ts:1091
▸ fromWeb(duplexStream, options?): Duplex
A utility method for creating a Duplex from a web ReadableStream and WritableStream.
| Name | Type |
|---|---|
duplexStream |
Object |
duplexStream.readable |
ReadableStream<any> |
duplexStream.writable |
WritableStream<any> |
options? |
Pick<DuplexOptions, "signal" | "highWaterMark" | "objectMode" | "encoding" | "decodeStrings" | "allowHalfOpen"> |
Since
v17.0.0
node_modules/@types/node/stream.d.ts:1135
▸ 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
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
node_modules/@types/node/events.d.ts:337
▸ isDisturbed(stream): boolean
Returns whether the stream has been read from or cancelled.
| Name | Type |
|---|---|
stream |
Readable | ReadableStream
|
boolean
Since
v16.8.0
node_modules/@types/node/stream.d.ts:58
▸ 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
node_modules/@types/node/events.d.ts:352
▸ toWeb(streamDuplex): Object
A utility method for creating a web ReadableStream and WritableStream from a Duplex.
| Name | Type |
|---|---|
streamDuplex |
Duplex |
Object
| Name | Type |
|---|---|
readable |
ReadableStream<any> |
writable |
WritableStream<any> |
Since
v17.0.0
node_modules/@types/node/stream.d.ts:1126
- @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