All files / assert/is-property-key/lib main.js

100% Statements 67/67
100% Branches 4/4
100% Functions 1/1
100% Lines 67/67

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 681x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 18x 18x 18x 18x 15x 18x 18x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2021 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 isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var isSymbol = require( '@stdlib/assert/is-symbol' ).isPrimitive;
var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
 
 
// MAIN //
 
/**
* Tests whether a value is a property key.
*
* ## Notes
*
* -   A property key is either a string, symbol, or a nonnegative integer.
*
* @param {*} value - value to test
* @returns {boolean} boolean indicating whether value is a property key
*
* @example
* var bool = isPropertyKey( 'beep' );
* // returns true
*
* @example
* var bool = isPropertyKey( 37 );
* // returns true
*
* @example
* var bool = isPropertyKey( {} );
* // returns false
*
* @example
* var bool = isPropertyKey( [] );
* // returns false
*/
function isPropertyKey( value ) {
	return (
		isString( value ) ||
		isSymbol( value ) ||
		isNonNegativeInteger( value )
	);
}
 
 
// EXPORTS //
 
module.exports = isPropertyKey;