timers-obj

timers-obj

This module provides the wrappers for standard timers module so all timers (immediate, interval and timeout) can be used as objects.

For constructors, callback argument is after delay argument so it provides more convenient syntax for CoffeeScript and LiveScript, ie.:

timers = await import('timers-obj')

timer = timers.interval 1000, ->
  console.log 'Time is ticking'

Requirements

This is ESM module which requires ES2020 and Node >= 14.

Installation

npm install timers-obj

Additionally for Typescript:

npm install -D @types/node

Usage

import * as timers from "timers-obj"

or:

import {Immediate, immediate, Interval, interval, Timeout, timeout} from "timers-obj"

immediate

Create timer

const timer = timers.immediate(cb, [...args])

Remove timer

timer.remove()

interval

Create timer

const timer = timers.interval(delay, cb, [...args])

Remove timer

timer.remove()

timeout

Create timer

const timer = timers.timeout(delay, cb, [...args])

Remove timer

timer.remove()

License

Copyright (c) 2016-2021 Piotr Roszatycki [e-mail]

MIT