0.0.2 • Published 1 year ago

@cyra/human64 v0.0.2

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

human64

Encoding scheme and javascript implementation for representing arbitrary strings using the base64url charset while preserving as much of the input as possible.

Usage in Node.js

Installation

npm install @cyra/human64

Encoding and decoding

const { encode, decode } = require('@cyra/human64')

const encoded = encode('hello :)') // hello___-8Rrb
const decoded = decode(encoded)

Project state

It works.

To do

I would like to

  • Properly document how this encoding scheme works and how to implement it (Beyond the basic descriptions of the test strings in test.js)
  • Clean up my own implementation (String manipulation gets messy quickly, especially when designing and implementing an encoding scheme at the same time)
  • Design and implement proper compression for the "unsafe part" of the encoder output
  • Make the javascript implementation browser-compatible (It currently makes use of Node.js Buffers)