Skip to content

Utilities to get and check variable types (isString, isPlainObject, isRegExp, etc)

License

Notifications You must be signed in to change notification settings

bevry/typechecker

Repository files navigation

TypeChecker

Status of the GitHub Workflow: bevry NPM version NPM downloads
GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button
Discord server badge Twitch community badge

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 isPlainObject are darn useful!

Usage

Complete API Documentation.

Install

  • Install: npm install --save typechecker
  • Import: import * as pkg from ('typechecker')
  • Require: const pkg = require('typechecker')
import * as pkg from 'https://unpkg.com/typechecker@^9.4.0/edition-deno/index.ts'
<script type="module">
    import * as pkg from '//cdn.skypack.dev/typechecker@^9.4.0'
</script>
<script type="module">
    import * as pkg from '//unpkg.com/typechecker@^9.4.0'
</script>
<script type="module">
    import * as pkg from '//dev.jspm.io/[email protected]'
</script>

This package is published with the following editions:

  • typechecker aliases typechecker/index.cjs which uses the Editions Autoloader to automatically select the correct edition for the consumer's environment
  • typechecker/source/index.ts is TypeScript source code with Import for modules
  • typechecker/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
  • typechecker/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
  • typechecker/edition-es5/index.js is TypeScript compiled against ES5 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
  • typechecker/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
  • typechecker/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
  • typechecker/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

Discover the release history by heading on over to the HISTORY.md file.

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

Maintainers

Contributors

Finances

GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button

Sponsors

  • Andrew Nesbitt — Software engineer and researcher
  • Balsa — We're Balsa, and we're building tools for builders.
  • Codecov — Empower developers with tools to improve code quality and testing.
  • Poonacha Medappa
  • Rob Morris
  • Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
  • Syntax — Syntax Podcast

Donors

License

Unless stated otherwise all works are:

and licensed under: