6bit-encoder 中文文档教程
6bit-encoder 
将 6 位数字 (0..63) 编码为 URL 安全字符。
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-encoder
目录 使用 DocToc 生成
API
SEPARATOR
不属于一部分的 URL 安全字符的编码表和 可以用作分隔符：'*'
类型：String
SEPARATORS
不属于编码表的其余 URL 安全字符和 可用作分隔符：<代码>； ,. 〜（'）！ * : @
decode
将一个字符解码为 6 位数字
参数
sString the char to decode
返回 Number 一个 6 位数字
decode2
将两个字符解码为一个 12 位数字
参数
sString the chars to decode
返回 Number 一个 12 位数字
decode3
将三个字符解码为一个 18 位数字
参数
sString the chars to decode
返回 Number 一个 18 位数字
decode4
将四个字符解码为一个24 位数字
参数
sString the chars to decode
decode5
将五个字符解码为一个 30 位数字
参数
sString the chars to decode
返回 Number 30 位数字
encode
将 6 位数字编码为 URL 安全字符
参数
nNumber a 6 bit number
返回 < a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String char
encode2
将一个 12 位数字编码成两个 URL safe chars
参数
nNumber a 12 bit number
返回String 字符
encode3
将 18 位数字编码为三个 URL 安全字符
参数
nNumber a 18 bit number
返回 String
encode4
将 24 位数字编码为四个 URL 安全字符
参数
nNumber a 24 bit number
返回 String chars
encode5
将 30 位数字编码为 fiv e URL 安全字符
参数
nNumber a 30 bit number
decodeFor
获取解码函数来解码 n 个字符
参数
nNumber the number of chars to decode
返回 function 匹配的解码函数
encodeFor
得到一个编码函数来编码一个n * 6 位数
参数
nNumber number of 6 bits to encode
返回 function 匹配的编码函数
License
麻省理工学院
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-encoder
Table 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
