mongo-counter

0.0.2 • Public • Published

node-mongo-counter

This module allows you to create a counter field using MongoDB

Installation

npm install mongo-counter

Usage

mongoCounter = new MongoCounter(db, [collectionName], [documentID], [fieldName], [initialValue])
// collectionName: (default: 'counters') the collection to use for the counter
// documentID: (default: undefined) the document ID where the counter is created
// fieldName: (default: 'counter') the field where the counter is stored
// initialValue: (default: 1) the initial value for the counter

mongoCounter.createDocument(function (err, objectID) {  })
// Creates the document for the counter. Not required when `documentID` is defined

mongoCounter.next(function (err, value) {  })
// Generates the next number

mongoCounter.set(value, function (err, success) {  })
// Sets the counter to `value`

mongoCounter.reset(function (err, success) {  })
// Resets the counter to the initial value

Dependencies (2)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i mongo-counter

    Weekly Downloads

    2

    Version

    0.0.2

    License

    BSD

    Last publish

    Collaborators

    • manuelcabral