npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

dynamic-json-generator

v1.1.0

Published

A tool to generate dynamic fake JSON data for testing purposes.

Downloads

8

Readme

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.

Templates

You can create nested templates to generate complex JSON structures. The following Faker data types are supported:

Common Types (Both English and Burmese)

  • uuid
  • title
  • image
  • description
  • body
  • message
  • fullName
  • street
  • city

Other Types directly from @faker-js/faker (English only)

  • person.jobTitle
  • date.past
  • lorem.sentence
  • image.url
  • image.avatar
  • other types from @faker-js/faker

You can create other types as needed.

Localization

The package supports two locales:

  • 'en': English (default)
  • 'mm': Burmese

To generate data in Burmese, pass 'mm' as the locale parameter to generateJson or generateMultipleJson.

License

This project is licensed under the ISC License.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any bugs or improvements.

Demo App

Demo App

Author