Function describeImmediateProp

packages/core/src/SpringValue.test.ts:461–548

()

}

function describeImmediateProp() {
  describe('when "immediate" prop is true', () => {
    it('still resolves the "start" promise', async () => {
      const spring = new SpringValue(0)
      const promise = spring.start(1, { immediate: true })
      await global.advanceUntilIdle()
      const result = await promise
      expect(result.finished).toBe(true)
      expect(result.value).toBe(1)
    })

    it('calls the "onStart" prop with finished: true', async () => {
      const onStart = vi.fn()
      const spring = new SpringValue(0)
      spring.start(1, { immediate: true, onStart })
      await global.advanceUntilIdle()
      expect(onStart).toBeCalledTimes(1)
      expect(onStart.mock.calls[0][0]).toMatchObject({
        finished: true,
        cancelled: false,
      })
    })

    it('calls the "onRest" prop with finished: true', async () => {
      const onRest = vi.fn()
      const spring = new SpringValue(0)
      spring.start(1, { immediate: true, onRest })
      await global.advanceUntilIdle()
      expect(onRest).toBeCalledTimes(1)
      expect(onRest.mock.calls[0][0]).toMatchObject({
        finished: true,
        value: 1,
      })
    })

    it('stops animating', async () => {
      const spring = new SpringValue(0)
      spring.start(2)
      await global.advanceUntilValue(spring, 1)

      // Use "immediate" to emulate the "stop" method. (see #884)
      const value = spring.get()
      spring.start(value, { immediate: true })

      // The "immediate" prop waits until the next frame before going idle.
      global.mockRaf.step()

      expect(spring.idle).toBeTruthy()
      expect(spring.get()).toBe(value)
    })
  })

  describe('when "immediate: true" is followed by "immediate: false" in same frame', () => {
    it('applies the immediate goal synchronously', () => {
      const spring = new SpringValue(0)

      // The immediate update is applied in the next frame.
      spring.start({ to: 1, immediate: true })