@stdlib/assert-is-nonnegative-integer
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.6 • Public • Published

    isNonNegativeInteger

    NPM version Build Status Coverage Status dependencies

    Test if a value is a number having a nonnegative integer value.

    Installation

    npm install @stdlib/assert-is-nonnegative-integer

    Usage

    var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' );

    isNonNegativeInteger( value )

    Tests if a value is a number having a nonnegative integer value.

    var Number = require( '@stdlib/number-ctor' );
    
    var bool = isNonNegativeInteger( 5.0 );
    // returns true
    
    bool = isNonNegativeInteger( new Number( 5.0 ) );
    // returns true
    
    bool = isNonNegativeInteger( -5.0 );
    // returns false
    
    bool = isNonNegativeInteger( 3.14 );
    // returns false
    
    bool = isNonNegativeInteger( null );
    // returns false

    isNonNegativeInteger.isPrimitive( value )

    Tests if a value is a primitive number having a nonnegative integer value.

    var Number = require( '@stdlib/number-ctor' );
    
    var bool = isNonNegativeInteger.isPrimitive( 3.0 );
    // returns true
    
    bool = isNonNegativeInteger.isPrimitive( new Number( 3.0 ) );
    // returns false

    isNonNegativeInteger.isObject( value )

    Tests if a value is a Number object having a nonnegative integer value.

    var Number = require( '@stdlib/number-ctor' );
    
    var bool = isNonNegativeInteger.isObject( 3.0 );
    // returns false
    
    bool = isNonNegativeInteger.isObject( new Number( 3.0 ) );
    // returns true

    Examples

    var Number = require( '@stdlib/number-ctor' );
    var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' );
    
    var bool = isNonNegativeInteger( 5.0 );
    // returns true
    
    bool = isNonNegativeInteger( new Number( 5.0 ) );
    // returns true
    
    bool = isNonNegativeInteger( 0.0 );
    // returns true
    
    bool = isNonNegativeInteger( 3.14 );
    // returns false
    
    bool = isNonNegativeInteger( -5.0 );
    // returns false
    
    bool = isNonNegativeInteger( '5' );
    // returns false
    
    bool = isNonNegativeInteger( null );
    // returns false

    Notice

    This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

    For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/assert-is-nonnegative-integer

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    4,764

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    43.7 kB

    Total Files

    11

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser