# node-initials

> To extract initials from names

Latest version **1.0.0** (published 2019-04-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install node-initials
pnpm add node-initials
yarn add node-initials
bun add node-initials
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-04-18 |
| First published | 2019-04-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 33 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Saravana |
| Maintainers | saravana2107 |
| Keywords | node-initials, initials |

## Links

- npm: https://www.npmjs.com/package/node-initials
- Repository: https://github.com/saravana2107/node-initials
- Homepage: https://github.com/saravana2107/node-initials#readme
- Issues: https://github.com/saravana2107/node-initials/issues
- npm.io page: https://npm.io/package/node-initials

## Recent versions

- 1.0.0 (latest) — 2019-04-18

## README

# node-initials

To extract initials from names.

## Installation

To install node-initials, use [npm](http://github.com/npm/npm):

```
npm i node-initials -S
```

## Usage

```javascript
import initials from 'node-initials';

initials('John');
/* 'JO' */

initials('', 'Wick');
/* 'WI' */

initials('John', 'Wick');
/* 'JW' */

initials('John Wick');
/* 'JW' */
```

## Options
- `firstName` - Define First Name or Full Name to get initials.
- `lastName` - Define Last Name to include in initials (default: null) [OPTIONAL]

## Tests

```
npm install
npm test
```

---
_Source: https://npm.io/package/node-initials · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._