Skip to main content

Class: Core

worker.Core

Core singleton representing an instance of the Rust Core SDK

Use install in order to customize the server connection options or other global process options.

Properties#

native#

Readonly native: Core


options#

Readonly options: CompiledCoreOptions

Methods#

install#

Static install(options): Promise<Core>

Instantiate a new Core object and set it as the singleton instance

If Core has already been instantiated with instance or this method, will throw a IllegalStateError.

Parameters#

NameType
optionsCoreOptions

Returns#

Promise<Core>


instance#

Static instance(): Promise<Core>

Get or instantiate the singleton Core object

If Core has not been instantiated with install or this method, a new Core instance will be installed and configured to connect to the local docker compose setup.

Returns#

Promise<Core>