# saslprep

> SASLprep: Stringprep Profile for User Names and Passwords, rfc4013.

Latest version **1.0.3** (published 2019-05-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install saslprep
pnpm add saslprep
yarn add saslprep
bun add saslprep
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-05-01 |
| First published | 2017-06-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/saslprep) |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 1 |
| Unpacked size | 446.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 20 |
| Author | Dmitry Tsvettsikh |
| Maintainers | reklatsmasters |
| Keywords | sasl, saslprep, stringprep, rfc4013, 4013 |

## Links

- npm: https://www.npmjs.com/package/saslprep
- Repository: https://github.com/reklatsmasters/saslprep
- Homepage: https://github.com/reklatsmasters/saslprep#readme
- Issues: https://github.com/reklatsmasters/saslprep/issues
- npm.io page: https://npm.io/package/saslprep

## Dependencies (1)

- [sparse-bitfield](https://npm.io/package/sparse-bitfield.md) ^3.0.3

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 1.0.3 (latest) — 2019-05-01
- 1.0.2 — 2018-09-13
- 1.0.1 — 2018-07-19
- 1.0.0 — 2017-06-21

## README

# 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

---
_Source: https://npm.io/package/saslprep · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
