Interface IdentityOfflinePlayground

An identity to be used while in development when you want to control the app name and the site ID of the peer.

Phased out in 4.x. Replaced by DittoConfig with connect: { mode: 'smallPeersOnly' }. This API will be replaced by DittoConfig in v5.

interface IdentityOfflinePlayground {
    appID: string;
    siteID?: number | BigInt;
    type: "offlinePlayground";
}

Properties

Properties

appID: string

The app ID for the Ditto instance.

siteID?: number | BigInt

The siteID needs to be an unsigned 64 bit integer >= 0, i.e. either a regular non-fractional number or a BigInt in the range between 0 and 2^64 - 1 (inclusive). If siteID is 0, Ditto will generate an appropriate site ID and persist it when needed. Default is 0.

siteID is deprecated and should no longer be specified in an offline playground identity.

type