Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 887 Bytes

README.md

File metadata and controls

52 lines (33 loc) · 887 Bytes

RowID

A time-based unique ID solution.

Installation

Install this package as a dependency in the project:

# npm
npm i rowid

# Yarn
yarn add rowid

# pnpm
pnpm add rowid

Quick Start

Create an ID with the following code:

import RowID from "rowid";

const id: string = RowID();

Or start a customization with the following code:

import type { RowIDWithConfigResult } from "rowid";
import { RowIDWithConfig } from "rowid";

const { RowID }: RowIDWithConfigResult = RowIDWithConfig({
    charList: "0123456789ABCDEFGHJKMNPQRSTVWXYZ",
    randomnessLength: 22,
});

const id: string = RowID();

Documentation

For more information, please refer to the documentation.

For the CLI, please refer to the CLI documentation.

License

This project is licensed under the terms of the MIT license.