Interface TransportConfig

Configuration passed to transport/types.ITransport.connect.

Remarks

passphrase is used by Gun.js SEA for symmetric encryption of the Gun node key. PeerJS ignores it — PeerJS connections are encrypted by the underlying WebRTC DTLS handshake.

interface TransportConfig {
    mode: "auto" | "peer" | "gun";
    passphrase: string;
    role: "host" | "player";
    roomId: string;
}

Index

Properties

mode passphrase role roomId

Properties

mode

mode: "auto" | "peer" | "gun"

Which transport to use. 'auto' tries PeerJS first, falls back to Gun.js.

passphrase

passphrase: string

Four-word passphrase used by Gun SEA encryption (e.g. 'tiger-lamp-cloud-seven').

role

role: "host" | "player"

'host' creates the room; 'player' joins an existing room.

roomId

roomId: string

Six-character uppercase room code (e.g. 'XK7RQZ').

Interface TransportConfig

Remarks

Index

Properties

Properties

mode

passphrase

role

roomId

Settings

On This Page