cypress-wait-on-last/dist/index.d.ts

Wait for the last matched Cypress alias, with optional validation. Continuously checks the latest matching interception and only returns when valid. Useful for handling unknown request counts or race conditions.

import type { Interception, WaitOptions } from "cypress/types/net-stubbing";
declare global {
    namespace Cypress {
        interface WaitOnLastOptions extends Partial<WaitOptions> {
            errorMessage?: string;
            requireValidation?: boolean;
            displayMessage?: string;
        }
        type WaitOnLastValidate<T> = (data?: Interception<T>) => boolean | void;
        interface WaitOnLastParams<T> {
            alias: string;
            validate?: WaitOnLastValidate<T>;
            options?: WaitOnLastOptions;
        }
        interface Chainable {
            waitOnLast<T = any>(alias: string, validate?: (data?: Nullable<Interception<T>>) => boolean | void, options?: {
                errorMessage?: string;
                requireValidation?: boolean;
                displayMessage?: string;
            } & Partial<WaitOptions>): Chainable<Interception<T>>;
            waitOnLast<T = any>(alias: string, options?: {
                errorMessage?: string;
                requireValidation?: boolean;
                displayMessage?: string;
            } & Partial<WaitOptions>): Chainable<Interception<T>>;
        }
    }
}