Skip to content

getDefaultConfig

getDefaultConfig(webrtcIceServers?): PeerborneConfig

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

Returns a fresh default config with no bootstrap peers.

Use this as a starting point for browser applications. Connect to peers after initialization via peerborne.connect([relayMultiaddr]).

For configs with bootstrap peers baked in, use defaultConfig(defaultBootstrapConfig(['/ip4/.../ws/p2p/...'])) instead.

Each call creates new IDB-backed blockstore/datastore instances so callers can safely mutate the returned config without leaking state across consumers. For shared/reused configs, store the result in a variable.

Note: Lazily instantiated — safe to import in Node.js test environments that lack IndexedDB as long as the function is not called.

readonly Readonly<IceServer>[]

Optional override for the WebRTC ICE server list. When undefined, DEFAULT_WEBRTC_ICE_SERVERS is used.

PeerborneConfig