time-to-botec/squiggle/node_modules/@stdlib/assert/is-nonpositive-integer/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

76 lines
1.4 KiB
Plaintext

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