feat: add a way to get the last-known rate limit status for a client

src/client.ts

@@ -1,6 +1,7 @@
 import type { Credentials } from "./gateway/creds";
 import type { Gateway } from "./gateway/gateway";
 import type { ClientAuth } from "./gateway/oauth";
+import type { RateLimit } from "./gateway/types";
 import type { Maybe } from "./helper/types";
 
 import { AnonGateway } from "./gateway/anon";
@@ -142,6 +143,17 @@ export class Client {
    */
   public readonly gateway: Gateway;
 
+  /**
+   * Get the last-known rate limit status for this client.
+   *
+   * @note The rate limit status is only updated when a request is made from
+   * this client. It will also get out of sync if there are multiple clients
+   * using the same authorization (and thus the same rate limit pool).
+   */
+  get rateLimit(): Maybe<RateLimit> {
+    return this.gateway.getRateLimit();
+  }
+
   /**
    * Make a new snoots Client.
    *

src/gateway/gateway.ts

@@ -128,6 +128,11 @@ export abstract class Gateway {
     return await this.doPost(path, jsonOptions, query);
   }
 
+  /** @internal */
+  public getRateLimit(): Maybe<RateLimit> {
+    return this.rateLimit ? { ...this.rateLimit } : undefined;
+  }
+
   protected abstract auth(): Promise<Maybe<Auth>>;
 
   protected async doPost<T>(

src/gateway/index.ts

@@ -3,4 +3,4 @@
 export type { Credentials } from "./creds";
 export type { Gateway } from "./gateway";
 export type { ClientAuth, TokenAuth, UsernameAuth } from "./oauth";
-// export type { Query, QueryValue } from "./types";
+export type { RateLimit } from "./types";