generate-random-username

generate-random-username

A tiny module to generate a random username from a list of adjectives and animals.

Options exist for a custom separator between the username, limiting username to a maximum length, adding random digits, and capitalizing the words in the username.

This module will generate close to 200k different unique usernames, without any digits appended. The wordlist has been manually looked at to ensure the words are appropriate for use in a username.

Install

npm install generate-random-username

Usage

import generateRandomUsername from 'generate-random-username';

generateRandomUsername();
//=> 'humble-shrew'

generateRandomUsername({ capitalize: true });
//=> 'Witty-Camel'

generateRandomUsername({ separator: '_' });
//=> 'safe_llama'

generateRandomUsername({ maxLength: 10 });
//=> 'clear-eel'

generateRandomUsername({ digits: 3, capitalize: true });
//=> 'Unaffected-Cat-184'

API

generateRandomUsername(options?)

options

Type: object

capitalize

Type: boolean
Default: false

Whether to capitalize each word used in the username.

separator

Type: string
Default: '-'

Separator to use between words in the username.

digits

Type: number
Default: 0

Number of random digits to append to end of username.

maxLength

Type: number
Default: null

The maximum length of a username to generate. For lengths under 10, it may not always find a username under that length, and will fallback to returning a longer username.