6bit-encoder v0.2.0
6bit-encoder 
Encodes 6bit numbers (0..63) to URL safe chars.
const assert = require('assert')
const { encode, encode5, decode, decode5 } = require('6bit-encoder')
assert.equal(encode(0b001111), 'F')
assert.equal(encode5(0b011111011111011111011111011111), 'VVVVV')
assert.equal(decode('F'), 0b001111)
assert.equal(decode5('VVVVV'), 0b011111011111011111011111011111)Installation
npm install 6bit-encoderTable of Contents generated with DocToc
API
SEPARATOR
A URL safe char that is not part of the encoding table and
can be used as a separator: '*'
Type: String
SEPARATORS
Remaining URL safe chars that are not part of the encoding table and
can be used as a separator: ; , . ~ ( ' ) ! * : @
decode
Decodes one char into a 6 bit number
Parameters
sString the char to decode
Returns Number a 6 bit number
decode2
Decodes two chars into a 12 bit number
Parameters
sString the chars to decode
Returns Number a 12 bit number
decode3
Decodes three chars into an 18 bit number
Parameters
sString the chars to decode
Returns Number an 18 bit number
decode4
Decodes four chars into an 24 bit number
Parameters
sString the chars to decode
Returns Number a 24 bit number
decode5
Decodes five chars into an 30 bit number
Parameters
sString the chars to decode
Returns Number a 30 bit number
encode
Encodes a 6 bit number into a URL safe char
Parameters
nNumber a 6 bit number
Returns String the char
encode2
Encodes a 12 bit number into two URL safe chars
Parameters
nNumber a 12 bit number
Returns String the chars
encode3
Encodes a 18 bit number into three URL safe chars
Parameters
nNumber a 18 bit number
Returns String the chars
encode4
Encodes a 24 bit number into four URL safe chars
Parameters
nNumber a 24 bit number
Returns String the chars
encode5
Encodes a 30 bit number into five URL safe chars
Parameters
nNumber a 30 bit number
Returns String the chars
decodeFor
Get a decode function to decode n chars
Parameters
nNumber the number of chars to decode
Returns function the matching decoding function
encodeFor
Get an encode function to encode an n * 6 bit number
Parameters
nNumber number of 6 bits to encode
Returns function the matching encoding function
License
MIT