time-to-botec/js/node_modules/@stdlib/assert/is-boxed-primitive/lib/main.js
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

79 lines
1.9 KiB
JavaScript

/**
* @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 isBoolean = require( './../../is-boolean' ).isObject;
var isNumber = require( './../../is-number' ).isObject;
var isString = require( './../../is-string' ).isObject;
var isSymbol = require( './../../is-symbol' ).isObject;
// MAIN //
/**
* Tests if a value is a JavaScript boxed primitive.
*
* @param {*} value - value to test
* @returns {boolean} boolean indicating if a value is a JavaScript boxed primitive
*
* @example
* var bool = isBoxedPrimitive( new String( 'beep' ) );
* // returns true
*
* @example
* var bool = isBoxedPrimitive( new Number( 3.21 ) );
* // returns true
*
* @example
* var Symbol = require( '@stdlib/symbol/ctor' );
* var bool = isBoxedPrimitive( Object( Symbol( 'beep' ) ) );
* // returns true
*
* @example
* var bool = isBoxedPrimitive( true );
* // returns false
*
* @example
* var bool = isBoxedPrimitive( {} );
* // returns false
*
* @example
* var Symbol = require( '@stdlib/symbol/ctor' );
* var bool = isBoxedPrimitive( Symbol( 'beep' ) );
* // returns false
*/
function isBoxedPrimitive( value ) {
if ( typeof value !== 'object' ) {
return false;
}
return (
isBoolean( value ) ||
isNumber( value ) ||
isString( value ) ||
isSymbol( value )
);
}
// EXPORTS //
module.exports = isBoxedPrimitive;