export type ConfigFor
= {
[K in keyof P]: P[K] extends string
? string[]
: P[K] extends number
? number[]
: P[K] extends boolean
? boolean[] | boolean
: never
}
export interface Scenario {
name: string
config: Record
only: boolean
fn: (props: Record) => Promise
}
export interface ScenarioVariant {
scenario: Scenario
props: Record
}
export interface CurrentScenario {
scenario: ScenarioVariant
iface: FullInterface
measurements: Map<
string,
{
value: number
unit: string
}
>
}
export type Interface = Partial
export interface FullInterface {
filterScenarios(scenarios: Scenario[]): Promise
filterScenarioVariants(
scenarioVariants: ScenarioVariant[]
): Promise
start(
scenario: string,
props: Record
): Promise
measurement(
scenario: string,
props: Record,
name: string,
value: number,
unit: string,
relativeTo?: string
): Promise
end(
scenario: string,
props: Record
): Promise
error(
scenario: string,
props: Record,
error: unknown
): Promise
finish(): Promise
}
export function intoFullInterface(iface: Interface): FullInterface {
return {
filterScenarios: iface.filterScenarios ?? (async (scenarios) => scenarios),
filterScenarioVariants:
iface.filterScenarioVariants ??
(async (scenarioVariants) => scenarioVariants),
start: iface.start ?? (async () => {}),
measurement: iface.measurement ?? (async () => {}),
end: iface.end ?? (async () => {}),
error: iface.error ?? (async () => {}),
finish: iface.finish ?? (async () => {}),
}
}
export {
describe,
measureTime,
reportMeasurement,
PREVIOUS,
} from './describe.js'
export { runScenarios } from './runner.js'