time-to-botec

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

main.js (1356B)


      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 // MAIN //
     22 
     23 /**
     24 * Tests if a value is falsy.
     25 *
     26 * @param {*} value - value to test
     27 * @returns {boolean} boolean indicating whether a value is falsy
     28 *
     29 * @example
     30 * var bool = isFalsy( false );
     31 * // returns true
     32 *
     33 * @example
     34 * var bool = isFalsy( null );
     35 * // returns true
     36 *
     37 * @example
     38 * var bool = isFalsy( '' );
     39 * // returns true
     40 *
     41 * @example
     42 * var bool = isFalsy( 0 );
     43 * // returns true
     44 *
     45 * @example
     46 * var bool = isFalsy( void 0 );
     47 * // returns true
     48 *
     49 * @example
     50 * var bool = isFalsy( NaN );
     51 * // returns true
     52 *
     53 * @example
     54 * var bool = isFalsy( [] );
     55 * // returns false
     56 */
     57 function isFalsy( value ) {
     58 	return ( value ) ? false : true; // eslint-disable-line no-unneeded-ternary
     59 }
     60 
     61 
     62 // EXPORTS //
     63 
     64 module.exports = isFalsy;