class-faker
TypeScript icon, indicating that this package has built-in type declarations

1.0.8 • Public • Published

class-faker

Little helper package designed to improve testing when using DTOs. Instead of writing functions to create fake objects to test with class-faker gives you ability to define how faked object should look like directly in class.

Usage

Basic usage

import {Fake, generateFakeData} from 'class-faker';

class User {
  @Fake(() => 'a9f17dd1-810d-494e-b60a-aae625650401')
  id: string;

  @Fake(() => 'username')
  username: string;
}
const user = generateFakeData(User);
console.log(user); // { id: 'a9f17dd1-810d-494e-b60a-aae625650401', username: 'username' }

Usage with options

import {Fake, generateFakeData} from 'class-faker';

class User {
  @Fake(() => 'a9f17dd1-810d-494e-b60a-aae625650401')
  id: string;

  @Fake(() => 'username')
  username: string;
}
const user = generateFakeData(User, {exclude: ['username']});
console.log(user); // { id: 'a9f17dd1-810d-494e-b60a-aae625650401' }

Options

Name Type Description Default
exclude string[] Names of properties that should not be faked []

Readme

Keywords

none

Package Sidebar

Install

npm i class-faker

Weekly Downloads

17

Version

1.0.8

License

ISC

Unpacked Size

4.23 kB

Total Files

4

Last publish

Collaborators

  • ruciu