Skip to content

Latest commit

 

History

History
107 lines (57 loc) · 1.77 KB

Timeout.md

File metadata and controls

107 lines (57 loc) · 1.77 KB

Utilities / Timeout

Class: Timeout

Call a function after a certain time has passed. Uses the window.setTimeout().

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Timeout()

Defined in

timeout/timeout.ts:8

Properties

id

Private id: number

Defined in

timeout/timeout.ts:6


is_active

Private is_active: boolean

Defined in

timeout/timeout.ts:5

Methods

clear

clear(): void

Cancels the timeout.

Returns

void

Defined in

timeout/timeout.ts:32


isActive

isActive(): boolean

Returns whether the timeout is active or not.

Returns

boolean

Defined in

timeout/timeout.ts:40


start

start(functionToCall, interval): void

Starts the timeout. If there was an active timeout already, that one is canceled.

Parameters

Name Type
functionToCall () => void
interval number

Returns

void

Defined in

timeout/timeout.ts:16