https://github.com/raphaelhaettich/simple-type-check
Simple and very small JavaScript library to check types and instanceof.
https://github.com/raphaelhaettich/simple-type-check
javascript micro npm small type type-check types
Last synced: about 1 month ago
JSON representation
Simple and very small JavaScript library to check types and instanceof.
- Host: GitHub
- URL: https://github.com/raphaelhaettich/simple-type-check
- Owner: RaphaelHaettich
- License: mit
- Created: 2018-11-22T14:31:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-27T14:28:48.000Z (about 7 years ago)
- Last Synced: 2025-02-18T13:05:00.347Z (over 1 year ago)
- Topics: javascript, micro, npm, small, type, type-check, types
- Language: JavaScript
- Homepage:
- Size: 150 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# simple-type-check
[](https://github.com/RaphaelHaettich/simple-type-check/blob/master/LICENSE)
[](https://travis-ci.org/RaphaelHaettich/simple-type-check)
[](https://www.npmjs.com/package/simple-type-check)
[](https://www.npmjs.com/package/simple-type-check)
[](https://github.com/RaphaelHaettich/simple-type-check/issues)
[](https://github.com/semantic-release/semantic-release)
[](https://github.com/airbnb/javascript)
# simple-type-check
> Simple and very small JavaScript library to check types and instanceof.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
npm install simple-type-check
```
## Usage
Include module in your file:
```js
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.
```js
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.
```js
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```.
```js
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```.
```js
const value = [];
const type = Array;
const result = simpleTypeCheck(value , type);
// result is true.
```
```js
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.