A collection of classes for data representation written in JavaScript.
npm install base-ex
BaseEx is a collection of classes for data representation from Base16 (hex) to Base2048 or even BasePhi.
BaseEx is completely standalone and works client and server side.
There are other good solutions for e.g. Base32, Base64, Base85, but BaseEx has them all in one place.
The Ex in the name stands for Exponent (of n) or - as read out loud - for an X.
converter (external links) | charsets (as required as argument) | standalone builds >> CDN links |
|---|---|---|
| Base1/Unary |
| |
| Base16 |
| |
| Base32 |
| |
| Base58 |
| |
| Base64 |
| |
| UUencode |
| |
| Base85 |
| |
| Base91 |
| |
| LEB128 |
| |
| Ecoji |
| |
| Base2048 |
| |
SimpleBase (Base2-Base62) |
| |
| BasePhi (Golden Ratio Base) |
| |
| ByteConverter | --- | |
| BaseEx | Ready to use instances of the above converters:
| (complete builds) |
_Additional charsets can be added. Watch this live example._
console
git clone https://github.com/UmamiAppearance/BaseExJS.git
`$3
console
nmp install base-ex
`Builds
There are multiple builds available which are always grouped as esm and iife, plus a minified version of each. The full build with all converters included can be found at dist, which contains:
* base-ex.esm.js
* base-ex.esm.min.js
* base-ex.iife.js
* base-ex.iife.min.jsApart from the full build, every converter can be used standalone. The associated builds can be found at dist/converters. Or at the table above. Ready to use CDN-links are listed here.
_Note that standalone converters are exported as default._
Usage
$3
#### Browser
html
`js
// ESM6 module// main class
import { BaseEx } from "./path/BaseEx.esm.min.js"
// explicit converter (e.g. Base32)
import { Base32 } from "./path/BaseEx.esm.min.js"
// explicit converter from a standalone build
import Base32 from "./path/base-32.esm.min.js"
`#### Node
js
// ESM6 Module// main class
import { BaseEx } from "base-ex"
// explicit converter (e.g. Base64)
import { Base64 } from "base-ex"
// CommonJS
const BaseEx = require("base-ex");
`#### Command Line Interface
A CLI can be found at: https://github.com/UmamiAppearance/BaseExCLI.
#### Available imports Browser/Node
The classic import via script tag has them all available without further ado. As it is a iife, everything is available under the scope of
BaseEx. *
BaseEx.Base1
* BaseEx.Base16
* BaseEx.Base32
* ...
* BaseEx.BaseEx
_(Which is not true for standalone builds, which are directly accessible, eg: Base16, Base32, ... See list)_
The same goes for the CommonJS import from Node. The only difference is, that the scope is not necessarily named BaseEx, as this is defined by the user (const myName = require("base-ex") --> myName.Base16...).Full import for ES6 modules:
`js
// browser
import {
Base1,
Base16,
Base32,
Base58,
Base64,
UUencode,
Base85,
Base91,
LEB128,
Ecoji,
Base2048,
SimpleBase,
BasePhi,
ByteConverter,
BaseEx
} from "./path/BaseEx.esm.min.js"// node
import { ... } from "base-ex"
`$3
Regardless of the environment, at instance of a converter gets created like so:
const b32 = new Base32();
The constructor takes some arguments/options (which may differ between different encoder types). Those can also can be passed ephemeral to the encoder and/or decoder.
$3
property arguments
endianness be le
padding nopad pad
sign unsigned signed
case lower upper
charset <various>
number-mode number
decimal-mode decimal
IO handler
- bytesIn >> accept only bytes as input
- bytesOut >> limits output to byte-like values
- bytesInOut >> in- and output limited to bytes
output types
- bigint64
- bigint_n
- biguint64
- buffer
- bytes
- float32
- float64
- float_n
- int8
- int16
- int32
- int_n
- str
- uint8
- uint16
- uint32
- uint_n
- view
$3
Example:
_(Ecoji is simply picked, because of its picturesque appearance, any other converter works the same)_
js
const ecoji = new Ecoji();
ecoji.encode("Hello World!");
// result: šÆš©šš·ššš¦šŖš”š¢ā// default output is an ArrayBuffer, pass 'str' to convert to string
ecoji.decode("šÆš©šš·ššš¦šŖš”š¢ā", "str");
// result: "Hello World!"
`$3
More explanation is shown at the LiveExamples. Also try out the Online Base Converter for additional code examples.___
You can play with the Examples on your local machine by running:
console
npm start
`
_(devDependencies required, run npm install` from the package folder first)_Copyright (c) 2023, UmamiAppearance
* The basE91 en-/decoder relies on the work of _Joachim Henke_. The original code is licensed under BSD-3-Clause. His method was transpiled to JavaScript with small adjustments.
* The test files for the Ecoji decoder (ecoji-orig.test.js) are copied from the Ecoji repository and are created by _Keith Turner_. These are licensed under Apache-2.0
* The Base2048 Decoder relies on the work of _qntm_. The original code is licensed under the MIT-License. The original code is already written in JavaScript and was slightly adjusted.
* Non Integer Bases can only work with a high decimal precision, this is done with the help of Big.js. The code is reduced to the requirements of the converters (at the moment this is only BasePhi). _Big.js_, created by _Michael Mclaughlin_, is licensed under the MIT-License.