# @types/happo-cypress

> TypeScript definitions for happo-cypress

Latest version **4.1.4** (published 2023-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/happo-cypress
pnpm add @types/happo-cypress
yarn add @types/happo-cypress
bun add @types/happo-cypress
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 4.1.4 |
| Published | 2023-11-21 |
| First published | 2021-02-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51437 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/happo-cypress
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/happo-cypress
- npm.io page: https://npm.io/package/@types/happo-cypress

## Dependencies (1)

- [cypress](https://npm.io/package/cypress.md) >=6.4.0

## Recent versions

- 4.1.4 (latest) — 2023-11-21
- 4.1.1 (ts4.3) — 2023-07-31
- 3.0.2 (ts4.2) — 2022-12-26
- 3.0.1 (ts4.0) — 2022-07-13
- 3.0.0 (ts3.9) — 2022-04-21
- 1.17.2 (ts3.6) — 2021-07-08
- 1.17.1 (ts3.4) — 2021-02-25
- 4.1.3 — 2023-11-07
- 4.1.2 — 2023-10-18
- 4.1.0 — 2023-03-14
- 1.17.0 — 2021-02-18

## README

# 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](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/happo-cypress/index.d.ts)
````ts
/// <reference types="cypress" />

export interface HappoScreenshotTarget {
    name: string;
    browser: string;
    viewport: string;
}

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

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

export interface HappoHideDynamicElementsOptions {
    matchers?: readonly RegExp[] | undefined;
    defaultMatchers?: readonly RegExp[] | undefined;
    selectors?: readonly string[] | undefined;
    defaultSelectors?: readonly string[] | undefined;
    replace?: boolean | undefined;
}

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

````

### Additional Details
 * Last updated: Mon, 20 Nov 2023 23:36:24 GMT
 * Dependencies: [cypress](https://npmjs.com/package/cypress)

# Credits
These definitions were written by [Alexander Polyankin](https://github.com/alexanderpolyankin), and [Mario Beltrán Alarcón](https://github.com/Belco90).

---
_Source: https://npm.io/package/@types/happo-cypress · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._