npm NPM

unique-username-generator

A package to generate a unique username from email or randomly selected nouns and adjectives. User can add a separator between the username, define the maximum length of a username and adds up to six random digits.

Installation

npm install @alixmixx/unique-username-generator

yarn add @alixmixx/unique-username-generator

Importing

// Using Node.js `require()`
const { generateFromEmail, generateUsername } = require("unique-username-generator");
// Using ES6 imports
import { generateFromEmail, generateUsername } from "unique-username-generator";

Usage

Generate username from email

It will generate username from email and add upto six random digits at the end of the name.

// add three random digits
const username = generateFromEmail(
  "lakshmi.narayan@example.com",
  3
);
console.log(username); // lakshminarayan234

// add four random digits
const username = generateFromEmail(
  "lakshmi.narayan@example.com",
  4
);
console.log(username); // lakshminarayan2347

Randomly generate unique username.

It will generate unique username from adjectives, nouns, random digits and separator. You can control these following parameters - separator, number of random digits and maximum length of a username.

// generaterUsername(separator, number of random digits, maximum length)

// Without any parameter
const username = generateUsername();
console.log(username); // blossomlogistical

// With any separator like "-, _"
const username = generateUsername("-");
console.log(username); // blossom-logistical

// With random digits and no separator
const username = generateUsername("", 3);
console.log(username); // blossomlogistical732

// With maximum length constraint and no separator, no random digits
const username = generateUsername("", 0, 15);
console.log(username); // blossomlogistic

// With maximum length constraint and separator but no random digits
const username = generateUsername("-", 0, 15);
console.log(username); // blossom-logisti

// With maximum length constraint and random digits but no separator
const username = generateUsername("", 2, 19);
console.log(username); // blossomlogistical73

// With all parameters
const username = generateUsername("-", 2, 20, 'unique username');
console.log(username); // unique-username-73

// With style formatting
const username = generateUsername("-", 0, undefined, undefined, Style.CamelCase);
console.log(username); // blossomLogistical

// With style formatting
const username = generateUsername("-", 0, undefined, undefined, Style.SnakeCase);
console.log(username); // blossom_logistical

Default dictionaries

By default, the unique username generator library comes with 2 dictionaries out of the box, so that you can use them straight away.

The new syntax for using the default dictionaries is the following:

import { uniqueUsernameGenerator, Config, adjectives, nouns } from 'unique-username-generator';

const config: Config = {
  dictionaries: [adjectives, nouns]
}

const username: string = uniqueUsernameGenerator(config); // blossomlogistical

Custom dictionaries

You might want to provide your custom dictionaries to use for generating your unique username, in order to meet your project requirements. You can easily do that using the dictionaries option.

import { uniqueUsernameGenerator, Style } from 'unique-username-generator';

const marvelCharacters = [
  'Iron Man',
  'Doctor Strange',
  'Hulk',
  'Captain America',
  'Thanos'
];

const config: Config = {
  dictionaries: [marvelCharacters],
  separator: '',
  style: Style.Capital,
  randomDigits: 3
}

const username: string = uniqueUsernameGenerator(config); // Hulk123

API