Blame view
node_modules/libqp/README.md
2.35 KB
f7563de62
first commit
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# libqp
Encode and decode quoted-printable strings according to [RFC2045](http://tools.ietf.org/html/rfc2045#section-6.7).
## Usage
Install with npm
npm install libqp
Require in your script
```javascript
var libqp = require('libqp');
```
### Encode values
Encode Buffer objects or unicode strings with
libqp.encode(val) → String
Where
* **val** is a Buffer or an unicode string
**Example**
```javascript
libqp.encode('jõgeva');
// j=C3=B5geva
```
### Wrap encoded values
Quoted-Printable encoded lines are limited to 76 characters but `encode` method might return lines longer than the limit.
To enforce soft line breaks on lines longer than 76 (or any other length) characters, use `wrap`
libqp.wrap(str[, lineLength]) → String
Where
* **str** is a Quoted-Printable encoded string
* **lineLength** (defaults to 76) is the maximum allowed line length. Any longer line will be soft wrapped
**Example**
```javascript
libqp.wrap('abc j=C3=B5geva', 10)
// abc j=\r
// =C3=B5geva
```
### Transform Streams
`libqp` makes it possible to encode and decode streams with `libqp.Encoder` and `libqp.Decoder` constructors.
### Encoder Stream
Create new Encoder Stream with
var encoder = new libqp.Encoder([options])
Where
* **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)
**Example**
The following example script reads in a file, encodes it to Quoted-Printable and saves the output to a file.
```javascript
var libqp = require('libqp');
var fs = require('fs');
var source = fs.createReadStream('source.txt');
var encoded = fs.createReadStream('encoded.txt');
var encoder = new libqp.Encoder();
source.pipe(encoder).pipe(encoded);
```
### Decoder Stream
Create new Decoder Stream with
var decoder = new libqp.Decoder([options])
Where
* **options** is the optional stream options object
**Example**
The following example script reads in a file in Quoted-Printable encoding, decodes it and saves the output to a file.
```javascript
var libqp = require('libqp');
var fs = require('fs');
var encoded = fs.createReadStream('encoded.txt');
var dest = fs.createReadStream('dest.txt');
var decoder = new libqp.Decoder();
encoded.pipe(decoder).pipe(dest);
```
## License
**MIT**
|