rksuid v0.1.1

rksuid

A friendly resource ID generator.

Based on Segment.io's ksuid, providing K-Sortable Globally Unqiue IDs as the base.

Examples IDs:

user_2RttptY2HdLulw15ZDGTc3xQuz7
post_2RttqiLwfbZF2B0tpUGGv2krakX
part_2RttrZCWvecv3y1nveesEjaevGA

Install

npm install rksuid

Usage

import * as ID from 'rksuid'

// Generate an ID
ID.generate('user') // user_2RttptY2HdLulw15ZDGTc3xQuz7


// Validate an ID
ID.isValid('invalid') // false
ID.isValid(ID.generate('user')) // true
ID.isValid('user_2RttptY2HdLulw15ZDGTc3xQuz7') // true


// Parse ID
const r = ID.parse('user_2RttptY2HdLulw15ZDGTc3xQuz7')
// r = { prefix: user, ksuid: '2RttptY2HdLulw15ZDGTc3xQuz7' }