Circle V2 API Docs
    Preparing search index...

    Type Alias BoundFunctions<Q>

    BoundFunctions: Q extends typeof queries
        ? {
            findAllByAltText<T extends HTMLElement = HTMLElement>(
                ...args: [
                    id: Matcher,
                    options?: MatcherOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T[]>;
            findAllByDisplayValue<T extends HTMLElement = HTMLElement>(
                ...args: [
                    id: Matcher,
                    options?: MatcherOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T[]>;
            findAllByLabelText<T extends HTMLElement = HTMLElement>(
                ...args: [
                    id: Matcher,
                    options?: SelectorMatcherOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T[]>;
            findAllByPlaceholderText<T extends HTMLElement = HTMLElement>(
                ...args: [
                    id: Matcher,
                    options?: MatcherOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T[]>;
            findAllByRole<T extends HTMLElement = HTMLElement>(
                ...args: [
                    role: ByRoleMatcher,
                    options?: ByRoleOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T[]>;
            findAllByTestId<T extends HTMLElement = HTMLElement>(
                ...args: [
                    id: Matcher,
                    options?: MatcherOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T[]>;
            findAllByText<T extends HTMLElement = HTMLElement>(
                ...args: [
                    id: Matcher,
                    options?: SelectorMatcherOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T[]>;
            findAllByTitle<T extends HTMLElement = HTMLElement>(
                ...args: [
                    id: Matcher,
                    options?: MatcherOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T[]>;
            findByAltText<T extends HTMLElement = HTMLElement>(
                ...args: [
                    id: Matcher,
                    options?: MatcherOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T>;
            findByDisplayValue<T extends HTMLElement = HTMLElement>(
                ...args: [
                    id: Matcher,
                    options?: MatcherOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T>;
            findByLabelText<T extends HTMLElement = HTMLElement>(
                ...args: [
                    id: Matcher,
                    options?: SelectorMatcherOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T>;
            findByPlaceholderText<T extends HTMLElement = HTMLElement>(
                ...args: [
                    id: Matcher,
                    options?: MatcherOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T>;
            findByRole<T extends HTMLElement = HTMLElement>(
                ...args: [
                    role: ByRoleMatcher,
                    options?: ByRoleOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T>;
            findByTestId<T extends HTMLElement = HTMLElement>(
                ...args: [
                    id: Matcher,
                    options?: MatcherOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T>;
            findByText<T extends HTMLElement = HTMLElement>(
                ...args: [
                    id: Matcher,
                    options?: SelectorMatcherOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T>;
            findByTitle<T extends HTMLElement = HTMLElement>(
                ...args: [
                    id: Matcher,
                    options?: MatcherOptions,
                    waitForElementOptions?: waitForOptions,
                ],
            ): Promise<T>;
            getAllByAltText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T[];
            getAllByDisplayValue<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T[];
            getAllByLabelText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: SelectorMatcherOptions],
            ): T[];
            getAllByPlaceholderText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T[];
            getAllByRole<T extends HTMLElement = HTMLElement>(
                ...args: [role: ByRoleMatcher, options?: ByRoleOptions],
            ): T[];
            getAllByTestId<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T[];
            getAllByText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: SelectorMatcherOptions],
            ): T[];
            getAllByTitle<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T[];
            getByAltText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T;
            getByDisplayValue<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T;
            getByLabelText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: SelectorMatcherOptions],
            ): T;
            getByPlaceholderText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T;
            getByRole<T extends HTMLElement = HTMLElement>(
                ...args: [role: ByRoleMatcher, options?: ByRoleOptions],
            ): T;
            getByTestId<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T;
            getByText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: SelectorMatcherOptions],
            ): T;
            getByTitle<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T;
            queryAllByAltText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T[];
            queryAllByDisplayValue<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T[];
            queryAllByLabelText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: SelectorMatcherOptions],
            ): T[];
            queryAllByPlaceholderText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T[];
            queryAllByRole<T extends HTMLElement = HTMLElement>(
                ...args: [role: ByRoleMatcher, options?: ByRoleOptions],
            ): T[];
            queryAllByTestId<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T[];
            queryAllByText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: SelectorMatcherOptions],
            ): T[];
            queryAllByTitle<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T[];
            queryByAltText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T | null;
            queryByDisplayValue<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T | null;
            queryByLabelText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: SelectorMatcherOptions],
            ): T | null;
            queryByPlaceholderText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T | null;
            queryByRole<T extends HTMLElement = HTMLElement>(
                ...args: [role: ByRoleMatcher, options?: ByRoleOptions],
            ): T | null;
            queryByTestId<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T | null;
            queryByText<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: SelectorMatcherOptions],
            ): T | null;
            queryByTitle<T extends HTMLElement = HTMLElement>(
                ...args: [id: Matcher, options?: MatcherOptions],
            ): T | null;
        } & { [P in keyof Q]: BoundFunction<Q[P]> }
        : { [P in keyof Q]: BoundFunction<Q[P]> }

    Type Parameters

    • Q