@generatedata/core

generatedata - npm package

Installation

npm install generatedata

Usage

The npm package provides both a binary you can use on the command line, or within your own code.

Binary

generatedata --config=configfile.json

Configuration file

The configuration file contains the generation settings (number of rows, location of file, etc.), the JSON representation of the type of data you want, and the format (JSON, CSV etc.). Here's a simple example that generates 1000 rows of first and last names in JSON format.

{
  "generationSettings": {
    "numResults": 1000,
    "stripWhitespace": true,
    "locale": "en",
    "filename": "generated-data.json"
  },
  "dataTemplate": [
    {
      "plugin": "Names",
      "title": "First Name",
      "settings": {
        "options": [
          "Name"
        ]
      }
    },
    {
      "plugin": "Names",
      "title": "Last Name",
      "settings": {
        "options": [
          "Surname"
        ]
      }
    }
  ],
  "exportSettings": {
    "plugin": "JSON",
    "settings": {
      "dataStructureFormat": "simple"
    }
  }
}

This file can get very large and hard to manually configure! The simplest way to create the file is to use the main website. There, just use the interface to construct the data set and format you want, then click on the "Schema" icon. That will generate the configuration file which you can download and use locally.

But let's look at the options. They're grouped into three top-level properties.

1. generationSettings

This section contains all high-level settings about the data you're generating.

Setting	Type	Required	Default value	Description
numResults	number	x	-	The number of rows of data you want to generate.
stripWhitespace	boolean		false	Whether to remove all whitespace from the generated data. This can significantly reduce file/output size.
locale	GDLocale		en	Some of the plugins that generate the data ("Data Types") and formats ("Export Types") use language strings here and there. This settings controls what language is provided to them.
target	string		file	The default behaviour of the npm + binary package is to generate a file. However, if you want to just pipe it to STDOUT for the command line utility, or return the value from the generate npm package method, set this value to 'return'.
filename	string	(x)	file	Required if you enter "file" for the target option. This is the name of the file you want to generate. You can also include a relative file path. Note that it'll be relative to where-ever you're executing the code (binary/npm package).

2. dataTemplate

This property contains an array of whatever type of data you want to generate, like Names, phone numbers etc. The types of data are separate plugins, called Data Types. Each of them may have their own settings to control whatever sort of information they provide. We'll provide links to all the available Data Types below with an example of how to configure them. But top-level, all of these rows contain the same properties:

Setting	Type	Required	Default value	Description
plugin	DataType	x	-	The Data Type plugin name. This will correspond to the folder name (list below).
title	string	x	-	This is used as an identifier for the row and will differ, depending on the Export Type you're choosing (e.g. HTML, XML, SQL, JSON etc.). For example, for XML it is used as the XML node name; for SQL the database column name; for JSON, the property name. As such, you'll need to enter a value that's valid for that export type or it will fail the validation step when you attempt to generate the data.
id	number		-	Some Data Types allow you to reference other rows. e.g. the Region Data Type lets you reference a Country row, so it generates a region within the random Country being generated. This ID column is used to provide that mapping. But you don't need to enter it otherwise.
settings	object		-	This section contains whatever settings are needed/offered for this particular Data Type plugin you've chosen.

3. exportSettings

This contains the settings for the format of the data you want, like XML, SQL etc.

Local dev

yarn build

• This generates the build artifacts. There will be two main

Note: requires the main client/ application to have been built first.

• yarn dev - runs index.ts for testing purposes