Type alias Timers

Type declaration

• clearInterval:function

  • clearInterval(timerId: number): void

  • Cancels an interval previously established by setInterval.

    Example

    const intervalId = timers.setInterval(() => {
      console.log('This will stop')
    }, 1000)
    
    timers.clearInterval(intervalId)
    

    Parameters

    • timerId: number

      The TimerId returned by setInterval

    Returns void

• clearTimeout:function

  • clearTimeout(timerId: number): void

  • Cancels a timeout previously established by setTimeout.

    Example

    const timeoutId = timers.setTimeout(() => {
      console.log('This will not run')
    }, 1000)
    
    timers.clearTimeout(timeoutId)
    

    Parameters

    • timerId: number

      The TimerId returned by setTimeout

    Returns void

• setInterval:function

  • setInterval(callback: TimerCallback, ms: number): number

  • Repeatedly executes a function at specified intervals.

    Returns

    A TimerId that can be used to cancel the interval

    Example

    const intervalId = timers.setInterval(() => {
      console.log('Printing this every 1 second')
    }, 1000)
    

    Parameters

    • callback: TimerCallback

      The function to execute at each interval

    • ms: number

      The interval in milliseconds

    Returns number

• setTimeout:function

  • setTimeout(callback: TimerCallback, ms: number): number

  • Delays the execution of a function by a given amount of milliseconds.

    Returns

    A TimerId that can be used to cancel the timeout

    Example

    const timeoutId = timers.setTimeout(() => {
      console.log('1 second passed')
    }, 1000)
    

    Parameters

    • callback: TimerCallback

      The function to execute after the delay

    • ms: number

      The delay in milliseconds

    Returns number