@kivixeletric/that-is
v1.0.5
Published
A JavaScript library that checks whether the value is of a specific type
Downloads
5
Maintainers
Readme
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
ora
- (type, ...values) -> Checks if value is a selected typedefined
ordef
- (...values) -> Checks if value is defined (is also applied to Object types)typeEquals
- (value1, value2) -> Checks if typeof value is equals a other typeof valueequals
- (value1, value2) -> Checks if value is equals a other value
~ Numeric Types
decimal
- (...values) -> Checks if value is decimal typebigint
- (...values) -> Checks if value is bigint typedivisible
- (value, number) -> Checks if value is divisible with another numberinfinite
- (...values) -> Checks if value is a infinite type
~ Object Types
element
orelem
ornode
- (...values) -> Checks if value is node element typeobject
orobj
- (...values) -> Checks if value is object typearray
orarr
- (...values) -> Checks if value is array type
~ Natural Types
number
,num
orint
- (...values) -> Checks if value is number typestring
orstr
- (...values) -> Checks if value is string typeboolean
orbool
- (...values) -> Checks if value is boolean typefunction
orfn
- (...values) -> Checks if value is function typesymbol
- (...values) -> Checks if value is symbol type
~ Special Types
regexp
- (...values) -> Checks if value is RegExp type
> License
- This project is licensed under MIT License