simple-type-check

simple-type-check

Simple and very small JavaScript library to check types and instanceof.

Install

Install with npm:

npm install simple-type-check

Usage

Include module in your file:

const simpleTypeCheck = require('simple-type-check');

You need to call the function with the parameters value and type. Value can be anything and the type needs to be a string for type checking or the function for instanceof checking.

const value = 1234;
const type = 'number';
const result = simpleTypeCheck(value , type);
// result is now true.

In the default settings the library returns true if the check was successful and throws an Error if it fails.

const value = 'string';
const type = 'number';
const result = simpleTypeCheck(value , type);
// result is undefinied and the error: "string is not of type number" is thrown.

The third argument is throwError, which is default true. You can add false as the third argument. Then the library will not throw an Error and instead return false.

const value = 'string';
const type = 'number';
const result = simpleTypeCheck(value , type, false);
// result is false.

If you want to test an Array, HTMLElement or something similar, you can do this too. In this case you need to add the function as type.

const value = [];
const type = Array;
const result = simpleTypeCheck(value , type);
// result is true.

const value = document.getElementById("testId");
const type = window.HTMLElement;
const result = simpleTypeCheck(value , type);
// result is true.

Testet types

The following types are testet, anything different should work too. You are welcome to add a PR with the test for more types.

| Type | Works | |--|--| | Array | ✅ | | HTMLElement | ✅ | | 'number' | ✅ | | 'function' | ✅ | | 'boolean' | ✅ | | 'object' | ✅ | | 'string' | ✅ | | 'undefined' | ✅ |

Contribute

If you want to contribute to this project please commit with the npm run commit command, this will secure the automatic semantic versioning.