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

unique-id-key

v2.0.2

Published

A module that returns random strings and API keys

Downloads

79

Readme


unique-id-key

A TypeScript module for generating unique random strings. The module provides methods to create numeric, alphabetic, or alphanumeric strings, and it can generate random API keys separated by a special character after every 4th character.

Installation

Install the package using npm:

npm install unique-id-key

Then, import the module in your project:

import { RandomString, RandomNum, AlphaNum, APIKEY, UUID } from 'unique-id-key';

Methods

RandomString(length: number, caseType?: "uppercase" | "lowercase")

Generates a random alphabetic string. You can specify the length of the string and optionally define if it should be uppercase or lowercase. If caseType is not provided, the result will include both uppercase and lowercase characters.

Parameters:

  • length: The length of the desired string (number).
  • caseType (optional): Specify "uppercase" for all uppercase letters or "lowercase" for all lowercase letters.

Example:

const any_randomString = RandomString(10);
console.log(any_randomString);
// Example output: "erRogWyRtr"

const uppercase_randomString = RandomString(8, "uppercase");
console.log(uppercase_randomString);
// Example output: "MNTVBSQW"

const lowercase_randomString = RandomString(11, "lowercase");
console.log(lowercase_randomString);
// Example output: "tqwicductda"

RandomNum(length: number)

Generates a random numeric string with the specified length.

Parameters:

  • length: The length of the numeric string (number).

Example:

const random_numeric = RandomNum(10);
console.log(random_numeric);
// Example output: "4836593648"

RandomAlphaNum(length: number)

Generates a random alphanumeric string with both letters (uppercase and lowercase) and numbers.

Parameters:

  • length: The length of the alphanumeric string (number).

Example:

const random_alphanum = RandomAlphaNum(10);
console.log(random_alphanum);
// Example output: "gp2WfI7ihd"

APIKEY(length: number, separator: string)

Generates a random API key with a specified length, and inserts a separator after every 4th character.

Parameters:

  • length: The total length of the API key (number).
  • separator: The character to insert after every 4th character (string).

Example:

const api_key_1 = APIKEY(16, "-");
console.log(api_key_1);
// Example output: "5TZS-JLG3-325O-1S5B"

const api_key_2 = APIKEY(12, ".");
console.log(api_key_2);
// Example output: "5hQw.tQ1l.yqgH"

UUID()

Generates a random UUID (Universally Unique Identifier).

Example:

const uuid = UUID();
console.log(uuid);
// Example output: "9f5b5672-9a34-4a6b-a52d-dcdfe1d33cb4"