Missing information in documentation about shouldAdvanceTime

• FakeTimers version : 6.0.1

I am using fake-timers for some time now and I wanted to utilize the shouldAdvanceTime option. But I did not get it to work from the start.

This was my install code;

const installFakeClock = (): void => {
  (window as any).fakeClock = install({
    now: new Date(),
    toFake: ['setTimeout', 'clearTimeout'],
    shouldAdvanceTime: true,
  });
};

According to the documentation, this should work. Set shouldAdvanceTime to true and it will use the default time delta of 20ms. However, it would not work. The fake timer was not advancing automatically.

I had to look through the source to see that it actually also expects setInterval and clearInterval to be faked too.

I’m not sure why the advanceTime needs set and clearInterval to be faked too, but it was not expected. If it is needed, could you change the documentation to reflect that the setInterval and clearInterval are needed for this option to work?

[stefanschenk]

@fatso83 Thanks for looking into it and creating a PR in such short time.

[fatso83]

Did not hear back, but this should make the actual implementation be in line with the docs, so no doc update needed 😄