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