Skip to content

IceServer

Defined in: packages/core/src/peerborne-config.ts:46

Project-local ICE-server interface used in place of the DOM lib’s RTCIceServer so consumers don’t need lib: ["DOM"] in their tsconfig (especially Node-only consumers of peerborne-node.ts). The shape mirrors the subset of WebIDL RTCIceServer peerborne actually reads and forwards into libp2p’s webRTC transport configuration.

Structurally compatible with RTCIceServer in browser environments, so values typed as IceServer can be cast to RTCIceServer[] at the libp2p call site without runtime conversion.

optional credential?: string

Defined in: packages/core/src/peerborne-config.ts:53

Credential (typically a shared secret / password) for TURN authentication. Optional.


urls: string | string[]

Defined in: packages/core/src/peerborne-config.ts:48

A single STUN/TURN URL or a list of URLs for this server entry.


optional username?: string

Defined in: packages/core/src/peerborne-config.ts:50

Username for TURN authentication. Optional.