time-to-botec

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

README.md (1943B)

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