time-to-botec/squiggle/node_modules/@stdlib/assert/is-nonnegative-integer-array/docs/repl.txt

75 lines
1.6 KiB
Plaintext
Raw Normal View History

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