diff options
Diffstat (limited to 'node_modules/base64-js/README.md')
| -rw-r--r-- | node_modules/base64-js/README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/node_modules/base64-js/README.md b/node_modules/base64-js/README.md new file mode 100644 index 000000000..e546d86d5 --- /dev/null +++ b/node_modules/base64-js/README.md @@ -0,0 +1,32 @@ +base64-js +========= + +`base64-js` does basic base64 encoding/decoding in pure JS. + +[](http://travis-ci.org/beatgammit/base64-js) + +[](https://ci.testling.com/beatgammit/base64-js) + +Many browsers already have base64 encoding/decoding functionality, but it is for text data, not all-purpose binary data. + +Sometimes encoding/decoding binary data in the browser is useful, and that is what this module does. + +## install + +With [npm](https://npmjs.org) do: + +`npm install base64-js` + +## methods + +`var base64 = require('base64-js')` + +`base64` has three exposed functions, `byteLength`, `toByteArray` and `fromByteArray`, which both take a single argument. + +* `byteLength` - Takes a base64 string and returns length of byte array +* `toByteArray` - Takes a base64 string and returns a byte array +* `fromByteArray` - Takes a byte array and returns a base64 string + +## license + +MIT |