JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 70805
  • Score
    100M100P100Q151921F
  • License MIT

Check if a value is an `Error` instance

Package Exports

  • is-error-instance

Readme

Node Browsers TypeScript Codecov Minified size Mastodon Medium

Check if a value is an Error instance.

This is like value instanceof Error except it works across realms, such as iframes or Node.js vm.

Example

import isErrorInstance from 'is-error-instance'

isErrorInstance(new Error('')) // true
isErrorInstance('') // false

const CrossRealmError = vm.runInNewContext('Error')
isErrorInstance(new CrossRealmError('')) // true

isErrorInstance(new TypeError('')) // true
isErrorInstance(new AnyOtherError('')) // true

isErrorInstance(new DOMException('')) // true
isErrorInstance(new DOMError('')) // true

isErrorInstance(new Proxy(new Error(''), {})) // true
isErrorInstance(
  new Proxy(new Error(''), {
    getPrototypeOf() {
      throw new Error('')
    },
  }),
) // false

Install

npm install is-error-instance

This package works in both Node.js >=14.18.0 and browsers. It is an ES module and must be loaded using an import or import() statement, not require().

API

isErrorInstance(value)

value any
Return value: boolean

Related projects

Support

For any question, don't hesitate to submit an issue on GitHub.

Everyone is welcome regardless of personal background. We enforce a Code of conduct in order to promote a positive and inclusive environment.

Contributing

This project was made with ❤️. The simplest way to give back is by starring and sharing it online.

If the documentation is unclear or has a typo, please click on the page's Edit button (pencil icon) and suggest a correction.

If you would like to help us fix a bug or add a new feature, please check our guidelines. Pull requests are welcome!