0.1.1 • Published 8 years ago

strossle-id v0.1.1

Weekly downloads
2
License
ISC
Repository
github
Last release
8 years ago

Strossle-id

Unique Strossle ID generator

Syntax

Strossle ID is composed of 38 hexadecimal characters:

VVVVRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRCC

  • First 4 characters VVVV represent the version of the ID
  • Next are 32 RRR...RRR random characters
  • The ID is concluded with 2 checksum CC characters

Installation

Install by running npm install strossle-id

Usage

const strossleId = require('strossle-id');

// Generate a new random id
let newID = strossleId.generate();

// Validate id
strossleId.validate(newID); // true

// OPTIONAL - generate a specific version of strossle-ID
let idVersion = 1;
let earlyVersionID = strossleId.generate(idVersion);

ID Versions

VersionDescriptionState
1 (current)Using metrohash128 and crc8Supported

Note: If an unsupported version is provided as parameter to generate() function, the function defaults to current version.

Tests

Run mocha test/unit-test.js