typechecker
TypeScript icon, indicating that this package has built-in type declarations

4.9.0-next.1573601622.18b9b60768f8bc32b28c53ce93b5dbf4f4b1dee0 • Public • Published

TypeChecker

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

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

npm

  • Install: npm install --save typechecker
  • Require: require('typechecker')

jspm

<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 environment
  • typechecker/source/index.js is esnext source code with require for modules
  • typechecker/edition-browsers/index.js is esnext compiled for browsers with require for modules
  • typechecker/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:

Sponsors

No sponsors yet! Will you be the first?

Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

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:

Readme

Keywords

Package Sidebar

Install

npm i typechecker@4.9.0-next.1573601622.18b9b60768f8bc32b28c53ce93b5dbf4f4b1dee0

Version

4.9.0-next.1573601622.18b9b60768f8bc32b28c53ce93b5dbf4f4b1dee0

License

MIT

Unpacked Size

54.5 kB

Total Files

22

Last publish

Collaborators

  • bevryme