# nfn

> Generates random nicknames using sections from other nicknames provided

Latest version **1.0.0** (published 2020-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install nfn
pnpm add nfn
yarn add nfn
bun add nfn
```

## 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 | 2020-11-22 |
| First published | 2020-11-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | agm-dev |
| Maintainers | agm-dev |

## Links

- npm: https://www.npmjs.com/package/nfn
- npm.io page: https://npm.io/package/nfn

## Recent versions

- 1.0.0 (latest) — 2020-11-22
- 0.0.9 — 2020-11-22

## README

# NFN - Nickname from nicknames

NFN is a simple library that exports a method to generate random nicknames by using substrings from provided nicknames.

### Installation:

```
npm install nfn --save
```

### Usage:

There is a whole example on examples folder.

```javascript
const { generateNicknames } = require("nfn");

const peopleInTheChat = [
  "g0ldstripes_",
  "nightbot",
  "tanya9psk",
  "eyren315",
  "iozul",
  "anaarry",
  "yuminita",
  "qraaam",
];

// main:
const generated = generateNicknames(peopleInTheChat, {
  numberOfSegments: 2,
  numberOfResults: 10,
  nicknameMinLength: 10,
});
```

### Options for nicknames generation:

```javascript
const options = {
  numberOfSegments: 2, // the number of sections each provided nickname will be splitted to
  numberOfResults: 10, // the number of randomly generated nicknames
  nicknameMinLength: 10, // the minimun length of the generated nicknames
};
```

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