attempt result interface

Author: williamd5

lib/AttemptResult.js

@@ -0,0 +1 @@
+export {};

src/AttemptResult.ts

@@ -0,0 +1,32 @@
+import {RateLimit} from "./RateLimit";
+
+/**
+ * The result from a rate limit attempt
+ * @interface
+ */
+export interface AttemptResult {
+    /**
+     * The number of requests this rate limit allows per time window
+     */
+    limit: number;
+
+    /**
+     * The number of requests remaining in the current time window
+     */
+    remaining: number;
+
+    /**
+     * The number of seconds until the current time window resets
+     */
+    reset: number;
+
+    /**
+     * The rate limit that this attempt was made on
+     */
+    rateLimit: RateLimit;
+
+    /**
+     * Whether this attempt should be allowed to proceed. If false, the attempt is rate limited.
+     */
+    allow: boolean;
+}