npmpackage.info

Gathering detailed insights and metrics for unique-username-generator

unique-username-generator

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

1.3.0

MIT

TypeScript

67.08 kB

1,832,105 3.6

Installations

npm install unique-username-generator

Score

99.7

Supply Chain

100

Quality

76.5

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

5

Total

15

Closed

1

Merged

9

Issues

Open

5

Total

13

Closed

8

Releases

v1.3.0

Published on 12 Jan 2024

v1.2.0

Published on 01 Aug 2023

v1.1.3

Published on 06 Nov 2022

Initial

v1.0.0

Published on 22 May 2021

View all 4 releases

Developer

subhamg

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

18.19.0

NPM Version

10.2.3 Statistics

88 Stars

57 Commits

19 Forks

2 Watching

3 Branches

6 Contributors

Updated on 16 Nov 2024

Bundle Size

169.10 kB

Minified

67.08 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

1,832,105

Last day

-1.5%

11,459

Compared to previous day

Last week

0.2%

75,840

Compared to previous week

Last month

36.5%

325,320

Compared to previous month

Last year

304.1%

1,408,076

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@istanbuljs/nyc-config-typescript @types/chai @types/mocha @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser chai cz-conventional-changelog eslint mocha nyc semantic-release source-map-support ts-mocha ts-node typescript

Versions

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

1npm install unique-username-generator --save

Importing

1// Using Node.js `require()`
2const { generateFromEmail, generateUsername } = require("unique-username-generator");
3// Using ES6 imports
4import { 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.

1// add three random digits
2const username = generateFromEmail(
3  "lakshmi.narayan@example.com",
4  3
5);
6console.log(username); // lakshminarayan234
7
8// add four random digits
9const username = generateFromEmail(
10  "lakshmi.narayan@example.com",
11  4
12);
13console.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.

1// generaterUsername(separator, number of random digits, maximum length)
2
3// Without any parameter
4const username = generateUsername();
5console.log(username); // blossomlogistical
6
7// With any separator like "-, _"
8const username = generateUsername("-");
9console.log(username); // blossom-logistical
10
11// With random digits and no separator
12const username = generateUsername("", 3);
13console.log(username); // blossomlogistical732
14
15// With maximum length constraint and no separator, no random digits
16const username = generateUsername("", 0, 15);
17console.log(username); // blossomlogistic
18
19// With maximum length constraint and separator but no random digits
20const username = generateUsername("-", 0, 15);
21console.log(username); // blossom-logisti
22
23// With maximum length constraint and random digits but no separator
24const username = generateUsername("", 2, 19);
25console.log(username); // blossomlogistical73
26
27// With all parameters
28const username = generateUsername("-", 2, 20, 'unique username');
29console.log(username); // unique-username-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:

1import { uniqueUsernameGenerator, Config, adjectives, nouns } from 'unique-username-generator';
2
3const config: Config = {
4  dictionaries: [adjectives, nouns]
5}
6
7const 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.

1import { uniqueUsernameGenerator } from 'unique-username-generator';
2
3const marvelCharacters = [
4  'Iron Man',
5  'Doctor Strange',
6  'Hulk',
7  'Captain America',
8  'Thanos'
9];
10
11const config: Config = {
12  dictionaries: [marvelCharacters],
13  separator: '',
14  style: 'capital',
15  randomDigits: 3
16}
17
18const username: string = uniqueUsernameGenerator(config); // Hulk123

API

uniqueUsernameGenerator (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 { uniqueUsernameGenerator, adjectives, nouns } from 'unique-username-generator';` `const username: string = uniqueUsernameGenerator({ dictionaries: [nouns, adjectives]}); // blossomlogistical`
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.

Thank you

If you'd like to say thanks, I'd really appreciate a coffee :)

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

SAST

Determines if the project uses static code analysis.

4

Security-Policy

Determines if the project has published a security policy.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.6

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More