is/NeuType

Tool for better type checking in javascript. You can also create your own type for stricter type enforcement.

Table of Contents

1. Install
   
2. Usage
   

Install

1npm i @neumatter/is

Usage

Default:

1// CJS require
2const is = require('@neumatter/is')
3const { NeuType } = require('@neumatter/is')
4// ESM import
5import is, { NeuType } from '@neumatter/is'
6
7is.array([]) // true
8is.emptyArray([]) // true
9is.falseType([]) // true
10
11is.object({}) // true
12is.emptyObject({}) // true
13
14is.string('') // true
15is.emptyString('') // true
16is.falseType('') // true
17
18is.boolean(false) // true
19
20is.number(NaN) // true
21is.NaN(NaN) // true
22
23is.infinite(Infinite) // true
24
25is.null(null) // true
26is.falseType(null) // true
27
28is.date(new Date()) // true
29
30is.undefined(undefined) // true
31is.falseType(undefined) // true
32
33is.function(NeuType) // true
34is.instance(new NeuType(), NeuType) // true
35
36is.symbol(Symbol) // true

Generating Types:

1// CJS require
2const { NeuType } = require('@neumatter/is')
3// ESM import
4import { NeuType } from '@neumatter/is'
5
6const arrType = new NeuType([{ hello: 'world' }])
7arrType.tag // Array<Object>
8arrType.is('Array') // true
9arrType.instance(Array) // true
10arrType.equals([{ random: 'obj' }]) // true | type must match Array<Object>
11
12// Type From Class
13class SomeClass {}
14const someClassObj = new SomeClass()
15const classObjType = new NeuType(someClassObj)
16classObjType.tag // Object[SomeClass]
17classObjType.is('Object') // true
18classObjType.is('SomeClass') // true
19classObjType.is(SomeClass) // true
20classObjType.equals(SomeClass) // false
21classObjType.new() // returns new instance of SomeClass
22`${classObjType}` // Object[SomeClass]
23'' + classObjType // Object[SomeClass]
24console.log(classObjType) // NeuType [Object[SomeClass]] {}
25
26is.array([]) // true
27is.emptyArray([]) // true
28is.falseType([]) // true
29
30is.object({}) // true
31is.emptyObject({}) // true
32
33is.string('') // true
34is.emptyString('') // true
35is.falseType('') // true
36
37is.boolean(false) // true
38
39is.number(NaN) // true
40is.NaN(NaN) // true
41
42is.infinite(Infinite) // true
43
44is.null(null) // true
45is.falseType(null) // true
46
47is.date(new Date()) // true
48
49is.undefined(undefined) // true
50is.falseType(undefined) // true
51
52is.function(NeuType) // true
53is.instance(new NeuType(), NeuType) // true
54
55is.symbol(Symbol) // true