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

1.0.2 • Public • Published

Sapphire Logo

@sapphire/timer-manager

Timer manager utilities for JavaScript.

GitHub codecov npm bundle size npm

Table of Contents

Features

  • Written in TypeScript
  • Bundled with esbuild so it can be used in NodeJS and browsers
  • Offers CommonJS, ESM and UMD bundles
  • Fully tested

Installation

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @sapphire/timer-manager

Usage

Note: While this section uses require, the imports match 1:1 with ESM imports. For example const { TimerManager } = require('@sapphire/timer-manager') equals import { TimerManager } from '@sapphire/timer-manager'.

Basic Usage

// Import the TimerManager class
const { TimerManager } = require('@sapphire/timer-manager');

// Use the class for timeouts
const timeout = TimerManager.setTimeout(() => console.log('Hello, world!'), 1000);
TimerManager.clearTimeout(timeout);

// Use the class for intervals
const interval = TimerManager.setInterval(() => console.log('Hello, world!'), 1000);
TimerManager.clearInterval(interval);

// Destroy all running timeouts and intervals so that NodeJS can gracefully exit
TimerManager.destroy();

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, PayPal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate With Address
Open Collective Click Here
Ko-fi Click Here
Patreon Click Here
PayPal Click Here

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Sapphire!

Package Sidebar

Install

npm i @sapphire/timer-manager

Weekly Downloads

2,002

Version

1.0.2

License

MIT

Unpacked Size

29.5 kB

Total Files

11

Last publish

Collaborators

  • favna
  • vladfrangu
  • kyranet