!ts

Friendly Username Generator

Tired of accidentally generating explicit usernames? Well fear no longer. This module will put your boss at ease by generating friendly usernames.

$3

``js
const { generateUsername } = require('friendly-username-generator');

// or

import { generateUsername } from 'friendly-username-generator';
`

$3

`js
// Structure: (adjective-animal)
generateUsername(); // --> "yellow-zebra596"
`

$3


You may pass options to generateUsername

`js
const options = {
useHyphen: Boolean, // if false, a hyphen will NOT be used. (True by default)
useRandomNumber: Boolean // if false, a random number will NOT be appended to the end of the random username. (True by default)
}
``

$3

- Zero dependancies! This module will use only native code. (Except for jest so I can write tests)
- Frequent updates to word lists.
- Typescript!

$3

If you'd like to support me, buy me a coffee!