time-to-botec

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

README.md (1661B)

      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 # isObject
     22 
     23 > Test if a value is an object.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var isObject = require( '@stdlib/assert/is-object' );
     31 ```
     32 
     33 #### isObject( value )
     34 
     35 Tests if a `value` is an `object`.
     36 
     37 ```javascript
     38 var bool = isObject( {} );
     39 // returns true
     40 
     41 bool = isObject( true );
     42 // returns false
     43 ```
     44 
     45 </section>
     46 
     47 <!-- /.usage -->
     48 
     49 <section class="notes">
     50 
     51 ## Notes
     52 
     53 -   The function returns `false` if provided an `array` or `null`.
     54 
     55     ```javascript
     56     var bool = isObject( [] );
     57     // returns false
     58 
     59     bool = isObject( null );
     60     // returns false
     61     ```
     62 
     63 </section>
     64 
     65 <!-- /.notes -->
     66 
     67 <section class="examples">
     68 
     69 ## Examples
     70 
     71 <!-- eslint no-undef: "error" -->
     72 
     73 ```javascript
     74 var isObject = require( '@stdlib/assert/is-object' );
     75 
     76 var bool = isObject( {} );
     77 // returns true
     78 
     79 bool = isObject( new Date() );
     80 // returns true
     81 
     82 bool = isObject( /.*/ );
     83 // returns true
     84 
     85 bool = isObject( null );
     86 // returns false
     87 
     88 bool = isObject( [] );
     89 // returns false
     90 ```
     91 
     92 </section>
     93 
     94 <!-- /.examples -->
     95 
     96 <section class="links">
     97 
     98 </section>
     99 
    100 <!-- /.links -->