Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

preconditions

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

preconditions

Support for Precondition error checking in Node.js.

3.0.2
latest
Source
npm

Version published: 3 years ago

Maintainers: 1

Created: 10 years ago

Source

Preconditions Library

Support for Precondition error checking in Node.js

Ensuring a fail fast development environment can help developers find bugs quicker and easier. Ensuring all invariants are true at an initial point of contact will help you ensure this fail fast environment. The Preconditions library will assist you in doing just that by immediately throwing an Error if any of your invariants fail. You can mix and match standard Guava API with convenience functions both with and without chaining.

Version 2 Additions

Version 2 adds a new entry point on the interface, 'errr'. The errr interface decorates the errr node module and helps to solve some important issues with Node, listed below. See https://www.npmjs.com/package/errr. This version also updates the module to Node 5 paradigms.

When templating / generating an error message, we must not string concat strings that are never used. Building an error message before it is needed, will take away cycles from more important tasks in the event queue. There are great performance gains to be found here if you are templating error messages.
Appends Error stack traces together. If you append errors at each layer of your code, and only print the stack trace at the top most layer of your code, you will have stack traces that paint a much clearer picture when debugging. Allows you to get a more informative stack trace when using promise chains.
Add debug params to stack traces to assist with bug resolution.

Install

npm install preconditions

Preconditions Interface

There are four functions that are exposed from the library.

errr() - Verify a one value at a time while building an 'errr' object. You can append errors together and add debug params to the stack trace.
singleton() - Verify one value at a time with a chainable preconditions interface.
instance() - Create a testing suite passing in a single object. Run a single, or multiple tests on the passed in object. Shouldn't be used in production code.
constructor() - Get the constructor function so you can extend the Preconditions library (see below for example). Shouldn't be used in production code.

Examples Using the Errr Interface (.errr())

You can use a static instance to verify one value at a time while using the errr module to build an errr. For more on the errr module see here https://github.com/corybill/Preconditions#errrdecorator and here https://github.com/corybill/errr#errr.

  
    var preconditions = require("preconditions").errr();
  
    preconditions.shouldBeDefined(someObj.valueOne).test();
    preconditions.shouldBeDefined(someObj.valueOne, "Custom error message.").test();
    preconditions.shouldBeDefined(someObj.valueOne, "Error (%s:%s): Error Message.", [errType, errCode]).test();
    preconditions.shouldBeDefined(someObj.valueOne, "Custom error message.").debug({param1: "someDebugParam"}).test();
    preconditions.shouldBeDefined(someObj.valueOne, "Custom error message.").appendTo(someErrorObj).test();
    preconditions.shouldBeDefined(someObj.valueTwo, "Error (%s:%s): Error Message.", [errType, errCode]);
      .debug({param1: "someDebugParam"})
      .appendTo(someErrorObj)
      .test();

Examples Using In Promise Chain

Best practice for achieving fail fast concept when function must return promise;

  
    var preconditions = require("preconditions").errr();

    new BlueBirdProm(function (resolve, reject {

      // THIS WILL THROW AND BE CAUGHT AT THE NEXT LEVEL OF THE CHAIN
      // NOTICE YOU DO NOT HAVE TO CALL REJECT BECAUSE WE ARE THROWING WITHIN A PROMISE.
      preconditions.shouldBeDefined(someObj.valueTwo, "Error (%s:%s): Error Message.", [errType, errCode]);
            .debug({param1: "someDebugParam"})
            .set("reason", "Some Error").set("statusCode", 400)
            .appendTo(someErrorObj)
            .test(); // Can also short hand this call to .t();
              
      return someAsynchFunc().then(function (result) {
        resolve(result);
      }).catch(function (err) {
        reject(err);
      });
    });

Examples Using the Singleton Interface (.singleton())

You can use a static instance to verify one value at a time.

  
    var preconditions = require("preconditions").singleton();
  
    preconditions.shouldBeDefined(someObj.valueOne)
      .shouldBeDefined(someObj.valueTwo, "Error (%s:%s): Error Message.", [errType, errCode]).test();
      .shouldBeDefined(someObj.valueThree, "Custom error message.");

Examples Using Instance Interface (.instance())

Should not be used in production code!

Setup Instance

  
    var preconditions = require("preconditions").instance(this);
    
    preconditions.shouldBeDefined("foo.deep.stringValue", "Custom error message.")
      .checkArguments("FOO" === "FOO");

Examples Using The Constructor (.constructor())

Should not be used in production code!

The Preconditions object itself is exposed so that you can extend the Preconditions class.

  
    let Constructor = preconditions.constructor();
    let ChildClass = class extends Constructor {
      constructor(out) {
        super(out);
      }

      shouldBeFoo(value, message) {
        let msg = message || defaultMessage;

        if (value !== "FOO") {
          throw new Error(msg);
        }
      }
    };
    
    new ChildClass(this).shouldBeDefined("foo.deep.stringValue", "Custom error message.")
      .shouldBeFoo("foo.deep.foo");

NPM Scripts

npm run test - Run linter and unit tests.
npm run ut - Use Maddox to Run Unit Tests.
npm run perf - Use Maddox to Performance metrics.
npm run uap - Use Maddox to Unit Tests and Performance metrics.
npm run lint - Run linter.
npm run docs - Rebuild public API Docs.

Missing API or Bugs

Please reach out to me (Cory Parrish) if you would like a new precondition added or if you think you have found a bug.

###Known Issues

Release 1.0.2 has an npm install bug and has been deprecated! Please update!
If you are using windows and are seeing npm install issues due to the '^' in the package.json, please update node to >= (v0.10.28).

Releases

2.0.0
- Adds errr interface which decorates errr node module
- Allows templating in singleton interface.
- Notes the poor performance in instance interface. Should not be used in production code.
- Redesign of code.
- Now uses maddox for unit testing.
- Moves to Node 5 paradigms.
1.0.8 - Removed 'underscore' and added 'lodash'.
- Added a .jshintrc file and a more extensive linting process
- Separated dependencies and dev-dependencies to reduce installation load (A big thanks to Esteban Ordano (eordano) for doing this work).
1.0.7 - First official public release.

API

Classes

InstanceValidator

Validate values in a nested object using a dot notation structure (e.g. .shouldBeString("Person.Address.Street.zip")) System will validate the the Person, Person.Address, and Person.Address.Street objects exist, and will validate that zip is a String.

Use this interface if you want to utilize the following functionality:

Nested object validation using a dot notation.

SingletonValidator

Validate single value with a chainable interface. Use this interface if you want to utilize the following functionality:

Error message templating.
Only templates error message if validation fails which saves event queue cycles.
Chain together precondition validations.

ErrrDecorator

Error Builder allows you to use optional functions to build an error object. The error can have appended stack traces and debug params to assist with debugging.

ErrrValidator

Validate single value with a buildable interface on top of the errr node module. Use this interface if you want to utilize the following functionality:

Error message templating.
Only templates error message if ErrrValidator fails which saves event queue cycles.
Gives ability to append Stack traces to an existing error.
Gives ability to append debug params to stack trace.

Preconditions

Preconditions entry point interface.

InstanceValidator

Use this interface if you want to utilize the following functionality:

Nested object validation using a dot notation.

Kind: global class

InstanceValidator
- new InstanceValidator(objectUnderTest)
- .shouldBeDefined(configPath, [message]) ⇒ this
- .shouldBeUndefined(configPath, [message]) ⇒ this
- .shouldBeNonEmptyArray(configPath, [message]) ⇒ this
- .shouldBeArray(configPath, [message]) ⇒ this
- .shouldNotBeArray(configPath, [message]) ⇒ this
- .shouldBeObject(configPath, [message]) ⇒ this
- .shouldNotBeObject(configPath, [message]) ⇒ this
- .shouldBeEmpty(configPath, [message]) ⇒ this
- .shouldNotBeEmpty(configPath, [message]) ⇒ this
- .shouldBeFunction(configPath, [message]) ⇒ this
- .shouldNotBeFunction(configPath, [message]) ⇒ this
- .shouldBeString(configPath, [message]) ⇒ this
- .shouldNotBeString(configPath, [message]) ⇒ this
- .shouldBeNumber(configPath, [message]) ⇒ this
- .shouldNotBeNumber(configPath, [message]) ⇒ this
- .shouldBeFinite(configPath, [message]) ⇒ this
- .shouldBeInfinite(configPath, [message]) ⇒ this
- .shouldBeBoolean(configPath, [message]) ⇒ this
- .shouldNotBeBoolean(configPath, [message]) ⇒ this
- .shouldBeDate(configPath, [message]) ⇒ this
- .shouldNotBeDate(configPath, [message]) ⇒ this
- .shouldBeRegExp(configPath, [message]) ⇒ this
- .shouldNotBeRegExp(configPath, [message]) ⇒ this
- .shouldBeFalsey(configPath, [message]) ⇒ this
- .shouldNotBeFalsey(configPath, [message]) ⇒ this
- .shouldBeFalsy(configPath, [message]) ⇒ this
- .shouldNotBeFalsy(configPath, [message]) ⇒ this
- .shouldBeTruthy(configPath, [message]) ⇒ this
- .shouldNotBeTruthy(configPath, [message]) ⇒ this
- .checkArgument(expression, [message], [template]) ⇒ this
- .checkState(expression, [message]) ⇒ this
- .checkElementIndex(index, size, [message]) ⇒ this
- .checkPositionIndex(index, size, [message]) ⇒ this
- .checkPositionIndexes(start, end, size, [message]) ⇒ this

new InstanceValidator(objectUnderTest)

Param	Type	Description
objectUnderTest	`Object`	Object to run validations against.

instanceValidator.shouldBeDefined(configPath, [message]) ⇒ `this`

Throws an error if any value does not exist in the objectToTest, from configPath. Throws an error if the last key from configPath is defined.