time-to-botec

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

index.js (1939B)

      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 an even number.
     23 *
     24 * @module @stdlib/assert/is-even
     25 *
     26 * @example
     27 * var isEven = require( '@stdlib/assert/is-even' );
     28 *
     29 * var bool = isEven( 4.0 );
     30 * // returns true
     31 *
     32 * bool = isEven( new Number( 4.0 ) );
     33 * // returns true
     34 *
     35 * bool = isEven( 3.0 );
     36 * // returns false
     37 *
     38 * bool = isEven( new Number( 5.0 ) );
     39 * // returns false
     40 *
     41 * bool = isEven( -3.14 );
     42 * // returns false
     43 *
     44 * bool = isEven( null );
     45 * // returns false
     46 *
     47 * @example
     48 * // Use interface to check for even number primitives...
     49 * var isEven = require( '@stdlib/assert/is-even' ).isPrimitive;
     50 *
     51 * var bool = isEven( -4.0 );
     52 * // returns true
     53 *
     54 * bool = isEven( new Number( -4.0 ) );
     55 * // returns false
     56 *
     57 * @example
     58 * // Use interface to check for even number objects...
     59 * var isEven = require( '@stdlib/assert/is-even' ).isObject;
     60 *
     61 * var bool = isEven( 4.0 );
     62 * // returns false
     63 *
     64 * bool = isEven( new Number( 4.0 ) );
     65 * // returns true
     66 */
     67 
     68 // MODULES //
     69 
     70 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     71 var isEven = require( './main.js' );
     72 var isPrimitive = require( './primitive.js' );
     73 var isObject = require( './object.js' );
     74 
     75 
     76 // MAIN //
     77 
     78 setReadOnly( isEven, 'isPrimitive', isPrimitive );
     79 setReadOnly( isEven, 'isObject', isObject );
     80 
     81 
     82 // EXPORTS //
     83 
     84 module.exports = isEven;