time-to-botec

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

index.js (1993B)

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