mock-typeorm/README.md

Never hit the database again while testing

# Mock TypeORM [![Test Status](https://github.com/jazimabbas/mock-typeorm/actions/workflows/nodejs.yml/badge.svg?branch=master)](https://github.com/jazimabbas/mock-typeorm/actions/workflows/nodejs.yml)

> Never hit the database again while testing.

A package for mocking TypeORM that can be utilized with any node.js testing library e.g. Jest, Mocha, Vitest etc..

## Installation

To install this package, use the following command:

```bash
npm install --save-dev mock-typeorm sinon @types/sinon
```

Note that Sinon is added as a peer dependency, so you need to install it as well.

## Documentation

You can find the MockTypeORM documentation [on the website](https://mock-typeorm-docs.vercel.app).

## Development

To install the dependencies, run the following command:

```bash
pnpm install
```

To run the linting, run the following command:

```bash
pnpm run lint
```

To run the tests, run the following command:

```bash
pnpm run test
```