refactor; bump

README.md

@@ -15,7 +15,7 @@ A token bucket rate limiter for Deno.
 ## Features
 
 - [x] Simple and easy to use.
-- [x] Regulates access to functions based on defined limits.
+- [x] Rate limiting based on token bucket algorithm.
 
 ## Install
 
@@ -33,7 +33,7 @@ import { createThrottle } from "@117/throttle";
 const throttle = createThrottle({ limit: 5, interval: 1000 });
 
 const work = () => {
-    if (throttle.canProceed()) {
+    if (throttle.check()) {
         console.log("request allowed, processing work");
     } else {
         console.log("request blocked, please wait");

deno.json

@@ -1,7 +1,7 @@
 {
   "name": "@117/throttle",
   "description": "A token bucket rate limiter for Deno.",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "exports": "./mod.ts",
   "imports": {
     "@/": "./",

src/createThrottle.ts

@@ -1,9 +1,29 @@
+/**
+ * Represents a throttle mechanism.
+ * @property {function(): boolean} check - Checks if a token is available.
+ */
+export type Throttle = {
+  check: () => boolean;
+};
+
+/**
+ * Options for creating a throttle.
+ * @property {number} limit - The maximum number of tokens.
+ * @property {number} interval - The time interval for token refill in milliseconds.
+ */
 export type CreateThrottleOptions = {
   limit: number;
   interval: number;
 };
 
-export const createThrottle = ({ limit, interval }: CreateThrottleOptions) => {
+/**
+ * Creates a throttle with the specified options.
+ * @param {CreateThrottleOptions} options - The options for the throttle.
+ * @returns {Throttle} The throttle instance.
+ */
+export const createThrottle = (
+  { limit, interval }: CreateThrottleOptions,
+): Throttle => {
   let tokens = limit;
   let lastRefill = Date.now();
 
@@ -16,7 +36,7 @@ export const createThrottle = ({ limit, interval }: CreateThrottleOptions) => {
     lastRefill = now;
   };
 
-  const canProceed = () => {
+  const check = () => {
     refillTokens();
 
     if (tokens > 0) {
@@ -27,5 +47,5 @@ export const createThrottle = ({ limit, interval }: CreateThrottleOptions) => {
     return false;
   };
 
-  return { canProceed };
+  return { check };
 };

src/createThrottle_test.ts

@@ -5,22 +5,22 @@ Deno.test("should allow requests within limit", () => {
   const throttle = createThrottle({ limit: 5, interval: 1000 });
 
   for (let i = 0; i < 5; i++) {
-    assert(throttle.canProceed(), `request ${i + 1} should be allowed`);
+    assert(throttle.check(), `request ${i + 1} should be allowed`);
   }
 });
 
 Deno.test("should block requests exceeding limit", async () => {
   const throttle = createThrottle({ limit: 2, interval: 1000 });
 
-  assert(throttle.canProceed(), "first request should be allowed");
-  assert(throttle.canProceed(), "second request should be allowed");
-  assert(!throttle.canProceed(), "third request should be blocked");
+  assert(throttle.check(), "first request should be allowed");
+  assert(throttle.check(), "second request should be allowed");
+  assert(!throttle.check(), "third request should be blocked");
 
   // Wait for the interval to pass
   await new Promise((resolve) => setTimeout(resolve, 1000));
 
   assert(
-    throttle.canProceed(),
+    throttle.check(),
     "fourth request should be allowed after interval",
   );
 });