# passwordly

> A simple password generator

Latest version **0.1.0** (published 2020-03-06) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2020-03-06 |
| First published | 2020-03-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 11.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mads Moi-Aune |
| Maintainers | madsmoiaune |
| Keywords | password, generator, node |

## Links

- npm: https://www.npmjs.com/package/passwordly
- Repository: https://github.com/madsaune/passwordly
- Issues: https://github.com/madsaune/passwordly/issues
- npm.io page: https://npm.io/package/passwordly

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2020-03-06

## README

# Passwordly

Passwordly is a simple password generator. It can generate random or word-based strings with a variety of options.

## Installation

`npm i passwordly --save`

## How to use

```javascript
const passwordly = require('passwordly');

passwordly('string', {
    uppercase: true,
    lowercase: true,
    digits: true
});

// Sample output: [ 'oIjENySr6eDN' ]

passwordly('string', {
    uppercase: true,
    lowercase: true,
    digits: true,
    suffix: true
});

// Sample output: [ 'YBpGsg36CVJT-3859' ]

passwordly('string', {
    uppercase: true,
    lowercase: true,
    digits: true,
    count: 3
});

// Sample output: [ 'NOBroeayPM9T', 'F3Az0Bab3sxm', '4opbY84VjlBS' ]

passwordly('string', {
    uppercase: true,
    lowercase: true,
    digits: true,
    symbols: true,
    count: 1,
    len: 32
});

// Sample output: [ '%lyydPQpVEj6@OV!aTg@we4yIhz#yPVj' ]

passwordly('word', {
    wordlist: [
      'romantic', 'eliminate', 'communication', 'automatic',
      'management', 'replace', 'shallow', 'outside',
      'discreet', 'allowance', 'training', 'appearance',
      'important', 'topple', 'exaggerate', 'suspect',
      'suspicion', 'conscience', 'castle', 'pleasant'
    ]
});

// Sample output: [ 'Suspect-Castle-Romantic' ]

passwordly('word', {
    wordlist: [
      'romantic', 'eliminate', 'communication', 'automatic',
      'management', 'replace', 'shallow', 'outside',
      'discreet', 'allowance', 'training', 'appearance',
      'important', 'topple', 'exaggerate', 'suspect',
      'suspicion', 'conscience', 'castle', 'pleasant'
    ],
    count: 5,
    numberOfWords: 2,
    suffix: true
});

// Sample output: [
//   'Romantic-Management-2544',
//   'Outside-Important-9117',
//   'Exaggerate-Management-2972',
//   'Communication-Suspect-4402',
//   'Training-Exaggerate-6006'
// ]
```

## Options

| Property | Type | Values |
|---|:---:|---|
| uppercase | boolean | default: false |
| lowercase | boolean | default: false |
| digits | boolean | default: false |
| symbols | boolean | default: false |
| prefix | boolean | default: false |
| suffix | boolean | default: false |
| len | int | default: 12 |
| count | int | default: 1 |
| numberOfWords | int | default: 3 |
| useDelimiter | boolean | default: true |
| delimiter | string | default: '-' |
| wordlist | array | [] |
| capitalization | string | camelcase (default), uppercase, lowercase |

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