Type Alias IteratorController

IteratorController: {
    cancel: (() => void);
    pause: (() => void);
    restart: (() => void);
    start: (() => void);
    get state(): IteratorControllerState;
}

Type declaration

  • cancel: (() => void)

    Cancels the running timer. This will stop playback, and next time start is called, it will be from the beginning.

      • (): void

      • Returns void

  • pause: (() => void)

    Pauses 'playback' of the iterator. If already paused, does nothing. Use start to resume.

      • (): void

      • Returns void

  • restart: (() => void)

    Starts or restarts 'playback' of the iterator.

      • (): void

      • Returns void

  • start: (() => void)

    Starts 'playback' of the iterator. If already started, this does nothing. If paused, continues playback. Use restart if you want to start with a reset.

      • (): void

      • Returns void

  • get state(): IteratorControllerState

Settings

Member Visibility