> For the complete documentation index, see [llms.txt](https://docs.oxygenhq.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.oxygenhq.org/download-installation-start/modules/module-eyes.md).

# eyes

## check

Preform visual validation for a certain target.

**Parameters:**

| Name   | Type     | Description                             |
| ------ | -------- | --------------------------------------- |
| `name` | `string` | A name to be associated with the match. |

## checkWindow

Takes a snapshot of the application under test and matches it withthe expected output.

## dispose

Closes Applitools Eyes session, terminates the sequence of checkpoints, and then waits for and returns the test results.

**Returns:**

`TestResult` - Eyes test result.

## init

Initializes Applitools Eyes session.

**Parameters:**

| Name     | Type               | Description                                                                              |
| -------- | ------------------ | ---------------------------------------------------------------------------------------- |
| `module` | `string`\|`object` | A module name or a reference to the mododule to be associated with Eyes current session. |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.oxygenhq.org/download-installation-start/modules/module-eyes.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
