www.aleph1.co.uk Git - yaffs-website/blob - node_modules/js-base64/README.md

   1 [![build status](https://secure.travis-ci.org/dankogai/js-base64.png)](http://travis-ci.org/dankogai/js-base64)
   2
   3 # base64.js
   4
   5 Yet another Base64 transcoder
   6
   7 ## Usage
   8
   9 ### In Browser
  10 ````html
  11 <script src="base64.js"></script>
  12 ````
  13 ### node.js
  14 ````javascript
  15 var Base64 = require('./base64.js').Base64;
  16 ````
  17
  18
  19 ## SYNOPSIS
  20
  21 ````javascript
  22 Base64.encode('dankogai');  // ZGFua29nYWk=
  23 Base64.encode('小飼弾');    // 5bCP6aO85by+
  24 Base64.encodeURI('小飼弾'); // 5bCP6aO85by-
  25
  26 Base64.decode('ZGFua29nYWk=');  // dankogai
  27 Base64.decode('5bCP6aO85by+');  // 小飼弾
  28 // note .decodeURI() is unnecessary since it accepts both flavors
  29 Base64.decode('5bCP6aO85by-');  // 小飼弾
  30 ````
  31
  32 ### String Extension for ES5
  33
  34 ````javascript
  35 if (Base64.extendString) {
  36     // you have to explicitly extend String.prototype
  37     Base64.extendString();
  38     // once extended, you can do the following
  39     'dankogai'.toBase64();       // ZGFua29nYWk=
  40     '小飼弾'.toBase64();         // 5bCP6aO85by+
  41     '小飼弾'.toBase64(true);     // 5bCP6aO85by-
  42     '小飼弾'.toBase64URI();      // 5bCP6aO85by-
  43     'ZGFua29nYWk='.fromBase64(); // dankogai
  44     '5bCP6aO85by+'.fromBase64(); // 小飼弾
  45     '5bCP6aO85by-'.fromBase64(); // 小飼弾
  46 }
  47 ````
  48
  49 ## SEE ALSO
  50
  51 + http://en.wikipedia.org/wiki/Base64