@kivixeletric/that-is NPM

That-is is a utility javascript library for type checking, the purpose of the project is to help with flexibility and code optimization.

> Installation

You can use the library using a latest version on github or via npm (the recommended way):

npm install @kivixeletric/that-is

> How to use

To use the library in your project is very simple, see the example below:

import is from '@kivixeletric/that-is'

// Number Type
is.number('0') // will return a False
is.number(0)   // will return a True

// String Type
is.string('boo') // will return a True
is.string(true)  // will return a False

But if you want to do multiple checks of the same type, see the example below:

is.number(1, '2')    // False
is.number(1, 2)      // True
is.number(1, '2', 3) // False
is.number(1, 2, 3)   // True

But some functions will not have multiple values, for example is.divisible and is.equal

> Type List

~ Logical Types

type or a - (type, ...values) -> Checks if value is a selected type
defined or def - (...values) -> Checks if value is defined (is also applied to Object types)
typeEquals - (value1, value2) -> Checks if typeof value is equals a other typeof value
equals - (value1, value2) -> Checks if value is equals a other value

~ Numeric Types

decimal - (...values) -> Checks if value is decimal type
bigint - (...values) -> Checks if value is bigint type
divisible - (value, number) -> Checks if value is divisible with another number
infinite - (...values) -> Checks if value is a infinite type

~ Object Types

element or elem or node - (...values) -> Checks if value is node element type
object or obj - (...values) -> Checks if value is object type
array or arr - (...values) -> Checks if value is array type