Code Monkey home page Code Monkey logo

engine-asserts's Introduction

Engine Asserts

Simple nodejs module that allow you to verify if enviroment version of node/mongodb matches version specified in your package.json/.nvmrc

Installation

As expected, you can install via npm:

$ npm install engine-asserts

Example Usage

insert following code in your package.json .nvmrc

//package.json
...
{
  "engines": {
    "node": "1.0.0",
    "mongodb": "3.2.1"
  }
}
...

// or .nvmrc
5.5.0

You can then use in your Node apps:

//your app.js

/**
 *
 * @param {Object} [cfg]
 * @param {Boolean} [cfg.consoleDisabled]       disable console output (default: false)
 * @param {String} [cfg.rootPath]               path to package.jsn & .nvmrc directory (default: process.cwd())
 */
var engineAsserts = require('engine-asserts')(cfg);


/**
 *
 * @param {Boolean} justWarn            true - displays error output in console
 *										false - displays error output in console and  * @returns {Boolean}
 */
engineAsserts.checkNodeVersion(justWarn);


/**
 *
 * @param {Boolean} justWarn            true - displays error output in console ,
 *										false - displays error output in console and exits process
 * @returns {Q.Promise}
 */
engineAsserts.checkMongoVersion(justWarn);

You can run tests:

$ npm run test

engine-asserts's People

Contributors

vojtesaak avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.