Package Exports
- @stdlib/string-acronym
- @stdlib/string-acronym/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/string-acronym) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
acronym
Generate an acronym for a given string.
Installation
npm install @stdlib/string-acronymUsage
var acronym = require( '@stdlib/string-acronym' );acronym( str[, options] )
Generates an acronym for a given string.
var out = acronym( 'the quick brown fox' );
// returns 'QBF'
out = acronym( 'Hard-boiled eggs' );
// returns 'HBE'The function accepts the following options:
- stopwords: list of custom stop words. If not specified, the function uses a default set of stop words from the English language that were deemed words one would likely want to exclude from the acronym generation (a subset of the stop words from @stdlib/datasets/stopwords-en).
By default, the function uses a list of common English stop words. To use a custom list, set the stopwords option.
var out = acronym( 'the quick brown fox', {
'stopwords': []
});
// returns 'TQBF'
out = acronym( 'the quick brown fox', {
'stopwords': [ 'the', 'quick', 'brown', 'fox' ]
});
// returns ''Examples
var acronym = require( '@stdlib/string-acronym' );
var str = 'Test-driven development';
var out = acronym( str );
// returns 'TDD'
str = 'Industrial Business Machines';
out = acronym( str );
// returns 'IBM'
str = 'National Aeronautics and Space Administration';
out = acronym( str );
// returns 'NASA'
str = 'To be determined...';
out = acronym( str, {
'stopwords': []
});
// returns 'TBD'CLI
Installation
To use the module as a general utility, install the module globally
npm install -g @stdlib/string-acronymUsage
Usage: acronym [options] [<string>]
Options:
-h, --help Print this message.
-V, --version Print the package version.
--stopwords str Comma-separated list of custom stop words.
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.Notes
If the split separator is a regular expression, ensure that the
splitoption is either properly escaped or enclosed in quotes.# Not escaped... $ echo -n $'quick brown fox\nAlpha-Centauri' | acronym --split /\r?\n/ # Escaped... $ echo -n $'quick brown fox\nAlpha-Centauri' | acronym --split /\\r?\\n/
The implementation ignores trailing delimiters.
Examples
$ acronym 'the quick brown fox'
QBFTo use as a standard stream,
$ echo -n 'the quick brown fox'' | acronym
QBFBy default, when used as a standard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.
$ echo -n 'quick brown fox\tAlpha-Centauri' | acronym --split '\t'
QBF
ACNotice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2022. The Stdlib Authors.