Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/assert-is-reference-error
Test if a value is a ReferenceError object.
https://github.com/stdlib-js/assert-is-reference-error
assert assertion err error exception is iserr iserror isvalid javascript node node-js nodejs reference stdlib util utilities utility utils valid
Last synced: 3 months ago
JSON representation
Test if a value is a ReferenceError object.
- Host: GitHub
- URL: https://github.com/stdlib-js/assert-is-reference-error
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-13T19:26:37.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T02:38:51.000Z (4 months ago)
- Last Synced: 2024-10-11T02:40:34.565Z (4 months ago)
- Topics: assert, assertion, err, error, exception, is, iserr, iserror, isvalid, javascript, node, node-js, nodejs, reference, stdlib, util, utilities, utility, utils, valid
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 822 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# isReferenceError
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Test if a value is a [ReferenceError][mdn-reference-error] object.
## Installation
```bash
npm install @stdlib/assert-is-reference-error
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var isReferenceError = require( '@stdlib/assert-is-reference-error' );
```
#### isReferenceError( value )
Tests if a `value` is a [`ReferenceError`][mdn-reference-error] object.
```javascript
var bool = isReferenceError( new ReferenceError( 'beep' ) );
// returns true
```
## Notes
- This function should **not** be considered robust. While the function should **always** return `true` if provided a [`ReferenceError`][mdn-reference-error] (or a descendant) object, false positives may occur due to the fact that the [`ReferenceError`][mdn-reference-error] constructor inherits from [`Error`][mdn-error] and has no internal class of its own. Hence, [`ReferenceError`][mdn-reference-error] impersonation is possible.
## Examples
```javascript
var isReferenceError = require( '@stdlib/assert-is-reference-error' );
var bool = isReferenceError( new ReferenceError( 'reference error' ) );
// returns true
bool = isReferenceError( new Error( 'error' ) );
// returns false
bool = isReferenceError( new EvalError( 'eval error' ) );
// returns false
bool = isReferenceError( new RangeError( 'range error' ) );
// returns false
bool = isReferenceError( new SyntaxError( 'syntax error' ) );
// returns false
bool = isReferenceError( new TypeError( 'type error' ) );
// returns false
bool = isReferenceError( new URIError( 'URI error' ) );
// returns false
bool = isReferenceError( {} );
// returns false
bool = isReferenceError( null );
// returns false
```
* * *
## See Also
- [`@stdlib/assert-is-error`][@stdlib/assert/is-error]: test if a value is an Error object.
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/assert-is-reference-error.svg
[npm-url]: https://npmjs.org/package/@stdlib/assert-is-reference-error
[test-image]: https://github.com/stdlib-js/assert-is-reference-error/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/assert-is-reference-error/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-reference-error/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-reference-error?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/assert-is-reference-error/tree/deno
[deno-readme]: https://github.com/stdlib-js/assert-is-reference-error/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/assert-is-reference-error/tree/umd
[umd-readme]: https://github.com/stdlib-js/assert-is-reference-error/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/assert-is-reference-error/tree/esm
[esm-readme]: https://github.com/stdlib-js/assert-is-reference-error/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/assert-is-reference-error/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-reference-error/main/LICENSE
[mdn-error]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
[mdn-reference-error]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError
[@stdlib/assert/is-error]: https://github.com/stdlib-js/assert-is-error