feat: add getConfiguration() method

Author: Jblew

README.md

@@ -195,6 +195,7 @@ const limiter = FirebaseFunctionsRateLimiter.mock()
 
 - `isQuotaAlreadyExceeded(qualifier?: string)` — Checks if quota was exceed, but does not record a usage. If you use this, you must call isQuotaExceededOrRecordUsage() to record the usage.
 
+- `getConfiguration()` — Returns this rate limiter configuration.
   
 
 - ~~`isQuotaExceeded(qualifier?: string)`~~ — **deprecated**: renamed to isQuotaExceededOrRecordUsage

src/FirebaseFunctionsRateLimiter.integration.test.ts

@@ -254,6 +254,13 @@ describe("FirebaseFunctionsRateLimiter", () => {
                     expect(_.keys(collection).length).to.be.equal(1);
                 });
             });
+
+            describe("getConfiguration", () => {
+                it("Returns correct configuration", () => {
+                    const { rateLimiter, config } = mock("firestore", { maxCalls: 5 });
+                    expect(rateLimiter.getConfiguration()).to.deep.include(config);
+                });
+            });
         }),
     );
 });

src/FirebaseFunctionsRateLimiter.mock.integration.test.ts

@@ -49,5 +49,6 @@ export function mock(
         uniqueDocName,
         rateLimiter,
         getDocument,
+        config,
     };
 }

src/FirebaseFunctionsRateLimiter.ts

@@ -146,6 +146,13 @@ export class FirebaseFunctionsRateLimiter {
         );
     }
 
+    /**
+     * Returns this rate limiter configuration
+     */
+    public getConfiguration(): FirebaseFunctionsRateLimiterConfiguration {
+        return this.configurationFull;
+    }
+
     /*
      * Private methods
      */