Mock Data Generator

Overview

The Mock Data Generator is an NPM package that provides a simple and customizable mock data generator for various entities like users, orders, products, and more. It uses the faker-js library to generate realistic mock data with random values for names, prices, image URLs, and other common data types. This package is designed for testing purposes, allowing you to populate databases, test UIs, and generate mock responses for APIs.

Features

• Generate mock data for users, products, orders, and more
• Supports random data generation for strings, numbers, dates, images, and other common data types
• Customizable number of items (e.g., 10 users, 5 orders, etc.)
• Works well for populating databases, testing UIs, and generating mock responses for APIs

Installation

To install the package, run:

npm install plain-mock-data

Usage

Here's an example of how to use the mock data generator in your project:

    import { generateUser, generateOrder, generateProduct } from 'plain-mock-data';
    import { generateMockData } from 'plain-mock-data';

1. Generate a single user:

You can generate a single user by calling the generateUser function:

import { generateUser, generateMockData } from 'plain-mock-data';

const users = generateMockData(generateUser, 1);

  console.log(User)

Output Example:

    {
    id: '1b1af283-f0e7-43f1-998d-99473a8f37b0',
    name: 'Geraldine Rohan',
    email: '[email protected]',
    email: '[email protected]',
    phone: '1-289-492-5680 x728',
    phone: '1-289-492-5680 x728',
    address: {
      street: '5789 Juniper Close',
      city: 'Lake Jeffview',
      state: 'Wisconsin',
      country: 'Malawi',
      zip: '35851-0237'
    }
  }

2.Generate a single Product:

You can generate a single user by calling the generateUser function:

import { generateProduct, generateMockData } from 'plain-mock-data';


const product = generateMockData(generateProduct, 1);

  console.log(product)

    Output Example:
    [
  {
    "id": "3db9434a-40b4-466d-9c82-ecfcf8efdc9f",
    "name": "Wireless Mouse",
    "description": "A wireless mouse with ergonomic design.",
    "price": "25.99",
    "category": "Electronics",
    "image": "https://picsum.photos/400/300"
  },
  ...
]

3.Generate a single Order:

You can generate a single user by calling the generateUser function:

import { generateOrder, generateMockData } from 'plain-mock-data';

const Order = generateMockData(generateOrder, 1);
  console.log(Order)

    Output Example:
    [
  {
    "id": "3db9434a-40b4-466d-9c82-ecfcf8efdc9f",
    "name": "Wireless Mouse",
    "description": "A wireless mouse with ergonomic design.",
    "price": "25.99",
    "category": "Electronics",
    "image": "https://picsum.photos/400/300"
  },
  ...
]

API Functions

generateUser()

Generates a random user object with the following properties:

• id (string)
• name (string)
• email (string)
• address (string)
• profilePicture (string)

generateProduct()

Generates a random product object with the following properties:

• id (string)
• name (string)
• description (string)
• price (string)
• category (string)
• image (string)

generateComment()

Generates a random Post object with the following properties:

• id: string;
• postId: string;
• userId: string;
• content: string;
• createdAt: Date;

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT