Interval

Repeatedly calls a function or executes a code snippet, with a time delay between each call, with controls to pause & resume the interval.

Interval class

class Interval<TArgs extends any[] = []> implements IInterval

Represents a repeated calls of a function with a time delay between each call.

Type Parameters

• TArgs extends any[] = [] Type of arguments to pass to the callback function.

Constructors

constructor(callback: Action, delay?: number | undefined)

Creates a new Interval.

Parameters

• callback: Action The function to be called when the interval elapses.
• delay?: number | undefined The delay between each call in milliseconds.

---

constructor(callback: Action, options?: IntervalOptions | undefined)

Creates a new Interval.

Parameters

• callback: Action The function to be called when the interval elapses.
• options?: IntervalOptions | undefined The options for the interval.

---

constructor(callback: Action<TArgs>, options?: number | IntervalOptions | undefined, ...args: TArgs)

Creates a new Interval.

Parameters

• callback: Action<TArgs> The function to be called when the interval elapses.
• options?: number | IntervalOptions | undefined The options for the interval.
• ...args: TArgs Arguments to pass to the callback function.

Properties

Name	Type	Description
isActive	boolean	get Whether the interval is currently active.
delay	number | undefined	get Delay in milliseconds.

pause method

pause(): void

Pauses the interval.

resume method

resume(): void

Resumes the interval.

IInterval interface

interface IInterval

Interface that represent a repeated calls of a function.

Properties

Name	Type	Description
delay	number | undefined	readonly optional Delay in milliseconds.
isActive	boolean	readonly Whether the interval is currently active.

pause method

pause(): void

Pauses the interval.

resume method

resume(): void

Resumes the interval.

IntervalOptions interface

interface IntervalOptions

Options for the Interval class.

Properties

Name	Type	Description
delay	number | undefined	optional Delay in milliseconds.
immediate	boolean | undefined	optional Whether to start the interval immediately.