@daiso-tech/core
Version:
The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.
61 lines (60 loc) • 2.52 kB
TypeScript
/**
* @module RateLimiter
*/
import { type TestAPI, type SuiteAPI, type ExpectStatic, type beforeEach } from "vitest";
import { type ConstantBackoffSettingsEnum } from "../../../backoff-policies/_module.js";
import { type IRateLimiterAdapter } from "../../../rate-limiter/contracts/_module.js";
import { type FixedWindowLimiterSettings } from "../../../rate-limiter/implementations/policies/_module.js";
import { type Promisable } from "../../../utilities/_module.js";
/**
*
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter/test-utilities"`
* @group TestUtilities
*/
export type FixedWindowLimiterTestSuiteSettings = {
expect: ExpectStatic;
test: TestAPI;
describe: SuiteAPI;
beforeEach: typeof beforeEach;
createAdapter: () => Promisable<IRateLimiterAdapter>;
};
/**
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter/test-utilities"`
* @group TestUtilities
*
* @example
* ```ts
* import { beforeEach, describe, expect, test } from "vitest";
* import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-adapter";
* import { FixedWindowLimiter } from "@daiso-tech/core/rate-limiter/policies";
* import { fixedWindowLimiterTestSuite } from "@daiso-tech/core/rate-limiter/test-utilities";
* import { constantBackoff } from "@daiso-tech/core/backoff-policies";
* import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storage-adapter";
*
* describe("fixed-window-limiter class: DatabaseRateLimiterAdapter", () => {
* fixedWindowLimiterTestSuite({
* createAdapter: () => {
* const adapter = new DatabaseRateLimiterAdapter({
* adapter: new MemoryRateLimiterStorageAdapter(),
* backoffPolicy: constantBackoff(
* fixedWindowLimiterTestSuite.backoffPolicySettings,
* ),
* rateLimiterPolicy: new FixedWindowLimiter(
* fixedWindowLimiterTestSuite.rateLimiterPolicySettings,
* ),
* });
* return adapter;
* },
* beforeEach,
* describe,
* expect,
* test,
* });
* });
* ```
*/
export declare function fixedWindowLimiterTestSuite(settings: FixedWindowLimiterTestSuiteSettings): void;
export declare namespace fixedWindowLimiterTestSuite {
var rateLimiterPolicySettings: Required<FixedWindowLimiterSettings>;
var backoffPolicySettings: Required<ConstantBackoffSettingsEnum>;
}