https://github.com/little-core-labs/base64-wasm
A Base64 implementation for WebAssembly (WASM) written in ZZ
https://github.com/little-core-labs/base64-wasm
base64 wasm zz
Last synced: 5 months ago
JSON representation
A Base64 implementation for WebAssembly (WASM) written in ZZ
- Host: GitHub
- URL: https://github.com/little-core-labs/base64-wasm
- Owner: little-core-labs
- License: mit
- Created: 2020-05-01T19:07:17.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-02T16:58:08.000Z (about 5 years ago)
- Last Synced: 2024-12-17T08:27:42.656Z (6 months ago)
- Topics: base64, wasm, zz
- Language: JavaScript
- Homepage:
- Size: 66.4 KB
- Stars: 14
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
base64-wasm
===========
> A Base64 implementation for WebAssembly (WASM) written in [ZZ][zz] that
> implements an [_Abstract Encoding_][abstract-encoding] interface.
## Installation
### Node
```sh
$ npm install base64-wasm
```
### WAPM
```sh
$ wapm install jwerle/base64-wasm
```
## Usage
```js
const b64 = require('base64-wasm')
// wait for module to be ready if loading in a browser environment
b64.ready((err) => {
const message = Buffer.from('hello world')
const encoded = b64.encode(message)
console.log(encoded.toString()) // aGVsbG8gd29ybGQ=
const decoded = b64.decode(encoded)
console.log(decoded.toString()) // hello world
})
```
## API
### `buffer = encode(input[, buffer[, offset]])`
Base64 encode an `input` optionally into `buffer` at an optionally
specified `offset`.
### `buffer = decode(input[, buffer[, offset]])`
Base64 decode an `input` optionally into `buffer` at an optionally
specified `offset`.
### `promise = ready(callback)`
Returns a promise that resolves or rejects when the WebAssembly exports
are loading. In some cases, this may happen synchronously when this
module is loaded.
```js
await b64.ready()
```
## Limits
### Initial Memory
By default, this module allocates 2 pages of memory for the WebAssembly module.
That is `2 * 64 * 1024` bytes.
### Maximum Memory
This module allows at most 256 pages of memory. That is `256 * 64 *
1024` bytes.
## License
MIT
[zz]: https://github.com/zetzit/zz
[abstract-encoding]: https://github.com/mafintosh/abstract-encoding