import type { Test } from "./types/Test.js";
import type { TestResult } from "./types/TestResult.js";
/**
 * Takes a `Test` object and returns a promise with a `TestResult`.
 *
 * @category Test
 * @example
 * ```typescript
 * test({
 * 	given: "🟢",
 * 	must: "🟩",
 * 	received: () => "🟩",
 * 	wanted: () => "🟩",
 * }); // Promise<{ given: "🟢", , must: "🟩" }>
 * test({
 * 	given: "🟢",
 * 	must: "🟩",
 * 	received: () => "❌",
 * 	wanted: () => "🟩",
 * }); // Promise<{ differences: [...], given: "🟢", , must: "🟩" }>
 * ```
 * @param test A `Test` object.
 * @returns A promise with a `TestResult` object.
 */
export declare const test: <Value>({
	given,
	must,
	received,
	wanted,
}: Test<Value>) => Promise<TestResult>;