- Notifications
You must be signed in to change notification settings - Fork0
Generate an acronym for a given string.
License
stdlib-js/string-acronym
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out onGitHub, and please considerfinancially supporting stdlib. We greatly appreciate your continued support!
Generate an acronym for a given string.
npm install @stdlib/string-acronym
Alternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use theES Module available on theesmbranch (seeREADME). - If you are using Deno, visit the
denobranch (seeREADME for usage intructions). - For use in Observable, or in browser/node environments, use theUniversal Module Definition (UMD) build available on the
umdbranch (seeREADME). - To use as a general utility for the command line, install the correspondingCLI package globally.
Thebranches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
varacronym=require('@stdlib/string-acronym');
Generates an acronym for a given string.
varout=acronym('the quick brown fox');// returns 'QBF'out=acronym('Hard-boiled eggs');// returns 'HBE'
The function accepts the followingoptions:
- 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 thestopwords option.
varout=acronym('the quick brown fox',{'stopwords':[]});// returns 'TQBF'out=acronym('the quick brown fox',{'stopwords':['the','quick','brown','fox']});// returns ''
varacronym=require('@stdlib/string-acronym');varstr='Test-driven development';varout=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'
To use as a general utility, install the CLI package globally
npm install -g @stdlib/string-acronym-cli
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/'.If the split separator is aregular 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.
$ acronym'the quick brown fox'QBFTo use as astandard stream,
$echo -n'the quick brown fox'' | acronymQBF
By default, when used as astandard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set thesplit option.
$echo -n'quick brown fox\tAlpha-Centauri'| acronym --split'\t'QBFAC
This package is part ofstdlib, 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 developstdlib, see the main projectrepository.
SeeLICENSE.
Copyright © 2016-2024. The StdlibAuthors.
About
Generate an acronym for a given string.
