class-mock

A mock library that lets you use decorators with classes to generate fake data.

English | 简体中文

Introduction

A mock library that lets you use decorators with classes to generate fake data. Based on @faker-js/faker。

class-mock decorators essentially just stores metadata (configuration data) and does not modify the class.

Finally, when createMock(MockClass) is executed, all metadata (configuration data) of MockClass will be taken out, and then data generation will be performed with @faker-js/faker.

Supports any ts project or @babel/plugin-proposal-decorators (legacy is true) js project.

Installation

for npm

npm i class-mock @faker-js/faker

for yarn

yarn add class-mock @faker-js/faker

for pnpm

pnpm add class-mock @faker-js/faker

Usage

The usage is documented in the documentation.

Notice

ts project needs to be configured in tsconfig.json:

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

Acknowledgement

• class-transformer
• class-validator
• typeorm

Contributing

Learn about contribution here.

This project exists thanks to all the people who contribute:

License

MIT License © 2022-PRESENT yangjinming