https://github.com/es-shims/es-arraybuffer-base64
An ES-spec-compliant shim/polyfill/replacement for ArrayBuffer base64 methods that works as far down as ES3
https://github.com/es-shims/es-arraybuffer-base64
arraybuffer base64 ecmascript javascript
Last synced: 3 months ago
JSON representation
An ES-spec-compliant shim/polyfill/replacement for ArrayBuffer base64 methods that works as far down as ES3
- Host: GitHub
- URL: https://github.com/es-shims/es-arraybuffer-base64
- Owner: es-shims
- License: mit
- Created: 2023-05-20T03:59:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-07T22:59:10.000Z (6 months ago)
- Last Synced: 2025-09-21T20:18:04.876Z (3 months ago)
- Topics: arraybuffer, base64, ecmascript, javascript
- Language: JavaScript
- Homepage:
- Size: 229 KB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# es-arraybuffer-base64 [![Version Badge][npm-version-svg]][package-url]
[![github actions][actions-image]][actions-url]
[![coverage][codecov-image]][codecov-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]
[![npm badge][npm-badge-png]][package-url]
An ES-spec-compliant shim/polyfill/replacement for ArrayBuffer base64 methods that works as far down as ES3
This package implements the [es-shim API](https://github.com/es-shims/api) “multi” interface. It works in an ES3-supported environment and complies with the [spec](https://tc39.es/proposal-arraybuffer-base64/).
Because the `Iterator.prototype` methods depend on a receiver (the `this` value), the main export in each subdirectory takes the string to operate on as the first argument.
The main export of the package itself is simply an array of the available directory names. It’s sole intended use is for build tooling and testing.
If `Uint8Array` is not present, the `shim` functions and `auto` entrypoints will be a no-op.
## Supported things
- [`Uint8Array.fromBase64`](https://tc39.es/proposal-arraybuffer-base64/spec/#sec-uint8array.frombase64)
- [`Uint8Array.fromHex`](https://tc39.es/proposal-arraybuffer-base64/spec/#sec-uint8array.fromhex)
- [`Uint8Array.prototype.toBase64`](https://tc39.es/proposal-arraybuffer-base64/spec/#sec-uint8array.prototype.tobase64)
- [`Uint8Array.prototype.toHex`](https://tc39.es/proposal-arraybuffer-base64/spec/#sec-uint8array.prototype.tohex)
- [`Uint8Array.prototype.setFromBase64`](https://tc39.es/proposal-arraybuffer-base64/spec/#sec-uint8array.prototype.setfrombase64)
- [`Uint8Array.prototype.setFromHex`](https://tc39.es/proposal-arraybuffer-base64/spec/#sec-uint8array.prototype.setfromhex)
## When you need this package
- When you are using an engine that does not support any of the above methods
- When using Safari 18.5 or earlier, which fails to throw on odd-length hex strings
## Getting started
```sh
npm install --save es-arraybuffer-base64
```
## Usage/Examples
```js
const fromHex = require('es-arraybuffer-base64/Uint8Array.fromHex');
const toHex = require('es-arraybuffer-base64/Uint8Array.prototype.toHex');
const assert = require('assert');
const array = new Uint8Array([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100]);
const hex = '48656c6c6f20576f726c64';
assert.deepEqual(fromHex(hex), array);
assert.equal(toHex(array), hex);
```
```js
require('./auto'); // shim all of the methods
require('./Uint8Array.fromHex/auto'); // shim the “fromHex” method
```
## Tests
Simply clone the repo, `npm install`, and run `npm test`
[package-url]: https://npmjs.org/package/es-arraybuffer-base64
[npm-version-svg]: https://versionbadg.es/es-shims/es-arraybuffer-base64.svg
[deps-svg]: https://david-dm.org/es-shims/es-arraybuffer-base64.svg
[deps-url]: https://david-dm.org/es-shims/es-arraybuffer-base64
[dev-deps-svg]: https://david-dm.org/es-shims/es-arraybuffer-base64/dev-status.svg
[dev-deps-url]: https://david-dm.org/es-shims/es-arraybuffer-base64#info=devDependencies
[npm-badge-png]: https://nodei.co/npm/es-arraybuffer-base64.png?downloads=true&stars=true
[license-image]: https://img.shields.io/npm/l/es-arraybuffer-base64.svg
[license-url]: LICENSE
[downloads-image]: https://img.shields.io/npm/dm/es-arraybuffer-base64.svg
[downloads-url]: https://npm-stat.com/charts.html?package=es-arraybuffer-base64
[codecov-image]: https://codecov.io/gh/es-shims/es-arraybuffer-base64/branch/main/graphs/badge.svg
[codecov-url]: https://app.codecov.io/gh/es-shims/es-arraybuffer-base64/
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/es-shims/es-arraybuffer-base64
[actions-url]: https://github.com/es-shims/es-arraybuffer-base64/actions