ReadonlyauthProvides access to authentication methods for logging on to Ditto Cloud.
ReadonlypresenceProvides access to the SDK's presence functionality.
ReadonlysmallProvides access to the SDK's small peer info functionality.
ReadonlystoreProvides access to the SDK's store functionality.
ReadonlysyncProvides access to the SDK's sync functionality.
The persistence directory used by Ditto to persist data, represented by an absolute path.
It is not recommended to directly read or write to this directory as its structure and contents are managed by Ditto and may change in future versions.
When Logger is enabled, logs may be written to this directory even after a Ditto instance was deallocated. Please refer to the documentation of Logger for more information.
In browsers, this string acts as a namespace for the in-memory data store and does not correspond to a file system directory.
The configuration used to initialize this Ditto instance.
The returned value is frozen, use
ditto.config.copy() to obtain a modifiable
copy.
when accessed after this Ditto instance has been closed.
Configure a custom identifier for this peer.
When using presence.observe(), each remote peer is represented by a short UTF-8 "device name". By default this will be a truncated version of the device's hostname.
Changes to this property after ditto.sync.start() was called will only take effect after the next restart of sync. The value does not need to be unique among peers. Device names longer than 24 bytes will be truncated once ditto.sync.start() is called.
Returns true if an offline license token has been set, otherwise returns false.
true once Ditto.close() has been called, otherwise
false.
Returns the current transport configuration, frozen. If you want to modify the transport config, make a copy first. Or use the updateTransportConfig() convenience method. By default peer-to-peer transports (Bluetooth, WiFi, and AWDL) are enabled if available in the current environment (Web, Node, OS, etc.).
StaticDEFAULT_The default root directory used for Ditto data persistence.
This property returns the platform-dependent directory where Ditto stores
its data when a relative persistence directory path (or null) is
provided.
Node.js
~/Library/Application Support/ditto directory.~/AppData/Roaming/ditto directory.~/.local/share/ditto directory.Note that sandboxed environments, such as Electron apps running under Apple's App Sandbox, can require setting a custom persistence directory as these default directories may not be accessible.
React Native
Browsers
In browsers, this returns an empty string as there is no file system access.
A string representing the default root directory.
DittoConfig.persistenceDirectory for more information on configuring the persistence directory.
StaticVERSIONA string containing the semantic version of the Ditto SDK. Example: 4.4.3
Shut down Ditto and release all resources.
Must be called before recreating a Ditto instance that uses the same persistence directory.
Register observer for changes of underlying transport conditions.
Ditto will prevent the process from exiting as long as there are active transport conditions observers (not relevant when running in the browser).
called when underlying transport conditions change with
the changed condition and its source.
Activate a Ditto instance by setting an offline only license token. You
cannot initiate sync with Ditto before you have activated it. The offline
license token is only valid for the smallPeersOnly
mode.
the license token to activate the Ditto instance
with. You can find yours on the Ditto portal.
Assigns a new transports configuration. By default peer-to-peer transports (Bluetooth, WiFi, and AWDL) are enabled. You may use this method to alter the configuration at any time, however sync will not begin until ditto.sync.start() is called.
Convenience method for updating the transport config. Creates a copy of the
current transport config, passes that copy to the update closure,
allowing it to mutate as needed, and sets that updated copy afterwards.
StaticdisableDon't terminate the process when callbacks are pending for a long time.
Some methods in the Ditto library accept asynchronous functions as callback parameters. If these asynchronous functions do not resolve within a certain period of time after having been invoked by Ditto, deadlock detection gets triggered, resulting in the termination of the process.
When Ditto is executed in a Node.js environment with an interactive
debugger attached, this deadlock detection might get activated upon
encountering a breakpoint. Calling Ditto.disableDeadlockDetection()
disables this behavior, thus allowing the use of an interactive debugger
without triggering the deadlock detection.
This feature is only available in Node.js environments.
StatichasReturns true if deadlock detection is enabled.
See Ditto.disableDeadlockDetection() for more information.
When called outside of a Node.js environment, this method always returns
false as deadlock detection is only available in Node.js.
true if deadlock detection is enabled
StaticisCheck if the current environment supports running Ditto.
Required APIs include:
BigIntFinalizationRegistryWeakRefInternet Explorer is not supported.
true if the environment is supported
StaticopenAsynchronously creates and returns a new Ditto instance using the
provided configuration.
This is the recommended way to initialize Ditto in async environments.
Optionalconfig: DittoConfigThe configuration to initialize the new Ditto instance with. Defaults to DittoConfig.default.
The newly created Ditto instance.
DittoError with code persistenceDirectoryLocked if the
chosen persistence directory is already in use by another Ditto instance.
DittoError with code invalidDittoConfig if the passed in
DittoConfig's contents do not meet the required validation criteria.
For detailed information on the validation requirements, consult the
documentation of the individual properties of DittoConfig.
May throw other DittoErrors for other initialization failures.
Ditto.openSync() for a blocking, non-async alternative.
StaticopenSynchronously creates and returns a new Ditto instance using the provided
configuration.
This is a blocking convenience method for initializing Ditto, intended for use in non-async environments.
Optionalconfig: DittoConfigThe configuration to initialize the new Ditto instance with. Defaults to DittoConfig.default.
The newly created Ditto instance.
DittoError with code persistenceDirectoryLocked if the
chosen persistence directory is already in use by another Ditto instance.
DittoError with code invalidDittoConfig if the passed in
DittoConfig's contents do not meet the required validation criteria.
For detailed information on the validation requirements, consult the
documentation of the individual properties of DittoConfig.
May throw other DittoErrors for other initialization failures.
Ditto.open() for an async alternative.
Ditto is the entry point for accessing Ditto-related functionality.