libp2p
    Preparing search index...

    Interface RepeatingTask

    interface RepeatingTask {
        run(): void;
        setInterval(ms: number): void;
        setTimeout(ms: number): void;
        start(): void;
        stop(): void;
    }
    Index

    Methods

    run setInterval setTimeout start stop

    Methods

    • Schedule the task to be run immediately - if the task is not running it will run after a short delay in order to debounce multiple .run() invocations.

      Returns void

    • Update the interval after which the next iteration of the task will run.

      This is useful if, for example, you want to retry a task with a short rest duration until it succeeds, then periodically after that.

      This only affects the next iteration of the task, if it is currently running, that run will not be interrupted.

      Setting the interval to the current value has no effect.

      Parameters

      • ms: number

      Returns void

    • Update the amount of time a task will run before the passed abort signal will fire.

      This only affects the next iteration of the task, if it is currently running, that run will not be interrupted.

      Parameters

      • ms: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods