is-syntax-error/test/test.js

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var vm = require( 'vm' ); // TODO: handle in-browser tests
var tape = require( 'tape' );
var IS_BROWSER = require( './../../is-browser' );
var inherit = require( '@stdlib/utils/inherit' );
var isSyntaxError = require( './../lib' );


// VARIABLES //

var opts = {
	'skip': IS_BROWSER
};


// TESTS //

tape( 'main export is a function', function test( t ) {
	t.ok( true, __filename );
	t.strictEqual( typeof isSyntaxError, 'function', 'main export is a function' );
	t.end();
});

tape( 'the function returns `true` if provided a `SyntaxError` object', function test( t ) {
	var values;
	var i;

	values = [
		new SyntaxError( 'syntax error' )
	];

	for ( i = 0; i < values.length; i++ ) {
		t.strictEqual( isSyntaxError( values[ i ] ), true, 'returns true when provided '+values[i] );
	}
	t.end();
});

tape( 'the function returns `true` if provided an object inheriting from `SyntaxError`', function test( t ) {
	function CustomError( msg ) {
		SyntaxError.call( this );
		this.name = 'CustomError';
		this.message = msg;
		return this;
	}

	inherit( CustomError, SyntaxError );

	t.strictEqual( isSyntaxError( new CustomError( 'custom error' ) ), true, 'returns true when provided a value which inherits from SyntaxError' );
	t.end();
});

tape( 'the function returns `true` if provided a `SyntaxError` object from a different realm', opts, function test( t ) {
	var error = vm.runInNewContext( 'new SyntaxError()' );
	t.strictEqual( isSyntaxError( error ), true, 'returns true' );
	t.end();
});

tape( 'the function returns `true` if provided an object from a different realm which inherits from a `SyntaxError` object', opts, function test( t ) {
	var error = vm.runInNewContext( 'function Err() { return this; }; Err.prototype = new SyntaxError(); new Err();' );
	t.strictEqual( isSyntaxError( error ), true, 'returns true' );
	t.end();
});

tape( 'the function returns `false` if not provided a `SyntaxError` object', function test( t ) {
	var values;
	var i;

	values = [
		'5',
		5,
		NaN,
		true,
		false,
		null,
		void 0,
		[],
		{},
		function noop() {},
		function error() {},
		new Date(),
		new RegExp( '.*' ), // eslint-disable-line prefer-regex-literals
		new Error( 'error' ),
		new EvalError( 'eval error' ),
		new ReferenceError( 'reference error' ),
		new RangeError( 'range error' ),
		new TypeError( 'type error' ),
		new URIError( 'URI error' )
	];

	for ( i = 0; i < values.length; i++ ) {
		t.strictEqual( isSyntaxError( values[ i ] ), false, 'returns false when provided '+values[i] );
	}
	t.end();
});