Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thlorenz/6bit-encoder
Encodes 6bit numbers (0..63) to URL safe chars.
https://github.com/thlorenz/6bit-encoder
Last synced: 26 days ago
JSON representation
Encodes 6bit numbers (0..63) to URL safe chars.
- Host: GitHub
- URL: https://github.com/thlorenz/6bit-encoder
- Owner: thlorenz
- License: mit
- Created: 2017-11-20T17:13:28.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-23T11:20:45.000Z (about 7 years ago)
- Last Synced: 2024-11-22T16:35:40.244Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://thlorenz.github.io/6bit-encoder
- Size: 1.13 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 6bit-encoder [](http://travis-ci.org/thlorenz/6bit-encoder)
Encodes 6bit numbers (0..63) to URL safe chars.
```js
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](https://github.com/thlorenz/doctoc)*
- [API](#api)
- [SEPARATOR](#separator)
- [decode](#decode)
- [decode2](#decode2)
- [decode3](#decode3)
- [decode4](#decode4)
- [decode5](#decode5)
- [encode](#encode)
- [encode2](#encode2)
- [encode3](#encode3)
- [encode4](#encode4)
- [encode5](#encode5)
- [decodeFor](#decodefor)
- [encodeFor](#encodefor)
- [License](#license)
## [API](https://thlorenz.github.io/6bit-encoder)
### SEPARATOR
A URL safe char that is not part of the encoding table and
can be used as a separator: `'*'`
Type: [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
### SEPARATORS
Remaining URL safe chars that are not part of the encoding table and
can be used as a separator: `; , . ~ ( ' ) ! * : @`
Type: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>
### decode
Decodes one char into a 6 bit number
**Parameters**
- `s` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the char to decode
Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** a 6 bit number
### decode2
Decodes two chars into a 12 bit number
**Parameters**
- `s` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the chars to decode
Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** a 12 bit number
### decode3
Decodes three chars into an 18 bit number
**Parameters**
- `s` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the chars to decode
Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** an 18 bit number
### decode4
Decodes four chars into an 24 bit number
**Parameters**
- `s` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the chars to decode
Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** a 24 bit number
### decode5
Decodes five chars into an 30 bit number
**Parameters**
- `s` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the chars to decode
Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** a 30 bit number
### encode
Encodes a 6 bit number into a URL safe char
**Parameters**
- `n` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** a 6 bit number
Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the char
### encode2
Encodes a 12 bit number into two URL safe chars
**Parameters**
- `n` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** a 12 bit number
Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the chars
### encode3
Encodes a 18 bit number into three URL safe chars
**Parameters**
- `n` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** a 18 bit number
Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the chars
### encode4
Encodes a 24 bit number into four URL safe chars
**Parameters**
- `n` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** a 24 bit number
Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the chars
### encode5
Encodes a 30 bit number into five URL safe chars
**Parameters**
- `n` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** a 30 bit number
Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the chars
### decodeFor
Get a decode function to decode n chars
**Parameters**
- `n` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** the number of chars to decode
Returns **[function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** the matching decoding function
### encodeFor
Get an encode function to encode an `n * 6` bit number
**Parameters**
- `n` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** number of 6 bits to encode
Returns **[function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** the matching encoding function
## License
MIT