TypeChecker
Utilities to get and check variable types (isString, isPlainObject, isRegExp, etc)
Why?
Why should I use this instead of say instanceof
?
Under certain circumstances instanceof
may not return the correct results. This occurs with node's vm module especially, and circumstances where an object's prototype has been dereferenced from the original. As such, for basic ==
and ===
checks (like a === null
), you're fine not using this, but for checks when you would have done instanceof
(like err instanceof Error
), you should try to use this instead. Plus things like isEmpty
, isEmptyObject
and isPlainObject
are darn useful!
Usage
API Documentation
Install
- Install:
npm install --save typechecker
- Require:
require('typechecker')
<script type="module">
import * as pkg from '//dev.jspm.io/typechecker'
</script>
This package is published with the following editions:
typechecker
aliases typechecker/index.js
which uses Editions to automatically select the correct edition for the consumers environmenttypechecker/source/index.js
is esnext source code with require for modulestypechecker/edition-browsers/index.js
is esnext compiled for browsers with require for modulestypechecker/edition-node-0.8/index.js
is esnext compiled for node.js 0.8 with require for modules
This project provides its type information via inline JSDoc Comments. To make use of this in TypeScript, set your maxNodeModuleJsDepth
compiler option to 5
or thereabouts. You can accomlish this via your tsconfig.json
file like so:
{
"compilerOptions": {
"maxNodeModuleJsDepth": 5
}
}
History
Discover the release history by heading on over to the HISTORY.md
file.
Contribute
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
Backers
Maintainers
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
Contributors
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
License
Unless stated otherwise all works are:
and licensed under: