Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smakss/password-generator
Generate random password
https://github.com/smakss/password-generator
generate-password generator javascript npm npm-install npm-package password password-generator passwords random yarn yarn-package yarn-packages
Last synced: 3 months ago
JSON representation
Generate random password
- Host: GitHub
- URL: https://github.com/smakss/password-generator
- Owner: SMAKSS
- License: mit
- Created: 2020-09-30T21:27:41.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-30T13:12:45.000Z (12 months ago)
- Last Synced: 2024-09-30T16:47:37.136Z (3 months ago)
- Topics: generate-password, generator, javascript, npm, npm-install, npm-package, password, password-generator, passwords, random, yarn, yarn-package, yarn-packages
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@smakss/password-generator
- Size: 319 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: Readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Password Generator
![npm](https://img.shields.io/npm/v/@smakss/password-generator) ![NPM](https://img.shields.io/npm/l/@smakss/password-generator) ![npm](https://img.shields.io/npm/dt/@smakss/password-generator) ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/@smakss/password-generator)
Generating secure and random passwords is a common necessity in today's digital world. The `@smakss/password-generator` package simplifies this task, providing an easy-to-use tool for creating random passwords. Whether you need a single password or a bulk set, this package offers the flexibility to include various character types or use a custom set of characters.
## Demo
Explore the functionality in a live environment on CodeSandbox:
[![View @smakss/password-generator](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/smakss-password-generator-o9ev4k?fontsize=14&hidenavigation=1&theme=dark)
## Installation
To install the package, run:
```bash
npm i @smakss/password-generator
# or
yarn add @smakss/password-generator
```To include it using CommonJS syntax:
```js
const PasswordGenerator = require('@smakss/password-generator');
```For ECMAScript modules:
```js
import PasswordGenerator from '@smakss/password-generator';
```## Usage
The `PasswordGenerator` function accepts an options object with the following parameters:
- `length` (`number`, Default: random between 1-20): The length of the desired password.
- `includeLower` (`boolean`, Default: `true`): Include lowercase characters.
- `includeCaps` (`boolean`, Default: `true`): Include uppercase characters.
- `includeNums` (`boolean`, Default: `true`): Include numeric characters.
- `includeSpecs` (`boolean`, Default: `true`): Include special characters.
- `characters` (`string`): Specify a custom string of characters for the password.
- `numberOfPasswords` (`number`): Number of passwords to generate in bulk.## Examples
### Generate a password with default parameters
```js
const password = PasswordGenerator();
// Result might be something like: "s%gu?TcT]bvc9"
```### Generate a password with a specified length
```js
const password = PasswordGenerator({ length: 10 });
// Result might be something like: ",tWy%[T8fU"
```### Generate a password excluding numbers and lowercase characters
```js
const password = PasswordGenerator({
length: 10,
includeLower: false,
includeNums: false
});
// Result might be something like: ":+U,G:JNXL"
```### Generate a password using only specified characters
```js
const password = PasswordGenerator({ length: 10, characters: 'a1~' });
// Result might be something like: "~a~a1~~~a~"
```### Generate a bulk set of passwords
```js
const passwords = PasswordGenerator({ numberOfPasswords: 5 });
// Results in an array of 5 random passwords
console.log(passwords);
```## Contributing
Contributions to enhance `@smakss/password-generator` are welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
## Code of Conduct
Our commitment to providing a welcoming and inclusive environment is outlined in our [Code of Conduct](./CODE_OF_CONDUCT.md).