Readonly
idOptional
inboundRead stream
Optional
outboundWrite stream - it's preferable to use the write method
Readonly
protocolDo we have a connection to read from?
Do we have a connection to write on?
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Optional
options: boolean | AddEventListenerOptionsAttach a raw inbound stream and setup a read stream
Optional
decoderOptions: DecoderOptionsAttach a raw outbound stream and setup a write stream
Closes the open connection to peer
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Removes the event listener in target's event listener list with the same type, callback, and options.
Optional
listener: null | EventHandler<PeerStreamEvents[K]>Optional
options: boolean | EventListenerOptionsOptional
detail: CustomEventInit<Detail>Send a message to this peer.
Throws if there is no stream
to write to available.
Thin wrapper around a peer's inbound / outbound pubsub streams