time-to-botec/js/node_modules/@stdlib/assert/is-positive-number/docs/repl.txt

76 lines
1.4 KiB
Plaintext
Raw Normal View History

{{alias}}( value )
Tests if a value is a positive number.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is a positive number.
Examples
--------
> var bool = {{alias}}( 5.0 )
true
> bool = {{alias}}( new Number( 5.0 ) )
true
> bool = {{alias}}( 3.14 )
true
> bool = {{alias}}( -5.0 )
false
> bool = {{alias}}( null )
false
{{alias}}.isPrimitive( value )
Tests if a value is a number primitive having a positive value.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is a number primitive having a positive
value.
Examples
--------
> var bool = {{alias}}.isPrimitive( 3.0 )
true
> bool = {{alias}}.isPrimitive( new Number( 3.0 ) )
false
{{alias}}.isObject( value )
Tests if a value is a number object having a positive value.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is a number object having a positive
value.
Examples
--------
> var bool = {{alias}}.isObject( 3.0 )
false
> bool = {{alias}}.isObject( new Number( 3.0 ) )
true
See Also
--------