Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

ts-mockery

1.2.0 • Public • Published

npm version Build Status Test Coverage Maintainability

ts-mockery

Simple type-safe mocking library for TypeScript.

StackBlitz Examples

Why use this?

  • Usable with either Jasmine or Jest.
  • The primary focus is type-safety.
  • Spies are setup for mocked functions.
  • Nested objects and arrays can be mocked with type-safety

How do I use this?

To create a Mock:

import { Mock } from 'ts-mockery';
 
interface ObjectToNest {
  anotherStringFunction: () => string;
  unusedFunction: () => void;
}
 
class ObjectToMock {
  nestedObject: ObjectToNest;
  string = ':-)';
  stringFunction = (buzz: string): string => buzz.toUpperCase();
}
 
Mock.of<ObjectToMock>({ string: 'not :-)' });
Mock.of<ObjectToMock>({ string: 'still not :-)', stringFunction: () => 'type-safe partial of return type' });
Mock.of<ObjectToMock>({ nestedObject: { anotherStringFunction: () => 'type-safe partial of return type' } });
 

To update a Mock:

import { Mock } from 'ts-mockery';
 
interface ObjectToNest {
  anotherStringFunction: () => string;
  unusedFunction: () => void;
}
 
class ObjectToMock {
  nestedObject: ObjectToNest;
  string = ':-)';
  stringFunction = (buzz: string): string => buzz.toUpperCase();
}
 
const mock = Mock.of<ObjectToMock>({ string: 'not :-)' });
Mock.extend(mock).with({ string: 'still not :-)', stringFunction: () => 'type-safe partial of return type' });
 

More usage examples can be found @ https://stackblitz.com/edit/ts-mockery-examples?file=tests.ts

To mock a static method:

import { Mock } from 'ts-mockery';
 
class ObjectToMock {
  static static: () => 'hi';
}
 
Mock.staticMethod(ObjectToMock, 'static', () => 'not hi');
 

Mock.from:

We noticed issues when we gave instantiated base class objects to Mock.of. The reason being that the type checker does not look at the prototype.

import { Mock } from 'ts-mockery';
Mock.of<SomeClass>(new BaseOfSomeClass());

now with Mock.from:

import { Mock } from 'ts-mockery';
Mock.from<SomeClass>(new BaseOfSomeClass());

Also when setting mocked property to an observable there is a circular reference that would throw an RangeError {}

import { Mock } from 'ts-mockery';
import { of } from 'rxjs';
Mock.of<SomeClass>({ something$: of(someValue) });

now with Mock.from:

import { Mock } from 'ts-mockery';
import { of } from 'rxjs';
Mock.from<SomeClass>({ something$: of(someValue) });

To mock a function you do not care about:

We got you covered, Mock.noop will return you a spied on function.

import { Mock } from 'ts-mockery';
 
class ObjectToMock {
  doNotCare: () => 'hi';
}
 
const mock = Mock.of<ObjectToMock>({ doNotCare: Mock.noop });
const result = mock.doNotCare();
 
expect(mock.doNotCare).toHaveBeenCalled();
expect(result).not.toBe('hi');

To mock an object you do not care about:

With Mock.all it will use a proxy to create spies as on demand.

import { Mock } from 'ts-mockery';
 
class ObjectToMock {
  doNotCare: () => 'hi';
}
 
const mock = Mock.all<ObjectToMock>();
const result = mock.doNotCare();
 
expect(mock.doNotCare).toHaveBeenCalled();
expect(result).not.toBe('hi');

How do I configure this?

Create a test setup file to be included in your Jest or Jasmine config.

import { Mock } from 'ts-mockery';
 
// The argument to configure can be either jest, jasmine, noop, or an object that implements the exported SpyAdapater interface
Mock.configure('jest');

The above can be added directly to your karma test shim if you'd like.

To configure in Jest add the mockery configuration into the jest config with the key "setupFiles" like so:

  setupFiles: ['./jest-setup.ts'],

It is important that this file is included before tests run.

Also Important:

Jest for whatever reason does not reset mocks between tests by default. This causes problems with the mocking of static methods. If you intend to use static method mocking you can add "restoreMocks: true" to your jest config and all will be right in the world.

Install

npm i ts-mockery

DownloadsWeekly Downloads

11,422

Version

1.2.0

License

MIT

Unpacked Size

76.5 kB

Total Files

28

Last publish

Collaborators

  • avatar