time-to-botec

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

README.md (2211B)

      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 # properties
     22 
     23 > Return an array of an object's own enumerable and non-enumerable property names and symbols.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var properties = require( '@stdlib/utils/properties' );
     31 ```
     32 
     33 #### properties( obj )
     34 
     35 Returns an `array` of an object's own enumerable and non-enumerable property names and symbols.
     36 
     37 ```javascript
     38 var obj = {
     39     'a': 1,
     40     'b': 2
     41 };
     42 
     43 var props = properties( obj );
     44 // e.g., returns [ 'a', 'b' ]
     45 ```
     46 
     47 </section>
     48 
     49 <!-- /.usage -->
     50 
     51 <section class="notes">
     52 
     53 ## Notes
     54 
     55 -   Property order is not guaranteed, as `object` property enumeration is not specified according to the [ECMAScript specification][ecma-262-for-in]. In practice, however, most engines use insertion order to sort an `object`'s properties, thus allowing for deterministic extraction.
     56 
     57 </section>
     58 
     59 <!-- /.notes -->
     60 
     61 <section class="examples">
     62 
     63 ## Examples
     64 
     65 <!-- eslint no-undef: "error" -->
     66 
     67 ```javascript
     68 var defineProperty = require( '@stdlib/utils/define-property' );
     69 var properties = require( '@stdlib/utils/properties' );
     70 
     71 function Foo() {
     72     this.beep = 'boop';
     73     this.a = {
     74         'b': 'c'
     75     };
     76     defineProperty( this, 'baz', {
     77         'value': 'qux',
     78         'configurable': true,
     79         'writable': true,
     80         'enumerable': false
     81     });
     82     return this;
     83 }
     84 
     85 Foo.prototype.foo = [ 'bar' ];
     86 
     87 var obj = new Foo();
     88 var props = properties( obj );
     89 
     90 console.log( props );
     91 // e.g., => [ 'beep', 'a', 'baz' ]
     92 ```
     93 
     94 </section>
     95 
     96 <!-- /.examples -->
     97 
     98 <section class="links">
     99 
    100 [ecma-262-for-in]: http://www.ecma-international.org/ecma-262/5.1/#sec-12.6.4
    101 
    102 </section>
    103 
    104 <!-- /.links -->