Document better how to restore synthetic clock

[bahmutov]

Really hard to find https://docs.cypress.io/api/commands/tick.html#Yields

• clock page
• stubs and clocks page

it('restores', () => {
  cy.clock(+ new Date())
  cy.visit('http://localhost:3000/sudoku')
  // make sure the application has rendered
  // and the synthetic clock started working
  cy.get('.game__cell--filled').should('have.length', 45)

  cy.tick(600 * 1000) // 10 minutes
  cy.contains('.status__time', '10:00')

  // resume the clock
  cy.tick().then(clock => {
    clock.restore()
  })
  // the clock is restored to original value
  // thus the timer will start measuring again
  // from the original date passed to "cy.clock"
  cy.contains('.status__time', '00:03')
})

People cannot find it: https://twitter.com/huchenme/status/1275225026531225600

Related cypress-io/cypress-example-kitchensink#429

[huchenme]

Thanks for this. Can I suggest to have a cy.restoreClock() or cy.clockRestore() with implementation of below?

cy.tick().then(clock => {
   clock.restore();
})

[bahmutov]

Shorthand

cy.tick().invoke('restore')

But still a dedicated command would be superior

[huchenme]

For some reason the trick does not work for me, I have to call .invoke('restore') on last tick() to make it work: huchenme/hacker-tab-extension@13bef19