Socket
Socket
Sign inDemoInstall

6bit-encoder

Package Overview
Dependencies
0
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    6bit-encoder

Encodes 6bit numbers (0..63) to URL safe chars.


Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Install size
18.3 kB
Created
Weekly downloads
 

Readme

Source

6bit-encoder build status

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: ; , . ~ ( ' ) ! * : @

Type: Array<String>

decode

Decodes one char into a 6 bit number

Parameters

Returns Number a 6 bit number

decode2

Decodes two chars into a 12 bit number

Parameters

Returns Number a 12 bit number

decode3

Decodes three chars into an 18 bit number

Parameters

Returns Number an 18 bit number

decode4

Decodes four chars into an 24 bit number

Parameters

Returns Number a 24 bit number

decode5

Decodes five chars into an 30 bit number

Parameters

Returns Number a 30 bit number

encode

Encodes a 6 bit number into a URL safe char

Parameters

Returns String the char

encode2

Encodes a 12 bit number into two URL safe chars

Parameters

Returns String the chars

encode3

Encodes a 18 bit number into three URL safe chars

Parameters

Returns String the chars

encode4

Encodes a 24 bit number into four URL safe chars

Parameters

Returns String the chars

encode5

Encodes a 30 bit number into five URL safe chars

Parameters

Returns String the chars

decodeFor

Get a decode function to decode n chars

Parameters

  • n Number 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

  • n Number number of 6 bits to encode

Returns function the matching encoding function

License

MIT

FAQs

Last updated on 23 Nov 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc