Dynamic-json-generator NPM

dynamic-json-generator

dynamic-json-generator is an npm package that allows front-end developers to easily generate dynamic, fake JSON data for testing purposes. The package uses @faker-js/faker to provide realistic data for a variety of common use cases.

Installation

Install the package via npm:

npm install dynamic-json-generator

Usage

Import the package in your project and use the generateJson and generateMultipleJson functions to create fake JSON data based on a given template.

Example

// Import CommonJS (require)
const { generateJson, generateMultipleJson } = require('dynamic-json-generator');

// Import ES Modules (import)
import { generateJson, generateMultipleJson } from 'dynamic-json-generator';

// Define a template
const userTemplate = {
    id: 'uuid',
    name: 'fullName',
    address: {
        street: 'street',
        city: 'city',
    },
};

const postTemplate = {
    id: 'uuid',
    title: 'title',
    body: 'body',
    userId: 'uuid',
    image: 'image',
};

// Generate a single JSON object (English locale)
const singleJsonEn = generateJson(userTemplate);
console.log(singleJsonEn);

// Generate multiple JSON objects (English locale)
const multipleJsonEn = generateMultipleJson(userTemplate, 20);
console.log(multipleJsonEn);

// Generate a single JSON object (Burmese locale)
const singleJsonMm = generateJson(userTemplate, 'mm');
console.log(singleJsonMm);

// Generate multiple JSON objects (Burmese locale)
const multipleJsonMm = generateMultipleJson(userTemplate, 20, 'mm');
console.log(multipleJsonMm);

Functions

generateJson(template, locale)

Generates a single JSON object based on the provided template.

template: An object where keys are field names and values are Faker data types (e.g., 'uuid', 'name', 'email').
locale (optional): The locale to use for generating data. Can be 'en' for English (default) or 'mm' for Burmese.
Returns an object with generated fake data.

generateMultipleJson(template, count, locale)

Generates multiple JSON objects based on the provided template.

template: An object where keys are field names and values are Faker data types (e.g., 'uuid', 'name', 'email').
count: The number of JSON objects to generate.
locale (optional): The locale to use for generating data. Can be 'en' for English (default) or 'mm' for Burmese.
Returns an array of objects with generated fake data.