@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.
46 lines (45 loc) • 1.88 kB
TypeScript
/**
* @module RateLimiter
*/
import { type TestAPI, type SuiteAPI, type ExpectStatic, type beforeEach } from "vitest";
import { type IRateLimiterStorageAdapter } from "../../../rate-limiter/contracts/_module.js";
import { type Promisable } from "../../../utilities/_module.js";
/**
*
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter/test-utilities"`
* @group TestUtilities
*/
export type RateLimiterStorageAdapterTestSuiteSettings = {
expect: ExpectStatic;
test: TestAPI;
describe: SuiteAPI;
beforeEach: typeof beforeEach;
createAdapter: () => Promisable<IRateLimiterStorageAdapter>;
};
/**
* The `rateLimiterStorageAdapterTestSuite` function simplifies the process of testing your custom implementation of {@link IRateLimiterStorageAdapter | `IRateLimiterStorageAdapter`} with `vitest`.
*
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter/test-utilities"`
* @group TestUtilities
* @example
* ```ts
* import { afterEach, beforeEach, describe, expect, test } from "vitest";
* import { rateLimiterStorageAdapterTestSuite } from "@daiso-tech/core/rate-limiter/test-utilities";
* import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storage-adapter";
* import { TimeSpan } from "@daiso-tech/core/time-span" from "@daiso-tech/core/time-span";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter";
* import { Serde } from "@daiso-tech/core/serde";
*
* describe("class: MemoryRateLimiterStorageAdapter", () => {
* rateLimiterStorageAdapterTestSuite({
* createAdapter: () =>
* new MemoryRateLimiterStorageAdapter(),
* test,
* beforeEach,
* expect,
* describe,
* });
* });
* ```
*/
export declare function rateLimiterStorageAdapterTestSuite(settings: RateLimiterStorageAdapterTestSuiteSettings): void;