base58-js

base58-js

A lightweight (~560 bytes) universal JavaScript Base58 encoder and decoder.

Installation

Install base58-js via npm:

npm install base58-js

Requirements

Supported environments:

• Node.js versions ^16 || >=17.0.0 .
• Browsers matching the Browserslist query > 0.5%, not OperaMini all, not dead.

Usage Examples

Convert Base58 to binary

import { base58_to_binary } from "base58-js";

const bin = base58_to_binary("6MRy");
console.log(bin);

Logged output will be Uint8Array(3) [15, 239, 64].

Convert binary to base58

import { binary_to_base58 } from "base58-js";

const str = binary_to_base58([15, 239, 64]);
console.log(str);

The logged output was Thequickbrownfoxjumpedoverthea1zydog.

Exports

Deep imports from the ECMAScript modules are exported via the package.json field exports:

• index.js
• create_base58_map.js
• binary_to_base58.js
• base58_to_binary.js
• base58_chars.js

TypeScript Support

This package includes type definitions via TypeScript JSDoc for excellent IntelliSense and type checking.

Changelog

3.0.3

Patch

• Fixed Corrected TypeScript declaration files (.d.ts) to export functions properly without importing .d.ts files directly.

• Updated index.d.ts to re-export named functions from implementation .js files, ensuring compatibility with TypeScript's module resolution and eliminating errors like TS2846 and TS1362.

• Changed Improved package.json exports and types fields to explicitly map .js files to their corresponding .d.ts typings for better editor support and module resolution.

• Enhanced README with detailed usage examples, environment requirements, export info, TypeScript support, and a clear explanation of tree-shaking implications.

• This fixes the issue described in #4.