# b2a

> btoa and atob (ie base64/base64url encoding and decoding) support for node.js or old browsers, with the Unicode Problems fixed

Latest version **1.1.2** (published 2019-08-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install b2a
pnpm add b2a
yarn add b2a
bun add b2a
```

## Health

**Score 28/100 (F)** — status: abandoned.

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2019-08-06 |
| First published | 2017-09-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/b2a) |
| Module format | ESM + CommonJS |
| Node | >=4 |
| Dependencies | 0 |
| Unpacked size | 10.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 21 |
| Author | kaelzhang |
| Maintainers | kael |
| Keywords | btoa, encode, decode, atob, base64, base64url, base64-url, unicode, 16-bit, 8-bit, homoglyphs |

## Links

- npm: https://www.npmjs.com/package/b2a
- Repository: https://github.com/kaelzhang/b2a
- Homepage: https://github.com/kaelzhang/b2a#readme
- Issues: https://github.com/kaelzhang/b2a/issues
- npm.io page: https://npm.io/package/b2a

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 1.1.2 (latest) — 2019-08-06
- 1.1.1 — 2019-08-06
- 1.1.0 — 2019-08-06
- 1.0.12 — 2019-06-24
- 1.0.11 — 2019-04-10
- 1.0.10 — 2018-02-24
- 1.0.9 — 2017-09-25
- 1.0.8 — 2017-09-12
- 1.0.7 — 2017-09-08
- 1.0.6 — 2017-09-08
- 1.0.5 — 2017-09-08
- 1.0.4 — 2017-09-08
- 1.0.3 — 2017-09-08
- 1.0.2 — 2017-09-08
- 1.0.1 — 2017-09-08
- … 1 more at https://npm.io/package/b2a/versions

## README

[![Build Status](https://travis-ci.org/kaelzhang/b2a.svg?branch=master)](https://travis-ci.org/kaelzhang/b2a)
[![Coverage](https://codecov.io/gh/kaelzhang/b2a/branch/master/graph/badge.svg)](https://codecov.io/gh/kaelzhang/b2a)
<!-- optional appveyor tst
[![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/kaelzhang/b2a?branch=master&svg=true)](https://ci.appveyor.com/project/kaelzhang/b2a)
-->
<!-- optional npm version
[![NPM version](https://badge.fury.io/js/b2a.svg)](http://badge.fury.io/js/b2a)
-->
<!-- optional npm downloads
[![npm module downloads per month](http://img.shields.io/npm/dm/b2a.svg)](https://www.npmjs.org/package/b2a)
-->
<!-- optional dependency status
[![Dependency Status](https://david-dm.org/kaelzhang/b2a.svg)](https://david-dm.org/kaelzhang/b2a)
-->

# b2a

`btoa` and `atob` (base64/base64url encoding and decoding) support for node.js or old browsers, with the [Unicode Problems](https://developer.mozilla.org/en-US/docs/Web/API/WindowBase64/Base64_encoding_and_decoding#The_Unicode_Problem) fixed.

The common problem of other libraries is that they fail to encode 16-bit strings. Since DOMStrings are 16-bit-encoded strings, in most browsers calling `window.btoa` on a Unicode string will cause a `'Character Out Of Range'` exception if a character exceeds the range of a 8-bit byte (`0x00~0xFF`).

This module will try to reuse `window.atob` and `window.btoa` when possible.

## Install

```sh
$ npm install b2a
```

## Usage

```js
import {
  // Encode a string in base-64
  btoa,
  // Decode a string in base-64
  atob,

  // Encode a string into base64url
  btoau,
  // Decode a base64url-encoded string
  atobu
} from 'b2a'

btoa('a')           // 'YQ=='
window.btoa('a')    // 'YQ==', works fine with ASCII characters


// Oooooooops!
// In most browsers, calling btoa() on a Unicode string
// will cause a Character Out Of Range exception.
window.btoa('中文')  // throws InvalidCharacterError ❌

btoa('中文')         // '5Lit5paH' ✅


// Oooooooops!
window.atob('5Lit5paH')   // '中æ', oh no! ❌

atob('5Lit5paH')          // '中文', great! ✅


btoau('μπορούμε')                 // zrzPgM6_z4HOv8-NzrzOtQ==

atobu('zrzPgM6_z4HOv8-NzrzOtQ==') // μπορούμε
```

## `base64url` support since 1.1.0

Since `1.1.0`, `btoau` and `atobu` are introduced to encode and decode in [base64url](https://en.wikipedia.org/wiki/Base64#URL_applications) format.

```js
import {btoau} from 'b2a'

location.href = `https://domain.com/login?return_to=${btoau(location.href)}`
```

## License

MIT

---
_Source: https://npm.io/package/b2a · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._