@oscarpalmer/timer 0.6.0 → 0.7.0

package/README.md

@@ -1,7 +1,45 @@
 # Timer
 
-A better timer?
+[![npm version](https://badge.fury.io/js/@oscarpalmer%2Ftimer.svg)](https://badge.fury.io/js/@oscarpalmer%2Ftimer)
+
+A better solution for timeout- and interval-based timers.
+
+## Installation
+
+Timer is available on _npm_ as [`@oscarpalmer/timer`](https://www.npmjs.com/package/@oscarpalmer/timer).
+
+## Getting started
+
+This is fairily lightweight package, so hopefully you'll be up and running in seconds :blush:
+
+### Examples
+
+The timers can be called with nice helper methods, which also auto-start the timers:
+
+```typescript
+import {repeat, wait} from '@oscarpalmer/timer';
+
+let waited = wait(callback, time);
+let repeated = repeat(callback, time, count);
+```
+
+Or they can be created using class syntax, but without being auto-started:
+
+```typescript
+import {Repeated, Waited} from '@oscarpalmer/timer';
+
+waited = new Waited(callback, time);
+repeated = new Repeated(callback, time, count);
+```
+
+Both the nice helper methods and the class syntax create similar objects – `Waited` and `Repeated` – which share methods:
+
+|Method|Description|
+|-----:|:----------|
+|`start()`|Starts the timer: necessary when creating a timer using the class syntax _(e.g. `new Waited...`)_, but helpful when the timer needs to be started at other times, as well|
+|`stop()`|Stops the timer|
+|`restart()`|Restarts the timer|
 
 ## License
 
-[MIT licensed](LICENSE), natch :blush:
+[MIT licensed](LICENSE), natch :wink:

package/dist/timer.js

@@ -1,4 +1,3 @@
-"use strict";
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => {
@@ -7,7 +6,7 @@ var __publicField = (obj, key, value) => {
 };
 
 // src/index.ts
-var milliseconds = 1e3 / 60;
+var milliseconds = Math.round(1e3 / 60);
 var Timed = class {
   constructor(type, callback, time, count) {
     __publicField(this, "callback");

package/package.json

@@ -3,17 +3,17 @@
 		"name": "Oscar Palmér",
 		"url": "https://oscarpalmer.se"
 	},
-	"description": "A better timer?",
+	"description": "A better solution for timeout- and interval-based timers.",
 	"devDependencies": {
 		"@tsconfig/recommended": "^1.0.0",
-		"@types/node": "^18.0.0",
-		"@typescript-eslint/eslint-plugin": "^5.30.0",
-		"@typescript-eslint/parser": "^5.30.0",
-		"esbuild": "^0.14.0",
-		"eslint": "^8.20.0",
-		"eslint-config-xo": "^0.41.0",
-		"eslint-config-xo-typescript": "^0.52.0",
-		"typescript": "^4.7.0"
+		"@types/node": "^18.7.0",
+		"@typescript-eslint/eslint-plugin": "^5.35.0",
+		"@typescript-eslint/parser": "^5.35.0",
+		"esbuild": "^0.15.0",
+		"eslint": "^8.22.0",
+		"eslint-config-xo": "^0.42.0",
+		"eslint-config-xo-typescript": "^0.53.0",
+		"typescript": "^4.8.0"
 	},
 	"exports": {
 		".": {
@@ -43,5 +43,5 @@
 	"type": "module",
 	"types": "src/index.d.ts",
 	"unpkg": "dist/timer.js",
-	"version": "0.6.0"
-}
+	"version": "0.7.0"
+}

package/src/index.ts

@@ -2,7 +2,7 @@ type RepeatedCallback = (index: number) => void;
 type TimerType = 'repeated' | 'waited';
 type WaitedCallback = () => void;
 
-const milliseconds = 1000 / 60;
+const milliseconds = Math.round(1000 / 60);
 
 abstract class Timed<Callback> {
 	private readonly callback: Callback;