tally-ttl 0.5.0 → 0.5.1

package/README.md

@@ -1 +1,61 @@
-# tally-ttl
+## Simple tally tracker with induvidual TTL per tally (sliding window tally)
+
+Useful for tracking how many events have occured in a recent window of time.
+
+Each tally has it's own TTL (rounded to 1 second increments).
+
+Contains both CommonJS and ESM modules for counting items. Typescript types included with ESM version.
+
+**Installation**
+
+```
+npm install tally-ttl
+```
+
+**Usage Examples**
+
+```javascript
+// For ESM use
+import TallyTTL from "tally-ttl";
+
+// OR, for CommonJS use
+const TallyTTL = require("tally-ttl");
+```
+
+```javascript
+// Example: 5 minute (300 second) tally
+const userActionTally = new TallyTTL({ defaultTtl: 60 });
+
+// in this case, we want to track how many times a user has failed to login
+userActionTally.tally("bob-login-failed");
+userActionTally.tally("bob-login-failed");
+
+let bobLoginFailedCount = userActionTally.get("bob-login-failed");
+// bobLoginFailedCount would be 2
+
+// wait a second...
+
+// Each call to tally() gets it's own expiration time, so calling it again here would last 60 seconds (the defaultTtl) from this current time
+// add another one
+userActionTally.tally("bob-login-failed");
+
+bobLoginFailedCount = userActionTally.get("bob-login-failed");
+// bobLoginFailedCount would be 3
+
+// wait 60 seconds...
+
+bobLoginFailedCount = userActionTally.get("bob-login-failed");
+// bobLoginFailedCount would be 1 since the first two have expired by now
+
+// wait a second...
+
+// out third call has now expired as well
+bobLoginFailedCount = userActionTally.get("bob-login-failed");
+// bobLoginFailedCount would be 0
+```
+
+```javascript
+// You can also overriude the defaultTtl for an induvidual tally
+// Example: this particular tally would persisit for 15 minutes (900 seconds)
+userActionTally.tally("bob-login-failed", 3600);
+```

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "tally-ttl",
-	"version": "0.5.0",
+	"version": "0.5.1",
 	"description": "A simple library to tally items with a configurable per-tally TTL",
 	"keywords": [
 		"tally",