# @gamestdio/clock

> A simple clock/ticker implementation to track elapsed/delta time.

Latest version **1.1.9** (published 2017-09-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @gamestdio/clock
pnpm add @gamestdio/clock
yarn add @gamestdio/clock
bun add @gamestdio/clock
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.1.9 |
| Published | 2017-09-28 |
| First published | 2017-08-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 19 |
| Author | Endel Dreyer |
| Maintainers | endel |
| Keywords | clock, ticker, delta, time |

## Links

- npm: https://www.npmjs.com/package/@gamestdio/clock
- Repository: https://github.com/endel/clock.js
- Homepage: https://github.com/endel/clock.js#readme
- Issues: https://github.com/endel/clock.js/issues
- npm.io page: https://npm.io/package/@gamestdio/clock

## Alternatives

- [@js-joda/timezone](https://npm.io/package/@js-joda/timezone.md) — 383.4K weekly downloads
- [chartjs-adapter-moment](https://npm.io/package/chartjs-adapter-moment.md) — 210.8K weekly downloads
- [strftime](https://npm.io/package/strftime.md) — 171.2K weekly downloads
- [vue-flatpickr-component](https://npm.io/package/vue-flatpickr-component.md) — 115.8K weekly downloads
- [timepicker](https://npm.io/package/timepicker.md) — 51.0K weekly downloads

## Recent versions

- 1.1.9 (latest) — 2017-09-28
- 1.1.8 — 2017-08-07
- 1.1.7 — 2017-08-07

## README

@gamestdio/clock [![Build Status](https://secure.travis-ci.org/gamestdio/clock.js.png?branch=master)](http://travis-ci.org/gamestdio/clock.js)
===

A simple clock/ticker implementation to track delta/elapsed time.

**2kb minified**

API
---

- `new Clock([useInterval=false])`
- `clock.start([useInterval=false])`
- `clock.stop()`
- `clock.tick()`
- `clock.elapsedTime`
- `clock.deltaTime`
- `clock.currentTime`

Usage example
---

There's two ways you can use clock.js: manual or automatic.

**Automatic**

By initializing `Clock` with `true` as the first argument, a interval will be
created, in which `tick()` is called 60 times per second.

```typescript
import * as Clock from '@gamestdio/clock';
let clock = new Clock(true);
```

You can also call `start(true)` to create the interval.

```javascript
import * as Clock from '@gamestdio/clock';
let clock = new Clock();
clock.start(true);
```

**Manual usage**

You call `tick()` manually in your existing loop.

```typescript
import * as Clock from '@gamestdio/clock';
var clock = new Clock();

setInterval(function() {
  clock.tick();
  console.log("Delta time: ", clock.deltaTime);
  console.log("Elapsed time: ", clock.elapsedTime);
  console.log("Current time: ", clock.currentTime);
}, 1000 / 60);
```


License
---

MIT

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