Synopsis

pred is a library of JavaScript predicates (functions that test their input and return a boolean).

  

  


Install

With NPM

``sh
npm install pred
`

From source

`sh
git clone https://github.com/pluma/pred.git
cd pred
npm install
make test
`

API

Complex predicates

$3

Returns a predicate that returns true if all of the predicates return true for the given input.

$3

Returns a predicate that returns true if any of the predicates return true for the given input.

$3

Returns a predicate that returns true if the input is identical to the given value (using === strict equal comparison).

$3

Returns a predicate that returns true if the input is equivalent to the given value.

Example:

`javascript
console.log(deepEquals({a: {b: ['c']}})({a: {b: ['c']}})); // true
`

$3

Returns a predicate that returns true if the input is greater than (but not equal to) the given value.

$3

Returns a predicate that returns true if the input is less than (but not equal to) the given value.

$3

Returns a predicate that returns true if the input is greater than (or equal to) the given minValue but less than (but not equal to) the given maxValue.

$3

Returns a predicate that returns true if the input is an object that has a property with the given name.

$3

Returns a predicate that returns true if the input is an object that has a property with each of the given names.

$3

Returns a predicate that returns true if the input is an object that has a property matching the given properties (name/value mapping).

$3

Returns a predicate that returns true if the input value matches the given regular expression.

$3

Returns a predicate that returns true if the input value is an instance of the given constructor function.

$3

Returns a predicate that returns true if the input value is the prototype of the given object.

$3

Returns a predicate that returns true if the given prototype is the prototype of the input value.

Simple predicates

$3

Returns true if the input is falsey (i.e. evaluates as boolean false).

$3

Returns true if the input is truthy (i.e. evaluates as boolean true).

$3

Returns true if the input is array-like and all of its items are equal, or if it is not array-like.

$3

Returns true if the given value is an Array.

$3

Returns true if the given value is an Array or an object with a numeric length property.

$3

Returns true if the given value is a Boolean.

$3

Returns true if the given value is falsey, an array-like object with length zero or an object with no properties.

$3

Returns true if the given value is a Function.

$3

Returns true if the given value is NaN.

$3

Returns true if the given value is null.

$3

Returns true if the given value is a number other than NaN.

$3

Returns true if the given value is an object other than null.

$3

Returns true if the given value is an instance of Object.

$3

Returns true if the given value is a string.

$3

Returns true if the given value is undefined`.

Unlicense

This is free and unencumbered public domain software. For more information, see http://unlicense.org/ or the accompanying UNLICENSE file.