Skip to content

🚀 Transform strings into memorable acronyms

License

Notifications You must be signed in to change notification settings

palashmon/acronymer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

acronymer

Transform strings into memorable acronyms

CI npm version npm downloads

Transform strings into memorable acronyms with ease using the acronymer npm package. This lightweight and efficient tool simplifies the process of generating acronyms from input strings, making them concise and easy to remember.

How It Can Be Useful

  • Abbreviating long phrases or technical terms in code or documentation.
  • Creating memorable identifiers for variables, functions, or entities.
  • Compressing data while maintaining readability.
  • Enhancing user experience by simplifying complex terminology.
  • Streamlining communication by providing concise representations of concepts or ideas.

Install

npm install acronymer

Usage

import acronymer from 'acronymer';

// Test cases
acronymer('Cascading Style Sheets')         // 'CSS'
acronymer('Behavior-driven design')         // 'BDD'
acronymer('HyperText Markup Language!')     // 'HTML'
acronymer('JavaScript Object Notation')     // 'JSON'
acronymer('CASCADING Style Sheets')         // 'CSS'
acronymer('HyperText and Markup Language')  // 'HTML'
acronymer('A B C')                          // 'ABC'
acronymer('')                               // ''
acronymer('1234567890!@#$%^&*()')           // ''

API

acronymer(text)

text

Type: string

The text to be transformed into an acronym. It must be a non-empty string containing at least one alphanumeric character. It will throw an error if the input is not a string.

License

MIT © Palash Mondal