time-to-botec/squiggle/node_modules/@stdlib/assert/is-positive-integer-array/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.7 KiB
Plaintext

{{alias}}( value )
Tests if a value is an array-like object containing only positive integers.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is an array-like object containing only
positive integers.
Examples
--------
> var bool = {{alias}}( [ 3.0, new Number(3.0) ] )
true
> bool = {{alias}}( [ 3.0, '3.0' ] )
false
{{alias}}.primitives( value )
Tests if a value is an array-like object containing only positive primitive
integer values.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is an array-like object containing only
positive primitive integer values.
Examples
--------
> var bool = {{alias}}.primitives( [ 1.0, 10.0 ] )
true
> bool = {{alias}}.primitives( [ 1.0, 0.0, 10.0 ] )
false
> bool = {{alias}}.primitives( [ 3.0, new Number(1.0) ] )
false
{{alias}}.objects( value )
Tests if a value is an array-like object containing only number objects
having positive integer values.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is an array-like object containing only
number objects having positive integer values.
Examples
--------
> var bool = {{alias}}.objects( [ new Number(1.0), new Number(10.0) ] )
true
> bool = {{alias}}.objects( [ 1.0, 2.0, 10.0 ] )
false
> bool = {{alias}}.objects( [ 3.0, new Number(1.0) ] )
false
See Also
--------