time-to-botec/squiggle/node_modules/@stdlib/assert/is-alphagram/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

32 lines
649 B
Plaintext

{{alias}}( value )
Tests if a value is an alphagram (i.e., a sequence of characters arranged in
alphabetical order).
The function first checks that an input value is a string before validating
that the value is an alphagram. For non-string values, the function returns
`false`.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is an alphagram.
Examples
--------
> var out = {{alias}}( 'beep' )
true
> out = {{alias}}( 'zba' )
false
> out = {{alias}}( '' )
false
See Also
--------