bycontract-plus v1.1.4

Description

node.js module for validating (primarily) function parameters.

This module provides a map that's the same as that provided by Dmitry Sheiko's 'bycontract' module, with the feature extensions described below. I tried contracting Dmitry to get his direction on the best way to extend his module, but he hasn't replied to me. Not knowing if I will have to repeat this extension work, I went with strategy that I can do most quickly and easily (but not necessarily best long-term)-- just make this new project that loads the bycontract module and adds to it.

Usage

Users will usually want to require/import the 'validate' and 'is' objects. The first for performing validations, and the second to add custom validator functions.

Enhancements

1. The original 'validate' function requires 2 and only 2 parameters. I support some optional extra params.
2. For validate calls where contract parameter (2nd) is an Array, I enforce that the number of value elements doesn't exceed that of the specified contract.
3. Test element count enforcement (previous item) is not done if 3rd parameter to validate call given as fase.
4. If the first non-boolean validate parameter after #2 is a string, then it is a message to be used in validation Errors, overriding the default.
5. The message for previous feature can use util.format % placeholders, with format varargs parameters being all remaining parameters.

I added the following validator functions, whose purposes should be obvious from the names.

• int
• date
• posint
• nonnegint
• posnum
• isotimestr
• plainobject

See file "readme.txt" for planned future enhancements.

Usage is same as for bycontract other than...

const { validate, is } = require("bcontract-plus");

// Allow more than two arguments elements:
validate(arguments, ["string", "int"], false);

// In case of validation failure, use the specified Error message.
validate(var, "string", "%ith element in issue list not a string", i);

// In particular, the run "[]" no longer means "any" Array, it means
// precisely [], a 0-length array.
// To get the original bycontract behavior to test for any Array, use:
validate(var, "", false);
validate(arguments, [""], false);