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

mart-id

v1.4.9

Published

A TypeScript library for generating IDs with predefined prefixes and customizable lengths

Downloads

23

Readme

Mart ID

Generates unique identifiers quickly and easily. Ideal for databases, sessions, and more.

Installation

To install Mart ID, use npm or yarn:

npm i mart-id

Usage

Here's a basic example of how to use Mart ID to generate a unique identifier:

import { mid } from "mart-id";

const newId = mid();
console.log("Generated ID:", newId);

API

mid(options?: Options): string

Generates a random unique identifier with customizable options.

Parameters:

  • options (optional): An object with the following properties:
    • prefix (string | null, default null): The selected prefix for the ID.
    • length (number, default 8): The length of the generated part of the ID (excluding the prefix).
    • charactersSet ("all" | "numbers" | "letters", default "all"): The character set to use.
    • includeChars (string): Additional characters to include in the character set.
    • excludeChars (string): Characters to exclude from the character set.

Returns:

  • string: The generated ID. The total length of the ID will be equal to the length of the prefix plus the specified length.

Example:

// Example 1: Using default parameters
// Default parameters: { prefix: null, length: 8, charactersSet: "all" }
const generatedId = mid();
console.log(generatedId); // Outputs something like 'oVnm1k2J'

// Example 2: Using custom parameters
const customId = mid({ prefix: "PVOC", length: 16, charactersSet: "all" });
console.log(customId); // Outputs something like 'PVOC1hgJks7d5jT2'

Contributing

If you'd like to contribute to Mart ID, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Make your changes and commit them with clear messages.
  4. Push your changes to your forked repository.
  5. Create a pull request to the main repository.

License

Mart ID is licensed under the MIT License. See the LICENSE file for more information.