https://github.com/venespana/password-generator

A simple password generator
https://github.com/venespana/password-generator

Last synced: 22 days ago
JSON representation

A simple password generator

• Host: GitHub
• URL: https://github.com/venespana/password-generator
• Owner: venespana
• License: agpl-3.0
• Created: 2020-06-29T19:34:29.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T10:17:21.000Z (about 2 years ago)
• Last Synced: 2024-10-14T07:25:06.193Z (3 months ago)
• Language: TypeScript
• Size: 848 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Install

```bash

yarn add @venespana/password-generator

```

or

```bash

npm i @venespana/password-generator --save

```

# Usage

## Generate

Generate one password with the given options. Returns a string.

### Example

```ts

import { generate } '@venespana/password-generator';

const password = generate({

    length: 12,

    numbers: true,

    uppercase: true

})

```

### Props

`generate(settings)`

## GenerateMultiple

Generate one password with the given options. Returns a string.

### Example

```ts

import { generateMultiple } '@venespana/password-generator';

const password = generateMultiple(3, {

    length: 12,

    numbers: true,

    uppercase: true

})

```

### Props

`generateMultiple(amount, settings)`

## Settings

Name                |Descrption                            |Def Value|Required

--------------------|--------------------------------------|:-------:|:------:

length              |integer, length of password           |         |*

lowercase           |boolean. allow lowercase letters      |true     |

uppercase           |boolean. allow uppercase letters      |true     |

numbers             |boolean. allow numbers                |true     |

symbols             |boolean. allow special chars          |false    |

excludeSimilarChars |boolean. remove similar chars like 'i'|false    |