Function createTimeout

Creates a non-running (paused) timer which will execute a function or specified piece of code when enabled and the timer expires, this is simular to using scheduleTimeout but the timer is not enabled (running) and you MUST call refresh to start the timer.

The timer may be cancelled (cleared) by calling the cancel() function on the returned ITimerHandler, or you can "reschedule" and/or "restart" the timer by calling the refresh() function on the returned ITimerHandler instance

Since

0.7.0

Param: callback

The function to be executed after the timer expires.

Param: timeout

The time, in milliseconds that the timer should wait before the specified function or code is executed. If this parameter is omitted, a value of 0 is used, meaning execute "immediately", or more accurately, the next event cycle.

Param: args

Additional arguments which are passed through to the function specified by callback.

Returns

A ITimerHandler instance which can be used to cancel the timeout.

Example

let timeoutCalled = false;
let theTimeout = createTimeout(() => {
    // This callback will be called after 100ms as this uses setTimeout()
    timeoutCalled = true;
}, 100);

// As the timer is not started you will need to call "refresh" to start the timer
theTimeout.refresh();

// or set enabled to true
theTimeout.enabled = true;
  • createTimeout<A>(callback, timeout, ...args): ITimerHandler

  • Creates a non-running (paused) timer which will execute a function or specified piece of code when enabled and the timer expires, this is simular to using scheduleTimeout but the timer is not enabled (running) and you MUST call refresh to start the timer.

    The timer may be cancelled (cleared) by calling the cancel() function on the returned ITimerHandler, or you can "reschedule" and/or "restart" the timer by calling the refresh() function on the returned ITimerHandler instance

    Type Parameters

    • A extends any[]

    Parameters

    • callback: ((...args: A) => void)

      The function to be executed after the timer expires.

        • (...args): void

        • Parameters

          • Rest...args: A

          Returns void

    • timeout: number

      The time, in milliseconds that the timer should wait before the specified function or code is executed. If this parameter is omitted, a value of 0 is used, meaning execute "immediately", or more accurately, the next event cycle.

    • Rest...args: A

      Additional arguments which are passed through to the function specified by callback.

    Returns ITimerHandler

    A ITimerHandler instance which can be used to cancel the timeout.

    Since

    0.7.0

    Example

    let timeoutCalled = false;
    let theTimeout = createTimeout(() => {
        // This callback will be called after 100ms as this uses setTimeout()
        timeoutCalled = true;
    }, 100);

    // As the timer is not started you will need to call "refresh" to start the timer
    theTimeout.refresh();

    // or set enabled to true
    theTimeout.enabled = true;

Settings

Member Visibility