@sapphire/ratelimits 3.0.0-pr-601.2f2c308a.0 → 3.0.0-pr-935.7da5c8bb

package/CHANGELOG.md

@@ -2,6 +2,43 @@
 
 All notable changes to this project will be documented in this file.
 
+# [@sapphire/ratelimits@2.4.10](https://github.com/sapphiredev/utilities/compare/@sapphire/ratelimits@2.4.9...@sapphire/ratelimits@2.4.10) - (2024-11-02)
+
+## 🐛 Bug Fixes
+
+- Move browser imports ([100ffb0](https://github.com/sapphiredev/utilities/commit/100ffb0a2471bb9f74cc580d282d11059e1a0a68)) ([#826](https://github.com/sapphiredev/utilities/pull/826) by @kyranet)
+- **deps:** Update all non-major dependencies ([083376a](https://github.com/sapphiredev/utilities/commit/083376aac55094dbeddb5194e8a8f0d794b8cceb)) ([#763](https://github.com/sapphiredev/utilities/pull/763) by @renovate[bot])
+- **deps:** Update all non-major dependencies ([e7fdc5d](https://github.com/sapphiredev/utilities/commit/e7fdc5db3632a7f90292ef3978898da32730343a)) ([#752](https://github.com/sapphiredev/utilities/pull/752) by @renovate[bot])
+
+## 📝 Documentation
+
+- **readme:** Fix readme table of contents ([c60e8bd](https://github.com/sapphiredev/utilities/commit/c60e8bd9fc89156cf973871597ec3f0ef0308c08))
+
+# [@sapphire/ratelimits@2.4.9](https://github.com/sapphiredev/utilities/compare/@sapphire/ratelimits@2.4.9...@sapphire/ratelimits@2.4.9) - (2024-01-19)
+
+## 🐛 Bug Fixes
+
+- Fixed commonjs typings export mapping (#707) ([216ff02](https://github.com/sapphiredev/utilities/commit/216ff0260d63a9590357f9a5069f1ae2b34eaf5d))
+
+# [@sapphire/ratelimits@2.4.8](https://github.com/sapphiredev/utilities/compare/@sapphire/ratelimits@2.4.8...@sapphire/ratelimits@2.4.8) - (2023-12-04)
+
+## 🐛 Bug Fixes
+
+- **ratelimits:** Properly split CJS, ESM and IIFE ([fc1a7d7](https://github.com/sapphiredev/utilities/commit/fc1a7d7ba96a6a6ab8dbaed486e221a9a064e108))
+
+# [@sapphire/ratelimits@2.4.7](https://github.com/sapphiredev/utilities/compare/@sapphire/ratelimits@2.4.6...@sapphire/ratelimits@2.4.7) - (2023-09-10)
+
+## 🐛 Bug Fixes
+
+- **ratelimits:** Fixed support for `@types/node` `>=v20` ([d2bdd53](https://github.com/sapphiredev/utilities/commit/d2bdd53a6fa01b4e95f163b5d6c4f2de280fad45))
+- Update export mapping for proper ESM/CJS split ([dd0cff8](https://github.com/sapphiredev/utilities/commit/dd0cff8e9b03a15812f25f7a1180501a92422629))
+- **deps:** Update all non-major dependencies (#607) ([9cc8bd0](https://github.com/sapphiredev/utilities/commit/9cc8bd0d4b5d650deab2c913e6c3d713861bae28))
+- **deps:** Update all non-major dependencies (#577) ([291dd67](https://github.com/sapphiredev/utilities/commit/291dd6783e57d8f075ce566218ba076ef6c4bbbd))
+
+## 🧪 Testing
+
+- Update vitest to coverage v8 ([a4bc6e4](https://github.com/sapphiredev/utilities/commit/a4bc6e4f24ea60143a150ecc76fda6484f172ab9))
+
 # [@sapphire/ratelimits@2.4.6](https://github.com/sapphiredev/utilities/compare/@sapphire/ratelimits@2.4.5...@sapphire/ratelimits@2.4.6) - (2023-03-09)
 
 ## 🏠 Refactor

package/README.md

@@ -7,7 +7,6 @@
 **Bucket implementation for Ratelimits.**
 
 [![GitHub](https://img.shields.io/github/license/sapphiredev/utilities)](https://github.com/sapphiredev/utilities/blob/main/LICENSE.md)
-[![codecov](https://codecov.io/gh/sapphiredev/utilities/branch/main/graph/badge.svg?token=OEGIV6RFDO)](https://codecov.io/gh/sapphiredev/utilities)
 [![npm bundle size](https://img.shields.io/bundlephobia/min/@sapphire/ratelimits?logo=webpack&style=flat-square)](https://bundlephobia.com/result?p=@sapphire/ratelimits)
 [![npm](https://img.shields.io/npm/v/@sapphire/ratelimits?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/@sapphire/ratelimits)
 
@@ -22,7 +21,7 @@
     -   [Token RateLimitManager](#token-ratelimitmanager)
     -   [Leaky RateLimitManager](#leaky-ratelimitmanager)
 -   [Buy us some doughnuts](#buy-us-some-doughnuts)
--   [Contributors ✨](#contributors-%E2%9C%A8)
+-   [Contributors](#contributors)
 
 ## Description
 

package/dist/{index.js → cjs/index.cjs}

@@ -3,13 +3,10 @@
 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 __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 
 // src/lib/RateLimit.ts
-var RateLimit = class {
+var _RateLimit = class _RateLimit {
   /**
    * @param manager The manager for this entry.
    */
@@ -51,10 +48,8 @@ var RateLimit = class {
    * Consumes {@link RateLimit.remaining} by one if it's not limited, calling {@link RateLimit.reset} first if {@link RateLimit.expired} is true.
    */
   consume() {
-    if (this.limited)
-      throw new Error("Cannot consume a limited bucket");
-    if (this.expired)
-      this.reset();
+    if (this.limited) throw new Error("Cannot consume a limited bucket");
+    if (this.expired) this.reset();
     this.remaining--;
     return this;
   }
@@ -79,10 +74,11 @@ var RateLimit = class {
     return this;
   }
 };
-__name(RateLimit, "RateLimit");
+__name(_RateLimit, "RateLimit");
+var RateLimit = _RateLimit;
 
 // src/lib/RateLimitManager.ts
-var _RateLimitManager = class extends Map {
+var _RateLimitManager = class _RateLimitManager extends Map {
   /**
    * @param time The amount of milliseconds for the ratelimits from this manager to expire.
    * @param limit The amount of times a {@link RateLimit} can drip before it's limited.
@@ -134,23 +130,22 @@ var _RateLimitManager = class extends Map {
    */
   sweep() {
     for (const [id, value] of this.entries()) {
-      if (value.expired)
-        this.delete(id);
+      if (value.expired) this.delete(id);
     }
-    if (this.size === 0 && this.sweepInterval !== null) {
+    if (this.size === 0 && this.sweepInterval !== void 0 && this.sweepInterval !== null) {
       clearInterval(this.sweepInterval);
       this.sweepInterval = null;
     }
   }
 };
-var RateLimitManager = _RateLimitManager;
-__name(RateLimitManager, "RateLimitManager");
+__name(_RateLimitManager, "RateLimitManager");
 /**
  * The delay in milliseconds for {@link RateLimitManager.sweepInterval}.
  */
-__publicField(RateLimitManager, "sweepIntervalDuration", 3e4);
+__publicField(_RateLimitManager, "sweepIntervalDuration", 3e4);
+var RateLimitManager = _RateLimitManager;
 
 exports.RateLimit = RateLimit;
 exports.RateLimitManager = RateLimitManager;
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/lib/RateLimit.ts","../../src/lib/RateLimitManager.ts"],"names":[],"mappings":";;;;;;;;AAEO,IAAM,UAAA,GAAN,MAAM,UAAA,CAAsB;AAAA;AAAA;AAAA;AAAA,EAmB3B,YAAY,OAAA,EAA8B;AAfjD;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAO,WAAA,CAAA;AAKP;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAO,SAAA,CAAA;AAKP;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAQ,SAAA,CAAA;AAMP,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AACf,IAAA,IAAA,CAAK,KAAA,EAAM;AAAA,EACZ;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,OAAA,GAAmB;AAC7B,IAAA,OAAO,KAAK,aAAA,KAAkB,CAAA;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,OAAA,GAAmB;AAC7B,IAAA,OAAO,IAAA,CAAK,SAAA,KAAc,CAAA,IAAK,CAAC,IAAA,CAAK,OAAA;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,aAAA,GAAwB;AAClC,IAAA,OAAO,KAAK,GAAA,CAAI,IAAA,CAAK,UAAU,IAAA,CAAK,GAAA,IAAO,CAAC,CAAA;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA,EAKO,OAAA,GAAgB;AACtB,IAAA,IAAI,IAAA,CAAK,OAAA,EAAS,MAAM,IAAI,MAAM,iCAAiC,CAAA;AACnE,IAAA,IAAI,IAAA,CAAK,OAAA,EAAS,IAAA,CAAK,KAAA,EAAM;AAE7B,IAAA,IAAA,CAAK,SAAA,EAAA;AACL,IAAA,OAAO,IAAA;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKO,KAAA,GAAc;AACpB,IAAA,OAAO,IAAA,CAAK,cAAA,EAAe,CAAE,SAAA,EAAU;AAAA,EACxC;AAAA;AAAA;AAAA;AAAA,EAKO,cAAA,GAAuB;AAC7B,IAAA,IAAA,CAAK,SAAA,GAAY,KAAK,OAAA,CAAQ,KAAA;AAC9B,IAAA,OAAO,IAAA;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKO,SAAA,GAAkB;AACxB,IAAA,IAAA,CAAK,OAAA,GAAU,IAAA,CAAK,GAAA,EAAI,GAAI,KAAK,OAAA,CAAQ,IAAA;AACzC,IAAA,OAAO,IAAA;AAAA,EACR;AACD,CAAA;AA9EmC,MAAA,CAAA,UAAA,EAAA,WAAA,CAAA;AAA5B,IAAM,SAAA,GAAN;;;ACAA,IAAM,iBAAA,GAAN,MAAM,iBAAA,SAAqC,GAAA,CAAqB;AAAA;AAAA;AAAA;AAAA;AAAA,EAoB/D,WAAA,CAAY,IAAA,EAAc,KAAA,GAAQ,CAAA,EAAG;AAC3C,IAAA,KAAA,EAAM;AAjBP;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAgB,MAAA,CAAA;AAKhB;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAgB,OAAA,CAAA;AAKhB;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAQ,eAAA,CAAA;AASP,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,IAAA,CAAK,KAAA,GAAQ,KAAA;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,QAAQ,EAAA,EAAqB;AACnC,IAAA,OAAO,KAAK,GAAA,CAAI,EAAE,CAAA,IAAK,IAAA,CAAK,OAAO,EAAE,CAAA;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,OAAO,EAAA,EAAqB;AAClC,IAAA,MAAM,KAAA,GAAQ,IAAI,SAAA,CAAU,IAAI,CAAA;AAChC,IAAA,IAAA,CAAK,GAAA,CAAI,IAAI,KAAK,CAAA;AAClB,IAAA,OAAO,KAAA;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOgB,GAAA,CAAI,IAAO,KAAA,EAA2B;AACrD,IAAA,IAAA,CAAK,aAAA,KAAL,IAAA,CAAK,aAAA,GAAkB,WAAA,CAAY,IAAA,CAAK,MAAM,IAAA,CAAK,IAAI,CAAA,EAAG,iBAAA,CAAiB,qBAAqB,CAAA,CAAA;AAChG,IAAA,OAAO,KAAA,CAAM,GAAA,CAAI,EAAA,EAAI,KAAK,CAAA;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA,EAKO,KAAA,GAAc;AACpB,IAAA,KAAA,MAAW,CAAC,EAAA,EAAI,KAAK,CAAA,IAAK,IAAA,CAAK,SAAQ,EAAG;AACzC,MAAA,IAAI,KAAA,CAAM,OAAA,EAAS,IAAA,CAAK,MAAA,CAAO,EAAE,CAAA;AAAA,IAClC;AAEA,IAAA,IAAI,IAAA,CAAK,SAAS,CAAA,IAAK,IAAA,CAAK,kBAAkB,MAAA,IAAa,IAAA,CAAK,kBAAkB,IAAA,EAAM;AACvF,MAAA,aAAA,CAAc,KAAK,aAAa,CAAA;AAChC,MAAA,IAAA,CAAK,aAAA,GAAgB,IAAA;AAAA,IACtB;AAAA,EACD;AAMD,CAAA;AAzEuE,MAAA,CAAA,iBAAA,EAAA,kBAAA,CAAA;AAAA;AAAA;AAAA;AAwEtE,aAAA,CAxEY,mBAwEE,uBAAA,EAAwB,GAAA,CAAA;AAxEhC,IAAM,gBAAA,GAAN","file":"index.cjs","sourcesContent":["import type { RateLimitManager } from './RateLimitManager';\n\nexport class RateLimit<K = string> {\n\t/**\n\t * The remaining amount of times this entry can be dripped before the bucket is empty.\n\t */\n\tpublic remaining!: number;\n\n\t/**\n\t * The timestamp that represents when this entry will reset back to a available state.\n\t */\n\tpublic expires!: number;\n\n\t/**\n\t * The {@link RateLimitManager} this entry is for.\n\t */\n\tprivate manager: RateLimitManager<K>;\n\n\t/**\n\t * @param manager The manager for this entry.\n\t */\n\tpublic constructor(manager: RateLimitManager<K>) {\n\t\tthis.manager = manager;\n\t\tthis.reset();\n\t}\n\n\t/**\n\t * Whether this entry is expired or not, allowing the bucket to be reset.\n\t */\n\tpublic get expired(): boolean {\n\t\treturn this.remainingTime === 0;\n\t}\n\n\t/**\n\t * Whether this entry is limited or not.\n\t */\n\tpublic get limited(): boolean {\n\t\treturn this.remaining === 0 && !this.expired;\n\t}\n\n\t/**\n\t * The remaining time in milliseconds before resetting.\n\t */\n\tpublic get remainingTime(): number {\n\t\treturn Math.max(this.expires - Date.now(), 0);\n\t}\n\n\t/**\n\t * Consumes {@link RateLimit.remaining} by one if it's not limited, calling {@link RateLimit.reset} first if {@link RateLimit.expired} is true.\n\t */\n\tpublic consume(): this {\n\t\tif (this.limited) throw new Error('Cannot consume a limited bucket');\n\t\tif (this.expired) this.reset();\n\n\t\tthis.remaining--;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Resets the entry back to it's full state.\n\t */\n\tpublic reset(): this {\n\t\treturn this.resetRemaining().resetTime();\n\t}\n\n\t/**\n\t * Resets the entry's {@link RateLimit.remaining} uses back to full state.\n\t */\n\tpublic resetRemaining(): this {\n\t\tthis.remaining = this.manager.limit;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Resets the entry's {@link RateLimit.expires} to the current time plus {@link RateLimitManager.time}.\n\t */\n\tpublic resetTime(): this {\n\t\tthis.expires = Date.now() + this.manager.time;\n\t\treturn this;\n\t}\n}\n","import { RateLimit } from './RateLimit';\n\nexport class RateLimitManager<K = string> extends Map<K, RateLimit<K>> {\n\t/**\n\t * The amount of milliseconds for the {@link RateLimit ratelimits} from this manager to expire.\n\t */\n\tpublic readonly time: number;\n\n\t/**\n\t * The amount of times a {@link RateLimit} can drip before it's limited.\n\t */\n\tpublic readonly limit: number;\n\n\t/**\n\t * The interval to sweep expired {@link RateLimit ratelimits}.\n\t */\n\tprivate sweepInterval!: NodeJS.Timeout | undefined | null;\n\n\t/**\n\t * @param time The amount of milliseconds for the ratelimits from this manager to expire.\n\t * @param limit The amount of times a {@link RateLimit} can drip before it's limited.\n\t */\n\tpublic constructor(time: number, limit = 1) {\n\t\tsuper();\n\n\t\tthis.time = time;\n\t\tthis.limit = limit;\n\t}\n\n\t/**\n\t * Gets a {@link RateLimit} from this manager or creates it if it does not exist.\n\t * @param id The id for the {@link RateLimit}\n\t */\n\tpublic acquire(id: K): RateLimit<K> {\n\t\treturn this.get(id) ?? this.create(id);\n\t}\n\n\t/**\n\t * Creates a {@link RateLimit} for this manager.\n\t * @param id The id the {@link RateLimit} belongs to\n\t */\n\tpublic create(id: K): RateLimit<K> {\n\t\tconst value = new RateLimit(this);\n\t\tthis.set(id, value);\n\t\treturn value;\n\t}\n\n\t/**\n\t * Wraps Collection's set method to set interval to sweep inactive {@link RateLimit}s.\n\t * @param id The id the {@link RateLimit} belongs to\n\t * @param value The {@link RateLimit} to set\n\t */\n\tpublic override set(id: K, value: RateLimit<K>): this {\n\t\tthis.sweepInterval ??= setInterval(this.sweep.bind(this), RateLimitManager.sweepIntervalDuration);\n\t\treturn super.set(id, value);\n\t}\n\n\t/**\n\t * Wraps Collection's sweep method to clear the interval when this manager is empty.\n\t */\n\tpublic sweep(): void {\n\t\tfor (const [id, value] of this.entries()) {\n\t\t\tif (value.expired) this.delete(id);\n\t\t}\n\n\t\tif (this.size === 0 && this.sweepInterval !== undefined && this.sweepInterval !== null) {\n\t\t\tclearInterval(this.sweepInterval);\n\t\t\tthis.sweepInterval = null;\n\t\t}\n\t}\n\n\t/**\n\t * The delay in milliseconds for {@link RateLimitManager.sweepInterval}.\n\t */\n\tpublic static sweepIntervalDuration = 30_000;\n}\n"]}

package/dist/esm/index.d.mts

@@ -0,0 +1,92 @@
+declare class RateLimitManager<K = string> extends Map<K, RateLimit<K>> {
+    /**
+     * The amount of milliseconds for the {@link RateLimit ratelimits} from this manager to expire.
+     */
+    readonly time: number;
+    /**
+     * The amount of times a {@link RateLimit} can drip before it's limited.
+     */
+    readonly limit: number;
+    /**
+     * The interval to sweep expired {@link RateLimit ratelimits}.
+     */
+    private sweepInterval;
+    /**
+     * @param time The amount of milliseconds for the ratelimits from this manager to expire.
+     * @param limit The amount of times a {@link RateLimit} can drip before it's limited.
+     */
+    constructor(time: number, limit?: number);
+    /**
+     * Gets a {@link RateLimit} from this manager or creates it if it does not exist.
+     * @param id The id for the {@link RateLimit}
+     */
+    acquire(id: K): RateLimit<K>;
+    /**
+     * Creates a {@link RateLimit} for this manager.
+     * @param id The id the {@link RateLimit} belongs to
+     */
+    create(id: K): RateLimit<K>;
+    /**
+     * Wraps Collection's set method to set interval to sweep inactive {@link RateLimit}s.
+     * @param id The id the {@link RateLimit} belongs to
+     * @param value The {@link RateLimit} to set
+     */
+    set(id: K, value: RateLimit<K>): this;
+    /**
+     * Wraps Collection's sweep method to clear the interval when this manager is empty.
+     */
+    sweep(): void;
+    /**
+     * The delay in milliseconds for {@link RateLimitManager.sweepInterval}.
+     */
+    static sweepIntervalDuration: number;
+}
+
+declare class RateLimit<K = string> {
+    /**
+     * The remaining amount of times this entry can be dripped before the bucket is empty.
+     */
+    remaining: number;
+    /**
+     * The timestamp that represents when this entry will reset back to a available state.
+     */
+    expires: number;
+    /**
+     * The {@link RateLimitManager} this entry is for.
+     */
+    private manager;
+    /**
+     * @param manager The manager for this entry.
+     */
+    constructor(manager: RateLimitManager<K>);
+    /**
+     * Whether this entry is expired or not, allowing the bucket to be reset.
+     */
+    get expired(): boolean;
+    /**
+     * Whether this entry is limited or not.
+     */
+    get limited(): boolean;
+    /**
+     * The remaining time in milliseconds before resetting.
+     */
+    get remainingTime(): number;
+    /**
+     * Consumes {@link RateLimit.remaining} by one if it's not limited, calling {@link RateLimit.reset} first if {@link RateLimit.expired} is true.
+     */
+    consume(): this;
+    /**
+     * Resets the entry back to it's full state.
+     */
+    reset(): this;
+    /**
+     * Resets the entry's {@link RateLimit.remaining} uses back to full state.
+     */
+    resetRemaining(): this;
+    /**
+     * Resets the entry's {@link RateLimit.expires} to the current time plus {@link RateLimitManager.time}.
+     */
+    resetTime(): this;
+}
+
+export { RateLimit, RateLimitManager };

package/dist/{index.mjs → esm/index.mjs}

@@ -1,13 +1,10 @@
 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 __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 
 // src/lib/RateLimit.ts
-var RateLimit = class {
+var _RateLimit = class _RateLimit {
   /**
    * @param manager The manager for this entry.
    */
@@ -49,10 +46,8 @@ var RateLimit = class {
    * Consumes {@link RateLimit.remaining} by one if it's not limited, calling {@link RateLimit.reset} first if {@link RateLimit.expired} is true.
    */
   consume() {
-    if (this.limited)
-      throw new Error("Cannot consume a limited bucket");
-    if (this.expired)
-      this.reset();
+    if (this.limited) throw new Error("Cannot consume a limited bucket");
+    if (this.expired) this.reset();
     this.remaining--;
     return this;
   }
@@ -77,10 +72,11 @@ var RateLimit = class {
     return this;
   }
 };
-__name(RateLimit, "RateLimit");
+__name(_RateLimit, "RateLimit");
+var RateLimit = _RateLimit;
 
 // src/lib/RateLimitManager.ts
-var _RateLimitManager = class extends Map {
+var _RateLimitManager = class _RateLimitManager extends Map {
   /**
    * @param time The amount of milliseconds for the ratelimits from this manager to expire.
    * @param limit The amount of times a {@link RateLimit} can drip before it's limited.
@@ -132,22 +128,21 @@ var _RateLimitManager = class extends Map {
    */
   sweep() {
     for (const [id, value] of this.entries()) {
-      if (value.expired)
-        this.delete(id);
+      if (value.expired) this.delete(id);
     }
-    if (this.size === 0 && this.sweepInterval !== null) {
+    if (this.size === 0 && this.sweepInterval !== void 0 && this.sweepInterval !== null) {
       clearInterval(this.sweepInterval);
       this.sweepInterval = null;
     }
   }
 };
-var RateLimitManager = _RateLimitManager;
-__name(RateLimitManager, "RateLimitManager");
+__name(_RateLimitManager, "RateLimitManager");
 /**
  * The delay in milliseconds for {@link RateLimitManager.sweepInterval}.
  */
-__publicField(RateLimitManager, "sweepIntervalDuration", 3e4);
+__publicField(_RateLimitManager, "sweepIntervalDuration", 3e4);
+var RateLimitManager = _RateLimitManager;
 
 export { RateLimit, RateLimitManager };
-//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/lib/RateLimit.ts","../../src/lib/RateLimitManager.ts"],"names":[],"mappings":";;;;;;AAEO,IAAM,UAAA,GAAN,MAAM,UAAA,CAAsB;AAAA;AAAA;AAAA;AAAA,EAmB3B,YAAY,OAAA,EAA8B;AAfjD;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAO,WAAA,CAAA;AAKP;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAO,SAAA,CAAA;AAKP;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAQ,SAAA,CAAA;AAMP,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AACf,IAAA,IAAA,CAAK,KAAA,EAAM;AAAA,EACZ;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,OAAA,GAAmB;AAC7B,IAAA,OAAO,KAAK,aAAA,KAAkB,CAAA;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,OAAA,GAAmB;AAC7B,IAAA,OAAO,IAAA,CAAK,SAAA,KAAc,CAAA,IAAK,CAAC,IAAA,CAAK,OAAA;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,aAAA,GAAwB;AAClC,IAAA,OAAO,KAAK,GAAA,CAAI,IAAA,CAAK,UAAU,IAAA,CAAK,GAAA,IAAO,CAAC,CAAA;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA,EAKO,OAAA,GAAgB;AACtB,IAAA,IAAI,IAAA,CAAK,OAAA,EAAS,MAAM,IAAI,MAAM,iCAAiC,CAAA;AACnE,IAAA,IAAI,IAAA,CAAK,OAAA,EAAS,IAAA,CAAK,KAAA,EAAM;AAE7B,IAAA,IAAA,CAAK,SAAA,EAAA;AACL,IAAA,OAAO,IAAA;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKO,KAAA,GAAc;AACpB,IAAA,OAAO,IAAA,CAAK,cAAA,EAAe,CAAE,SAAA,EAAU;AAAA,EACxC;AAAA;AAAA;AAAA;AAAA,EAKO,cAAA,GAAuB;AAC7B,IAAA,IAAA,CAAK,SAAA,GAAY,KAAK,OAAA,CAAQ,KAAA;AAC9B,IAAA,OAAO,IAAA;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKO,SAAA,GAAkB;AACxB,IAAA,IAAA,CAAK,OAAA,GAAU,IAAA,CAAK,GAAA,EAAI,GAAI,KAAK,OAAA,CAAQ,IAAA;AACzC,IAAA,OAAO,IAAA;AAAA,EACR;AACD,CAAA;AA9EmC,MAAA,CAAA,UAAA,EAAA,WAAA,CAAA;AAA5B,IAAM,SAAA,GAAN;;;ACAA,IAAM,iBAAA,GAAN,MAAM,iBAAA,SAAqC,GAAA,CAAqB;AAAA;AAAA;AAAA;AAAA;AAAA,EAoB/D,WAAA,CAAY,IAAA,EAAc,KAAA,GAAQ,CAAA,EAAG;AAC3C,IAAA,KAAA,EAAM;AAjBP;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAgB,MAAA,CAAA;AAKhB;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAgB,OAAA,CAAA;AAKhB;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAQ,eAAA,CAAA;AASP,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,IAAA,CAAK,KAAA,GAAQ,KAAA;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,QAAQ,EAAA,EAAqB;AACnC,IAAA,OAAO,KAAK,GAAA,CAAI,EAAE,CAAA,IAAK,IAAA,CAAK,OAAO,EAAE,CAAA;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,OAAO,EAAA,EAAqB;AAClC,IAAA,MAAM,KAAA,GAAQ,IAAI,SAAA,CAAU,IAAI,CAAA;AAChC,IAAA,IAAA,CAAK,GAAA,CAAI,IAAI,KAAK,CAAA;AAClB,IAAA,OAAO,KAAA;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOgB,GAAA,CAAI,IAAO,KAAA,EAA2B;AACrD,IAAA,IAAA,CAAK,aAAA,KAAL,IAAA,CAAK,aAAA,GAAkB,WAAA,CAAY,IAAA,CAAK,MAAM,IAAA,CAAK,IAAI,CAAA,EAAG,iBAAA,CAAiB,qBAAqB,CAAA,CAAA;AAChG,IAAA,OAAO,KAAA,CAAM,GAAA,CAAI,EAAA,EAAI,KAAK,CAAA;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA,EAKO,KAAA,GAAc;AACpB,IAAA,KAAA,MAAW,CAAC,EAAA,EAAI,KAAK,CAAA,IAAK,IAAA,CAAK,SAAQ,EAAG;AACzC,MAAA,IAAI,KAAA,CAAM,OAAA,EAAS,IAAA,CAAK,MAAA,CAAO,EAAE,CAAA;AAAA,IAClC;AAEA,IAAA,IAAI,IAAA,CAAK,SAAS,CAAA,IAAK,IAAA,CAAK,kBAAkB,MAAA,IAAa,IAAA,CAAK,kBAAkB,IAAA,EAAM;AACvF,MAAA,aAAA,CAAc,KAAK,aAAa,CAAA;AAChC,MAAA,IAAA,CAAK,aAAA,GAAgB,IAAA;AAAA,IACtB;AAAA,EACD;AAMD,CAAA;AAzEuE,MAAA,CAAA,iBAAA,EAAA,kBAAA,CAAA;AAAA;AAAA;AAAA;AAwEtE,aAAA,CAxEY,mBAwEE,uBAAA,EAAwB,GAAA,CAAA;AAxEhC,IAAM,gBAAA,GAAN","file":"index.mjs","sourcesContent":["import type { RateLimitManager } from './RateLimitManager';\n\nexport class RateLimit<K = string> {\n\t/**\n\t * The remaining amount of times this entry can be dripped before the bucket is empty.\n\t */\n\tpublic remaining!: number;\n\n\t/**\n\t * The timestamp that represents when this entry will reset back to a available state.\n\t */\n\tpublic expires!: number;\n\n\t/**\n\t * The {@link RateLimitManager} this entry is for.\n\t */\n\tprivate manager: RateLimitManager<K>;\n\n\t/**\n\t * @param manager The manager for this entry.\n\t */\n\tpublic constructor(manager: RateLimitManager<K>) {\n\t\tthis.manager = manager;\n\t\tthis.reset();\n\t}\n\n\t/**\n\t * Whether this entry is expired or not, allowing the bucket to be reset.\n\t */\n\tpublic get expired(): boolean {\n\t\treturn this.remainingTime === 0;\n\t}\n\n\t/**\n\t * Whether this entry is limited or not.\n\t */\n\tpublic get limited(): boolean {\n\t\treturn this.remaining === 0 && !this.expired;\n\t}\n\n\t/**\n\t * The remaining time in milliseconds before resetting.\n\t */\n\tpublic get remainingTime(): number {\n\t\treturn Math.max(this.expires - Date.now(), 0);\n\t}\n\n\t/**\n\t * Consumes {@link RateLimit.remaining} by one if it's not limited, calling {@link RateLimit.reset} first if {@link RateLimit.expired} is true.\n\t */\n\tpublic consume(): this {\n\t\tif (this.limited) throw new Error('Cannot consume a limited bucket');\n\t\tif (this.expired) this.reset();\n\n\t\tthis.remaining--;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Resets the entry back to it's full state.\n\t */\n\tpublic reset(): this {\n\t\treturn this.resetRemaining().resetTime();\n\t}\n\n\t/**\n\t * Resets the entry's {@link RateLimit.remaining} uses back to full state.\n\t */\n\tpublic resetRemaining(): this {\n\t\tthis.remaining = this.manager.limit;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Resets the entry's {@link RateLimit.expires} to the current time plus {@link RateLimitManager.time}.\n\t */\n\tpublic resetTime(): this {\n\t\tthis.expires = Date.now() + this.manager.time;\n\t\treturn this;\n\t}\n}\n","import { RateLimit } from './RateLimit';\n\nexport class RateLimitManager<K = string> extends Map<K, RateLimit<K>> {\n\t/**\n\t * The amount of milliseconds for the {@link RateLimit ratelimits} from this manager to expire.\n\t */\n\tpublic readonly time: number;\n\n\t/**\n\t * The amount of times a {@link RateLimit} can drip before it's limited.\n\t */\n\tpublic readonly limit: number;\n\n\t/**\n\t * The interval to sweep expired {@link RateLimit ratelimits}.\n\t */\n\tprivate sweepInterval!: NodeJS.Timeout | undefined | null;\n\n\t/**\n\t * @param time The amount of milliseconds for the ratelimits from this manager to expire.\n\t * @param limit The amount of times a {@link RateLimit} can drip before it's limited.\n\t */\n\tpublic constructor(time: number, limit = 1) {\n\t\tsuper();\n\n\t\tthis.time = time;\n\t\tthis.limit = limit;\n\t}\n\n\t/**\n\t * Gets a {@link RateLimit} from this manager or creates it if it does not exist.\n\t * @param id The id for the {@link RateLimit}\n\t */\n\tpublic acquire(id: K): RateLimit<K> {\n\t\treturn this.get(id) ?? this.create(id);\n\t}\n\n\t/**\n\t * Creates a {@link RateLimit} for this manager.\n\t * @param id The id the {@link RateLimit} belongs to\n\t */\n\tpublic create(id: K): RateLimit<K> {\n\t\tconst value = new RateLimit(this);\n\t\tthis.set(id, value);\n\t\treturn value;\n\t}\n\n\t/**\n\t * Wraps Collection's set method to set interval to sweep inactive {@link RateLimit}s.\n\t * @param id The id the {@link RateLimit} belongs to\n\t * @param value The {@link RateLimit} to set\n\t */\n\tpublic override set(id: K, value: RateLimit<K>): this {\n\t\tthis.sweepInterval ??= setInterval(this.sweep.bind(this), RateLimitManager.sweepIntervalDuration);\n\t\treturn super.set(id, value);\n\t}\n\n\t/**\n\t * Wraps Collection's sweep method to clear the interval when this manager is empty.\n\t */\n\tpublic sweep(): void {\n\t\tfor (const [id, value] of this.entries()) {\n\t\t\tif (value.expired) this.delete(id);\n\t\t}\n\n\t\tif (this.size === 0 && this.sweepInterval !== undefined && this.sweepInterval !== null) {\n\t\t\tclearInterval(this.sweepInterval);\n\t\t\tthis.sweepInterval = null;\n\t\t}\n\t}\n\n\t/**\n\t * The delay in milliseconds for {@link RateLimitManager.sweepInterval}.\n\t */\n\tpublic static sweepIntervalDuration = 30_000;\n}\n"]}

package/dist/{index.global.js → iife/index.global.js}

@@ -1,16 +1,13 @@
-var SapphireRatelimits = (function (exports) {
+var SapphireSnowflake = (function (exports) {
   '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 __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-  var __publicField = (obj, key, value) => {
-    __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-    return value;
-  };
+  var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 
   // src/lib/RateLimit.ts
-  var RateLimit = class {
+  var _RateLimit = class _RateLimit {
     /**
      * @param manager The manager for this entry.
      */
@@ -52,10 +49,8 @@ var SapphireRatelimits = (function (exports) {
      * Consumes {@link RateLimit.remaining} by one if it's not limited, calling {@link RateLimit.reset} first if {@link RateLimit.expired} is true.
      */
     consume() {
-      if (this.limited)
-        throw new Error("Cannot consume a limited bucket");
-      if (this.expired)
-        this.reset();
+      if (this.limited) throw new Error("Cannot consume a limited bucket");
+      if (this.expired) this.reset();
       this.remaining--;
       return this;
     }
@@ -80,10 +75,11 @@ var SapphireRatelimits = (function (exports) {
       return this;
     }
   };
-  __name(RateLimit, "RateLimit");
+  __name(_RateLimit, "RateLimit");
+  var RateLimit = _RateLimit;
 
   // src/lib/RateLimitManager.ts
-  var _RateLimitManager = class extends Map {
+  var _RateLimitManager = class _RateLimitManager extends Map {
     /**
      * @param time The amount of milliseconds for the ratelimits from this manager to expire.
      * @param limit The amount of times a {@link RateLimit} can drip before it's limited.
@@ -135,21 +131,20 @@ var SapphireRatelimits = (function (exports) {
      */
     sweep() {
       for (const [id, value] of this.entries()) {
-        if (value.expired)
-          this.delete(id);
+        if (value.expired) this.delete(id);
       }
-      if (this.size === 0 && this.sweepInterval !== null) {
+      if (this.size === 0 && this.sweepInterval !== void 0 && this.sweepInterval !== null) {
         clearInterval(this.sweepInterval);
         this.sweepInterval = null;
       }
     }
   };
-  var RateLimitManager = _RateLimitManager;
-  __name(RateLimitManager, "RateLimitManager");
+  __name(_RateLimitManager, "RateLimitManager");
   /**
    * The delay in milliseconds for {@link RateLimitManager.sweepInterval}.
    */
-  __publicField(RateLimitManager, "sweepIntervalDuration", 3e4);
+  __publicField(_RateLimitManager, "sweepIntervalDuration", 3e4);
+  var RateLimitManager = _RateLimitManager;
 
   exports.RateLimit = RateLimit;
   exports.RateLimitManager = RateLimitManager;
@@ -157,5 +152,5 @@ var SapphireRatelimits = (function (exports) {
   return exports;
 
 })({});
-//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.global.js.map
 //# sourceMappingURL=index.global.js.map

package/dist/iife/index.global.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/lib/RateLimit.ts","../../src/lib/RateLimitManager.ts"],"names":[],"mappings":";;;;;;;;;EAEO,IAAM,UAAA,GAAN,MAAM,UAAA,CAAsB;EAAA;EAAA;EAAA;EAAA,EAmB3B,YAAY,OAAA,EAA8B;EAfjD;EAAA;EAAA;EAAA,IAAA,aAAA,CAAA,IAAA,EAAO,WAAA,CAAA;EAKP;EAAA;EAAA;EAAA,IAAA,aAAA,CAAA,IAAA,EAAO,SAAA,CAAA;EAKP;EAAA;EAAA;EAAA,IAAA,aAAA,CAAA,IAAA,EAAQ,SAAA,CAAA;EAMP,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;EACf,IAAA,IAAA,CAAK,KAAA,EAAM;EAAA,EACZ;EAAA;EAAA;EAAA;EAAA,EAKA,IAAW,OAAA,GAAmB;EAC7B,IAAA,OAAO,KAAK,aAAA,KAAkB,CAAA;EAAA,EAC/B;EAAA;EAAA;EAAA;EAAA,EAKA,IAAW,OAAA,GAAmB;EAC7B,IAAA,OAAO,IAAA,CAAK,SAAA,KAAc,CAAA,IAAK,CAAC,IAAA,CAAK,OAAA;EAAA,EACtC;EAAA;EAAA;EAAA;EAAA,EAKA,IAAW,aAAA,GAAwB;EAClC,IAAA,OAAO,KAAK,GAAA,CAAI,IAAA,CAAK,UAAU,IAAA,CAAK,GAAA,IAAO,CAAC,CAAA;EAAA,EAC7C;EAAA;EAAA;EAAA;EAAA,EAKO,OAAA,GAAgB;EACtB,IAAA,IAAI,IAAA,CAAK,OAAA,EAAS,MAAM,IAAI,MAAM,iCAAiC,CAAA;EACnE,IAAA,IAAI,IAAA,CAAK,OAAA,EAAS,IAAA,CAAK,KAAA,EAAM;EAE7B,IAAA,IAAA,CAAK,SAAA,EAAA;EACL,IAAA,OAAO,IAAA;EAAA,EACR;EAAA;EAAA;EAAA;EAAA,EAKO,KAAA,GAAc;EACpB,IAAA,OAAO,IAAA,CAAK,cAAA,EAAe,CAAE,SAAA,EAAU;EAAA,EACxC;EAAA;EAAA;EAAA;EAAA,EAKO,cAAA,GAAuB;EAC7B,IAAA,IAAA,CAAK,SAAA,GAAY,KAAK,OAAA,CAAQ,KAAA;EAC9B,IAAA,OAAO,IAAA;EAAA,EACR;EAAA;EAAA;EAAA;EAAA,EAKO,SAAA,GAAkB;EACxB,IAAA,IAAA,CAAK,OAAA,GAAU,IAAA,CAAK,GAAA,EAAI,GAAI,KAAK,OAAA,CAAQ,IAAA;EACzC,IAAA,OAAO,IAAA;EAAA,EACR;EACD,CAAA;EA9EmC,MAAA,CAAA,UAAA,EAAA,WAAA,CAAA;AAA5B,MAAM,SAAA,GAAN;;;ECAA,IAAM,iBAAA,GAAN,MAAM,iBAAA,SAAqC,GAAA,CAAqB;EAAA;EAAA;EAAA;EAAA;EAAA,EAoB/D,WAAA,CAAY,IAAA,EAAc,KAAA,GAAQ,CAAA,EAAG;EAC3C,IAAA,KAAA,EAAM;EAjBP;EAAA;EAAA;EAAA,IAAA,aAAA,CAAA,IAAA,EAAgB,MAAA,CAAA;EAKhB;EAAA;EAAA;EAAA,IAAA,aAAA,CAAA,IAAA,EAAgB,OAAA,CAAA;EAKhB;EAAA;EAAA;EAAA,IAAA,aAAA,CAAA,IAAA,EAAQ,eAAA,CAAA;EASP,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;EACZ,IAAA,IAAA,CAAK,KAAA,GAAQ,KAAA;EAAA,EACd;EAAA;EAAA;EAAA;EAAA;EAAA,EAMO,QAAQ,EAAA,EAAqB;EACnC,IAAA,OAAO,KAAK,GAAA,CAAI,EAAE,CAAA,IAAK,IAAA,CAAK,OAAO,EAAE,CAAA;EAAA,EACtC;EAAA;EAAA;EAAA;EAAA;EAAA,EAMO,OAAO,EAAA,EAAqB;EAClC,IAAA,MAAM,KAAA,GAAQ,IAAI,SAAA,CAAU,IAAI,CAAA;EAChC,IAAA,IAAA,CAAK,GAAA,CAAI,IAAI,KAAK,CAAA;EAClB,IAAA,OAAO,KAAA;EAAA,EACR;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA,EAOgB,GAAA,CAAI,IAAO,KAAA,EAA2B;EACrD,IAAA,IAAA,CAAK,aAAA,KAAL,IAAA,CAAK,aAAA,GAAkB,WAAA,CAAY,IAAA,CAAK,MAAM,IAAA,CAAK,IAAI,CAAA,EAAG,iBAAA,CAAiB,qBAAqB,CAAA,CAAA;EAChG,IAAA,OAAO,KAAA,CAAM,GAAA,CAAI,EAAA,EAAI,KAAK,CAAA;EAAA,EAC3B;EAAA;EAAA;EAAA;EAAA,EAKO,KAAA,GAAc;EACpB,IAAA,KAAA,MAAW,CAAC,EAAA,EAAI,KAAK,CAAA,IAAK,IAAA,CAAK,SAAQ,EAAG;EACzC,MAAA,IAAI,KAAA,CAAM,OAAA,EAAS,IAAA,CAAK,MAAA,CAAO,EAAE,CAAA;EAAA,IAClC;EAEA,IAAA,IAAI,IAAA,CAAK,SAAS,CAAA,IAAK,IAAA,CAAK,kBAAkB,MAAA,IAAa,IAAA,CAAK,kBAAkB,IAAA,EAAM;EACvF,MAAA,aAAA,CAAc,KAAK,aAAa,CAAA;EAChC,MAAA,IAAA,CAAK,aAAA,GAAgB,IAAA;EAAA,IACtB;EAAA,EACD;EAMD,CAAA;EAzEuE,MAAA,CAAA,iBAAA,EAAA,kBAAA,CAAA;EAAA;EAAA;EAAA;EAwEtE,aAAA,CAxEY,mBAwEE,uBAAA,EAAwB,GAAA,CAAA;AAxEhC,MAAM,gBAAA,GAAN","file":"index.global.js","sourcesContent":["import type { RateLimitManager } from './RateLimitManager';\n\nexport class RateLimit<K = string> {\n\t/**\n\t * The remaining amount of times this entry can be dripped before the bucket is empty.\n\t */\n\tpublic remaining!: number;\n\n\t/**\n\t * The timestamp that represents when this entry will reset back to a available state.\n\t */\n\tpublic expires!: number;\n\n\t/**\n\t * The {@link RateLimitManager} this entry is for.\n\t */\n\tprivate manager: RateLimitManager<K>;\n\n\t/**\n\t * @param manager The manager for this entry.\n\t */\n\tpublic constructor(manager: RateLimitManager<K>) {\n\t\tthis.manager = manager;\n\t\tthis.reset();\n\t}\n\n\t/**\n\t * Whether this entry is expired or not, allowing the bucket to be reset.\n\t */\n\tpublic get expired(): boolean {\n\t\treturn this.remainingTime === 0;\n\t}\n\n\t/**\n\t * Whether this entry is limited or not.\n\t */\n\tpublic get limited(): boolean {\n\t\treturn this.remaining === 0 && !this.expired;\n\t}\n\n\t/**\n\t * The remaining time in milliseconds before resetting.\n\t */\n\tpublic get remainingTime(): number {\n\t\treturn Math.max(this.expires - Date.now(), 0);\n\t}\n\n\t/**\n\t * Consumes {@link RateLimit.remaining} by one if it's not limited, calling {@link RateLimit.reset} first if {@link RateLimit.expired} is true.\n\t */\n\tpublic consume(): this {\n\t\tif (this.limited) throw new Error('Cannot consume a limited bucket');\n\t\tif (this.expired) this.reset();\n\n\t\tthis.remaining--;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Resets the entry back to it's full state.\n\t */\n\tpublic reset(): this {\n\t\treturn this.resetRemaining().resetTime();\n\t}\n\n\t/**\n\t * Resets the entry's {@link RateLimit.remaining} uses back to full state.\n\t */\n\tpublic resetRemaining(): this {\n\t\tthis.remaining = this.manager.limit;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Resets the entry's {@link RateLimit.expires} to the current time plus {@link RateLimitManager.time}.\n\t */\n\tpublic resetTime(): this {\n\t\tthis.expires = Date.now() + this.manager.time;\n\t\treturn this;\n\t}\n}\n","import { RateLimit } from './RateLimit';\n\nexport class RateLimitManager<K = string> extends Map<K, RateLimit<K>> {\n\t/**\n\t * The amount of milliseconds for the {@link RateLimit ratelimits} from this manager to expire.\n\t */\n\tpublic readonly time: number;\n\n\t/**\n\t * The amount of times a {@link RateLimit} can drip before it's limited.\n\t */\n\tpublic readonly limit: number;\n\n\t/**\n\t * The interval to sweep expired {@link RateLimit ratelimits}.\n\t */\n\tprivate sweepInterval!: NodeJS.Timeout | undefined | null;\n\n\t/**\n\t * @param time The amount of milliseconds for the ratelimits from this manager to expire.\n\t * @param limit The amount of times a {@link RateLimit} can drip before it's limited.\n\t */\n\tpublic constructor(time: number, limit = 1) {\n\t\tsuper();\n\n\t\tthis.time = time;\n\t\tthis.limit = limit;\n\t}\n\n\t/**\n\t * Gets a {@link RateLimit} from this manager or creates it if it does not exist.\n\t * @param id The id for the {@link RateLimit}\n\t */\n\tpublic acquire(id: K): RateLimit<K> {\n\t\treturn this.get(id) ?? this.create(id);\n\t}\n\n\t/**\n\t * Creates a {@link RateLimit} for this manager.\n\t * @param id The id the {@link RateLimit} belongs to\n\t */\n\tpublic create(id: K): RateLimit<K> {\n\t\tconst value = new RateLimit(this);\n\t\tthis.set(id, value);\n\t\treturn value;\n\t}\n\n\t/**\n\t * Wraps Collection's set method to set interval to sweep inactive {@link RateLimit}s.\n\t * @param id The id the {@link RateLimit} belongs to\n\t * @param value The {@link RateLimit} to set\n\t */\n\tpublic override set(id: K, value: RateLimit<K>): this {\n\t\tthis.sweepInterval ??= setInterval(this.sweep.bind(this), RateLimitManager.sweepIntervalDuration);\n\t\treturn super.set(id, value);\n\t}\n\n\t/**\n\t * Wraps Collection's sweep method to clear the interval when this manager is empty.\n\t */\n\tpublic sweep(): void {\n\t\tfor (const [id, value] of this.entries()) {\n\t\t\tif (value.expired) this.delete(id);\n\t\t}\n\n\t\tif (this.size === 0 && this.sweepInterval !== undefined && this.sweepInterval !== null) {\n\t\t\tclearInterval(this.sweepInterval);\n\t\t\tthis.sweepInterval = null;\n\t\t}\n\t}\n\n\t/**\n\t * The delay in milliseconds for {@link RateLimitManager.sweepInterval}.\n\t */\n\tpublic static sweepIntervalDuration = 30_000;\n}\n"]}

package/package.json

@@ -1,29 +1,37 @@
 {
   "name": "@sapphire/ratelimits",
-  "version": "3.0.0-pr-601.2f2c308a.0",
+  "version": "3.0.0-pr-935.7da5c8bb",
   "description": "Bucket implementation for Ratelimits.",
   "author": "@sapphire",
   "license": "MIT",
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "browser": "dist/index.global.js",
-  "unpkg": "dist/index.global.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.mjs",
+  "browser": "dist/iife/index.global.js",
+  "unpkg": "dist/iife/index.global.js",
+  "types": "dist/cjs/index.d.cts",
   "exports": {
-    "import": "./dist/index.mjs",
-    "require": "./dist/index.js",
-    "types": "./dist/index.d.ts"
+    "import": {
+      "types": "./dist/esm/index.d.mts",
+      "default": "./dist/esm/index.mjs"
+    },
+    "require": {
+      "types": "./dist/cjs/index.d.cts",
+      "default": "./dist/cjs/index.cjs"
+    },
+    "browser": "./dist/iife/index.global.js"
   },
   "sideEffects": false,
   "homepage": "https://github.com/sapphiredev/utilities/tree/main/packages/ratelimits",
   "scripts": {
     "test": "vitest run",
     "lint": "eslint src tests --ext ts --fix -c ../../.eslintrc",
-    "build": "tsup",
+    "build": "yarn gen-index && tsup && yarn build:rename-cjs-index",
+    "build:rename-cjs-index": "tsx ../../scripts/rename-cjs-index.cts",
     "docs": "typedoc-json-parser",
     "prepack": "yarn build",
     "bump": "cliff-jumper",
-    "check-update": "cliff-jumper --dry-run"
+    "check-update": "cliff-jumper --dry-run",
+    "gen-index": "tsx ../../scripts/gen-index.cts ratelimits --write"
   },
   "repository": {
     "type": "git",
@@ -31,9 +39,7 @@
     "directory": "packages/ratelimits"
   },
   "files": [
-    "dist/**/*.js*",
-    "dist/**/*.mjs*",
-    "dist/**/*.d*"
+    "dist/"
   ],
   "engines": {
     "node": ">=v14.0.0",
@@ -56,12 +62,13 @@
     "access": "public"
   },
   "devDependencies": {
-    "@favware/cliff-jumper": "^2.0.1",
-    "@vitest/coverage-c8": "^0.31.1",
-    "tsup": "^6.7.0",
-    "typedoc": "^0.24.7",
-    "typedoc-json-parser": "^8.1.2",
-    "typescript": "^5.0.4",
-    "vitest": "^0.31.1"
+    "@favware/cliff-jumper": "^6.0.0",
+    "@vitest/coverage-v8": "^3.2.4",
+    "tsup": "^8.5.0",
+    "tsx": "^4.20.6",
+    "typedoc": "^0.26.11",
+    "typedoc-json-parser": "^10.2.0",
+    "typescript": "~5.4.5",
+    "vitest": "^3.2.4"
   }
 }

package/dist/index.global.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/lib/RateLimit.ts","../src/lib/RateLimitManager.ts"],"names":[],"mappings":";;;;;;;;;AAEO,IAAM,YAAN,MAA4B;AAAA;AAAA;AAAA;AAAA,EAmB3B,YAAY,SAA8B;AAfjD;AAAA;AAAA;AAAA,wBAAO;AAKP;AAAA;AAAA;AAAA,wBAAO;AAKP;AAAA;AAAA;AAAA,wBAAQ;AAMP,SAAK,UAAU;AACf,SAAK,MAAM;AAAA,EACZ;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,UAAmB;AAC7B,WAAO,KAAK,kBAAkB;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,UAAmB;AAC7B,WAAO,KAAK,cAAc,KAAK,CAAC,KAAK;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,gBAAwB;AAClC,WAAO,KAAK,IAAI,KAAK,UAAU,KAAK,IAAI,GAAG,CAAC;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA,EAKO,UAAgB;AACtB,QAAI,KAAK;AAAS,YAAM,IAAI,MAAM,iCAAiC;AACnE,QAAI,KAAK;AAAS,WAAK,MAAM;AAE7B,SAAK;AACL,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKO,QAAc;AACpB,WAAO,KAAK,eAAe,EAAE,UAAU;AAAA,EACxC;AAAA;AAAA;AAAA;AAAA,EAKO,iBAAuB;AAC7B,SAAK,YAAY,KAAK,QAAQ;AAC9B,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKO,YAAkB;AACxB,SAAK,UAAU,KAAK,IAAI,IAAI,KAAK,QAAQ;AACzC,WAAO;AAAA,EACR;AACD;AA9Ea;;;ACAN,IAAM,oBAAN,cAA2C,IAAqB;AAAA;AAAA;AAAA;AAAA;AAAA,EAoB/D,YAAY,MAAc,QAAQ,GAAG;AAC3C,UAAM;AAjBP;AAAA;AAAA;AAAA,wBAAgB;AAKhB;AAAA;AAAA;AAAA,wBAAgB;AAKhB;AAAA;AAAA;AAAA,wBAAQ;AASP,SAAK,OAAO;AACZ,SAAK,QAAQ;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,QAAQ,IAAqB;AACnC,WAAO,KAAK,IAAI,EAAE,KAAK,KAAK,OAAO,EAAE;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,OAAO,IAAqB;AAClC,UAAM,QAAQ,IAAI,UAAU,IAAI;AAChC,SAAK,IAAI,IAAI,KAAK;AAClB,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOgB,IAAI,IAAO,OAA2B;AACrD,SAAK,kBAAL,KAAK,gBAAkB,YAAY,KAAK,MAAM,KAAK,IAAI,GAAG,kBAAiB,qBAAqB;AAChG,WAAO,MAAM,IAAI,IAAI,KAAK;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA,EAKO,QAAc;AACpB,eAAW,CAAC,IAAI,KAAK,KAAK,KAAK,QAAQ,GAAG;AACzC,UAAI,MAAM;AAAS,aAAK,OAAO,EAAE;AAAA,IAClC;AAEA,QAAI,KAAK,SAAS,KAAK,KAAK,kBAAkB,MAAM;AACnD,oBAAc,KAAK,aAAa;AAChC,WAAK,gBAAgB;AAAA,IACtB;AAAA,EACD;AAMD;AAzEO,IAAM,mBAAN;AAAM;AAAA;AAAA;AAAA;AAwEZ,cAxEY,kBAwEE,yBAAwB","sourcesContent":["import type { RateLimitManager } from './RateLimitManager';\n\nexport class RateLimit<K = string> {\n\t/**\n\t * The remaining amount of times this entry can be dripped before the bucket is empty.\n\t */\n\tpublic remaining!: number;\n\n\t/**\n\t * The timestamp that represents when this entry will reset back to a available state.\n\t */\n\tpublic expires!: number;\n\n\t/**\n\t * The {@link RateLimitManager} this entry is for.\n\t */\n\tprivate manager: RateLimitManager<K>;\n\n\t/**\n\t * @param manager The manager for this entry.\n\t */\n\tpublic constructor(manager: RateLimitManager<K>) {\n\t\tthis.manager = manager;\n\t\tthis.reset();\n\t}\n\n\t/**\n\t * Whether this entry is expired or not, allowing the bucket to be reset.\n\t */\n\tpublic get expired(): boolean {\n\t\treturn this.remainingTime === 0;\n\t}\n\n\t/**\n\t * Whether this entry is limited or not.\n\t */\n\tpublic get limited(): boolean {\n\t\treturn this.remaining === 0 && !this.expired;\n\t}\n\n\t/**\n\t * The remaining time in milliseconds before resetting.\n\t */\n\tpublic get remainingTime(): number {\n\t\treturn Math.max(this.expires - Date.now(), 0);\n\t}\n\n\t/**\n\t * Consumes {@link RateLimit.remaining} by one if it's not limited, calling {@link RateLimit.reset} first if {@link RateLimit.expired} is true.\n\t */\n\tpublic consume(): this {\n\t\tif (this.limited) throw new Error('Cannot consume a limited bucket');\n\t\tif (this.expired) this.reset();\n\n\t\tthis.remaining--;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Resets the entry back to it's full state.\n\t */\n\tpublic reset(): this {\n\t\treturn this.resetRemaining().resetTime();\n\t}\n\n\t/**\n\t * Resets the entry's {@link RateLimit.remaining} uses back to full state.\n\t */\n\tpublic resetRemaining(): this {\n\t\tthis.remaining = this.manager.limit;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Resets the entry's {@link RateLimit.expires} to the current time plus {@link RateLimitManager.time}.\n\t */\n\tpublic resetTime(): this {\n\t\tthis.expires = Date.now() + this.manager.time;\n\t\treturn this;\n\t}\n}\n","import { RateLimit } from './RateLimit';\n\nexport class RateLimitManager<K = string> extends Map<K, RateLimit<K>> {\n\t/**\n\t * The amount of milliseconds for the {@link RateLimit ratelimits} from this manager to expire.\n\t */\n\tpublic readonly time: number;\n\n\t/**\n\t * The amount of times a {@link RateLimit} can drip before it's limited.\n\t */\n\tpublic readonly limit: number;\n\n\t/**\n\t * The interval to sweep expired {@link RateLimit ratelimits}.\n\t */\n\tprivate sweepInterval!: NodeJS.Timer | null;\n\n\t/**\n\t * @param time The amount of milliseconds for the ratelimits from this manager to expire.\n\t * @param limit The amount of times a {@link RateLimit} can drip before it's limited.\n\t */\n\tpublic constructor(time: number, limit = 1) {\n\t\tsuper();\n\n\t\tthis.time = time;\n\t\tthis.limit = limit;\n\t}\n\n\t/**\n\t * Gets a {@link RateLimit} from this manager or creates it if it does not exist.\n\t * @param id The id for the {@link RateLimit}\n\t */\n\tpublic acquire(id: K): RateLimit<K> {\n\t\treturn this.get(id) ?? this.create(id);\n\t}\n\n\t/**\n\t * Creates a {@link RateLimit} for this manager.\n\t * @param id The id the {@link RateLimit} belongs to\n\t */\n\tpublic create(id: K): RateLimit<K> {\n\t\tconst value = new RateLimit(this);\n\t\tthis.set(id, value);\n\t\treturn value;\n\t}\n\n\t/**\n\t * Wraps Collection's set method to set interval to sweep inactive {@link RateLimit}s.\n\t * @param id The id the {@link RateLimit} belongs to\n\t * @param value The {@link RateLimit} to set\n\t */\n\tpublic override set(id: K, value: RateLimit<K>): this {\n\t\tthis.sweepInterval ??= setInterval(this.sweep.bind(this), RateLimitManager.sweepIntervalDuration);\n\t\treturn super.set(id, value);\n\t}\n\n\t/**\n\t * Wraps Collection's sweep method to clear the interval when this manager is empty.\n\t */\n\tpublic sweep(): void {\n\t\tfor (const [id, value] of this.entries()) {\n\t\t\tif (value.expired) this.delete(id);\n\t\t}\n\n\t\tif (this.size === 0 && this.sweepInterval !== null) {\n\t\t\tclearInterval(this.sweepInterval);\n\t\t\tthis.sweepInterval = null;\n\t\t}\n\t}\n\n\t/**\n\t * The delay in milliseconds for {@link RateLimitManager.sweepInterval}.\n\t */\n\tpublic static sweepIntervalDuration = 30_000;\n}\n"]}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/lib/RateLimit.ts","../src/lib/RateLimitManager.ts"],"names":[],"mappings":";;;;;;;;;AAEO,IAAM,YAAN,MAA4B;AAAA;AAAA;AAAA;AAAA,EAmB3B,YAAY,SAA8B;AAfjD;AAAA;AAAA;AAAA,wBAAO;AAKP;AAAA;AAAA;AAAA,wBAAO;AAKP;AAAA;AAAA;AAAA,wBAAQ;AAMP,SAAK,UAAU;AACf,SAAK,MAAM;AAAA,EACZ;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,UAAmB;AAC7B,WAAO,KAAK,kBAAkB;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,UAAmB;AAC7B,WAAO,KAAK,cAAc,KAAK,CAAC,KAAK;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,gBAAwB;AAClC,WAAO,KAAK,IAAI,KAAK,UAAU,KAAK,IAAI,GAAG,CAAC;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA,EAKO,UAAgB;AACtB,QAAI,KAAK;AAAS,YAAM,IAAI,MAAM,iCAAiC;AACnE,QAAI,KAAK;AAAS,WAAK,MAAM;AAE7B,SAAK;AACL,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKO,QAAc;AACpB,WAAO,KAAK,eAAe,EAAE,UAAU;AAAA,EACxC;AAAA;AAAA;AAAA;AAAA,EAKO,iBAAuB;AAC7B,SAAK,YAAY,KAAK,QAAQ;AAC9B,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKO,YAAkB;AACxB,SAAK,UAAU,KAAK,IAAI,IAAI,KAAK,QAAQ;AACzC,WAAO;AAAA,EACR;AACD;AA9Ea;;;ACAN,IAAM,oBAAN,cAA2C,IAAqB;AAAA;AAAA;AAAA;AAAA;AAAA,EAoB/D,YAAY,MAAc,QAAQ,GAAG;AAC3C,UAAM;AAjBP;AAAA;AAAA;AAAA,wBAAgB;AAKhB;AAAA;AAAA;AAAA,wBAAgB;AAKhB;AAAA;AAAA;AAAA,wBAAQ;AASP,SAAK,OAAO;AACZ,SAAK,QAAQ;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,QAAQ,IAAqB;AACnC,WAAO,KAAK,IAAI,EAAE,KAAK,KAAK,OAAO,EAAE;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,OAAO,IAAqB;AAClC,UAAM,QAAQ,IAAI,UAAU,IAAI;AAChC,SAAK,IAAI,IAAI,KAAK;AAClB,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOgB,IAAI,IAAO,OAA2B;AACrD,SAAK,kBAAL,KAAK,gBAAkB,YAAY,KAAK,MAAM,KAAK,IAAI,GAAG,kBAAiB,qBAAqB;AAChG,WAAO,MAAM,IAAI,IAAI,KAAK;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA,EAKO,QAAc;AACpB,eAAW,CAAC,IAAI,KAAK,KAAK,KAAK,QAAQ,GAAG;AACzC,UAAI,MAAM;AAAS,aAAK,OAAO,EAAE;AAAA,IAClC;AAEA,QAAI,KAAK,SAAS,KAAK,KAAK,kBAAkB,MAAM;AACnD,oBAAc,KAAK,aAAa;AAChC,WAAK,gBAAgB;AAAA,IACtB;AAAA,EACD;AAMD;AAzEO,IAAM,mBAAN;AAAM;AAAA;AAAA;AAAA;AAwEZ,cAxEY,kBAwEE,yBAAwB","sourcesContent":["import type { RateLimitManager } from './RateLimitManager';\n\nexport class RateLimit<K = string> {\n\t/**\n\t * The remaining amount of times this entry can be dripped before the bucket is empty.\n\t */\n\tpublic remaining!: number;\n\n\t/**\n\t * The timestamp that represents when this entry will reset back to a available state.\n\t */\n\tpublic expires!: number;\n\n\t/**\n\t * The {@link RateLimitManager} this entry is for.\n\t */\n\tprivate manager: RateLimitManager<K>;\n\n\t/**\n\t * @param manager The manager for this entry.\n\t */\n\tpublic constructor(manager: RateLimitManager<K>) {\n\t\tthis.manager = manager;\n\t\tthis.reset();\n\t}\n\n\t/**\n\t * Whether this entry is expired or not, allowing the bucket to be reset.\n\t */\n\tpublic get expired(): boolean {\n\t\treturn this.remainingTime === 0;\n\t}\n\n\t/**\n\t * Whether this entry is limited or not.\n\t */\n\tpublic get limited(): boolean {\n\t\treturn this.remaining === 0 && !this.expired;\n\t}\n\n\t/**\n\t * The remaining time in milliseconds before resetting.\n\t */\n\tpublic get remainingTime(): number {\n\t\treturn Math.max(this.expires - Date.now(), 0);\n\t}\n\n\t/**\n\t * Consumes {@link RateLimit.remaining} by one if it's not limited, calling {@link RateLimit.reset} first if {@link RateLimit.expired} is true.\n\t */\n\tpublic consume(): this {\n\t\tif (this.limited) throw new Error('Cannot consume a limited bucket');\n\t\tif (this.expired) this.reset();\n\n\t\tthis.remaining--;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Resets the entry back to it's full state.\n\t */\n\tpublic reset(): this {\n\t\treturn this.resetRemaining().resetTime();\n\t}\n\n\t/**\n\t * Resets the entry's {@link RateLimit.remaining} uses back to full state.\n\t */\n\tpublic resetRemaining(): this {\n\t\tthis.remaining = this.manager.limit;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Resets the entry's {@link RateLimit.expires} to the current time plus {@link RateLimitManager.time}.\n\t */\n\tpublic resetTime(): this {\n\t\tthis.expires = Date.now() + this.manager.time;\n\t\treturn this;\n\t}\n}\n","import { RateLimit } from './RateLimit';\n\nexport class RateLimitManager<K = string> extends Map<K, RateLimit<K>> {\n\t/**\n\t * The amount of milliseconds for the {@link RateLimit ratelimits} from this manager to expire.\n\t */\n\tpublic readonly time: number;\n\n\t/**\n\t * The amount of times a {@link RateLimit} can drip before it's limited.\n\t */\n\tpublic readonly limit: number;\n\n\t/**\n\t * The interval to sweep expired {@link RateLimit ratelimits}.\n\t */\n\tprivate sweepInterval!: NodeJS.Timer | null;\n\n\t/**\n\t * @param time The amount of milliseconds for the ratelimits from this manager to expire.\n\t * @param limit The amount of times a {@link RateLimit} can drip before it's limited.\n\t */\n\tpublic constructor(time: number, limit = 1) {\n\t\tsuper();\n\n\t\tthis.time = time;\n\t\tthis.limit = limit;\n\t}\n\n\t/**\n\t * Gets a {@link RateLimit} from this manager or creates it if it does not exist.\n\t * @param id The id for the {@link RateLimit}\n\t */\n\tpublic acquire(id: K): RateLimit<K> {\n\t\treturn this.get(id) ?? this.create(id);\n\t}\n\n\t/**\n\t * Creates a {@link RateLimit} for this manager.\n\t * @param id The id the {@link RateLimit} belongs to\n\t */\n\tpublic create(id: K): RateLimit<K> {\n\t\tconst value = new RateLimit(this);\n\t\tthis.set(id, value);\n\t\treturn value;\n\t}\n\n\t/**\n\t * Wraps Collection's set method to set interval to sweep inactive {@link RateLimit}s.\n\t * @param id The id the {@link RateLimit} belongs to\n\t * @param value The {@link RateLimit} to set\n\t */\n\tpublic override set(id: K, value: RateLimit<K>): this {\n\t\tthis.sweepInterval ??= setInterval(this.sweep.bind(this), RateLimitManager.sweepIntervalDuration);\n\t\treturn super.set(id, value);\n\t}\n\n\t/**\n\t * Wraps Collection's sweep method to clear the interval when this manager is empty.\n\t */\n\tpublic sweep(): void {\n\t\tfor (const [id, value] of this.entries()) {\n\t\t\tif (value.expired) this.delete(id);\n\t\t}\n\n\t\tif (this.size === 0 && this.sweepInterval !== null) {\n\t\t\tclearInterval(this.sweepInterval);\n\t\t\tthis.sweepInterval = null;\n\t\t}\n\t}\n\n\t/**\n\t * The delay in milliseconds for {@link RateLimitManager.sweepInterval}.\n\t */\n\tpublic static sweepIntervalDuration = 30_000;\n}\n"]}

package/dist/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/lib/RateLimit.ts","../src/lib/RateLimitManager.ts"],"names":[],"mappings":";;;;;;;;;AAEO,IAAM,YAAN,MAA4B;AAAA;AAAA;AAAA;AAAA,EAmB3B,YAAY,SAA8B;AAfjD;AAAA;AAAA;AAAA,wBAAO;AAKP;AAAA;AAAA;AAAA,wBAAO;AAKP;AAAA;AAAA;AAAA,wBAAQ;AAMP,SAAK,UAAU;AACf,SAAK,MAAM;AAAA,EACZ;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,UAAmB;AAC7B,WAAO,KAAK,kBAAkB;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,UAAmB;AAC7B,WAAO,KAAK,cAAc,KAAK,CAAC,KAAK;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA,EAKA,IAAW,gBAAwB;AAClC,WAAO,KAAK,IAAI,KAAK,UAAU,KAAK,IAAI,GAAG,CAAC;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA,EAKO,UAAgB;AACtB,QAAI,KAAK;AAAS,YAAM,IAAI,MAAM,iCAAiC;AACnE,QAAI,KAAK;AAAS,WAAK,MAAM;AAE7B,SAAK;AACL,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKO,QAAc;AACpB,WAAO,KAAK,eAAe,EAAE,UAAU;AAAA,EACxC;AAAA;AAAA;AAAA;AAAA,EAKO,iBAAuB;AAC7B,SAAK,YAAY,KAAK,QAAQ;AAC9B,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKO,YAAkB;AACxB,SAAK,UAAU,KAAK,IAAI,IAAI,KAAK,QAAQ;AACzC,WAAO;AAAA,EACR;AACD;AA9Ea;;;ACAN,IAAM,oBAAN,cAA2C,IAAqB;AAAA;AAAA;AAAA;AAAA;AAAA,EAoB/D,YAAY,MAAc,QAAQ,GAAG;AAC3C,UAAM;AAjBP;AAAA;AAAA;AAAA,wBAAgB;AAKhB;AAAA;AAAA;AAAA,wBAAgB;AAKhB;AAAA;AAAA;AAAA,wBAAQ;AASP,SAAK,OAAO;AACZ,SAAK,QAAQ;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,QAAQ,IAAqB;AACnC,WAAO,KAAK,IAAI,EAAE,KAAK,KAAK,OAAO,EAAE;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,OAAO,IAAqB;AAClC,UAAM,QAAQ,IAAI,UAAU,IAAI;AAChC,SAAK,IAAI,IAAI,KAAK;AAClB,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOgB,IAAI,IAAO,OAA2B;AACrD,SAAK,kBAAL,KAAK,gBAAkB,YAAY,KAAK,MAAM,KAAK,IAAI,GAAG,kBAAiB,qBAAqB;AAChG,WAAO,MAAM,IAAI,IAAI,KAAK;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA,EAKO,QAAc;AACpB,eAAW,CAAC,IAAI,KAAK,KAAK,KAAK,QAAQ,GAAG;AACzC,UAAI,MAAM;AAAS,aAAK,OAAO,EAAE;AAAA,IAClC;AAEA,QAAI,KAAK,SAAS,KAAK,KAAK,kBAAkB,MAAM;AACnD,oBAAc,KAAK,aAAa;AAChC,WAAK,gBAAgB;AAAA,IACtB;AAAA,EACD;AAMD;AAzEO,IAAM,mBAAN;AAAM;AAAA;AAAA;AAAA;AAwEZ,cAxEY,kBAwEE,yBAAwB","sourcesContent":["import type { RateLimitManager } from './RateLimitManager';\n\nexport class RateLimit<K = string> {\n\t/**\n\t * The remaining amount of times this entry can be dripped before the bucket is empty.\n\t */\n\tpublic remaining!: number;\n\n\t/**\n\t * The timestamp that represents when this entry will reset back to a available state.\n\t */\n\tpublic expires!: number;\n\n\t/**\n\t * The {@link RateLimitManager} this entry is for.\n\t */\n\tprivate manager: RateLimitManager<K>;\n\n\t/**\n\t * @param manager The manager for this entry.\n\t */\n\tpublic constructor(manager: RateLimitManager<K>) {\n\t\tthis.manager = manager;\n\t\tthis.reset();\n\t}\n\n\t/**\n\t * Whether this entry is expired or not, allowing the bucket to be reset.\n\t */\n\tpublic get expired(): boolean {\n\t\treturn this.remainingTime === 0;\n\t}\n\n\t/**\n\t * Whether this entry is limited or not.\n\t */\n\tpublic get limited(): boolean {\n\t\treturn this.remaining === 0 && !this.expired;\n\t}\n\n\t/**\n\t * The remaining time in milliseconds before resetting.\n\t */\n\tpublic get remainingTime(): number {\n\t\treturn Math.max(this.expires - Date.now(), 0);\n\t}\n\n\t/**\n\t * Consumes {@link RateLimit.remaining} by one if it's not limited, calling {@link RateLimit.reset} first if {@link RateLimit.expired} is true.\n\t */\n\tpublic consume(): this {\n\t\tif (this.limited) throw new Error('Cannot consume a limited bucket');\n\t\tif (this.expired) this.reset();\n\n\t\tthis.remaining--;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Resets the entry back to it's full state.\n\t */\n\tpublic reset(): this {\n\t\treturn this.resetRemaining().resetTime();\n\t}\n\n\t/**\n\t * Resets the entry's {@link RateLimit.remaining} uses back to full state.\n\t */\n\tpublic resetRemaining(): this {\n\t\tthis.remaining = this.manager.limit;\n\t\treturn this;\n\t}\n\n\t/**\n\t * Resets the entry's {@link RateLimit.expires} to the current time plus {@link RateLimitManager.time}.\n\t */\n\tpublic resetTime(): this {\n\t\tthis.expires = Date.now() + this.manager.time;\n\t\treturn this;\n\t}\n}\n","import { RateLimit } from './RateLimit';\n\nexport class RateLimitManager<K = string> extends Map<K, RateLimit<K>> {\n\t/**\n\t * The amount of milliseconds for the {@link RateLimit ratelimits} from this manager to expire.\n\t */\n\tpublic readonly time: number;\n\n\t/**\n\t * The amount of times a {@link RateLimit} can drip before it's limited.\n\t */\n\tpublic readonly limit: number;\n\n\t/**\n\t * The interval to sweep expired {@link RateLimit ratelimits}.\n\t */\n\tprivate sweepInterval!: NodeJS.Timer | null;\n\n\t/**\n\t * @param time The amount of milliseconds for the ratelimits from this manager to expire.\n\t * @param limit The amount of times a {@link RateLimit} can drip before it's limited.\n\t */\n\tpublic constructor(time: number, limit = 1) {\n\t\tsuper();\n\n\t\tthis.time = time;\n\t\tthis.limit = limit;\n\t}\n\n\t/**\n\t * Gets a {@link RateLimit} from this manager or creates it if it does not exist.\n\t * @param id The id for the {@link RateLimit}\n\t */\n\tpublic acquire(id: K): RateLimit<K> {\n\t\treturn this.get(id) ?? this.create(id);\n\t}\n\n\t/**\n\t * Creates a {@link RateLimit} for this manager.\n\t * @param id The id the {@link RateLimit} belongs to\n\t */\n\tpublic create(id: K): RateLimit<K> {\n\t\tconst value = new RateLimit(this);\n\t\tthis.set(id, value);\n\t\treturn value;\n\t}\n\n\t/**\n\t * Wraps Collection's set method to set interval to sweep inactive {@link RateLimit}s.\n\t * @param id The id the {@link RateLimit} belongs to\n\t * @param value The {@link RateLimit} to set\n\t */\n\tpublic override set(id: K, value: RateLimit<K>): this {\n\t\tthis.sweepInterval ??= setInterval(this.sweep.bind(this), RateLimitManager.sweepIntervalDuration);\n\t\treturn super.set(id, value);\n\t}\n\n\t/**\n\t * Wraps Collection's sweep method to clear the interval when this manager is empty.\n\t */\n\tpublic sweep(): void {\n\t\tfor (const [id, value] of this.entries()) {\n\t\t\tif (value.expired) this.delete(id);\n\t\t}\n\n\t\tif (this.size === 0 && this.sweepInterval !== null) {\n\t\t\tclearInterval(this.sweepInterval);\n\t\t\tthis.sweepInterval = null;\n\t\t}\n\t}\n\n\t/**\n\t * The delay in milliseconds for {@link RateLimitManager.sweepInterval}.\n\t */\n\tpublic static sweepIntervalDuration = 30_000;\n}\n"]}