[Feature]: Please expose runToFrame() from sinon/fake_timers in @jest/fake-timers

[alexreardon]

🚀 Feature Proposal

Hi legends,

Could you please expose clock.runToFrame() from sinon/fake-timers in @jest/fake-timers? (@jest/fake-timers is mostly a re-export of sinon/fake-timers)

clock.runToFrame()
Advances the clock to the next frame, firing all scheduled animation frame callbacks, if any, for that frame as well as any other timers scheduled along the way.

Right now I am doing this workaround:

jest.advanceTimersByTime(16);

But this seems suboptimal as there is a bit of logic controlling how long the frame duration should be.

Motivation

I am looking to explicitly have a scheduled animation frame run in a test.

Example

// release the next animation frame
jest.runToFrame();

Pitch

It would be helpful to be able to use the runToFrame() to have more explicit control over animation frames

[SimenB]

Yeah, happy to 🙂 Wanna send a PR?

[alexreardon]

Yep, can do

[SimenB]

Awesome 👍 The work is mostly adding to types (incl. type tests) and docs I think, not necessarily the code change itself 😅

It should also throw when using legacy timers

[alexreardon]

Pull request raised @SimenB

#14598

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.