@knorm/virtuals

Virtuals plugin for @knorm/knorm.

This plugin adds support for virtual fields.

Installation

npm install --save @knorm/knorm @knorm/virtuals

@knorm/virtuals has a peer dependency on @knorm/knorm

Usage

const knorm = require("@knorm/knorm");
const knormVirtuals = require("@knorm/virtuals");

const orm = knorm({
  // knorm options
}).use(
  knormVirtuals({
    // @knorm/virtuals options
  })
);

Options

Option	Type	Default	Description
name	string	virtuals	The name of the plugin, allows accessing the plugin instance via Knorm's plugin registry