# @matrixai/timer

> Stopwatch timer object

Latest version **2.1.1** (published 2025-02-04) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @matrixai/timer
pnpm add @matrixai/timer
yarn add @matrixai/timer
bun add @matrixai/timer
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2025-02-04 |
| First published | 2022-09-12 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 2 |
| Unpacked size | 38.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Roger Qiu |
| Maintainers | brianbotha74, cmcdragonkai, matrixai-bot |
| Keywords | timer, stopwatch, setTimeout |

## Links

- npm: https://www.npmjs.com/package/@matrixai/timer
- Repository: https://github.com/MatrixAI/js-timer
- Homepage: https://github.com/MatrixAI/js-timer#readme
- Issues: https://github.com/MatrixAI/js-timer/issues
- npm.io page: https://npm.io/package/@matrixai/timer

## Dependencies (2)

- [@matrixai/errors](https://npm.io/package/@matrixai/errors.md) ^2.0.1
- [@matrixai/async-cancellable](https://npm.io/package/@matrixai/async-cancellable.md) ^2.0.0

## Recent versions

- 2.1.1 (latest) — 2025-02-04
- 2.1.0 — 2023-11-08
- 1.1.3 — 2023-11-08
- 1.1.2 — 2023-10-26
- 2.0.0 — 2023-08-12
- 1.1.1 — 2023-06-15
- 1.1.0 — 2023-03-15
- 1.0.0 — 2022-09-12

## README

# js-timer

This library provides a reified `Timer` replacing the imperative `setTimeout` in JS. This is useful for keeping track of elapsed time and calculating how time is left. Think of this as a "Stopwatch".

This does not use `Date.now()`, it uses `Performance` API.

## Installation

```sh
npm install --save @matrixai/timer
```

## Usage

```ts
import { Timer } from '@matrixai/timer';

const t1 = new Timer(() => 2, 10);
const result = await t1;
```

## Development

Run `nix develop`, and once you're inside, you can use:

```sh
# install (or reinstall packages from package.json)
npm install
# build the dist
npm run build
# run the repl (this allows you to import from ./src)
npm run tsx
# run the tests
npm run test
# lint the source code
npm run lint
# automatically fix the source
npm run lintfix
```

### Docs Generation

```sh
npm run docs
```

See the docs at: https://matrixai.github.io/js-timer/

### Publishing

Publishing is handled automatically by the staging pipeline.

Prerelease:

```sh
# npm login
npm version prepatch --preid alpha # premajor/preminor/prepatch
git push --follow-tags
```

Release:

```sh
# npm login
npm version patch # major/minor/patch
git push --follow-tags
```

Manually:

```sh
# npm login
npm version patch # major/minor/patch
npm run build
npm publish --access public
git push
git push --tags
```

---
_Source: https://npm.io/package/@matrixai/timer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._