https://github.com/gaskam-com/dev-timer

Dev Timer is a very simple library to help you implement timings in your code. It's designed to stay precise over time.
https://github.com/gaskam-com/dev-timer

alpha js library npm timer ts

Last synced: about 2 months ago
JSON representation

Dev Timer is a very simple library to help you implement timings in your code. It's designed to stay precise over time.

• Host: GitHub
• URL: https://github.com/gaskam-com/dev-timer
• Owner: gaskam-com
• License: bsd-3-clause
• Created: 2023-07-17T13:03:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-09T12:08:36.000Z (3 months ago)
• Last Synced: 2024-10-14T03:23:19.352Z (3 months ago)
• Topics: alpha, js, library, npm, timer, ts
• Language: JavaScript
• Homepage: https://gaskam.com
• Size: 231 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
Dev-Timer




![npm](https://img.shields.io/npm/v/dev-timer)

![npm](https://img.shields.io/npm/dw/dev-timer)

![npm bundle size](https://img.shields.io/bundlephobia/min/dev-timer)

![GitHub last commit (branch)](https://img.shields.io/github/last-commit/gaskam-com/dev-timer/main)

![Static Badge](https://img.shields.io/badge/JS%20%2B%20TS-%20100%25-blue)



Dev Timer is a very simple library to help you implement timings in your code.


---

> ⚠️ This library is currently in Beta release. Expect changes.

## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

- [Credits](#credits)

- [License](#license)

## Installation

You can easily install it using the command below :

> ⚠️ This library is not yet compatible with imports with script tag.

### npm

```

npm i dev-timer

```

NodeJS usage

```js

const { Timer } = require("dev-timer");

```

### ESM

Dev Timer can be imported as ES modules for browsers that support it. The specifics differ depending on the CDN, but here's a pattern for including the ES module where supported, and falling back to a UMD version for older browsers.

HTML5

```html

```

JS ( index.js )

```js

import { Timer } from "https://unpkg.com/[email protected]/ES/Timer.js";

```

## Usage

You can find the documentation [here](https://github.com/BOT-maKeR-0000/dev-timer/wiki).

To find more examples, please refer to [examples folder](https://github.com/BOT-maKeR-0000/dev-timer/tree/main/examples) or [step by step examples](https://github.com/BOT-maKeR-0000/dev-timer/wiki/examples).

### Basic Example :

```js

const { Timer } = require('dev-timer');

// Create a new timer instance with a 15 seconds duration

const timer = new Timer(15000); 

timer.start(); // Start the timer

// Add a callback to be called when the timer ends

timer.onEnd = ()=>{

    console.log('Timer ended');

}

```

## Credits

This project was mainly created by me... so... But I would like to thank [Patafix](https://github.com/PatafixPLTX) who helped me to create this README.

But this project was only possible thanks to TypeScript, Javascript, npm and Github <3

## License

Dev Timer's code is licenced under [BSD-3 Clause Licence](https://opensource.org/license/bsd-3-clause/).

You can find the licence file [here](https://github.com/BOT-maKeR-0000/dev-timer/blob/main/LICENSE) too.