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

79 lines
1.6 KiB
Plaintext
Raw Normal View History

{{alias}}( value )
Tests if a value is a square triangular number.
Return values are not reliable for numbers greater than 1125899906842624.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is a square triangular number.
Examples
--------
> var bool = {{alias}}( 36.0 )
true
> bool = {{alias}}( new Number( 36.0 ) )
true
> bool = {{alias}}( 3.14 )
false
> bool = {{alias}}( -5.0 )
false
> bool = {{alias}}( null )
false
{{alias}}.isPrimitive( value )
Tests if a value is a number primitive which is a square triangular number.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is a number primitive which is a
square triangular number.
Examples
--------
> var bool = {{alias}}.isPrimitive( 36.0 )
true
> bool = {{alias}}.isPrimitive( new Number( 36.0 ) )
false
{{alias}}.isObject( value )
Tests if a value is a number object having a value which is a square
triangular number.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is a number object having a value which
is a square triangular number.
Examples
--------
> var bool = {{alias}}.isObject( 36.0 )
false
> bool = {{alias}}.isObject( new Number( 36.0 ) )
true
See Also
--------