		{
		"name": "@chronark/prefixed-id",
		"version": "0.3.8",
		"main": "./src/index.js",
		"typings": "./src/index.d.ts",
		"dependencies": {
		"base-x": "^3.0.9"
		"version": "0.4.0",
		"description": "",
		"main": "dist/index.js",
		"module": "dist/index.mjs",
		"types": "dist/index.d.ts",
		"files": [
		"dist"
		],
		"keywords": [],
		"author": "Andreas Thomas",
		"license": "ISC",
		"devDependencies": {
		"@types/node": "^18.8.5",
		"rome": "^11.0.0",
		"tsup": "^6.2.3",
		"tsx": "^3.10.1",
		"typescript": "^4.8.4"
		},
		"peerDependencies": {}
		}
		"scripts": {
		"test": "node --loader=tsx --test ./*/.test.ts ",
		"build": "tsup",
		"fmt": "rome check . --apply-suggested && rome format . --write"
		}
		}

README.md

		@@ -1,21 +0,55 @@
		# prefixed-id
		<div align="center">
		<h1 align="center">@chronark/prefixed-id</h1>
		<h5>pre_JUbF9zRGz9hrFXUyNJLXcowD9GsqCD</h5>
		</div>

		Easy way to generate prefixed unique ids similar to what stripe does.
		Based on uuid v4.
		<br/>

		This is just a typesafe convenient wrapper for generating prefixed ids.
		A minimal library to generate Stripe inspired predixed ids for your application.

		# Usage
		Works in
		- Nodejs
		- Cloudflare Workers
		- Vercel Edge

		```typescript
		import { IdGenerator } from '@chronark/prefixed-id';
		## Install

		```
		npm i @chronark/prefixed-id
		```

		## Usage

		### Nodejs

		```ts

		import nodeCrypto from "node:crypto"

		const idGenerator = new IdGenerator({
		humanReadableName: 'prefix',
		// Example:
		user: 'u',
		});
		prefixes: {
		"user": "u",
		},
		crypto: nodeCrypto
		})

		idGenerator.id('user');
		// -> u_xxxxxxxxxxxxxxxxxx...
		console.log(idGenerator.id("user"))
		// u_PtbBA7NGcYYDpae6ULWujk
		```

		### WebCrypto

		- Cloudflare Workers
		- Vercel Edge

		```ts
		const idGenerator = new IdGenerator({
		prefixes: {
		"user": "u",
		},
		crypto: crypto // will be globally defined
		})

		console.log(idGenerator.id("user"))
		// u_PtbBA7NGcYYDpae6ULWujk
		```

CHANGELOG.md

src/index.d.ts

src/index.js

src/index.js.map

src/lib/encoding.d.ts

src/lib/encoding.js

src/lib/encoding.js.map

src/lib/prefixed-id.d.ts

src/lib/prefixed-id.js

src/lib/prefixed-id.js.map

@chronark/prefixed-id - npm Package Compare versions

New alerts