dev-mode.md

Dev Mode

The dev-mode plugin adds many checks and validations to RxDB. This ensures that you use the RxDB API properly and so the dev-mode plugin should always be used when using RxDB in development mode.

• Adds readable error messages.
• Ensures that readonly JavaScript objects are not accidentally mutated.
• Adds validation check for validity of schemas, queries, ORM methods and document fields.
  • NOTICE: The dev-mode plugin does not perform schema checks against the data see schema validation for that.

IMPORTANT: The dev-mode plugin will increase your build size and decrease the performance. It must always be used in development. You should never use it in production.

import { addRxPlugin } from 'rxdb';
import { RxDBDevModePlugin } from 'rxdb/plugins/dev-mode';
addRxPlugin(RxDBDevModePlugin);

Usage with Node.js

async function createDb() {
    if (process.env.NODE_ENV !== "production") {
        await import('rxdb/plugins/dev-mode').then(
            module => addRxPlugin(module as any)
        );
    }
    const db = createRxDatabase( /* ... */ );
}

Usage with Angular

import { isDevMode } from '@angular/core';

async function createDb() {
    if (isDevMode()){
        await import('rxdb/plugins/dev-mode').then(
            module => addRxPlugin(module as any)
        );
    }

    const db = createRxDatabase( /* ... */ );
    // ...
}