initials

Initials. Because JD is shorter than John Doe

a JavaScript function to get initials from names

Installation

Install using bower for usage in browser:

bower install --save initials

Install using npm for node.js:

npm install --save initials

Usage

console.log( initials('John Doe') );
// 'JD'

console.log( initials(['John Doe', 'Robert Roe']) );
// ['JD', 'RR']

// alias
initials.find('John Doe')

// parse name(s)
initials.parse('John Doe')
// {name: 'John Doe', initials: 'JD'}

// add initials to name(s)
initials.addTo('John Doe')
// 'John Doe (JD)'

Notes

Preffered initials can be passed in (JD), e.g.

console.log( initials('John Doe (JoDo)') );
// 'JoDo'

If a name contains an email, it gets ignored when calculating initials

console.log( initials('John Doe [e-mail]') );
// 'JD'

If a name is an email, the domain part gets ignored

console.log( initials('[e-mail]') );
// 'jo'

When passing an Array of names, doublicates of initials are avoided

console.log( initials(['John Doe', 'Jane Dane']) );
// ['JDo', 'JDa']

Todo

I'd say the implementations is robust, but has room for performance optimizations. Pull requests welcome!

Fine Print

initials.js have been authored by Gregor Martynus, proud member of Team Hoodie. Support our work: gittip us.

License: MIT