RxDB extra plugins

This package provides small utility plugins for RxDB, including searchable fields and automatic timestamps.

Install

npm i rxdb-extra --save

Simple search

import { addRxPlugin, createRxDatabase } from 'rxdb';
import { getRxStorageMemory } from 'rxdb/plugins/storage-memory';
import { RxDBSimpleSearchPlugin } from 'rxdb-extra';

addRxPlugin(RxDBSimpleSearchPlugin);

const database = await createRxDatabase({
  name: 'appdb',
  storage: getRxStorageMemory(),
});

await database.addCollections({
  users: {
    schema: {
      version: 0,
      primaryKey: 'id',
      type: 'object',
      properties: {
        id: { type: 'string', maxLength: 100 },
        name: { type: 'string' },
        age: { type: 'integer' },
        searchIndex: { type: 'string', default: '' },
      },
    },
    options: {
      searchable: {
        fields: ['name', 'age'], // required
        index: 'searchIndex',
      },
    },
  },
});

const doc = await database.users.insert({
  id: '1',
  name: 'Bill Gates',
  age: 67,
});

console.log(doc.toJSON().searchIndex); // "bill gates 67"

searchable.fields is required and defines which attributes are merged into the stored search string.

Modify values before indexing

If you want to keep the default serializer but normalize a specific field first, use modifier. This is useful for formatting date values.

options: {
  searchable: {
    fields: ['name', 'createdAt'],
    index: 'searchIndex',
    modifier: (value, field) =>
      field === 'createdAt' ? String(value ?? '').slice(0, 10) : value,
  },
}

Custom serializer

options: {
  searchable: {
    fields: ['name', 'age'],
    index: 'searchIndex',
    serializer: (data, fields) =>
      fields.map((field) => String(data[field] ?? '')).join('|').toUpperCase(),
  },
}

You can then query the stored field with regular RxDB selectors, for example using $regex.

Strict schema

The strict-schema plugin removes properties that are not declared in schema.properties. It runs on insert and save, so out-of-schema fields are stripped before documents are persisted.

import { addRxPlugin, createRxDatabase } from 'rxdb';
import { getRxStorageMemory } from 'rxdb/plugins/storage-memory';
import { RxDBStrictSchemaPlugin } from 'rxdb-extra';

addRxPlugin(RxDBStrictSchemaPlugin);

const database = await createRxDatabase({
  name: 'appdb',
  storage: getRxStorageMemory(),
});

await database.addCollections({
  users: {
    schema: {
      version: 0,
      primaryKey: 'id',
      type: 'object',
      properties: {
        id: { type: 'string', maxLength: 100 },
        name: { type: 'string' },
        age: { type: 'integer' },
      },
      required: ['id', 'name'],
    },
  },
});

const doc = await database.users.insert({
  id: '2',
  name: 'Alan Turing',
  age: 41,
  extraField: 'will be removed',
});

console.log(doc.toJSON());
// { id: '2', name: 'Alan Turing', age: 41 }

Notes:

• Only top-level keys are filtered.
• Fields declared in schema.properties are preserved.

Timestamps

The timestamps plugin automatically maintains createdAt and updatedAt fields for each document. It is enabled by default and can also be configured per collection or at database level. The timestamp fields must already be declared in schema.properties; the plugin does not mutate the schema.

import { addRxPlugin, createRxDatabase } from 'rxdb';
import { getRxStorageMemory } from 'rxdb/plugins/storage-memory';
import { RxDBTimestampsPlugin } from 'rxdb-extra';

addRxPlugin(RxDBTimestampsPlugin);

const database = await createRxDatabase({
  name: 'appdb',
  storage: getRxStorageMemory(),
  options: {
    timestamps: true,
  },
});

await database.addCollections({
  users: {
    schema: {
      version: 0,
      primaryKey: 'id',
      type: 'object',
      properties: {
        id: { type: 'string', maxLength: 100 },
        name: { type: 'string' },
        createdAt: { type: 'string', format: 'date-time', final: true },
        updatedAt: { type: 'string', format: 'date-time' },
      },
      required: ['id', 'name', 'createdAt', 'updatedAt'],
    },
  },
});

To disable timestamps for a specific collection, set timestamps: false:

options: {
  timestamps: false,
}

You can also customize the field names with:

options: {
  timestamps: {
    createdAt: 'created_on',
    updatedAt: 'updated_on',
  },
}

To format generated timestamps before save, use modifier:

options: {
  timestamps: {
    modifier: (value, field) =>
      value instanceof Date ? value.toISOString().slice(0, 10) : value,
  },
}