Functions

createDatabase

Create and initialize RxDB database

Signature:

createDatabase(config: RxDBConfig): Promise<RxDatabase>

Parameters:

Returns:

Promise<RxDatabase> -

getPluginConfig

Get plugin configuration from RxDBConfig Presets are overridden by explicit plugin config

Signature:

getPluginConfig(config: RxDBConfig): PluginConfig

Parameters:

Returns:

PluginConfig -

initializePlugins

Initialize RxDB plugins based on configuration

Signature:

initializePlugins(pluginConfig: PluginConfig): void

Parameters:

initializePremium

Initialize premium flag if enabled

Signature:

initializePremium(enabled: boolean): Promise<void>

Parameters:

Returns:

Promise<void> -

resetPlugins

Reset plugin initialization state (for testing)

Signature:

resetPlugins(): void

wrapStorageWithEncryption

Wrap storage with encryption if enabled

Signature:

wrapStorageWithEncryption(storage: any): any

Parameters:

Returns:

any - Wrapped storage with encryption wrapper applied

getEncryptionPassword

Get encryption password from config or environment

Signature:

getEncryptionPassword(encryption?: EncryptionConfig | undefined): string | undefined

Parameters:

Returns:

string \| undefined - The encryption password or undefined

detectEnvironment

Detect current environment

Signature:

detectEnvironment(): "browser" | "node"

Returns:

"browser" \| "node" -

getStorage

Get storage instance based on configuration

Signature:

getStorage(config: StorageConfig): Promise<RxStorage<any, any>>

Parameters:

Returns:

Promise<RxStorage<any, any>> -