Files
releases/docs/book/node_modules/abab
Torin Sandall fa9ae9437c Vendor node_modules for gitbook
The gitbook install has been incredibly flaky due to it's dependency on
npm. This commit simply vendors the node_modules so that each time we
build the site the process doesn't have to re-run gitbook install.

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2018-11-26 15:10:14 -08:00
..
2018-11-26 15:10:14 -08:00
2018-11-26 15:10:14 -08:00
2018-11-26 15:10:14 -08:00
2018-11-26 15:10:14 -08:00
2018-11-26 15:10:14 -08:00
2018-11-26 15:10:14 -08:00

abab

npm version Build Status

A module that implements window.atob and window.btoa according to the WHATWG spec. The code is originally from w3c/web-platform-tests.

Compatibility: Node.js version 3+ and all major browsers (using browserify or webpack)

Install with npm:

npm install abab

API

btoa (base64 encode)

const btoa = require('abab').btoa;
btoa('Hello, world!'); // 'SGVsbG8sIHdvcmxkIQ=='

atob (base64 decode)

const atob = require('abab').atob;
atob('SGVsbG8sIHdvcmxkIQ=='); // 'Hello, world!'

Valid characters

Per the spec, btoa will accept strings "containing only characters in the range U+0000 to U+00FF." If passed a string with characters above U+00FF, btoa will return null. If atob is passed a string that is not base64-valid, it will also return null. In both cases when null is returned, the spec calls for throwing a DOMException of type InvalidCharacterError.

Browsers

If you want to include just one of the methods to save bytes in your client-side code, you can require the desired module directly.

var atob = require('abab/lib/atob');
var btoa = require('abab/lib/btoa');

Checklists

If you're submitting a PR or deploying to npm, please use the checklists in CONTRIBUTING.md

Remembering atob vs. btoa

Here's a mnemonic that might be useful: if you have a plain string and want to base64 encode it, then decode it, btoa is what you run before (before - btoa), and atob is what you run after (after - atob).