@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.
40 lines (39 loc) • 1.48 kB
TypeScript
/**
* @module FileStorage
*/
import { type beforeEach, type ExpectStatic, type SuiteAPI, type TestAPI } from "vitest";
import { type IReadableContext } from "../../../execution-context/contracts/_module.js";
import { type IFileStorageAdapter } from "../../../file-storage/contracts/_module.js";
import { type Promisable } from "../../../utilities/_module.js";
/**
* IMPORT_PATH: `"@daiso-tech/core/file-storage/test-utilities"`
* @group TestUtilities
*/
export type FileStorageAdapterTestSuiteSettings = {
expect: ExpectStatic;
test: TestAPI;
describe: SuiteAPI;
beforeEach: typeof beforeEach;
createAdapter: () => Promisable<IFileStorageAdapter>;
/**
* @default true
*/
enableGetMetaData?: boolean;
/**
* @default
* ```ts
* import { ExecutionContext } from "@daiso-tech/core/execution-context"
* import { NoOpExecutionContextAdapter } from "@daiso-tech/core/execution-context/no-op-execution-context-adapter"
*
* new ExecutionContext(new NoOpExecutionContextAdapter())
* ```
*/
context?: IReadableContext;
};
/**
* The `fileStorageAdapterTestSuite` function simplifies the process of testing your custom implementation of {@link IFileStorageAdapter | `IFileStorageAdapter`} with `vitest`.
*
* IMPORT_PATH: `"@daiso-tech/core/file-storage/test-utilities"`
* @group TestUtilities
*/
export declare function fileStorageAdapterTestSuite(settings: FileStorageAdapterTestSuiteSettings): void;