npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

generator_username_random

v1.0.5

Published

A package for generating random username and uuid

Downloads

9

Readme

Installation

npm install generator_username_random --save 

yarn add generator_username_random
  • Importing
// Using Node.js `require()`
const { generate_from_email, generate_from_username } = require("generator_username_random");

// Using ES6 imports
import { generate_from_email, generate_from_email } from "generator_username_random";

usege

It will generate a username from the email and you can add up to six random digits to the end of the name.

// add three random digits
const username = generate_from_email(
  "[email protected]",
  3
);
console.log(username); // narutouzumaki154

// add four random digits
const username = generate_from_email(
  "[email protected]",
  4
);
console.log(username); // narutouzumaki1544

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.

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

// Without any parameter
const username = generate_from_username();
console.log(username); // kiko-vecino

// With any separator like "-, _"
const username = generate_from_username("-");
console.log(username); // kiko-vecino

// With random digits and no separator
const username = generate_from_username("", 3);
console.log(username); // kiko-vecino732

// With maximum length constraint and no separator, no random digits
const username = generate_from_username("", 0, 15);
console.log(username); // kiko-vecino

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

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

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

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, substantives } from 'generator_username_random';

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

const username: string = generate_from_username_unique(config); // narutouzumaki

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 { generate_from_username_unique } from 'generator_username_random';

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

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

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

UUID

import { validate_uuid } from 'generator_username_random';

const validate = validate_uuid('84108d0b-65cf-4a74-b7e1-1fcb806e53b8'); // true
const validate = validate_uuid('84108d0b-65cf-4a74-b7e1-1fcb806e53b{}'); // false
import { generate_uuid_v4 } from 'generator_username_random';

const uuid = generate_uuid_v4(); // 'cf7a1f8a-e1a4-4ac9-b9aa-a92c48f9d37a'

API

generate_from_username_unique (options)

Returns a string with a random generated username

options

Type: Config

The options argument mostly corresponds to the properties defined for uniqueUsernameGenerator. Only dictionaries is required.

| Option | Type | Description | Default value | Example value | |--------------|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | dictionaries | array | This is an array of dictionaries. Each dictionary is an array of strings containing the words to use for generating the string.The provided dictionaries can be imported from the library as a separate modules and provided in the desired order. | n/a | import { generate_from_username_unique, adjectives, substantives } from 'generator_username_random';const username: string = generate_from_username_unique({ dictionaries: [substantives, adjectives]}); // narutouzumaki | | separator | string | A string separator to be used for separate the words generated. The default separator is set to be empty string. | "" | - | | randomDigits | number | A number of random digits to add at the end of a username. | 0 | 3 | | length | number | A maximum length of a username | 15 | 12 | | style | lowerCase \| upperCase \| capital | The default value is set to lowerCase and it will return a lower case username.By setting the value to upperCase, the words, will be returned with all the letters in upper case format.The capital option will capitalize each word of the unique username generated | lowerCase | lowerCase |

License

The MIT License.