time-to-botec/squiggle/node_modules/@stdlib/string/acronym/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

29 lines
524 B
Plaintext

{{alias}}( str[, options] )
Generates an acronym for a given string.
Parameters
----------
str: string
Input string.
options: Object (optional)
Options.
options.stopwords: Array<string> (optional)
Array of custom stop words.
Returns
-------
out: string
Acronym for the given string.
Examples
--------
> var out = {{alias}}( 'the quick brown fox' )
'QBF'
> out = {{alias}}( 'Hard-boiled eggs' )
'HBE'
See Also
--------