Examples

Build the package before running the repository examples:

npm ci
npm run build
node examples/node-basic.js

Generate and store

const { HID, HybridID } = require('../dist');
const generator = new HID({ machineId: 1, useCrypto: true });
const id = generator.nextId();
const stored = id.toBase62();
console.log('Base62:', stored);
console.log('Fields:', generator.info(id));
console.log('Expired:', generator.isIdExpired(id, 60_000));
console.log('Round trip:', HybridID.fromBase62(stored).isEqual(id));

Use a unique database constraint on the persisted ID. Decide how your application retries a collision or handles generator restarts.

Emit events

import { HID } from 'hybrid-id-generator';

const generator = new HID({ machineId: 2, enableEventEmission: true });
generator.on('idGenerated', id => console.log(id.toString()));
generator.nextIds(3);

Events fire synchronously, after the generator commits its timestamp/sequence state. Exceptions thrown by event listeners propagate to the caller. A failed batch may already have generated IDs and emitted events.

Use an environment machine ID

MACHINE_ID=42 node examples/node-basic.js

To read that value in your own code:

const generator = new HID({
  machineIdStrategy: 'env',
  machineId: 'MACHINE_ID',
});

Browser example

Serve the repository over localhost and open examples/browser-basic.html. Its script uses the built global bundle, so no CDN or polyfill is required.

python3 -m http.server 3103

Runtime compatibility covers bundler and CDN setup.