@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.
100 lines (99 loc) • 3.26 kB
TypeScript
/**
* @module SharedLock
*/
import { type TestAPI, type SuiteAPI, type ExpectStatic, type beforeEach } from "vitest";
import { type ISerde } from "../../../serde/contracts/_module.js";
import { type ISharedLockFactory } from "../../../shared-lock/contracts/_module.js";
import { type ITimeSpan } from "../../../time-span/contracts/_module.js";
import { type Promisable } from "../../../utilities/_module.js";
/**
* IMPORT_PATH: `"@daiso-tech/core/shared-lock/test-utilities"`
* @group Utilities
*/
export type SharedLockFactoryTestSuiteSettings = {
expect: ExpectStatic;
test: TestAPI;
describe: SuiteAPI;
beforeEach: typeof beforeEach;
createSharedLockFactory: () => Promisable<{
sharedLockFactory: ISharedLockFactory;
serde: ISerde;
}>;
/**
* @default true
*/
excludeSerdeTests?: boolean;
/**
* @default true
*/
excludeEventTests?: boolean;
/**
* Enable retry for flaky tests.
* @default 0
*/
retry?: number;
/**
* @default
* ```ts
* import { TimeSpan } from "@daiso-tech/core/time-span";
*
* TimeSpan.fromMilliseconds(10)
* ```
*/
delayBuffer?: ITimeSpan;
/**
* @default
* ```ts
* import { TimeSpan } from "@daiso-tech/core/time-span";
*
* TimeSpan.fromMilliseconds(10)
* ```
*/
timeSpanEqualityBuffer?: ITimeSpan;
/**
* @default
* ```ts
* import { TimeSpan } from "@daiso-tech/core/time-span"
*
* TimeSpan.fromMilliseconds(10)
* ```
*/
eventDispatchWaitTime?: ITimeSpan;
};
/**
* The `sharedLockFactoryTestSuite` function simplifies the process of testing your custom implementation of {@link ISharedLock | `ISharedLock`} with `vitest`.
*
* IMPORT_PATH: `"@daiso-tech/core/shared-lock/test-utilities"`
* @group Utilities
* @example
* ```ts
* import { describe, expect, test, beforeEach } from "vitest";
* import { MemorySharedLockAdapter } from "@daiso-tech/core/shared-lock/memory-shared-lock-adapter";
* import { SharedLockFactory } from "@daiso-tech/core/shared-lock";
* import { EventBus } from "@daiso-tech/core/event-bus";
* import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/memory-event-bus-adapter";
* import { sharedLockFactoryTestSuite } from "@daiso-tech/core/shared-lock/test-utilities";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter";
* import type { ISharedLockData } from "@daiso-tech/core/shared-lock/contracts";
*
* describe("class: SharedLockFactory", () => {
* sharedLockFactoryTestSuite({
* createSharedLockFactory: () => {
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const sharedLockFactory = new SharedLockFactory({
* serde,
* adapter: new MemorySharedLockAdapter(),
* });
* return { sharedLockFactory, serde };
* },
* beforeEach,
* describe,
* expect,
* test,
* serde,
* });
* });
* ```
*/
export declare function sharedLockFactoryTestSuite(settings: SharedLockFactoryTestSuiteSettings): void;