Home

Awesome

Data From Types

This thing generates data from TypeScript types

Install

npm install --save-dev data-from-types

Usage

you have the file:

// test-file.ts

export interface Person {
  firstName: string;
  lastName: string;
  age: number;
}

you want to generate data based on the interfaces

// my.spec.ts

import * as DataFromTypes from "data-from-types";

const generatedData = DataFromTypes.getData("./test-file.ts");

// generatedData is now { Person: {firstName: 'igor', lastName: 'romanov', age: 12}}
expect(generatedData).toHaveProperty("Person");
expect(generatedData.Person).toHavePropertyOfType("firstName", "string");
expect(generatedData.Person).toHavePropertyOfType("lastName", "string");
expect(generatedData.Person).toHavePropertyOfType("age", "number");

Reference

getData(filePath)

Generates fake data for all exported interfaces, based on the types.

getFileSchema(filePath)

Generates an object which describes the schema of the exported interfaces.