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!
isPropertyKey
Test whether a value is a property key.
Installation
npm install @stdlib/assert-is-property-key
Usage
var isPropertyKey = require( '@stdlib/assert-is-property-key' );
isPropertyKey( value )
Tests whether a value is a property key.
var bool = isPropertyKey( 'beep' );
// returns true
bool = isPropertyKey( 3.14 );
// returns false
Notes
- A valid property key is either a string, symbol, or a nonnegative integer. For example,
'beep', Symbol( 'beep' ), and 3 are all valid property keys.
- Only primitive values are considered to be valid property keys. This excludes object wrappers such as
new String( 'beep' ).
Examples
var Symbol = require( '@stdlib/symbol-ctor' );
var hasSymbolSupport = require( '@stdlib/assert-has-symbol-support' );
var isPropertyKey = require( '@stdlib/assert-is-property-key' );
var hasSymbols = hasSymbolSupport();
var bool = isPropertyKey( 'beep' );
// returns true
if ( hasSymbols ) {
bool = isPropertyKey( Symbol( 'beep' ) );
// returns true
} else {
console.log( 'Environment does not support symbols.' );
}
bool = isPropertyKey( 37 );
// returns true
bool = isPropertyKey( {} );
// returns false
bool = isPropertyKey( [] );
// returns false
Notice
This package is part of 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, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.
