time-to-botec

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

README.md (1769B)

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