Nonflavored Prescription Medicine

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

    0.0.6 • Public • Published

    isFinite

    NPM version Build Status Coverage Status dependencies

    Test if a value is a finite number.

    Installation

    npm install @stdlib/assert-is-finite

    Usage

    var isFinite = require( '@stdlib/assert-is-finite' );

    isFinite( value )

    Tests if a value is a finite number.

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

    isFinite.isPrimitive( value )

    Tests if a value is a primitive number having a finite value.

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

    isFinite.isObject( value )

    Tests if a value is a Number object having a finite value.

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

    Notes

    • In contrast to the built-in isFinite, input values are not coerced to numbers.

    Examples

    var Number = require( '@stdlib/number-ctor' );
    var isFinite = require( '@stdlib/assert-is-finite' );
    
    var bool = isFinite( -5.0 );
    // returns true
    
    bool = isFinite( 0.0 );
    // returns true
    
    bool = isFinite( new Number( 5.0 ) );
    // returns true
    
    bool = isFinite( 5.256 );
    // returns true
    
    bool = isFinite( 1.0/0.0 );
    // returns false
    
    bool = isFinite( -1.0/0.0 );
    // returns false
    
    bool = isFinite( '5' );
    // returns false
    
    bool = isFinite( 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-finite

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    20

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    42.7 kB

    Total Files

    11

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser