JavaScript implementation of TypeIDs using TypeScript.
TypeIDs are a modern, type-safe, globally unique identifier based on the upcoming UUIDv7 standard. They provide a ton of nice properties that make them a great choice as the primary identifiers for your data in a database, APIs, and distributed systems. Read more about TypeIDs in their spec.
This is the official JavaScript / TypeScript implementation of TypeID by the jetify team. It provides an npm package that can be used by any JavaScript or TypeScript project.
_ If you wish to use a string-based representation of typeid (instead of class-based), please follow the instructions here. _
Using npm:
npm install typeid-jsUsing yarn:
yarn add typeid-jsUsing pnpm:
pnpm add typeid-jsNote: this package requires Typescript > 5.0.0
To create a random TypeID of a given type, use the typeid() function:
import { typeid } from 'typeid-js';
const tid = typeid('prefix');The prefix is optional, so if you need to create an id without a type prefix, you can do that too:
import { typeid } from 'typeid-js';
const tid = typeid();The return type of typeid("prefix") is TypeID<"prefix">, which lets you use
TypeScript's type checking to ensure you are passing the correct type prefix to
functions that expect it.
For example, you can create a function that only accepts TypeIDs of type user:
import { typeid, TypeID } from 'typeid-js';
function doSomethingWithUserID(id: TypeID<'user'>) {
// ...
}In addition to the typeid() function, the TypeID class has additional methods
to encode/decode from other formats.
For example, to parse an existing typeid from a string:
import { TypeID } from 'typeid-js';
// The asType() call is optional, but it converts to type TypeID<"prefix"> instead
// of TypeID<string>
const tid = TypeID.fromString('prefix_00041061050r3gg28a1c60t3gf').asType(
'prefix'
);To encode an existing UUID as a TypeID:
import { TypeID } from 'typeid-js';
// In this case TypeID<"prefix"> is inferred from the first argument
const tid = TypeID.fromUUID('prefix', '00000000-0000-0000-0000-000000000000');The full list of methods includes:
getType(): Returns the type of the type prefixgetSuffix(): Returns uuid suffix in its base32 representationtoString(): Encodes the object as a string, using the canonical formattoUUID(): Decodes the TypeID into a UUID string in hex format. The type prefix is ignoredtoUUIDBytes(): Decodes the TypeID into a UUID byte array. The type prefix is ignoredfromString(str): Parses a TypeID from a stringfromUUID(prefix, uuid): Creates a TypeID from a prefix and a UUID in hex formatfromUUIDBytes(prefix, bytes): Creates a TypeID from a prefix and a UUID in byte array format
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent