Fix module export in type definitions

[amitbeck]

TL;DR: From microsoft/TypeScript#7185 (comment):

export = and import x = require('./x') corresponds to CommonJS/AMD/etc.'s notion of module.exports:

// ./a.js
module.exports = { a: 10, b: 20 };

// ./b.js
let a = require('./a');

Therefore the correct way to export the module in its type definitions would be using export =, and importing it should be done using import mockingoose = require('mockingoose').

---

The module is exported using module.exports =, and the current type definitions export the module using export default:

mockingoose/src/index.js

Line 382 in 8090c8f

module.exports = mockingoose;

mockingoose/types.d.ts

Line 62 in 8090c8f

export default mockingoose;

This prevents TS users using allowSyntheticDefaultImports: true from being able to import the package correctly:

import mockingoose from 'mockingoose';

mockingoose.resetAll();
//          ~~~~~~~~
//          Property 'resetAll' does not exist on type 'typeof import("path/to/node_modules/mockingoose/types")'. ts(2339)

The following does pass TypeScript's compiler but fails at runtime:

import mockingoose from 'mockingoose';

mockingoose.default.resetAll();
//          ^^^^^^^
//          TypeError: mockingoose_1.default.default is not a function

Even after the proposed change, a regular import won't work at runtime:

import mockingoose from 'mockingoose';
//     ^^^^^^^^^^^
//     TypeError: (0 , mockingoose_1.default) is not a function

mockingoose.resetAll();

Finally, the following does work after the proposed change, as expected as it is a CommonJS module:

// Works 🎉
import mockingoose = require('mockingoose');

mockingoose.resetAll();

Until the issue is fixed, as in the proposed change, TS users using allowSyntheticDefaultImports: true are forced to use const mockingoose = require('mockingoose') which loses all typings.

[amitbeck]

@alonronin Seems that the tests need to be updated regardless, as there's a breaking change from Mongoose

[alonronin]

@alonronin Seems that the tests need to be updated regardless, as there's a breaking change from Mongoose

yep. i need to upgrade to support new mongoose. i'm planning on rewrite in typescript.

[amitbeck]

@alonronin Are you planning on publishing a new version including this fix to NPM?