@sapphire/stopwatch

@sapphire/stopwatch

Accurately measure passing time

Table of Contents

• Description
• Features
• Installation
• Usage
  • Basic Usage
• API Documentation
• Buy us some doughnuts
• Contributors ✨

Description

Provides a set of methods and properties that you can use to accurately measure elapsed time.

Features

• Written in TypeScript
• 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/stopwatch

Usage

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

Basic Usage

// Import the Stopwatch class
const { Stopwatch } = require('@sapphire/stopwatch');

// Create a new Stopwatch (which also starts it immediately)
const stopwatch = new Stopwatch();

// run other task here

console.log(stopwatch.stop().toString());
// 200ms

---

API Documentation

For the full API documentation please refer to the TypeDoc generated documentation.

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 💻 🚇 📆 📖 ⚠️	Antonio Román 💻 📆 👀 ⚠️	Gryffon Bellish 💻 👀 ⚠️	Vlad Frangu 💻 🐛 👀 📓 ⚠️	Stitch07 💻 📆 ⚠️	depfu[bot] 🚧	allcontributors[bot] 📖
Tyler J Russell 📖	Ivan Lieder 💻 🐛	Hezekiah Hendry 💻	Stitch07 💻 ⚠️	Vetlix 💻	Ethan Mitchell 📖	Elliot 💻
Jurien Hamaker 💻	Charalampos Fanoulis 📖	dependabot[bot] 🚧	Kaname 💻	nandhagk 🐛

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