# the-password

> Password util for the-framework

Latest version **4.0.3** (published 2019-02-15) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install the-password
pnpm add the-password
yarn add the-password
bun add the-password
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 4.0.3 |
| Published | 2019-02-15 |
| First published | 2017-07-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 1 |
| Unpacked size | 34.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | the |

## Links

- npm: https://www.npmjs.com/package/the-password
- Repository: https://github.com/the-labo/the-password
- Homepage: https://github.com/the-labo/the-password#readme
- Issues: https://github.com/the-labo/the-password/issues
- npm.io page: https://npm.io/package/the-password

## Dependencies (1)

- [abind](https://npm.io/package/abind.md) ^1.0.3

## Alternatives

- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads
- [escher-request](https://npm.io/package/escher-request.md) — 545 weekly downloads

## Recent versions

- 4.0.3 (latest) — 2019-02-15
- 4.0.2 — 2019-02-15
- 4.0.1 — 2019-01-31
- 4.0.0 — 2019-01-31
- 3.0.0 — 2018-09-05
- 2.0.0 — 2018-01-14
- 1.0.2 — 2017-07-30
- 1.0.1 — 2017-07-30
- 1.0.0 — 2017-07-29

## README

the-password
==========

<!---
This file is generated by the-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/the-labo/the-password
[bd_travis_url]: http://travis-ci.org/the-labo/the-password
[bd_travis_shield_url]: http://img.shields.io/travis/the-labo/the-password.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/the-labo/the-password
[bd_travis_com_shield_url]: https://api.travis-ci.com/the-labo/the-password.svg?token=
[bd_license_url]: https://github.com/the-labo/the-password/blob/master/LICENSE
[bd_npm_url]: http://www.npmjs.org/package/the-password
[bd_npm_shield_url]: http://img.shields.io/npm/v/the-password.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Password util for the-framework

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install the-password --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const thePassword = require('the-password')

async function tryExample () {
  const {generateSalt, generatePassword, digest} = thePassword()

  const salt = generateSalt()
  const password = generatePassword()

  const passwordHash = digest(password, salt)
  /* ... */

}

tryExample().catch((err) => console.error(err))

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/10.API Guide.md.hbs" Start -->

<a name="section-doc-guides-10-a-p-i-guide-md"></a>

API Guide
-----

+ [the-password@4.0.3](./doc/api/api.md)
  + [create(args)](./doc/api/api.md#the-password-function-create)
  + [ThePassword](./doc/api/api.md#the-password-class)


<!-- Section from "doc/guides/10.API Guide.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/the-labo/the-password/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [THE Labo][t_h_e_labo_url]

[t_h_e_labo_url]: https://github.com/the-labo

<!-- Links End -->

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