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

@unleashit/mock-data

v1.0.7

Published

Wrapper for mocker-data-generator providing a set of templates and arguments. Can optionally write to a file (node)

Downloads

122

Readme

Mock Data

NPM npm (scoped) npm bundle size

Wrapper for mocker-data-generator providing a set of templates with arguments. Can also optionally write to a file. This is mainly meant for the server, but if you have a good enough reason (please take note of the package size), everything works on the client except file writing.

So far the templates currently available are user, article, order and product. More will be added over time.

Install

npm install @unleashit/mock-data

Single schema

For a single schema, call the library with a config object. Possible properties are template, templates, total, args, name, hiddenFields and path.

If path is provided and the envirnment is Node, a JSON file will be written.

import mockData from "@unleashit/mock-data";

async function generateMockData() {
  // returns a promise
  return await mockData({
    template: "product",
    total: 20,
    args: {
      minPrice: 500,
      maxPrice: 10000,
      maxDescription: 10
    },
    hiddenFields: ["createdAt"]
  });
}

generateMockData();

// { product: [ ... ] }

With multiple schemas

For multiple schemas, add as an array on the templates property. Each template can have any of the same fields (except path and templates) as a single template.

const data = await mockData({
  templates: [
    {
      template: "user",
      total: 10,
      name: "authors"
    },
    {
      template: "article",
      total: 20,
      name: "blogs"
    }
  ],
  name: "mockData",
  path: "/home/myUser"
});

// data is returned and saved as /home/myUser/mockData.json
//
// {
//   authors: [...]
//   blogs: [...]
// }

Custom template(s)

Templates are in the same format as mocker-data-generator except must be supplied as a function. Supply any arguments to the args property as an object.

const args = {
  min: 18,
  max: 110,
  setProperty: "anything"
};

const template = () => ({
  id: {
    chance: "guid"
  },
  age: {
    faker: `random.number({"min": ${args.min}, "max": ${args.max}})`
  },
  setProperty: {
    static: `${args.setProperty}`
  }
});

const data = await mockData({
  template: template,
  total: 20,
  args,
  name: "myData"
});

// { myData: [...] }