Identifiers that are readable, spellable, and pronounceable
Identifiers that are readable, spellable, and pronounceable.
A "proquint" (see here) is a method of encoding an integer (or really, a sequence of 0 or more 16-bit words) as a sequence of 5-character, pronounceable strings. This is to facilitate easy communication of the identifier via "wetware" (read: human) channels.
Note that because proquint operates on 16-bit (2-byte) words, all the buffers you put into it will need to have lengths that are multiples of 2. You'll probably get awesome stack traces if you don't. Yay!
var proquint = require"proquint";var id = proquintencodeBuffer0x01 0x02 0x03 0x04;console.logid;
Available via npm:
$ npm install proquint
Or via git:
$ git clone git://github.com/deoxxa/proquint.git node_modules/proquint
Encodes a buffer to a proquint string.
var encoded = proquintencodeBuffer0x01 0x02;console.logencoded;
Decodes a proquint string into a buffer.
var buffer = proquintdecode"fahab-hasab";console.logbuffer;
Also see example.js.
// we're going to use the crypto module for getting random datavar crypto = require"crypto";// this is proquint! go proquint!var proquint = require"proquint";// you can use whatever you like for this, as long as you can get the identifier// to fit into a buffer with a length that is a multiple of twovar id = cryptorandomBytes8;// buffers are awesome - they let us get nice hex strings to readconsole.logidtoString"hex";// here's how we encode a buffervar encoded = proquintencodeid;// this guy is a regular old stringconsole.logencoded;// and this is the inverse!var decoded = proquintdecodeencoded;// another buffer!console.logdecodedtoString"hex";
3-clause BSD. A copy is included with the source.