@thi.ng/base-n

[!NOTE] This is one of 188 standalone projects, maintained as part of the @thi.ng/umbrella monorepo and anti-framework.

🚀 Please help me to work full-time on these projects by sponsoring me on GitHub. Thank you! ❤️

• About
• Status
• Installation
• Dependencies
• API
• Authors
• License

About

Arbitrary base-n conversions w/ presets for base8/16/32/36/58/62/64/83/85, support for bigints and encoding/decoding of byte arrays.

In addition to the actual converters/encoders, the package also provides the plain character strings for each base and variations.

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/base-n

ESM import:

import * as base from "@thi.ng/base-n";

Browser ESM import:

<script type="module" src="https://esm.run/@thi.ng/base-n"></script>

JSDelivr documentation

For Node.js REPL:

const base = await import("@thi.ng/base-n");

Package sizes (brotli'd, pre-treeshake): ESM: 1.25 KB

Dependencies

None

API

Generated API docs

import { BASE85, defBase } from "@thi.ng/base-n";

BASE85.encodeBigInt(2n ** 128n - 1);
// '=r54lj&NUUO~Hi%c2ym0'

BASE85.decodeBigInt("=r54lj&NUUO~Hi%c2ym0").toString(16);
// 'ffffffffffffffffffffffffffffffff'

// define a custom base impl
const ternary = defBase("012");

ternary.encode(12345678)
// '212020020002100'

ternary.decode("212020020002100");
// 12345678

Authors

• Karsten Schmidt

If this project contributes to an academic publication, please cite it as:

@misc{thing-base-n,
  title = "@thi.ng/base-n",
  author = "Karsten Schmidt",
  note = "https://thi.ng/base-n",
  year = 2017
}

License

© 2017 - 2024 Karsten Schmidt // Apache License 2.0