dockerized_openAger/nodered/rootfs/data/node_modules/utf7/README.md

34 lines
1.1 KiB
Markdown
Raw Normal View History

2020-10-17 16:42:50 +00:00
# UTF-7
[![CircleCI](https://circleci.com/gh/kkaefer/utf7.svg?style=svg)](https://circleci.com/gh/kkaefer/utf7)
Encodes and decodes JavaScript (Unicode/UCS-2) strings to UTF-7 ASCII strings. It supports two modes: UTF-7 as defined in [RFC 2152](http://tools.ietf.org/html/rfc2152) and Modified UTF-7 as defined by the IMAP standard in [RFC 3501, section 5.1.3](http://tools.ietf.org/html/rfc3501#section-5.1.3)
## Usage
**RFC 2152**
```javascript
var utf7 = require('utf7');
var encoded = utf7.encode('Jyväskylä');
assert.equal('Jyv+AOQ-skyl+AOQ-', encoded);
var decoded = utf7.decode(encoded);
assert.equal('Jyväskylä', decoded);
```
By default, `.encode()` only encodes the default characeters defined in RFC 2152. To also encode optional characters, use `.encodeAll()` or specify the characters you want to encode as the second argument to `.encode()`.
**IMAP (RFC 3501)**
```javascript
var utf7 = require('utf7').imap;
var encoded = utf7.encode('"你好" heißt "Hallo"');
assert.equal('"&T2BZfQ-" hei&AN8-t "Hallo"', encoded);
var decoded = utf7.decode(encoded);
assert.equal('"你好" heißt "Hallo"', decoded);
```