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

advance-username-generator

v2.1.2

Published

advance-username-generator is a simple Node.js package that provides a utility function to generate unique usernames. It can be used in applications where a random or unique username is required, such as user registration systems, chat applications, or an

Downloads

5

Readme

Username Generator

Description

usernameGenerator is a flexible JavaScript library designed to integrate seamlessly with Express.js controllers. It efficiently generates unique usernames based on user-provided criteria without blocking the event loop, ideal for handling HTTP requests within an Express application.

Installation

Install the package using npm:

npm install username-generator

Features

  • Asynchronous Username Generation: Perfect for real-time web applications.
  • Customizable: Supports custom lengths, inclusion of symbols, and various separators.
  • Express Compatibility: Optimized for use within Express.js server environments.

API Reference

usernameGenerator(options: UsernameGeneratorInput): Promise<string>

Generates a unique username based on provided options.

Parameters

  • fullName (string): The user's full name from which the username will be generated.
  • usedUsernames (string[]): An array of usernames already in use to ensure uniqueness.
  • minLength (number): Optional. Minimum length of the username, default is 8 characters.
  • allowSymbols (boolean): Optional. Whether to include symbols, default is false.
  • separator (string): Optional. Character to replace spaces in names, default is an empty string.

Returns

  • Promise: A promise that resolves to the generated username.

Example Usage

Below is an example of how usernameGenerator can be used:

import { usernameGenerator, UsernameGeneratorInput } from 'username-generator';

async function generateAndLogUsername() {
  const options: UsernameGeneratorInput = {
    fullName: 'John Doe', // Full name
    usedUsernames: ['johndoe', 'john_doe', 'johndoe1'], // List of used usernames
    allowSymbols: false, // Symbols allowed in username
    minLength: 6, // Minimum length of the username
    separator: '_', // Separator between first and last name
  };

  try {
    const username = await usernameGenerator(options); // Generate username
    console.log('Generated Username:', username); // Log the generated username
  } catch (error) {
    console.error('Error during username generation:', error); // Log error if username generation fails
  }
}

generateAndLogUsername(); // Call the function to generate and log a username

This example demonstrates how the usernameGenerator function can be used to generate a username with customized options.

Support

For support, issues, or further documentation, please visit our GitHub repository.