{
  "doc": {
    "id": "api/cypress-api/ensure",
    "title": "Cypress.ensure | Cypress Documentation",
    "description": "Cypress.ensure is a collection of helper methods for making assertions. They are mostly useful when writing custom queries or custom commands.",
    "section": "api",
    "source_path": "/llm/markdown/api/cypress-api/ensure.md",
    "version": "48b03b5502f7aea1d0454750cce208f775403542",
    "updated_at": "2026-05-20T19:00:20.270Z",
    "headings": [
      {
        "id": "api/cypress-api/ensure#cypress-ensure",
        "text": "Cypress.ensure",
        "level": 1
      },
      {
        "id": "api/cypress-api/ensure#syntax",
        "text": "Syntax",
        "level": 2
      },
      {
        "id": "api/cypress-api/ensure#usage",
        "text": "Usage",
        "level": 3
      },
      {
        "id": "api/cypress-api/ensure#see-also",
        "text": "See also",
        "level": 2
      }
    ]
  },
  "content": {
    "type": "root",
    "children": [
      {
        "type": "heading",
        "depth": 1,
        "children": [
          {
            "type": "text",
            "value": "Cypress.ensure"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "`Cypress.ensure` is a collection of helper methods for making assertions. They are mostly useful when writing "
          },
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/api/cypress-api/custom-queries.md",
            "children": [
              {
                "type": "text",
                "value": "custom queries"
              }
            ]
          },
          {
            "type": "text",
            "value": " or "
          },
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/api/cypress-api/custom-commands.md",
            "children": [
              {
                "type": "text",
                "value": "custom commands"
              }
            ]
          },
          {
            "type": "text",
            "value": "."
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Most functions on `Cypress.ensure` accept a "
          },
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/app/core-concepts/introduction-to-cypress.md#Subject-Management",
            "children": [
              {
                "type": "text",
                "value": "`subject`"
              }
            ]
          },
          {
            "type": "text",
            "value": " argument, check an assertion, and throw an error if the assertion fails. These functions have no return value."
          }
        ]
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "Syntax"
          }
        ]
      },
      {
        "type": "code",
        "lang": null,
        "meta": null,
        "value": "// Type of argumentCypress.ensure.isType(subject, type, commandName, cy)​Cypress.ensure.isElement(subject, commandName, cy)​Cypress.ensure.isWindow(subject, commandName, cy)Cypress.ensure.isDocument(subject, commandName, cy)​// State of DOM elementCypress.ensure.isAttached(subject, commandName, cy)​Cypress.ensure.isNotDisabled(subject, commandName)​Cypress.ensure.isNotHiddenByAncestors(subject, commandName)​Cypress.ensure.isNotReadonly(subject, commandName)​Cypress.ensure.isScrollable(subject, commandName)​Cypress.ensure.isStrictlyVisible(subject, commandName)​Cypress.ensure.isVisible(subject, commandName)​"
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Many of these functions accept an optional `onFail` argument. This is a legacy feature used to customize the thrown error, and may be removed in a future release; we recommend against relying on it. If you need more control over the error thrown, write your own `ensure` function instead."
          }
        ]
      },
      {
        "type": "heading",
        "depth": 3,
        "children": [
          {
            "type": "text",
            "value": "Usage"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Correct Usage"
          }
        ]
      },
      {
        "type": "code",
        "lang": null,
        "meta": null,
        "value": "Cypress.Commands.addQuery('getChildById', function (id) {  return (subject) => {    // Verify that the subject is an element, document, or window object    Cypress.ensure.isType(      subject,      ['element', 'document', 'window'],      'getChildById',      cy    )    return $$(`#${id}`, subject)  }})const queryName = 'verifyElementActionable'Cypress.Commands.addQuery(queryName, function (...args) {  return (subject) => {    // Verify that the subject fulfills a variety of conditions    Cypress.ensure.isElement(subject, queryName, cy)    Cypress.ensure.isVisible(subject, queryName, cy)    Cypress.ensure.isNotDisabled(subject, queryName, cy)    Cypress.ensure.isNotReadonly(subject, queryName, cy)    return subject  }})"
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "See also"
          }
        ]
      },
      {
        "type": "list",
        "ordered": false,
        "start": null,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/api/cypress-api/custom-queries.md",
                    "children": [
                      {
                        "type": "text",
                        "value": "\"Custom Queries\""
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": " contains more information about writing custom queries, which is the main use-case for the `ensure` functions."
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "token_estimate": 295
}