Class ESPRMNeoBase

Configures and manages the ESP RainMaker Neo SDK.

Holds process-wide configuration, adapters, and auth state. Call ESPRMNeoBase.configure once before using other SDK APIs. Low-level initialization helpers live in utils/baseUtils.

Index

Constructors

constructor

new ESPRMNeoBase(): ESPRMNeoBase
Returns ESPRMNeoBase

Accessors

`Static`storageAdapter

get storageAdapter(): undefined | ESPStorageAdapter
Gets the current storage adapter, if any.

Returns undefined | ESPStorageAdapter
The configured ESPStorageAdapter, or undefined.
- Defined in src/ESPRMNeoBase.ts:192
set storageAdapter(adapter: ESPStorageAdapter): void
Sets the storage adapter for the SDK.

Prefer setStorageAdapter for clearer call sites.
Parameters
- adapter: ESPStorageAdapter
  Adapter implementing ESPStorageAdapter.
Returns void
- Defined in src/ESPRMNeoBase.ts:204

`Static`subscriptionManager

get subscriptionManager(): ESPRMNeoSubscriptionManager
Returns the subscription manager instance.

Returns ESPRMNeoSubscriptionManager
The ESPRMNeoSubscriptionManager for managing subscriptions.

Throws
If the SDK has not been initialized.
- Defined in src/ESPRMNeoBase.ts:168

Methods

`Static`configure

configure(config: ESPRMNeoBaseConfig): void
Configures the ESP RainMaker Neo SDK with the given options. Must be called before using any other SDK functionality.

If the SDK is already configured, previous state is disposed first so re-configure is safe.
Parameters
- config: ESPRMNeoBaseConfig
  Base URL (include API Gateway stage if any), Cognito/IoT settings, and optional adapters.
Returns void
Throws
If the configuration is invalid or initialization fails.
- Defined in src/ESPRMNeoBase.ts:83

`Static`dispose

dispose(): void
Disposes SDK state and resets peer singletons so configure can run again. Prefer this over jest.resetModules() when tearing down in tests.

Returns void
- Defined in src/ESPRMNeoBase.ts:128

`Static`getAuthInstance

getAuthInstance(): ESPRMNeoAuth
Returns the authentication instance for the SDK.

Returns ESPRMNeoAuth
The ESPRMNeoAuth instance used for auth operations.

Throws
If the SDK has not been initialized.
- Defined in src/ESPRMNeoBase.ts:157

`Static`getConfig

getConfig(): Readonly<ESPRMNeoBaseConfig>
Returns a readonly copy of the current SDK configuration.

Returns Readonly<ESPRMNeoBaseConfig>
Frozen shallow copy of the active config.

Throws
If the SDK has not been initialized.
- Defined in src/ESPRMNeoBase.ts:146

`Static`getLocalControlAdapter

getLocalControlAdapter(): undefined | ESPLocalControlAdapterInterface
Gets the local control adapter.

Returns undefined | ESPLocalControlAdapterInterface
The local control adapter, or undefined if not configured.
- Defined in src/ESPRMNeoBase.ts:258

`Static`getLocalDiscoveryAdapter

getLocalDiscoveryAdapter(): undefined | ESPLocalDiscoveryAdapterInterface
Gets the local discovery adapter.

Returns undefined | ESPLocalDiscoveryAdapterInterface
The local discovery adapter, or undefined if not configured.
- Defined in src/ESPRMNeoBase.ts:288

`Static`getProvisionAdapter

getProvisionAdapter(): undefined | ESPProvisionAdapterInterface
Gets the provisioning adapter.

Returns undefined | ESPProvisionAdapterInterface
The provisioning adapter, or undefined if not configured.
- Defined in src/ESPRMNeoBase.ts:229

`Static`getTransportOrder

getTransportOrder(): string[]
Returns a copy of the global default transport priority order.

Returns string[]
Shallow copy of the current transport order.
- Defined in src/ESPRMNeoBase.ts:312

`Static`init

init(config: ESPRMNeoBaseConfig): void
Initializes the ESP RainMaker Neo SDK with the given configuration. Back-compat alias for configure.
Parameters
- config: ESPRMNeoBaseConfig
  Same options as configure.
Returns void
- Defined in src/ESPRMNeoBase.ts:120

`Static`setLocalControlAdapter

setLocalControlAdapter(adapter: ESPLocalControlAdapterInterface): void
Sets the local control adapter used to talk to nodes over the LAN via the rmaker_local_ctrl protocol.
Parameters
- adapter: ESPLocalControlAdapterInterface
  Adapter implementing ESPLocalControlAdapterInterface.
Returns void
Throws
If the SDK is not initialized or the adapter is invalid.
- Defined in src/ESPRMNeoBase.ts:242

`Static`setLocalDiscoveryAdapter

setLocalDiscoveryAdapter(adapter: ESPLocalDiscoveryAdapterInterface): void
Sets the local discovery adapter used to browse for nodes on the LAN (mDNS). Required before subscribing to localDiscovery via ESPRMNeoUser.subscribe.
Parameters
- adapter: ESPLocalDiscoveryAdapterInterface
  Adapter implementing ESPLocalDiscoveryAdapterInterface.
Returns void
Throws
If the SDK is not initialized or the adapter is invalid.
- Defined in src/ESPRMNeoBase.ts:272

`Static`setProvisioningAdapter

setProvisioningAdapter(adapter: ESPProvisionAdapterInterface): void
Sets the provisioning adapter for the SDK.
Parameters
- adapter: ESPProvisionAdapterInterface
  Adapter implementing ESPProvisionAdapterInterface.
Returns void
Throws
If the SDK is not initialized or the adapter is invalid.
- Defined in src/ESPRMNeoBase.ts:216

`Static`setStorageAdapter

setStorageAdapter(adapter: ESPStorageAdapter): void
Sets the storage adapter for the SDK and re-initializes persistent storage.
Parameters
- adapter: ESPStorageAdapter
  Adapter implementing ESPStorageAdapter.
Returns void
Throws
If the SDK is not initialized or the adapter is invalid.
- Defined in src/ESPRMNeoBase.ts:179

`Static`setTransportOrder

setTransportOrder(order: string[]): void
Sets the global default transport priority order. New nodes adopt this order at construction; existing nodes keep their current order unless updated per-node via ESPRMNeoNode.setTransportOrder.
Parameters
- order: string[]
  Non-empty ordered list of transport modes (built-in ESPTransportMode values or custom string keys).
Returns void
Throws
If the order is empty or not an array.
- Defined in src/ESPRMNeoBase.ts:303

Class ESPRMNeoBase

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns ESPRMNeoBase

Accessors

StaticstorageAdapter

Returns undefined | ESPStorageAdapter

Parameters

Returns void

StaticsubscriptionManager

Returns ESPRMNeoSubscriptionManager

Throws

Methods

Staticconfigure

Parameters

Returns void

Throws

Staticdispose

Returns void

StaticgetAuthInstance

Returns ESPRMNeoAuth

Throws

StaticgetConfig

Returns Readonly<ESPRMNeoBaseConfig>

Throws

StaticgetLocalControlAdapter

Returns undefined | ESPLocalControlAdapterInterface

StaticgetLocalDiscoveryAdapter

Returns undefined | ESPLocalDiscoveryAdapterInterface

StaticgetProvisionAdapter

Returns undefined | ESPProvisionAdapterInterface

StaticgetTransportOrder

Returns string[]

Staticinit

Parameters

Returns void

StaticsetLocalControlAdapter

Parameters

Returns void

Throws

StaticsetLocalDiscoveryAdapter

Parameters

Returns void

Throws

StaticsetProvisioningAdapter

Parameters

Returns void

Throws

StaticsetStorageAdapter

Parameters

Returns void

Throws

StaticsetTransportOrder

Parameters

Returns void

Throws

Settings

On This Page

`Static`storageAdapter

`Static`subscriptionManager

`Static`configure

`Static`dispose

`Static`getAuthInstance

`Static`getConfig

`Static`getLocalControlAdapter

`Static`getLocalDiscoveryAdapter

`Static`getProvisionAdapter

`Static`getTransportOrder

`Static`init

`Static`setLocalControlAdapter

`Static`setLocalDiscoveryAdapter

`Static`setProvisioningAdapter

`Static`setStorageAdapter

`Static`setTransportOrder