hexagon/base64

Base64 and base64url to string or arraybuffer, and back. Works in Node, Deno or browser.

Probably the only JavaScript base64 library you'll ever need!

@hexagon/base64

Encode, decode and validate base64/base64url to string/arraybuffer and vice-versa. Works in Node, Deno and browser.

• Supports regular base64 and base64url
• Convert to/from string or arraybuffer
• Validate / identify base64 and base64url
• Works in Node.js >=4.0 (both require and import).
• Works in Deno >=1.16.
• Works in browsers as standalone, UMD or ES-module.
• Includes TypeScript typings.

// Encode string as regular base64
const example1enc = base64.fromString("Hellö Wörld, how are you doing today?!");
console.log(example1enc);
// > SGVsbMO2IFfDtnJsZCwgaG93IGFyZSB5b3UgZG9pbmcgdG9kYXk/IQ==

// Decode string as regular base64
const example1dec = base64.toString("SGVsbMO2IFfDtnJsZCwgaG93IGFyZSB5b3UgZG9pbmcgdG9kYXk/IQ==");
console.log(example1dec);
// > Hellö Wörld, how are you doing today?!

Full documentation available at base64.56k.guru

Quick Installation

Node.js: npm install @hexagon/base64 --save

Deno (x): import base64 from "https://deno.land/x/[email protected]/src/base64.js";

Deno (jsr.io): import base64 from "jsr:@hexagon/[email protected]";

For browser/cdn usage, refer to the documentation.

Quick API

• fromArrayBuffer(buffer, urlMode) - Encodes ArrayBuffer into base64 or base64url if urlMode(optional) is true

• toArrayBuffer(str, urlMode) - Decodes base64url string (or base64url string if urlMode is true) to ArrayBuffer

• fromString(str, urlMode) - Encodes String into base64 string(base64url string if urlMode is true)

• toString(str, urlMode) - Decodes base64 or base64url string to String

• validate(str, urlMode) - Returns true if String str is valid base64/base64 dependending on urlMode

Contributing

See Contribution Guide

Donations

If you found this library helpful and wish to support its development, consider making a donation through Hexagon's GitHub Sponsors page. Your generosity ensures the library's continued development and maintenance.

Contributors

The underlying code is loosely based on github.com/niklasvh/base64-arraybuffer

License

MIT

base64's Issues

types not exported correctly

Types are not being picked up in my project, heres a minimal reproduction:

https://stackblitz.com/edit/vitejs-vite-ayep6m?file=src%2Fmain.ts

I think this has todo with the following settings in tsconfig

"moduleResolution": "Bundler",
"module": "ESNext",

I could resolve this by patching @hexagon/base64 package.json to the following:

   "exports": {
     ".": {
-      "import": "./src/base64.js",
+      "import": {"default":"./src/base64.js", "types":"./types/base64.d.ts"},
       "require": "./dist/base64.cjs",
       "browser": "./dist/base64.min.js"
     }

Grammar check of readme and comments

I do not speak english natively, so a grammar check of readme and code comments would be awesome.