time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

README.md (1910B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2018 The Stdlib Authors.
      6 
      7 Licensed under the Apache License, Version 2.0 (the "License");
      8 you may not use this file except in compliance with the License.
      9 You may obtain a copy of the License at
     10 
     11    http://www.apache.org/licenses/LICENSE-2.0
     12 
     13 Unless required by applicable law or agreed to in writing, software
     14 distributed under the License is distributed on an "AS IS" BASIS,
     15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     16 See the License for the specific language governing permissions and
     17 limitations under the License.
     18 
     19 -->
     20 
     21 # propertySymbols
     22 
     23 > Return an array of an object's own [symbol][@stdlib/symbol/ctor] properties.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var propertySymbols = require( '@stdlib/utils/property-symbols' );
     31 ```
     32 
     33 #### propertySymbols( obj )
     34 
     35 Returns an `array` of an object's own [symbol][@stdlib/symbol/ctor].
     36 
     37 ```javascript
     38 var symbols = propertySymbols( {} );
     39 ```
     40 
     41 </section>
     42 
     43 <!-- /.usage -->
     44 
     45 <section class="notes">
     46 
     47 ## Notes
     48 
     49 -   In contrast to the built-in `Object.getOwnPropertySymbols()`, if provided `null` or `undefined`, the function returns an empty `array`, rather than throwing an error.
     50 
     51 </section>
     52 
     53 <!-- /.notes -->
     54 
     55 <section class="examples">
     56 
     57 ## Examples
     58 
     59 <!-- eslint no-undef: "error" -->
     60 
     61 ```javascript
     62 var hasSymbolSupport = require( '@stdlib/assert/has-symbol-support' );
     63 var Symbol = require( '@stdlib/symbol/ctor' );
     64 var propertySymbols = require( '@stdlib/utils/property-symbols' );
     65 
     66 function Foo() {
     67     if ( hasSymbolSupport() ) {
     68         this[ Symbol( 'beep' ) ] = 'boop';
     69     }
     70     return this;
     71 }
     72 
     73 Foo.prototype.foo = 'bar';
     74 
     75 var obj = new Foo();
     76 var symbols = propertySymbols( obj );
     77 
     78 console.log( symbols );
     79 ```
     80 
     81 </section>
     82 
     83 <!-- /.examples -->
     84 
     85 <section class="links">
     86 
     87 [@stdlib/symbol/ctor]: https://www.npmjs.com/package/@stdlib/symbol-ctor
     88 
     89 </section>
     90 
     91 <!-- /.links -->