@types/happo-cypress

Installation

npm install --save @types/happo-cypress

Summary

This package contains type definitions for happo-cypress (https://github.com/happo/happo-cypress#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/happo-cypress.

index.d.ts

// Type definitions for happo-cypress 3.0
// Project: https://github.com/happo/happo-cypress#readme
// Definitions by: Alexander Polyankin <https://github.com/alexanderpolyankin>
//                 Mario Beltrán Alarcón <https://github.com/Belco90>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

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

export interface HappoScreenshotOptions {
    component?: string | undefined;
    variant?: string | undefined;
    targets?: ReadonlyArray<string> | undefined;
    responsiveInlinedCanvases?: boolean | undefined;
    transformDOM?: HappoTransformDOMOptions | undefined;
}

export interface HappoTransformDOMOptions {
    selector: string;
    transform: (element: Element, document: Document) => Element;
}

export interface HappoHideDynamicElementsOptions {
    matchers?: ReadonlyArray<RegExp> | undefined;
    defaultMatchers?: ReadonlyArray<RegExp> | undefined;
    selectors?: ReadonlyArray<string> | undefined;
    defaultSelectors?: ReadonlyArray<string> | undefined;
    replace?: boolean | undefined;
}

declare global {
    namespace Cypress {
        interface Chainable {
            happoScreenshot(options?: HappoScreenshotOptions): void;
            happoHideDynamicElements(options?: HappoHideDynamicElementsOptions): void;
        }
    }
}

Additional Details

• Last updated: Mon, 26 Dec 2022 19:02:32 GMT
• Dependencies: @types/cypress
• Global values: none

Credits

These definitions were written by Alexander Polyankin, and Mario Beltrán Alarcón.