Test if a value is a SyntaxError object.
npm install @stdlib/assert-is-syntax-errorWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Test if a value is a [SyntaxError][mdn-syntax-error] object.
``bash`
npm install @stdlib/assert-is-syntax-error
`javascript`
var isSyntaxError = require( '@stdlib/assert-is-syntax-error' );
#### isSyntaxError( value )
Tests if a value is a [SyntaxError][mdn-syntax-error] object.
`javascript`
var bool = isSyntaxError( new SyntaxError( 'beep' ) );
// returns true
- This function should not be considered robust. While the function should always return true if provided a [SyntaxError][mdn-syntax-error] (or a descendant) object, false positives may occur due to the fact that the [SyntaxError][mdn-syntax-error] constructor inherits from [Error][mdn-error] and has no internal class of its own. Hence, [SyntaxError][mdn-syntax-error] impersonation is possible.
`javascript
var isSyntaxError = require( '@stdlib/assert-is-syntax-error' );
var bool = isSyntaxError( new SyntaxError( 'syntax error' ) );
// returns true
bool = isSyntaxError( new Error( 'error' ) );
// returns false
bool = isSyntaxError( new EvalError( 'eval error' ) );
// returns false
bool = isSyntaxError( new ReferenceError( 'reference error' ) );
// returns false
bool = isSyntaxError( new RangeError( 'range error' ) );
// returns false
bool = isSyntaxError( new TypeError( 'type error' ) );
// returns false
bool = isSyntaxError( new URIError( 'URI error' ) );
// returns false
bool = isSyntaxError( {} );
// returns false
bool = isSyntaxError( null );
// returns false
`
*
- [@stdlib/assert-is-error][@stdlib/assert/is-error]: test if a value is an Error object.
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/assert-is-syntax-error.svg
[npm-url]: https://npmjs.org/package/@stdlib/assert-is-syntax-error
[test-image]: https://github.com/stdlib-js/assert-is-syntax-error/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/assert-is-syntax-error/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-syntax-error/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-syntax-error?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[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-syntax-error/tree/deno
[deno-readme]: https://github.com/stdlib-js/assert-is-syntax-error/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/assert-is-syntax-error/tree/umd
[umd-readme]: https://github.com/stdlib-js/assert-is-syntax-error/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/assert-is-syntax-error/tree/esm
[esm-readme]: https://github.com/stdlib-js/assert-is-syntax-error/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/assert-is-syntax-error/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-syntax-error/main/LICENSE
[mdn-error]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
[mdn-syntax-error]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError
[@stdlib/assert/is-error]: https://www.npmjs.com/package/@stdlib/assert-is-error