Skip to content
Caprid

node

View .mdOpen in ClaudeOpen in ChatGPT

@caprid/relay/node: the SDK for Node. It exports everything @caprid/relay does, and its connect functions default createTransport to @caprid/relay-quic, the native QUIC transport adapter, an optional peer dependency installed next to this package. It uses that adapter even when a global WebTransport exists, and warns once when the global could replace it.

import { connectRelayPublisher } from '@caprid/relay/node';


const publisher = await connectRelayPublisher({ url, namespace, getToken });

Interfaces

Section titled “Interfaces”

Type Aliases

Section titled “Type Aliases”

Functions

Section titled “Functions”

References

Section titled “References”

ConnectRelayOptions

Section titled “ConnectRelayOptions”

Re-exports ConnectRelayOptions

ConnectRelayPublisherOptions

Section titled “ConnectRelayPublisherOptions”

Re-exports ConnectRelayPublisherOptions

ConnectRelaySubscriberOptions

Section titled “ConnectRelaySubscriberOptions”

Re-exports ConnectRelaySubscriberOptions

ConnectSupervisedPublisherOptions

Section titled “ConnectSupervisedPublisherOptions”

Re-exports ConnectSupervisedPublisherOptions

ConnectSupervisedSubscriberOptions

Section titled “ConnectSupervisedSubscriberOptions”

Re-exports ConnectSupervisedSubscriberOptions

DEFAULT_ENDPOINT

Section titled “DEFAULT_ENDPOINT”

Re-exports DEFAULT_ENDPOINT

Goaway

Section titled “Goaway”

Re-exports Goaway

KeyValuePair

Section titled “KeyValuePair”

Re-exports KeyValuePair

LocationFilter

Section titled “LocationFilter”

Re-exports LocationFilter

MessageParameters

Section titled “MessageParameters”

Re-exports MessageParameters

MoqtObject

Section titled “MoqtObject”

Re-exports MoqtObject

MoqTrackSource

Section titled “MoqTrackSource”

Re-exports MoqTrackSource

MoqtTransport

Section titled “MoqtTransport”

Re-exports MoqtTransport

NamespaceEvent

Section titled “NamespaceEvent”

Re-exports NamespaceEvent

NamespaceEventOptions

Section titled “NamespaceEventOptions”

Re-exports NamespaceEventOptions

NamespaceEvents

Section titled “NamespaceEvents”

Re-exports NamespaceEvents

PublishDone

Section titled “PublishDone”

Re-exports PublishDone

PublisherGeneration

Section titled “PublisherGeneration”

Re-exports PublisherGeneration

PublishProperty

Section titled “PublishProperty”

Re-exports PublishProperty

readJSON

Section titled “readJSON”

Re-exports readJSON

readText

Section titled “readText”

Re-exports readText

RegisterTrackOptions

Section titled “RegisterTrackOptions”

Re-exports RegisterTrackOptions

RelayCredential

Section titled “RelayCredential”

Re-exports RelayCredential

RelayError

Section titled “RelayError”

Re-exports RelayError

RelayErrorCode

Section titled “RelayErrorCode”

Re-exports RelayErrorCode

RelayErrorPhase

Section titled “RelayErrorPhase”

Re-exports RelayErrorPhase

RelayGroupWriter

Section titled “RelayGroupWriter”

Re-exports RelayGroupWriter

RelayPublisher

Section titled “RelayPublisher”

Re-exports RelayPublisher

RelaySubscriber

Section titled “RelaySubscriber”

Re-exports RelaySubscriber

RelaySubscription

Section titled “RelaySubscription”

Re-exports RelaySubscription

RelaySubscriptionHandlers

Section titled “RelaySubscriptionHandlers”

Re-exports RelaySubscriptionHandlers

RelayTrackOptions

Section titled “RelayTrackOptions”

Re-exports RelayTrackOptions

RelayTrackWriter

Section titled “RelayTrackWriter”

Re-exports RelayTrackWriter

RelayTransportFactory

Section titled “RelayTransportFactory”

Re-exports RelayTransportFactory

RequestError

Section titled “RequestError”

Re-exports RequestError

RestartReason

Section titled “RestartReason”

Re-exports RestartReason

roomEndpoint

Section titled “roomEndpoint”

Re-exports roomEndpoint

SubscribeOk

Section titled “SubscribeOk”

Re-exports SubscribeOk

Subscription

Section titled “Subscription”

Re-exports Subscription

SubscriptionConnectionClosedError

Section titled “SubscriptionConnectionClosedError”

Re-exports SubscriptionConnectionClosedError

SubscriptionEnd

Section titled “SubscriptionEnd”

Re-exports SubscriptionEnd

SubscriptionEndKind

Section titled “SubscriptionEndKind”

Re-exports SubscriptionEndKind

SubscriptionEvent

Section titled “SubscriptionEvent”

Re-exports SubscriptionEvent

SubscriptionEventOptions

Section titled “SubscriptionEventOptions”

Re-exports SubscriptionEventOptions

SubscriptionEvents

Section titled “SubscriptionEvents”

Re-exports SubscriptionEvents

SubscriptionHandlers

Section titled “SubscriptionHandlers”

Re-exports SubscriptionHandlers

SubscriptionOverflowError

Section titled “SubscriptionOverflowError”

Re-exports SubscriptionOverflowError

SubscriptionRequestError

Section titled “SubscriptionRequestError”

Re-exports SubscriptionRequestError

SupervisedPublisher

Section titled “SupervisedPublisher”

Re-exports SupervisedPublisher

SupervisedStatus

Section titled “SupervisedStatus”

Re-exports SupervisedStatus

SupervisedSubscriber

Section titled “SupervisedSubscriber”

Re-exports SupervisedSubscriber

SupervisionBackoff

Section titled “SupervisionBackoff”

Re-exports SupervisionBackoff

SwitchableHandlers

Section titled “SwitchableHandlers”

Re-exports SwitchableHandlers

SwitchableSubscription

Section titled “SwitchableSubscription”

Re-exports SwitchableSubscription

SwitchedInfo

Section titled “SwitchedInfo”

Re-exports SwitchedInfo

SwitchOptions

Section titled “SwitchOptions”

Re-exports SwitchOptions

WantHandlers

Section titled “WantHandlers”

Re-exports WantHandlers

WantOptions

Section titled “WantOptions”

Re-exports WantOptions

WantSwitchedInfo

Section titled “WantSwitchedInfo”

Re-exports WantSwitchedInfo

WantTarget

Section titled “WantTarget”

Re-exports WantTarget