cli-testing-library/dist/esm/query-helpers.d.ts

Simple and complete CLI testing utilities that encourage good testing practices.

import { waitForOptions as WaitForOptions } from './wait-for.js';
import { Variant } from './suggestions.js';
import { TestInstance } from './types.js';
import { Matcher, MatcherOptions } from './matches.js';
export type WithSuggest = {
    suggest?: boolean;
};
export type GetErrorFunction<TArguments extends Array<any> = [string]> = (c: TestInstance | null, ...args: TArguments) => string;
export interface SelectorMatcherOptions extends MatcherOptions {
    selector?: string;
    ignore?: boolean | string;
}
export type QueryMethod<TArguments extends Array<any>, TReturn> = (container: TestInstance, ...args: TArguments) => TReturn;
declare function getInstanceError(message: string | null, instance: TestInstance): Error;
declare function makeFindQuery<TQueryFor>(getter: (container: TestInstance, text: Matcher, options?: MatcherOptions) => TQueryFor): <T extends TestInstance = TestInstance>(instance: TestInstance, text: Matcher, options?: MatcherOptions, waitForOptions?: WaitForOptions) => Promise<T>;
declare const wrapSingleQueryWithSuggestion: <TArguments extends Array<unknown>>(query: (container: TestInstance, ...args: TArguments) => TestInstance | null, queryByName: string, variant: Variant) => <T extends TestInstance = TestInstance>(container: TestInstance, ...args: TArguments) => T;
declare function buildQueries(queryBy: QueryMethod<[
    matcher: Matcher,
    options?: MatcherOptions
], TestInstance | null>, getMissingError: GetErrorFunction<[
    matcher: Matcher,
    options?: MatcherOptions
]>): readonly [<T extends TestInstance = TestInstance>(container: TestInstance, matcher: Matcher, options?: MatcherOptions | undefined) => T, <T extends TestInstance = TestInstance>(container: TestInstance, matcher: Matcher, options?: MatcherOptions | undefined) => T, <T extends TestInstance = TestInstance>(instance: TestInstance, text: Matcher, options?: MatcherOptions, waitForOptions?: WaitForOptions) => Promise<T>];
export { getInstanceError, wrapSingleQueryWithSuggestion, makeFindQuery, buildQueries, };