32 lines
1.0 KiB
Markdown
32 lines
1.0 KiB
Markdown
# saslprep
|
|
[![Build Status](https://travis-ci.org/reklatsmasters/saslprep.svg?branch=master)](https://travis-ci.org/reklatsmasters/saslprep)
|
|
[![npm](https://img.shields.io/npm/v/saslprep.svg)](https://npmjs.org/package/saslprep)
|
|
[![node](https://img.shields.io/node/v/saslprep.svg)](https://npmjs.org/package/saslprep)
|
|
[![license](https://img.shields.io/npm/l/saslprep.svg)](https://npmjs.org/package/saslprep)
|
|
[![downloads](https://img.shields.io/npm/dm/saslprep.svg)](https://npmjs.org/package/saslprep)
|
|
|
|
Stringprep Profile for User Names and Passwords, [rfc4013](https://tools.ietf.org/html/rfc4013)
|
|
|
|
### Usage
|
|
|
|
```js
|
|
const saslprep = require('saslprep')
|
|
|
|
saslprep('password\u00AD') // password
|
|
saslprep('password\u0007') // Error: prohibited character
|
|
```
|
|
|
|
### API
|
|
|
|
##### `saslprep(input: String, opts: Options): String`
|
|
|
|
Normalize user name or password.
|
|
|
|
##### `Options.allowUnassigned: bool`
|
|
|
|
A special behavior for unassigned code points, see https://tools.ietf.org/html/rfc4013#section-2.5. Disabled by default.
|
|
|
|
## License
|
|
|
|
MIT, 2017-2019 (c) Dmitriy Tsvettsikh
|