@ix-xs/twitch.api 2.0.1 → 2.0.2

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to `@ix-xs/twitch.api` are documented here. This project
 adheres to [Semantic Versioning](https://semver.org).
 
+## 2.0.2
+
+### Fixed
+
+- `twitch.rateLimitOf()` returned `undefined` on a client with little traffic.
+  Twitch reports a reset time that is already reached when the bucket is
+  nearly full, and the client took that for a finished window. It now reports
+  the bucket as full once its reset time has passed.
+
 ## 2.0.1
 
 ### Changed

package/dist/index.cjs

@@ -3104,7 +3104,8 @@ var RateLimiter = class {
     if (!state) return 0;
     const now = Date.now();
     if (now >= state.resetAt) {
-      this.#buckets.delete(bucket);
+      if (state.limit === 0) this.#buckets.delete(bucket);
+      else state.remaining = state.limit;
       return 0;
     }
     if (state.remaining > 0) {
@@ -3638,7 +3639,8 @@ var Twitch = class _Twitch {
   }
   rateLimitOf(userId) {
     const state = this.#shared.limiter.get(userId ? `user:${userId}` : "app");
-    return state && state.resetAt > Date.now() ? { ...state } : void 0;
+    if (!state || state.limit === 0) return void 0;
+    return state.resetAt > Date.now() ? { ...state } : { ...state, remaining: state.limit };
   }
   close() {
     this.#shared.auth.close();

package/dist/index.d.cts

@@ -11218,6 +11218,10 @@ declare class Twitch {
     /**
      * What is known about a rate limit bucket: the app token's by default, a
      * user's when you pass their ID. `undefined` until Twitch has reported it.
+     *
+     * `resetAt` is when the bucket is full again. Twitch refills it as time
+     * passes, so with little traffic that moment is always close: once it has
+     * passed, the bucket is reported full.
      */
     rateLimitOf(userId?: string): {
         limit: number;

package/dist/index.d.ts

@@ -11218,6 +11218,10 @@ declare class Twitch {
     /**
      * What is known about a rate limit bucket: the app token's by default, a
      * user's when you pass their ID. `undefined` until Twitch has reported it.
+     *
+     * `resetAt` is when the bucket is full again. Twitch refills it as time
+     * passes, so with little traffic that moment is always close: once it has
+     * passed, the bucket is reported full.
      */
     rateLimitOf(userId?: string): {
         limit: number;

package/dist/index.js

@@ -3102,7 +3102,8 @@ var RateLimiter = class {
     if (!state) return 0;
     const now = Date.now();
     if (now >= state.resetAt) {
-      this.#buckets.delete(bucket);
+      if (state.limit === 0) this.#buckets.delete(bucket);
+      else state.remaining = state.limit;
       return 0;
     }
     if (state.remaining > 0) {
@@ -3636,7 +3637,8 @@ var Twitch = class _Twitch {
   }
   rateLimitOf(userId) {
     const state = this.#shared.limiter.get(userId ? `user:${userId}` : "app");
-    return state && state.resetAt > Date.now() ? { ...state } : void 0;
+    if (!state || state.limit === 0) return void 0;
+    return state.resetAt > Date.now() ? { ...state } : { ...state, remaining: state.limit };
   }
   close() {
     this.#shared.auth.close();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ix-xs/twitch.api",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "The whole Twitch API, typed. A zero-dependency client for JavaScript and TypeScript: all 149 Helix endpoints and 83 EventSub events, with tokens, rate limits, pagination and reconnects handled for you.",
   "keywords": [
     "twitch",