JSPM

  • Created
  • Published
  • Downloads 115
  • Score
    100M100P100Q67375F
  • License MIT

constructor-based type checking

Package Exports

  • utils-type

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (utils-type) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

npm downloads NPM version build

utils-type

progressed.io

A posteriory, constructor-based, simple type checking for JS.

Heavily inspired by api design of ianstorm's is.

Implementation state : missing browser tests.

install

$ npm install utils-type

usage

var is = require('utils-type');

is( 0 );
// -> { number: '0' }
is( 42 );
// -> { number: 42 }
is( NaN );
// -> { number: 'NaN', nan: true }
is( null );
// -> { null: true }
is( true );
// -> { boolean: true, true: true }
is( false );
 // -> { boolean: 'false', false: true }
is( Infinity );
// -> { number: Infinity, infinity: true }
is( undefined );
// -> { undefined: true }
is( 'a string');
// -> { string: 'a string' }
is( /a regex/ );
// -> { object: true, regexp: /a regex/ }
is( [ Math.E ] );
// -> { object: true,  array: [ 2.718281828459045 ] }
is( { type : 'toy' });
// -> { object: { type: 'toy' } }
is( new Date());
// -> { object: true,  date: Mon Sep 08 2014 19:10:32 GMT+0200 (CEST) }
is( new Error() );
// -> { object: true, error: [Error] }
is( new Stream() );
// -> { object: true, eventemitter: true, stream: { domain: null, _events: {}, _maxListeners: 10 } }
is( new EventEmitter() );
// -> { object: true, eventemitter: { domain: null, _events: {}, _maxListeners: 10 } }
is( function(){ } );
// -> { object: true, function: [Function] }

composing

The function returns an object, so you can compose. No more booleans!

var arr = [false,0,/heythere/];

is(is(arr).array[0]).boolean
// -> 'false'       (truthy)
is(is(arr).array[1]).number
// -> '0'           (truthy)
is(is(arr).array[1]).object
// -> undefined     (nope)
is(is(arr).array[2]).regexp
// /heythere/     (truthy)

ternary what?

or is enough

var check = is([false,0,/heythere/]);
var grab = is(check.array[0]).object  || /* -> undefined  */
           is(check.array[1]).regexp  || /* -> undefined  */
           is(check.array[2]).regexp     /* -> /heythere/ */;

todo

  • Maybe chain everything ?
    • that is is([1,2,3]).array[1].number > 0
    • instead of what's the case now is(is([1,2,3]).array[1]).number > 0
  • Make browser tests
  • Make more server tests
  • Provide a map to rename type/instances names as properties since it seems to be an issue for some environments.

test

$ make test
or
$ npm test

license

LICENSE