diff options
Diffstat (limited to 'node_modules/saslprep/readme.md')
-rw-r--r-- | node_modules/saslprep/readme.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/node_modules/saslprep/readme.md b/node_modules/saslprep/readme.md new file mode 100644 index 0000000..8ff3d70 --- /dev/null +++ b/node_modules/saslprep/readme.md @@ -0,0 +1,31 @@ +# saslprep +[](https://travis-ci.org/reklatsmasters/saslprep) +[](https://npmjs.org/package/saslprep) +[](https://npmjs.org/package/saslprep) +[](https://npmjs.org/package/saslprep) +[](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 |