|
| 1 | +# libbase64 |
| 2 | + |
| 3 | +Encode and decode base64 strings. |
| 4 | + |
| 5 | +## Usage |
| 6 | + |
| 7 | +Install with npm |
| 8 | + |
| 9 | + npm install libbase64 |
| 10 | + |
| 11 | +Require in your script |
| 12 | + |
| 13 | +```javascript |
| 14 | +var libbase64 = require('libbase64'); |
| 15 | +``` |
| 16 | + |
| 17 | +### Encode values |
| 18 | + |
| 19 | +Encode Buffer objects or unicode strings with |
| 20 | + |
| 21 | + libbase64.encode(val) → String |
| 22 | + |
| 23 | +Where |
| 24 | + |
| 25 | + * **val** is a Buffer or an unicode string |
| 26 | + |
| 27 | +**Example** |
| 28 | + |
| 29 | +```javascript |
| 30 | +libbase64.encode('jõgeva'); |
| 31 | +// asO1Z2V2YQ== |
| 32 | +``` |
| 33 | + |
| 34 | +### Wrap encoded values |
| 35 | + |
| 36 | +To enforce soft line breaks on lines longer than selected amount of characters, use `wrap` |
| 37 | + |
| 38 | + libbase64.wrap(str[, lineLength]) → String |
| 39 | + |
| 40 | +Where |
| 41 | + |
| 42 | + * **str** is a base64 encoded string |
| 43 | + * **lineLength** (defaults to 76) is the maximum allowed line length |
| 44 | + |
| 45 | +**Example** |
| 46 | + |
| 47 | +```javascript |
| 48 | +libbase64.wrap('asO1Z2V2asO1Z2V2asO1Z2V2YQ==', 10) |
| 49 | +// asO1Z2V2as\r\n |
| 50 | +// O1Z2V2asO1\r\n |
| 51 | +// Z2V2YQ== |
| 52 | +``` |
| 53 | + |
| 54 | +### Transform Streams |
| 55 | + |
| 56 | +`libbase64` makes it possible to encode and decode streams with `libbase64.Encoder` and `libbase64.Decoder` constructors. |
| 57 | + |
| 58 | +### Encoder Stream |
| 59 | + |
| 60 | +Create new Encoder Stream with |
| 61 | + |
| 62 | + var encoder = new libbase64.Encoder([options]) |
| 63 | + |
| 64 | +Where |
| 65 | + |
| 66 | + * **options** is the optional stream options object with an additional option `lineLength` if you want to use any other line length than the default 76 characters (or set to `false` to turn the soft wrapping off completely) |
| 67 | + |
| 68 | +**Example** |
| 69 | + |
| 70 | +The following example script reads in a file, encodes it to base64 and saves the output to a file. |
| 71 | + |
| 72 | +```javascript |
| 73 | +var libbase64 = require('libbase64'); |
| 74 | +var fs = require('fs'); |
| 75 | +var source = fs.createReadStream('source.txt'); |
| 76 | +var encoded = fs.createReadStream('encoded.txt'); |
| 77 | +var encoder = new libbase64.Encoder(); |
| 78 | + |
| 79 | +source.pipe(encoder).pipe(encoded); |
| 80 | +``` |
| 81 | + |
| 82 | +### Decoder Stream |
| 83 | + |
| 84 | +Create new Decoder Stream with |
| 85 | + |
| 86 | + var decoder = new libbase64.Decoder([options]) |
| 87 | + |
| 88 | +Where |
| 89 | + |
| 90 | + * **options** is the optional stream options object |
| 91 | + |
| 92 | +**Example** |
| 93 | + |
| 94 | +The following example script reads in a file in base64 encoding, decodes it and saves the output to a file. |
| 95 | + |
| 96 | +```javascript |
| 97 | +var libbase64 = require('libbase64'); |
| 98 | +var fs = require('fs'); |
| 99 | +var encoded = fs.createReadStream('encoded.txt'); |
| 100 | +var dest = fs.createReadStream('dest.txt'); |
| 101 | +var decoder = new libbase64.Decoder(); |
| 102 | + |
| 103 | +encoded.pipe(decoder).pipe(dest); |
| 104 | +``` |
| 105 | + |
| 106 | +## License |
| 107 | + |
| 108 | +**MIT** |
0 commit comments