Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dex4er/js-timers-obj
Timers as objects
https://github.com/dex4er/js-timers-obj
hacktoberfest
Last synced: about 2 months ago
JSON representation
Timers as objects
- Host: GitHub
- URL: https://github.com/dex4er/js-timers-obj
- Owner: dex4er
- License: mit
- Created: 2016-07-31T10:41:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T20:50:40.000Z (9 months ago)
- Last Synced: 2024-04-16T03:47:42.496Z (8 months ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/timers-obj
- Size: 61.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# timers-obj
[](https://github.com/dex4er/js-timers-obj)
[](https://github.com/dex4er/js-timers-obj/actions/workflows/ci.yaml)
[](https://github.com/dex4er/js-timers-obj/actions/workflows/trunk.yaml)
[](https://coveralls.io/github/dex4er/js-timers-obj)
[](https://www.npmjs.com/package/timers-obj)
This module provides the wrappers for the standard
[timers](https://nodejs.org/api/timers.html) module so all timers (immediate,
interval and timeout) can be used as objects.
The classes are separate for each timer to prevent mistakes, ie. closing the
wrong timer.
For constructors, the callback argument is after `delay` argument so it
provides a more convenient syntax for
[CoffeeScript](http://coffeescript.org/) and
[LiveScript](http://livescript.net/), ie.:
```coffee
timers = await import('timers-obj')
timer = timers.interval 1000, ->
console.log 'Time is ticking'
```
## Requirements
This is an ESM module that requires ES2021 and Node >= 16.
## Installation
```shell
npm install timers-obj
```
_Additionally for Typescript:_
```shell
npm install -D @types/node
```
## Usage
```js
import * as timers from "timers-obj"
```
or:
```js
import {Immediate, immediate, Interval, interval, Timeout, timeout} from "timers-obj"
```
### immediate
Creates timer with immediate callback.
```js
const timer = timers.immediate(cb, [...args])
```
### interval
Creates timer with callback run in intervals.
```js
const timer = timers.interval(delay, cb, [...args])
```
### timeout
Creates timer with callback run after timeout.
```js
const timer = timers.timeout(delay, cb, [...args])
```
### close
Closes timer.
```js
timer = timer.close()
```
The method returns this object.
### hasRef
Returns `true` if the object will keep the Node.js event loop active.
```js
const hasRef = timer.hasRef()
```
### ref
Requests that the Node.js event loop does not exit so long as the Timeout is
active.
```js
timer = timer.ref()
```
The method returns this object.
### unref
Requests that the Node.js event loop exits even if the Timeout is active.
```js
timer = timer.unref()
```
The method returns this object.
### refresh
Sets the timer's start time to the current time. Only for interval and
timeout timers.
```js
timer = timer.refresh()
```
The method returns this object.
### [Symbol.dispose]
Clears the timer at the end of a scope.
```ts
using timer = timers.immediate(cb, [...args])
using timer = timers.interval(delay, cb, [...args])
using timer = timers.timeout(delay, cb, [...args])
```
## License
Copyright (c) 2016-2024 Piotr Roszatycki
[MIT](https://opensource.org/licenses/MIT)