Claymen NPM | npm.io

Claymen

A Library for generating fake data for schemas

Configuration

Claymen looks for configurations in a /clay directory in your root project directory. Output will be placed into a /clayput directory in your project root.

The configuration instructs Claymen how to generate fake data for the specified fields.

tableName: The name of the generated csv
createThisMany: Amount of fake records to generate
fields: An array containing the configuration for each of the fields that compose the entity you want to created fake data for.
- name: The name of the field you want to created fake data for
- fakeDataType: choose a FieldTag that accurately defines that type of fake data you want to generate. Consult the list of FieldTags for choices.
- customGenerator: Instead of defining a fakeDataType you can define a custom generator that will be used to generate fake data.
- foreignDependency: If this field has a foreignDependency then you can specify the tableName and field name in this format: tableName.fieldName. When generating fake data, Claymen will use the data of foreignDependency to populate this field.
- isForeignDepedency: a boolean flag that signals that the field is foreignDependency.

Example Construction:

{
        tableName: String,
        fields: [
            {name: string, fakeDataType: FieldTags, isForeignDependency: boolean },
            ...
        ],
        createThisMany: number
    },

Practical Example:

import { FieldTags, createClaymen } from "claymen"

config = [{
        tableName: "People",
        fields: [
            {name: "id", fakeDataType: FieldTags.serialId, isForeignDependency: true },
            {name: "firstName", fakeDataType: FieldTags.firstName }
        ],
        createThisMany: 10
    },
    {
        tableName: "Cars",
        fields: [
            {name: "id", fakeDataType: FieldTags.serialId },
            {name: "make", customGenerator: () => "Honda" },
            {name: "owner", foreignDependency: "Peopel.id" },
        ],
        createThisMany: 10
    }]
    
    createClaymen();