Whether this stream is inbound or outbound
Unique identifier for a stream. Identifiers are not unique across muxers.
If no data is transmitted over the stream in this many ms, the stream will be aborted with an InactivityTimeoutError
ReadonlylogA logging implementation that can be used to log stream-specific messages
OptionalmaxThe maximum number of bytes to store when paused. If receipt of more bytes from the remote end of the stream causes the buffer size to exceed this value the stream will be reset and a 'close' event emitted.
This value can be changed at runtime.
OptionalmaxWhen the .send method returns false it means that the underlying resource
has signalled that it's write buffer is full. If the user continues to call
.send, outgoing bytes are stored in an internal buffer until the
underlying resource signals that it can accept more data.
If the size of that internal buffer exceed this value the stream will be reset and a 'close' event emitted.
This value can be changed at runtime.
The protocol negotiated for this stream
Protected ReadonlyreadAny data stored here is emitted before any new incoming data.
This is used when the stream is paused or if data is pushed onto the stream
The status of the readable end of the stream
The status of the readable end of the remote end of the stream - n.b. this requires the underlying stream transport to support sending STOP_SENDING messages or similar.
The status of the writable end of the remote end of the stream
ProtectedsendingThe current status of the message stream
ReadonlytimelineTimestamps of when stream events occurred
If this property is true, the underlying transport has signalled that its
write buffer is full and that .send should not be called again.
A drain event will be emitted after which is its safe to call .send
again to resume sending.
Protected ReadonlywriteThe status of the writable end of the stream
True once 'end' has been emitted. Read this instead of waiting for the event, which fires only once and may already have passed.
It does not mean the readable end is closed, or that the read buffer is empty. Where the readable end is still open, data can be pushed back after 'end', for example by unwrapping a byte stream that read ahead.
Returns the number of bytes that are queued to be read
Returns the number of bytes that are queued to be written
Close immediately for reading and writing and send a reset message (local error)
Add a listener for an event
Optionaloptions: boolean | AddEventListenerOptionsOptionaloptions: boolean | AddEventListenerOptionsStop accepting new data to send and return a promise that resolves when any unsent data has been written into the underlying resource.
Optionaloptions: AbortOptionsSend a message to the remote end of the stream informing them that any incoming data will be discarded so they should stop sending.
This requires the underlying resource to support this operation - for example the QUIC, WebTransport, WebRTC transports do but anything multiplexed using Yamux or Mplex do not.
Optionaloptions: AbortOptionsThe dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
ProtecteddispatchhandleWindowUpdate is called when the stream receives a window update frame
Returns the number of listeners for the event type
ProtectedmaybeEmit 'end' if nothing is buffered and no more data will be delivered. Emits at most once
When an extending class reads data from it's implementation-specific source, call this method to allow the stream consumer to read the data.
Returns a promise that resolves when the stream can accept new data or rejects if the stream is closed or reset before this occurs.
Optionaloptions: AbortOptionsCalled by extending classes when the remote closes its readable end
Called by extending classes when the remote closes its writable end
Receive a reset message - close immediately for reading and writing (remote error)
The underlying resource or transport this stream uses has closed - it is not possible to send any more messages though any data still in the read buffer may still be read
Optionalerr: ErrorStop emitting further 'message' events. Any received data will be stored in
an internal buffer. If the buffer size reaches maxReadBufferLength, the
stream will be reset and a StreamAbortEvent emitted.
If the underlying resource supports it, the remote peer will be instructed to pause transmission of further data.
ProtectedprocessQueue the passed data to be emitted as a 'message' event either during the next tick or sooner if data is received from the underlying resource.
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
Optionallistener: EventHandler<MessageStreamEvents[K]> | nullOptionaloptions: boolean | EventListenerOptionsResume emitting 'message' events.
If the underlying resource supports it, the remote peer will be informed that it is ok to start sending data again.
Type-safe version of EventTarget.dispatchEvent - only events from the event map are supported.
Attempting to dispatch an unsupported event results in a TypeScript compilation error.
Optionaldetail: CustomEventInit<Detail>Write data to the stream. If the method returns false it means the internal buffer is now full and the caller should wait for the 'drain' event before sending more data.
This method may throw if:
Send a message to the remote muxer, informing them no more data messages will be read by this end of the stream - this is a no-op on Yamux streams
Optionaloptions: AbortOptionsSend a message to the remote muxer, informing them no more data messages will be sent by this end of the stream
Stop sending window updates temporarily - in the interim the the remote send window will exhaust and the remote will stop sending data
Send a reset message to the remote muxer
Start sending window updates as normal
Potentially sends a window update enabling further remote writes to take place.
Similar to the .push method, except this ensures the passed data is
emitted before any other queued data.
YamuxStream is used to represent a logical stream within a session