Skip to content

Latest commit

 

History

History
148 lines (119 loc) · 18.3 KB

README.md

File metadata and controls

148 lines (119 loc) · 18.3 KB

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 ✨

Thanks goes to these wonderful people (emoji key):


Jeroen Claassens

💻 🚇 📆 📖 ⚠️

Aura Román

💻 📆 👀 ⚠️

Gryffon Bellish

💻 👀 ⚠️

Vlad Frangu

💻 🐛 👀 📓 ⚠️

Stitch07

💻 📆 ⚠️

depfu[bot]

🚧

allcontributors[bot]

📖

Tyler J Russell

📖

Ivan Lieder

💻 🐛

Hezekiah Hendry

💻 🔧

Vetlix

💻

Ethan Mitchell

📖

Elliot

💻

Jurien Hamaker

💻

Charalampos Fanoulis

📖

dependabot[bot]

🚧

Kaname

💻

nandhagk

🐛

megatank58

💻

UndiedGamer

💻

Lioness100

📖 💻

David

💻

renovate[bot]

🚧

WhiteSource Renovate

🚧

FC

💻

Jérémy de Saint Denis

💻

MrCube

💻

bitomic

💻

c43721

💻

Commandtechno

💻

Aura

💻

Jonathan

💻

Parbez

🚧

Paul Andrew

📖

Mzato

💻 🐛

Harry Allen

📖

Evo

💻

Enes Genç

💻

muchnameless

💻

Priyam

💻

Voxelli

💻

Cit The Dev

💻

Goestav

💻

DD

💻

This project follows the all-contributors specification. Contributions of any kind welcome!