Mocking data from MongoDB to satisfy TypeScript in Jest

Question

I am creating a TypeScript interface for each model that extends mongoose.Document.

import mongoose, { Document } from 'mongoose';

export interface IAccount extends Document {
  _id: mongoose.Types.ObjectId;
  name: string;
  industry: string;
}

The schema is then exported with the interface:

export default mongoose.model<IAccount>('Account', accountSchema);

The problem is that in Jest, creating an object with the properties required for the function being testing isn't enough, TypeScript complains about all the missing fields.

function getData(account: IAccount){
  return account;
}

const account = {
  name: 'Test account name',
  industry: 'test account industry'
}

getData(account);

Argument of type '{ name: string; industry: string; }' is not assignable to parameter of type 'IAccount'. Type '{ name: string; industry: string; }' is missing the following properties from type 'IAccount': _id, increment, model, and 52 more.ts(2345)

What is the simplest way to create an object that satisfies TypeScript for testing purposes?

Brian Adams Brian Adams · Accepted Answer · 2019-06-07T22:02:38

One option is to create a mock that matches the expected type...

...but that can be very difficult for highly complex types.

The other option is to tell TypeScript you want your mock to pass through compile-time type checking.

You can do that by assigning your mock the type any:

function getData(account: IAccount){
  return account;
}

const account: any = {  // <= use type "any"
  name: 'Test account name',
  industry: 'test account industry'
}

getData(account);  // <= no error

Mocking data from MongoDB to satisfy TypeScript in Jest

1 Answers