Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.07 KB

README.md

File metadata and controls

56 lines (39 loc) · 1.07 KB

MONGO-SEQ

loopback v3 mixin to add support for sequential property.

usage

  • install via npm.
npm install loopback-mixin-mongo-seq
  • update server.js to load mixin.
const loopbackMixinMongoSeq = require('loopback-mixin-mongo-seq');

loopbackMixinMongoSeq(app, {
  dataSource: 'MongoDS', modelName: 'Counter'
});
  • add mixins property to the required model.
"mixins": {
  "Seq" : {
    "propertyName": "ID",
    "step": 1,
    "initialVal": 1,
    "readOnly": true,
    "definiton": {
      "index": { "unique": true }
    }
  }
}

options

propertyName: property name, defaults to ID.

step: defaults to 1.

initialVal: value to start counter from if the sequence doesn't exist, defaults to the highest record in the target model if not found then 1.

readOnly: if the value should be protested against changes, defaults to true.

definition: property definition ( can be used to add index to property), defaults to {}.

DEBUG MODE

DEBUG='loopback:mixin:mongo-seq'