SignalCD Modern PoC API
    Preparing search index...

    Interface PeerJsTransportOptions

    interface PeerJsTransportOptions {
        lobby?: Omit<PeerJsLobbyOptions, "peerFactory">;
        namespace?: string;
        peerFactory?: PeerFactory;
        peerOptions?: DefaultPeerFactoryOptions;
        recipientPhoneNumber?: string;
        rendezvousSecret: string | Uint8Array<ArrayBufferLike>;
    }
    Index
    lobby? namespace? peerFactory? peerOptions? recipientPhoneNumber? rendezvousSecret
    lobby?: Omit<PeerJsLobbyOptions, "peerFactory">

    peerjslib lobby tuning. maxMessageBytes is interpreted as the maximum e2e-col application payload; transport framing overhead is added internally.

    namespace?: string

    Domain-separates this consumer before the document UUID is added.

    peerFactory?: PeerFactory

    Test/custom PeerJS factory. Mutually exclusive with peerOptions.

    peerOptions?: DefaultPeerFactoryOptions

    Options for peerjslib's DefaultPeerFactory (PeerJS Cloud is used when omitted).

    recipientPhoneNumber?: string

    Local Signal-style routing identity. When present, incoming e2e-col fan-out frames are reduced to this recipient's encrypted envelope before delivery to DocumentSession. peerjslib itself still sees only opaque bytes.

    rendezvousSecret: string | Uint8Array<ArrayBufferLike>

    Invitation-grade capability material; never the public document UUID itself.

    Settings
    Member Visibility

    On This Page
    Properties