value

> ⚠️ DEPRECATED ⚠️
>
> This module has been deprecated. You should lock your version to 0.3.3. It will be replaced by a different module.

value
=====
Convenient high-performance type-checking for JavaScript

value is designed to ease type-checking in JavaScript while keeping performance in mind. It comes with a fluent api to improve the readability of your code. Use value to sanitize function parameters and to provide better error messages if some type is unexpected.


Installation
------------

npm install value@0.3.3

**It's important to use this version number because newer versions will be an entire

If you're not using a CommonJS-system in the browser value is namespaced under window.jhnns.value.

Examples
--------

``javascript
var value = require("value");

// value takes every possible type in JavaScript
// and provides some methods to test for the type.
value(undefined).typeOf(Object); // = false
value(null).typeOf(Object); // = false

value([]).typeOf(Array); // = true
value([]).typeOf(Object); // = false

value(2).typeOf(Number); // = true

value(new String("hello")).typeOf(String); // = true
value(new String("hello")).typeOf(Object); // = false

value(/myRegExp/).typeOf(RegExp); // = true

value(document.createElement("a")).typeOf(HTMLAnchorElement); // = true


// value also provides a negation for better readability
value(2).notTypeOf(String); // = true


// you can also check conveniently for null and undefined with one call
value(undefined).isSet(); // = false
value(null).isNotSet(); // = true


// value also supports convenient type-checking within collections
value([1, 2, 3]).each.typeOf(Number); // = true
value([1, "2", 3]).any.notTypeOf(Number); // = true
value({ one: 1, two: 2, three: null }).any.isNotSet(); // = true
`

API
--------

$3

Tests if the subject is a child of the constructor. Respects the complete inheritance chain. Keep in mind that everything that is neither null nor undefined is a child of Object (see below).

$3

Negation of typeOf()

$3

Returns true when the subject is neither null nor undefined

$3

Negation of isSet()

$3

Invokes value(item).typeOf(constructor) on every item within the given collection. Returns true if every item returned true. A collection can be an array or an object.

$3

Invokes the value(item).isSet() on every item within the given collection. Returns true if every item returned true. A collection can be an array or an object.

$3

Negation of each.typeOf()

$3

Negation of each.isSet()

$3

Returns subject.constructor or null if the subject was null or undefined.

Fixes
--------

value contains a set of opinionated presumptions to avoid common and annoying pitfalls. It has been designed to act like you would expect from a language like ActionScript with optional static types. The returned result is not always conform with the JavaScript type-specification.

This is a collection of cases where value acts differently to the original typeof-operator:

$3

In contrast to typeof null === "object"

`javascript
value(null).typeOf(Object); // = false
`

$3

In constrast to typeof new String() === "object"

`javascript
value(new String()).typeOf(String); // = true
value(new String()).typeOf(Object); // = false
`

$3

In constrast to typeof [] === "object"

`javascript
value([]).typeOf(Object); // = false
value([]).typeOf(Array); // = true
`

$3

In constrast to typeof NaN === "number" and typeof Infinity === "number"

`javascript
value(NaN).typeOf(Number); // = false
value(Infinity).typeOf(Number); // = false
`

While NaN and Infinity are numbers from a theoretical point of view it's a common mistake when trying to sanitize calculation parameters. value assumes that numbers are numeric - that's why NaN and Infinity are not numbers.

Please note
--------

$3

This stays the same: value(arguments).typeOf(Array) will return false because arguments doesn't provide all methods of Array`.

License
--------

$3