checkif.js

This library aims to perform various checks in the javascript environment.

Installation

checkif.js is distributed as a npm package.

npm install checkif.js

Documentation

The library is constituted of a set of checkers to perform different verifications.

`is`

import { is } from 'checkif.js';

Types

This group of methods allows to verify if a given value is from a specific type.

`null(value)`

Check if a given value is null.

`undefined(value)`

Check if a given value is undefined.

`nan(value)`

Check if a given value is NaN. Same as Number.isNaN.

is.nan(NaN); // true
is.nan(Number.NaN); // true

`array(value)`

Check if a given value is an array. This method is the same as Array.isArray, if available.

is.array([]); // true
is.array(new Array(0)); // true

`boolean(value)`

Check if a given value is a boolean.

is.boolean(true); // true
is.boolean(new Boolean(0)); // true

`string(value)`

Check if a given value is a string.

is.string(''); // true
is.string(String('')); // true
is.string(new String('')); // true

`char(value)`

Check if a given value is a char.

is.char(' '); // true
is.char('1'); // true
is.char(1); // false

`date(value)`

Check if a given value is a date.

is.date(new Date('November 23, 1998 03:24:00')); // true, my birthdate btw ;)

`number(value)`

Check if a given value is a number.

is.number(Number(1)); // true
is.number(new Number(1)); // true
is.number(1); // false

`regexp(value)`

Check if a given value is a regular expression.

is.regexp(\a\); // true
is.regexp(RegExp()); // true
is.regexp(new RegExp()); // true

`object(value)`

Check if a given value is an object.

is.object({}); // true
is.object(String(1)); // true
is.object('1'); // false

`pureObject(value)`

Check if a given value is a pure JSON object.

is.pureObject({}); // true
is.pureObject({ value: 1 }); // true
is.pureObject(new Date()); // false

`function(value)`

Check if a given value is a function.

is.function(function () { }); // true
is.function(x => x); // true
is.function(new Function('x', 'return x')); // true

`error(value)`

Check if a given value is an error.

is.error(Error('Fatal error')); // true
is.error(new Error('Nothing works anymore')); // true

`domNode(value)`

Check if a given value is a DOM node.

// Browser
is.domNode(window.document.body); // true
// Node.js
let dom = new JSDOM(`<html !DOCTYPE><body></body></html>`);
is.domNode(dom.window.document.body); // true

`windowObject(value)`

Check if a given value is a window object.

// Browser
is.windowObject(window); // true
// Node.js
let dom = new JSDOM(`<html !DOCTYPE></html>`)
is.windowObject(dom.window); // true

RegExp

This group of methods allows to verify if a given string is from a specific known type of value. To be implemented

String

This group of methods allows to verify if a given string is a from a specific format. To be implemented

Arithemetic

This group of methods allows to verify if a given number is a from a specific class of numbers. To be implemented

Environment

This group of methods allows to verify if the current environment is a specific environment. To be implemented

Time

This group of methods allows to verify if a date is a specific kind. To be implemented

`all`

import { all } from 'checkif.js';

This method verifies if all elements in a given enumerable (array or object) match a specific value or function.

`all` on arrays

all([0, 0, 0, 0], 0); // true
all([2, 4, 6, 8], x => x%2 === 0); // true

all([0, 1, 2, 3], 1); // false

`all` on objects

all({ x: 1, y: 1 }, 1); // true
let a = {};
all({ x: a, y: a }, x => x === a); // true

all({ x: 0, y: new Number(0) }, function(x){ return x === 0; }); // false

Strict mode

The second parameter of all() is automatically resolved as a matcher function when it's a function. But you may want to check if the values are exactly equal to the function (as a value). In this case, you should use the strict mode by setting the 3rd parameter to true (default false).

import { all } from 'checkif.js';

let _function = function (x) { ... };
all({ x: _function, y: _function }, _function, true); // true

Feel free to build complex logic for your checks.

import { all, is } from 'checkif.js';
all({ x: ['a', 'b'], y: ['a', 'c'] }, x => all(x, is.char)); // true

`any`

import { all } from 'checkif.js';

This method verifies if any element in a given enumerable (array or object) match a specific value or function.

`any` on arrays

any([0,1,2,3], 2); // true
any([0,1,2,3], x => x === 0); // true

all([0, 1, 2, 3], 1); // false
any([0,1,2,3], x => x === 5); //false

`any` on objects

any({ x : 1, y : 1}, 1); // true
any({ x : 1, y : 1}, x => x === 1); // true

any({ x : 1, y : 1}, 2); // false
any({ x : 1, y : 1}, x => x === 2); // false

Strict mode

The second parameter of any() is automatically resolved as a matcher function when it's a function. But you may want to check if the values are exactly equal to the function (as a value). In this case, you should use the strict mode by setting the 3rd parameter to true (default false).

import { any } from 'checkif.js';

let _function = function (x) { ... };
any({ x: 0, y: _function }, _function, true); // true

Contributing

Any help is wanted and welcome. You can check out our github issues and projects or our slack page.

Please follow our contributing guidelines.

lucas-carl / checkif.js Goto Github PK

checkif.js's Introduction

checkif.js

Installation

Documentation

is

Types

null(value)

undefined(value)

nan(value)

array(value)

boolean(value)

string(value)

char(value)

date(value)

number(value)

regexp(value)

object(value)

pureObject(value)

function(value)

error(value)

domNode(value)

windowObject(value)

RegExp

String

Arithemetic

Environment

Time

all

all on arrays

all on objects

Strict mode

any

any on arrays

any on objects

Strict mode

Contributing

checkif.js's People

Contributors

Stargazers

Watchers

Recommend Projects

Recommend Topics

Recommend Org

`is`

`null(value)`

`undefined(value)`

`nan(value)`

`array(value)`

`boolean(value)`

`string(value)`

`char(value)`

`date(value)`

`number(value)`

`regexp(value)`

`object(value)`

`pureObject(value)`

`function(value)`

`error(value)`

`domNode(value)`

`windowObject(value)`

`all`

`all` on arrays

`all` on objects

`any`

`any` on arrays

`any` on objects