spy on function jest code example

Example 1: jest spyon

// jest.spyOn(object, methodName)
const spy = jest.spyOn(video, 'play');

// jest.spyOn(object, methodName, accessType?)
const spy = jest.spyOn(video, 'play', 'get'); // we pass 'get'

Example 2: jest mock restore

// equvalent to mockReset

test("mockFn.mockRestore", () => {
  const StringUtils = {
    toUpperCase(arg) {
      return arg && arg.toUpperCase();
    }
  };

  const spy = jest.spyOn(StringUtils, "toUpperCase").mockImplementation(() => "MOCK");

  expect(StringUtils.toUpperCase("arg")).toBe("MOCK");
  expect(spy).toHaveBeenCalledTimes(1);
  expect(jest.isMockFunction(StringUtils.toUpperCase)).toBeTruthy();

  spy.mockRestore();

  expect(spy("arg")).toBeUndefined();
  expect(jest.isMockFunction(StringUtils.toUpperCase)).not.toBeTruthy();
  expect(StringUtils.toUpperCase("arg")).toBe("ARG");
  expect(spy).toHaveBeenCalledTimes(1);
 
});

Example 3: jest spy on class method

//class.js
class MyClass {
  methodOne() {
    return 1;
  }
  methodTwo() {
    return 2;
  }
}
module.exports = MyClass;

// class.test.js
test('spy using class method', () => {
  const result = new MyClass()
  const spy = jest.spyOn(result, 'methodOne')
  result.methodOne()

  // check class method is call or not
  expect(spy).toHaveBeenCalled()

  // expect old value
  expect(result.methodOne()).toBe(1)

  // expect new value
  spy.mockReturnValueOnce(12)
  expect(result.methodOne()).toBe(12)
})