1.0.2 • Published 11 years ago

validate-arg-types v1.0.2

Weekly downloads
2
License
MIT
Repository
github
Last release
11 years ago

Validate Argument types.

Validate parameters you pass into methods. Can log or throw errors.

Mostly written for the purpose of understanding npm, writing a module, functional programming, etc. There are lots of argument validators I could have used.

Installation

  npm install https://github.com/emileswain/validate-arg-types/tarball/master --save
  
  npm install validate-arg-types --save
  

Usage

New instance
  var ValidateArgs = require('validate-arg-types');

  var validator = ValidateArgs('MyMethod');
  
To Throw or not to Throw

Fail fast?, in which case call throwThem first. All tests will throw at the first opportunity.

  validator.throwThem().isString('isAString');
  

or fail last and once.

  validator.throwThem(false).isString('isAString').throw();
  

you may want to log all errors detected.

  validator.throwThem(false).isString('isAString').log().throw();
  
  validator.isString('isAString').log().throw();
  
Basic tests
  
  validator.throwThem().isString('isAString');
  validator.throwThem().isArray([]);
  validator.throwThem().isObject({});
  validator.throwThem().isNumber(1234);
  validator.throwThem().isFunction(function(){});
  
Advanced tests.
  
  validator.throwThem().isObject({name:'firstname'}).has('name');
  
  

Contributing

I'm no javascript expert, writing this was in part a foray into writing an npm module on a whim.

Thanks to

https://quickleft.com/blog/creating-and-publishing-a-node-js-module/

Pondering

For the purpose of experimentation, how to re-factor to add in <,>,= tests on properties.

Release History

  • 1.0.0 follows semver recommendations.
  • 0.2.0 Adding functionality, docs.
  • 0.1.0 Initial release
1.1.0

11 years ago

1.0.2

11 years ago

1.0.0

11 years ago

0.2.0

11 years ago

0.1.0

11 years ago