Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/milospaunovic/complete-randomer
A simple NPM helper package for generating random values.
https://github.com/milospaunovic/complete-randomer
boolean color date generator number random string
Last synced: 19 days ago
JSON representation
A simple NPM helper package for generating random values.
- Host: GitHub
- URL: https://github.com/milospaunovic/complete-randomer
- Owner: MilosPaunovic
- License: mit
- Created: 2021-04-25T10:54:00.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2023-07-28T17:32:58.000Z (over 1 year ago)
- Last Synced: 2024-04-26T18:43:44.554Z (7 months ago)
- Topics: boolean, color, date, generator, number, random, string
- Language: JavaScript
- Homepage: https://bit.ly/3BNq2zK
- Size: 723 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# complete-randomer
[](https://badge.fury.io/js/complete-randomer) [](https://github.com/MilosPaunovic/complete-randomer/actions/workflows/testing.yml) [](https://github.com/MilosPaunovic/complete-randomer/blob/develop/LICENSE)
A simple NPM helper package for generating random values.
## Install
```bash
npm i complete-randomer
# or
yarn add complete-randomer
```
## Usage
```js
const randomer = require('complete-randomer');
```
## Methods
#### Number
```js
// Integer between min & max parameters, inclusively
randomer.NUMBER.INTEGER(min, max); // Defaults to 1, 100
```
#### String
```js
// Parameter number of characters, could be used as a random password generator
randomer.STRING.GIBBERISH(length); // Defaults to 10
// Array of full name strings between 1 and 1000 results
randomer.STRING.NAMES(howMany); // Defaults to 10
```
#### Boolean
```js
// Random Boolean value
randomer.BOOLEAN.IS();
// Random YES or NO string
randomer.BOOLEAN.YES_NO();
```
#### Colors
```js
// HEX, #41D831
randomer.COLOR.HEX();
// RGB, rgb(180 206 38)
randomer.COLOR.RGB();
// RGBA, rgb(22 26 189 / 60%)
randomer.COLOR.RGBA();
// HSL, hsl(346 78% 49%)
randomer.COLOR.HSL();
// HSLA, hsl(134 75% 74% / 26%)
randomer.COLOR.HSLA();
```
#### Date
```js
// Random date between 01/01/1970 and 31/12/2030
randomer.DATE.FULL();
// Random date between 01/01/1970 and current date
randomer.DATE.PAST();
// Random date between current date and 31/12/2030
randomer.DATE.FUTURE();
```
#### Quotes
```js
// Random quote object, { text: '...', author: '...' }
randomer.QUOTES.SINGLE();
// Array of quote objects between 1 and 1000 results
randomer.QUOTES.LIST(howMany); // Defaults to 10
```
#### Emails
```js
// Random email address with 'host' part customizable
randomer.EMAIL.SINGLE(host); // Defaults to randomer
// Array of email addresses between 1 and 1000 results
randomer.EMAIL.LIST(howMany); // Defaults to 10
```
#### Users
```js
// Random user object, { firstName: '...', lastName: '...', email: '...', password: '...', dob: '...' }
randomer.USER.SINGLE();
// Array of user objects between 1 and 1000 results
randomer.USER.LIST(howMany); // Defaults to 10
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](https://raw.githubusercontent.com/MilosPaunovic/complete-randomer/main/LICENSE/)