README.md

Note

This is one of 199 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
• Related packages
• Installation
• Dependencies
• API
• Authors
• License

About

Hex string formatters for 4/8/16/24/32/48/64bit words, hexdump formatting of binary data.

Status

STABLE - used in production

Search or submit any issues for this package

Related packages

• @thi.ng/base-n - 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

Installation

yarn add @thi.ng/hex

ESM import:

import * as hex from "@thi.ng/hex";

Browser ESM import:

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

JSDelivr documentation

For Node.js REPL:

const hex = await import("@thi.ng/hex");

Package sizes (brotli'd, pre-treeshake): ESM: 631 bytes

Dependencies

None

API

Generated API docs

import * as h from "@thi.ng/hex";

const cssColor = (x: number) => "#" + h.U24(x);

cssColor(10597059)
// "#a1b2c3"

h.U48(223928981472033);
// "cba987654321"

h.U48HL(0xcba9, 0x87654321)
// "cba987654321"

h.U64(0xaa * 0x010101010101)
// "0000aaaaaaaaaaaa"

h.U64HL(0x11223344, 0x89abcdef);
// "1122334489abcdef"

// format directly from byte arrays

const BUF = [1, 2, 3, 4, 0x10, 0x20, 0x30, 0x40];

// big-endian

h.U32BE(BUF, 0)
// "01020304"
h.U32BE(BUF, 4)
// "10203040"

// little-endian

h.U32LE(BUF, 0)
// "04030201"

h.U32LE(BUF, 4)
// "40302010"

Authors

• Karsten Schmidt

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

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

License

© 2020 - 2024 Karsten Schmidt // Apache License 2.0