ixfx
    Preparing search index...

    Type Alias IteratorController

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

    Accessors

    state

    Properties

    cancel pause restart start

    Accessors

    Properties

    cancel: () => void

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

    Type declaration

      • (): void

      • Returns void

    pause: () => void

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

    Type declaration

      • (): void

      • Returns void

    restart: () => void

    Starts or restarts 'playback' of the iterator.

    Type declaration

      • (): 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.

    Type declaration

      • (): void

      • Returns void

    Settings

    Member Visibility

    On This Page

    Accessors
    Properties