https://github.com/8hrsk/ranger
Package for generating fake userdata to work with.
https://github.com/8hrsk/ranger
data factory faker generator npm
Last synced: about 2 months ago
JSON representation
Package for generating fake userdata to work with.
- Host: GitHub
- URL: https://github.com/8hrsk/ranger
- Owner: 8hrsk
- Created: 2024-10-26T20:04:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-26T20:16:03.000Z (over 1 year ago)
- Last Synced: 2025-02-14T11:53:10.266Z (over 1 year ago)
- Topics: data, factory, faker, generator, npm
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@8hrsk/ranger
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Ranger
Ranger is an npm module for generating random user data. It creates user profiles complete with names, nicknames, surnames, birthdays, emails, and passwords. This module is useful for testing and prototyping applications where user data is required.
## Installation
You can install the Ranger module using npm:
```bash
npm install @8hrsk/ranger
```
## Usage
To start using Ranger, require the module and create an instance of the Ranger class:
```javascript
const Ranger = require('@8hrsk/ranger');
const ranger = new Ranger();
```
### Generating a Single User
You can generate a single user with various properties such as name, nickname, surname, birthday, email, password, and unhashed password:
```javascript
const user = ranger.User();
console.log(user);
```
### Generating Multiple Users
To generate an array of user objects, specify the number of users you want:
```javascript
const users = ranger.Users(5);
console.log(users);
```
### Generating Individual Properties
Ranger provides methods to generate individual properties:
#### Name
Generate a random name:
```javascript
const name = ranger.name();
console.log(name);
```
#### Surname
Generate a random surname:
```javascript
const surname = ranger.surname();
console.log(surname);
```
#### Birthday
Generate a random birthday:
```javascript
const birthday = ranger.birthday();
console.log(birthday);
```
#### Email
Generate a random email, optionally providing a name, surname, and year:
```javascript
const email = ranger.email('John', 'Doe', 1985);
console.log(email);
```
#### Nickname
Generate a random nickname:
```javascript
const nickname = ranger.nickname();
console.log(nickname);
```
#### Password
Generate a hashed and unhashed password:
```javascript
const password = ranger.password();
console.log(password);
```
## Methods
### `User()`
- Returns a user object with properties: `name`, `nickname`, `surname`, `birthday`, `email`, `password`, and `unhashedPassword`.
### `Users(amount)`
- Generates an array of user objects.
- **Parameters:**
- `amount` (number): The number of users to generate.
### `name()`
- Returns an object with a randomly generated `name`.
### `surname()`
- Returns an object with a randomly generated `surname`.
### `birthday()`
- Returns an object with a randomly generated `birthday`.
### `email(name, surname, year)`
- **Parameters:**
- `name` (string, optional): Name for the email.
- `surname` (string, optional): Surname for the email.
- `year` (number, optional): Year for the email.
- Returns an object with a randomly generated `email`.
### `nickname()`
- Returns an object with a randomly generated `nickname`.
### `password()`
- Returns an object with `unhashedPassword` and `hashed password`.
## Error Handling
- The `Users` method throws an error if the `amount` is not a number.
- The `email` methods throws errors if the `name` or `surname` are given, but now strings, and `year` given, but not a number.
## License
This module is open-source and available under the MIT License.
---
Feel free to contribute to the Ranger module by submitting issues or pull requests on GitHub. Happy coding!"