time-to-botec

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

index.js (1791B)

      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 /**
     22 * Test if a value is a boolean.
     23 *
     24 * @module @stdlib/assert/is-boolean
     25 *
     26 * @example
     27 * var isBoolean = require( '@stdlib/assert/is-boolean' );
     28 *
     29 * var bool = isBoolean( false );
     30 * // returns true
     31 *
     32 * bool = isBoolean( new Boolean( false ) );
     33 * // returns true
     34 *
     35 * @example
     36 * // Use interface to check for boolean primitives...
     37 * var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
     38 *
     39 * var bool = isBoolean( false );
     40 * // returns true
     41 *
     42 * bool = isBoolean( new Boolean( true ) );
     43 * // returns false
     44 *
     45 * @example
     46 * // Use interface to check for boolean objects...
     47 * var isBoolean = require( '@stdlib/assert/is-boolean' ).isObject;
     48 *
     49 * var bool = isBoolean( true );
     50 * // returns false
     51 *
     52 * bool = isBoolean( new Boolean( false ) );
     53 * // returns true
     54 */
     55 
     56 // MODULES //
     57 
     58 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     59 var isBoolean = require( './main.js' );
     60 var isPrimitive = require( './primitive.js' );
     61 var isObject = require( './object.js' );
     62 
     63 
     64 // MAIN //
     65 
     66 setReadOnly( isBoolean, 'isPrimitive', isPrimitive );
     67 setReadOnly( isBoolean, 'isObject', isObject );
     68 
     69 
     70 // EXPORTS //
     71 
     72 module.exports = isBoolean;