Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TrackerOptions

Custom configuration for client Trackers.

Hierarchy

  • TrackerOptions

Index

Properties

Optional connectTimeoutMs

connectTimeoutMs: undefined | number

Optionally override the amount of time to wait for this tracker to connect.

Optional customPeerOpts

customPeerOpts: PeerConfig

Optionally overwrite client values passed into each Peer created by this tracker.

Optional isNativeServer

isNativeServer: undefined | false | true

If set to true, this tracker must be running the custom Switchboard Peering Server. This allows for self-hosting more streamlined peering servers, rather than relying on tracker protocol.

Optional isRequired

isRequired: undefined | false | true

If true, the whole Switchboard will fail (and disconnect from all trackers) if this tracker fails to connect.

Optional maxReconnectAttempts

maxReconnectAttempts: undefined | number

If specified, Switchboard will only attempt to reconnect to this tracker this many times before giving up.

Optional passCode

passCode: undefined | string

If using the native Switchboard Peering Server which requires a passcode, it can be set here.

Optional trackerAnnounceInterval

trackerAnnounceInterval: undefined | number

The interval, in milliseconds, that each tracker should re-announce. Don't change this unless you know what you're doing.

uri

uri: string

The WebSocket URI to join.

Generated using TypeDoc