@wavevision/timer
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

Wavevision s.r.o.

Timer

Build Status Coverage Status npm

Simple utility for creating resumable timeouts written in TypeScript. Works both in Node and browser environments.

Installation

Via Yarn

yarn add @wavevision/timer

or npm

npm install --save @wavevision/timer

Usage

Create your own timer.

import timer from '@wavevision/timer';

timer(() => alert('Time is up!'), 1000);
// this timer will be auto-started
timer(() => alert('Hello!'), 500, true);

The returned object exposes following functions:

  • clear(): void – clears the timeout
  • pause(): number – pauses the timeout, returns remaining time
  • remains(): number – returns remaining time
  • restart(): void – clears and starts the timeout over again
  • resume(): void – resumes the timeout (or starts if not running)
  • running(): boolean – returns whether the timeout is running at the moment
  • start(): void – starts the timeout (or resumes if paused)

Package Sidebar

Install

npm i @wavevision/timer

Weekly Downloads

0

Version

1.0.1

License

MIT

Unpacked Size

7.9 kB

Total Files

8

Last publish

Collaborators

  • vitrozsival