Skip to main content

Interface: PresenceOptions

Extends

  • BusOptions

Properties

heartbeatMs?

optional heartbeatMs?: number;

Presence heartbeat interval in ms. Default 2000.

Inherited from

BusOptions.heartbeatMs

kind?

optional kind?: PeerKind;

What this client announces itself as. Defaults to 'worker' when there is no document, else 'tab'.

Inherited from

BusOptions.kind

pruneAfterMs?

optional pruneAfterMs?: number;

Peers silent for longer than this are dropped. Default 5000ms.


transport?

optional transport?: (name) => Transport;

Transport factory, mainly for tests. Defaults to defaultTransport.

Parameters

ParameterType
namestring

Returns

Transport

Inherited from

BusOptions.transport