generation-passwordjs/README.md

generation-passwordjs is a library for generating random password.

# What is it ?

> generation-passwordjs is a library for generating random password.

## Install

```bash
$ npm install generation-passwordjs
```

## Usage

#### `generatePassword({options})`

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

```javascript
import generatePassword from 'generation-passwordjs';

let password = generatePassword({
  characterAmount: 12,
  includeUppercase: true,
  includeNumbers: true,
  includeSymbols: true,
});
```

### Options

Any of these can be passed into the options object for each function.

| Name             | Description                            | Default Value |
| ---------------- | -------------------------------------- | ------------- |
| characterAmount  | amount of charcters in password.       | 10            |
| includeUppercase | use the uppercase letters in password. | false         |
| includeNumbers   | use the digits in password.            | true          |
| includeSymbols   | use the symbols in password.           | false         |