Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 2.46 KB

File metadata and controls

55 lines (34 loc) · 2.46 KB

shortname is a JavaScript function designed to shorten names (Portuguese - PT 🇵🇹 | BR 🇧🇷 | AO 🇦🇴) in a simple and user-friendly way. The function allows users to quickly enter full names and receive abbreviated versions of those names in return.

The MIT License Version npm npm downloads npm bundle size TypeScript Prettier Jest Coverage Status PRs Welcome GitHub stars

Install

yarn

yarn add @mosmmy/shortname

NPM

npm install @mosmmy/shortname

Use

import { shortName } from '@mosmmy/shortname'

console.log(shortName('Jorge Pedro André dos Santos'))          //Jorge P. A. dos Santos

console.log(shortName('Pedro de Sousa André'))                  //Pedro de S. André

console.log(shortName('Marilda dos Santos Pedro de Souza'))     //Marilda dos S. P. de Souza

console.log(shortName('Marcos Ângelo Mateus dos Santos'))       //Marcos A. M. dos Santos

To run the test:

npm run test

npm run test:coverage

Licence

This project is governed by the MIT. Just remember to be a nice person and send back any modifications, corrections or improvements. ✌️

Author


@moser-jose