docsearch/cypress/support/commands.d.ts

/// <reference types="cypress" />

declare namespace Cypress {
  interface Chainable {
    /**
     * Ensures the modal is visible and focused.
     */
    modalIsVisibleAndFocused: () => void;
    /**
     * Ensures the modal not visible.
     */
    modalIsNotVisible: () => void;
    /**
     * Toggles the dark mode on the preview website.
     */
    darkmode: () => void;
    /**
     * Wait for the page to load.
     */
    waitLoad: () => void;
    /**
     * Opens the DocSearch modal.
     */
    openModal: () => void;
    /**
     * Closes the DocSearch modal.
     */
    closeModal: () => void;
    /**
     * Search for a given query.
     */
    search: (query: string) => void;
    /**
     * Types a query that returns results.
     */
    typeQueryMatching: () => void;

    /**
     * Clears the search input.
     */
    clearSearch: () => void;
    /**
     * Types a query that returns no results.
     */
    typeQueryNotMatching: () => void;
    /**
     * Returns to the keyword search screen.
     */
    returnToSearch: () => void;
    /**
     * Navigates to the Ask AI screen.
     */
    goToAskAi: () => void;
  }
}