cypress

property animationDistanceThreshold

animationDistanceThreshold: number;

• The distance in pixels an element must exceed over time to be considered animating

  5

property scrollBehavior

scrollBehavior: scrollBehaviorOptions;

• Viewport position to which an element should be scrolled prior to action commands. Setting false disables scrolling.

  'top'

property waitForAnimations

waitForAnimations: boolean;

• Whether to wait for elements to finish animating before executing commands

  true

call signature

(
    action: 'uncaught:exception',
    fn: (
        error: Error,
        runnable: Mocha.Runnable,
        promise?: Promise<any>
    ) => false | void
): Cypress;

• Fires when an uncaught exception or unhandled rejection occurs in your application. If it's an unhandled rejection, the rejected promise will be the 3rd argument. Cypress will fail the test when this fires. Return false from this event and Cypress will not fail the test. Also useful for debugging purposes because the actual error instance is provided to you.

  Example 1

  ``` // likely want to do this in a support file // so it's applied to all spec files // cypress/support/{e2e|component}.js

  Cypress.on('uncaught:exception', (err, runnable) => { // returning false here prevents Cypress from // failing the test return false }) // stub "window.alert" in a single test it('shows alert', () => { const stub = cy.stub() cy.on('window:alert', stub) // trigger application code that calls alert(...) .then(() => { expect(stub).to.have.been.calledOnce }) }) ```

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(
    action: 'window:confirm',
    fn:
        | ((text: string) => false | void)
        | SinonSpyAgent<sinon.SinonSpy>
        | SinonSpyAgent<sinon.SinonStub>
): Cypress;

• Fires when your app calls the global window.confirm() method. Cypress will auto accept confirmations. Return false from this event and the confirmation will be canceled.

  Example 1

  ``` cy.on('window:confirm', (str) => { console.log(str) return false // simulate "Cancel" }) ```

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(action: 'scrolled', fn: ($el: JQuery) => void): Cypress;

• Fires whenever **Cypress** is scrolling your application. This event is fired when Cypress is {% url 'waiting for and calculating actionability' interacting-with-elements %}. It will scroll to 'uncover' elements currently being covered. This event is extremely useful to debug why Cypress may think an element is not interactive.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(
    action: 'command:enqueued',
    fn: (command: EnqueuedCommandAttributes) => void
): Cypress;

• Fires when a cy command is first invoked and enqueued to be run later. Useful for debugging purposes if you're confused about the order in which commands will execute.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(action: 'command:start', fn: (command: CommandQueue) => void): Cypress;

• Fires when cy begins actually running and executing your command. Useful for debugging and understanding how the command queue is async.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(action: 'command:end', fn: (command: CommandQueue) => void): Cypress;

• Fires when cy finishes running and executing your command. Useful for debugging and understanding how commands are handled.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(action: 'skipped:command:end', fn: (command: CommandQueue) => void): Cypress;

• Fires when a command is skipped, namely the should command. Useful for debugging and understanding how commands are handled.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(action: 'command:retry', fn: (command: CommandQueue) => void): Cypress;

• Fires whenever a command begins its retrying routines. This is called on the trailing edge after Cypress has internally waited for the retry interval. Useful to understand **why** a command is retrying, and generally includes the actual error causing the retry to happen. When commands fail the final error is the one that actually bubbles up to fail the test. This event is essentially to debug why Cypress is failing.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(action: 'log:added', fn: (attributes: ObjectLike, log: any) => void): Cypress;

• Fires whenever a command emits this event so it can be displayed in the Command Log. Useful to see how internal cypress commands utilize the {% url 'Cypress.log()' cypress-log %} API.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(action: 'log:changed', fn: (attributes: ObjectLike, log: any) => void): Cypress;

• Fires whenever a command's attributes changes. This event is debounced to prevent it from firing too quickly and too often. Useful to see how internal cypress commands utilize the {% url 'Cypress.log()' cypress-log %} API.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(
    action: 'test:before:run',
    fn: (attributes: ObjectLike, test: Mocha.Test) => void
): Cypress;

• Fires before the test and all **before** and **beforeEach** hooks run.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(
    action: 'test:before:run:async',
    fn: (attributes: ObjectLike, test: Mocha.Test) => void | Promise<any>
): Cypress;

• Fires before the test and all **before** and **beforeEach** hooks run. If a Promise is returned, it will be awaited before proceeding.

call signature

(
    action: 'window:alert',
    fn:
        | ((text: string) => void)
        | SinonSpyAgent<sinon.SinonSpy>
        | SinonSpyAgent<sinon.SinonStub>
): Cypress;

• Fires when your app calls the global window.alert() method. Cypress will auto accept alerts. You cannot change this behavior.

  Example 1

  ``` const stub = cy.stub() cy.on('window:alert', stub) // assume the button calls window.alert() cy.get('.my-button') .click() .then(() => { expect(stub).to.have.been.calledOnce }) ```

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(
    action: 'test:after:run',
    fn: (attributes: ObjectLike, test: Mocha.Test) => void
): Cypress;

• Fires after the test and all **afterEach** and **after** hooks run.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(action: 'window:before:load', fn: (win: AUTWindow) => void): Cypress;

• Fires as the page begins to load, but before any of your applications JavaScript has executed. This fires at the exact same time as cy.visit() onBeforeLoad callback. Useful to modify the window on a page transition.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(action: 'window:load', fn: (win: AUTWindow) => void): Cypress;

• Fires after all your resources have finished loading after a page transition. This fires at the exact same time as a cy.visit() onLoad callback.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(
    action: 'window:before:unload',
    fn: (event: BeforeUnloadEvent) => void
): Cypress;

• Fires when your application is about to navigate away. The real event object is provided to you. Your app may have set a returnValue on the event, which is useful to assert on.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(action: 'window:unload', fn: (event: Event) => void): Cypress;

• Fires when your application is has unloaded and is navigating away. The real event object is provided to you. This event is not cancelable.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(action: 'url:changed', fn: (url: string) => void): Cypress;

• Fires whenever Cypress detects that your application's URL has changed.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(
    action: 'fail',
    fn: (error: CypressError, mocha: Mocha.Runnable) => void
): Cypress;

• Fires when the test has failed. It is technically possible to prevent the test from actually failing by binding to this event and invoking an async done callback. However this is **strongly discouraged**. Tests should never legitimately fail. This event exists because it's extremely useful for debugging purposes.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

call signature

(action: 'viewport:changed', fn: (viewport: Viewport) => void): Cypress;

• Fires whenever the viewport changes via a cy.viewport() or naturally when Cypress resets the viewport to the default between tests. Useful for debugging purposes.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

property webSocketDebuggerUrl

webSocketDebuggerUrl: string;

property dimensions

dimensions?: Dimensions;

property path

path?: string;

property size

size?: number;

property buildOptions

buildOptions: Record<string, any>;

property root

root: string;

property sourceRoot

sourceRoot: string;

property type

type: 'query' | 'static';

• The type of alias to store, which impacts how the value is retrieved later in the test. If an alias should be a 'query' (re-runs all queries leading up to the resulting value so it's alway up-to-date) or a 'static' (read once when the alias is saved and is never updated). type has no effect when aliasing intercepts, spies, and stubs.

  'query'

property password

password: string;

property username

username: string;

call signature

(task: 'firefox:force:gc'): Promise<void>;

• Firefox only: Force Cypress to run garbage collection routines. No-op if not running in Firefox.

  See Also

  • https://on.cypress.io/firefox-gc-issue

call signature

(task: 'net', eventName: string, frame: any): Promise<void>;

property args

args: string[];

property env

env: { [key: string]: any };

property extensions

extensions: string[];

property preferences

preferences: { [key: string]: any };

property autoCancelAfterFailures

autoCancelAfterFailures?: number | false;

property browser

browser?: Browser;

property config

config: ConfigOptions;

property cypressVersion

cypressVersion: string;

property group

group?: string;

property parallel

parallel?: boolean;

property runUrl

runUrl?: string;

property specPattern

specPattern?: string[];

property specs

specs?: Spec[];

property system

system: SystemDetails;

property tag

tag?: string;

property channel

channel: BrowserChannel;

• The release channel of the browser.

property displayName

displayName: string;

• Human-readable browser name.

property family

family: BrowserFamily;

• The underlying engine for this browser.

property info

info?: string;

• Informational text to accompany this browser. Shown in desktop-gui.

property isHeaded

isHeaded: boolean;

property isHeadless

isHeadless: boolean;

property majorVersion

majorVersion: number | string;

property minSupportedVersion

minSupportedVersion?: number;

• The minimum majorVersion of this browser supported by Cypress.

property name

name: BrowserName;

• Short browser name.

property path

path: string;

property unsupportedVersion

unsupportedVersion?: boolean;

• If true, this browser is too old to be supported by Cypress.

property version

version: string;

property warning

warning?: string;

• Warning text to accompany this browser. Shown in desktop-gui.

property matchCase

matchCase: boolean;

• Check case sensitivity

  true

property and

and: Chainer<Subject>;

• Create an assertion. Assertions are automatically retried until they pass or time out.

  should

  See Also

  • https://on.cypress.io/and

property off

off: Actions;

• These events come from Cypress as it issues commands and reacts to their state. These are all useful to listen to for debugging purposes.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

property on

on: Actions;

• These events come from Cypress as it issues commands and reacts to their state. These are all useful to listen to for debugging purposes.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

property once

once: Actions;

• These events come from Cypress as it issues commands and reacts to their state. These are all useful to listen to for debugging purposes.

  See Also

  • https://on.cypress.io/catalog-of-events#App-Events

property should

should: Chainer<Subject>;

• Create an assertion. Assertions are automatically retried until they pass or time out.

  Example 1

  // Assert on the href of the location cy.location('href').should('contain', '/tag/tutorials/')

  See Also

  • https://on.cypress.io/should

method $$

$$: <TElement extends Element = HTMLElement>(
    selector: JQuery.Selector,
    context?: Element | Document | JQuery
) => JQuery<TElement>;

• jQuery library bound to the AUT

  Example 1

  cy.$$('p')

  See Also

  • https://on.cypress.io/$

method as

as: (alias: string, options?: Partial<AsOptions>) => Chainable<Subject>;

• Assign an alias for later use. Reference the alias later within a [cy.get()](https://on.cypress.io/get) or [cy.wait()](https://on.cypress.io/wait) command with a @ prefix. You can alias DOM elements, routes, stubs and spies.

  Example 1

  // Get the aliased 'todos' elements cy.get('ul#todos').as('todos')

  // later retrieve the todos cy.get('@todos')

  See Also

  • https://on.cypress.io/as

  • https://on.cypress.io/variables-and-aliases

  • https://on.cypress.io/get

method blur

blur: (options?: Partial<BlurOptions>) => Chainable<Subject>;

• Blur a focused element. This element must currently be in focus. If you want to ensure an element is focused before blurring, try using .focus() before .blur().

  See Also

  • https://on.cypress.io/blur

method check

check: {
    (options?: Partial<CheckOptions>): Chainable<Subject>;
    (
        value: string | string[],
        options?: Partial<CheckOptions>
    ): Chainable<Subject>;
};

• Check checkbox(es) or radio(s). This element must be an <input> with type checkbox or radio.

  Example 1

  // Check checkbox element cy.get('[type="checkbox"]').check() // Check first radio element cy.get('[type="radio"]').first().check()

  See Also

  • https://on.cypress.io/check

• Check checkbox(es) or radio(s). This element must be an <input> with type checkbox or radio.

  Example 1

  // Select the radio with the value of 'US' cy.get('[type="radio"]').check('US') // Check the checkboxes with the values 'ga' and 'ca' cy.get('[type="checkbox"]').check(['ga', 'ca'])

  See Also

  • https://on.cypress.io/check

method children

children: {
    <E extends Node = HTMLElement>(
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<E>>;
    <K extends keyof HTMLElementTagNameMap>(
        selector: K,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<HTMLElementTagNameMap[K]>>;
    <E extends Node = HTMLElement>(
        selector: string,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<E>>;
};

• Get the children of each DOM element within a set of DOM elements.

  See Also

  • https://on.cypress.io/children

method clear

clear: (options?: Partial<ClearOptions>) => Chainable<Subject>;

• Clear the value of an input or textarea. An alias for .type({selectall}{del})

  See Also

  • https://on.cypress.io/clear

method clearAllCookies

clearAllCookies: (options?: Partial<Loggable & Timeoutable>) => Chainable<null>;

• Clear all browser cookies.

  Cypress automatically clears all cookies _before_ each test to prevent state from being shared across tests when test isolation is enabled. You shouldn't need to use this command unless you're using it to clear all cookie inside a single test or test isolation is disabled.

  See Also

  • https://on.cypress.io/clearallcookies

method clearAllLocalStorage

clearAllLocalStorage: (options?: Partial<Loggable>) => Chainable<null>;

• Clear local storage for all origins.

  Cypress automatically clears all local storage _before_ each test to prevent state from being shared across tests when test isolation is enabled. You shouldn't need to use this command unless you're using it to clear localStorage inside a single test or test isolation is disabled.

  See Also

  • https://on.cypress.io/clearalllocalstorage

method clearAllSessionStorage

clearAllSessionStorage: (options?: Partial<Loggable>) => Chainable<null>;

• Clear session storage for all origins.

  See Also

  • https://on.cypress.io/clearallsessionstorage

method clearCookie

clearCookie: (name: string, options?: CookieOptions) => Chainable<null>;

• Clear a specific browser cookie for a domain.

  Cypress automatically clears all cookies _before_ each test to prevent state from being shared across tests when test isolation is enabled. You shouldn't need to use this command unless you're using it to clear a specific cookie inside a single test or test isolation is disabled.

  See Also

  • https://on.cypress.io/clearcookie

method clearCookies

clearCookies: (options?: CookieOptions) => Chainable<null>;

• Clear browser cookies for a domain.

  Cypress automatically clears all cookies _before_ each test to prevent state from being shared across tests when test isolation is enabled. You shouldn't need to use this command unless you're using it to clear specific cookies inside a single test or test isolation is disabled.

  See Also

  • https://on.cypress.io/clearcookies

method clearLocalStorage

clearLocalStorage: {
    (key?: string): Chainable<Storage>;
    (re: RegExp): Chainable<Storage>;
    (options: Partial<Loggable>): Chainable<Storage>;
    (key: string, options: Partial<Loggable>): Chainable<Storage>;
};

• Clear data in local storage for the current origin.

  Cypress automatically clears all local storage _before_ each test to prevent state from being shared across tests when test isolation is enabled. You shouldn't need to use this command unless you're using it to clear localStorage inside a single test or test isolation is disabled.

  Parameter key

  name of a particular item to remove (optional).

  Example 1

  ``` // Removes all local storage keys cy.clearLocalStorage() .should(ls => { expect(ls.getItem('prop1')).to.be.null }) // Removes item "todos" cy.clearLocalStorage("todos") ```

  See Also

  • https://on.cypress.io/clearlocalstorage

• Clear keys in local storage that match given regular expression.

  Parameter re

  regular expression to match.

  Example 1

  ``` // Clears all local storage matching /app-/ cy.clearLocalStorage(/app-/) ```

  See Also

  • https://on.cypress.io/clearlocalstorage

• Clear data in local storage. Cypress automatically runs this command before each test to prevent state from being shared across tests. You shouldn't need to use this command unless you're using it to clear localStorage inside a single test. Yields localStorage object.

  Parameter object

  options object

  Example 1

  ``` // Removes all local storage items, without logging cy.clearLocalStorage({ log: false }) ```

  See Also

  • https://on.cypress.io/clearlocalstorage

• Clear data in local storage. Cypress automatically runs this command before each test to prevent state from being shared across tests. You shouldn't need to use this command unless you're using it to clear localStorage inside a single test. Yields localStorage object.

  Parameter key

  name of a particular item to remove (optional).

  Parameter object

  options object

  Example 1

  ``` // Removes item "todos" without logging cy.clearLocalStorage("todos", { log: false }) ```

  See Also

  • https://on.cypress.io/clearlocalstorage

method click

click: {
    (options?: Partial<ClickOptions>): Chainable<Subject>;
    (
        position: PositionType,
        options?: Partial<ClickOptions>
    ): Chainable<Subject>;
    (x: number, y: number, options?: Partial<ClickOptions>): Chainable<Subject>;
};

• Click a DOM element.

  Example 1

  cy.get('button').click() // Click on button cy.focused().click() // Click on el with focus cy.contains('Welcome').click() // Click on first el containing 'Welcome'

  See Also

  • https://on.cypress.io/click

• Click a DOM element at specific corner / side.

  Parameter position

  The position where the click should be issued. The center position is the default position.

  Example 1

  cy.get('button').click('topRight')

  See Also

  • https://on.cypress.io/click

• Click a DOM element at specific coordinates

  Parameter x

  The distance in pixels from the element's left to issue the click.

  Parameter y

  The distance in pixels from the element's top to issue the click.

  Example 1

  ``` // The click below will be issued inside of the element // (15px from the left and 40px from the top). cy.get('button').click(15, 40) ```

  See Also

  • https://on.cypress.io/click

method clock

clock: {
    (): Chainable<Clock>;
    (now: number | Date, options?: Loggable): Chainable<Clock>;
    (
        now: number | Date,
        functions?: (
            | 'setTimeout'
            | 'clearTimeout'
            | 'setInterval'
            | 'clearInterval'
            | 'Date'
        )[],
        options?: Loggable
    ): Chainable<Clock>;
    (options: Loggable): Chainable<Clock>;
};

• cy.clock() overrides native global functions related to time allowing them to be controlled synchronously via [cy.tick()](https://on.cypress.io/tick) or the yielded clock object. This includes controlling: * setTimeout * clearTimeout * setInterval * clearInterval * Date Objects

  The clock starts at the unix epoch (timestamp of 0). This means that when you instantiate new Date in your application, it will have a time of January 1st, 1970.

  To restore the real clock call .restore()

  Example 1

  cy.clock() ... // restore the application clock cy.clock().then(clock => { clock.restore() }) // or use this shortcut cy.clock().invoke('restore')

  See Also

  • https://on.cypress.io/clock

• Mocks global clock and sets current timestamp to the given value. Overrides all functions that deal with time.

  Example 1

  // in your app code $('#date').text(new Date().toJSON()) // in the spec file // March 14, 2017 timestamp or Date object const now = new Date(2017, 2, 14).getTime() cy.clock(now) cy.visit('/index.html') cy.get('#date').contains('2017-03-14') // to restore the real clock cy.clock().then(clock => { clock.restore() }) // or use this shortcut cy.clock().invoke('restore')

  See Also

  • https://on.cypress.io/clock

• Mocks global clock but only overrides specific functions.

  Example 1

  // keep current date but override "setTimeout" and "clearTimeout" cy.clock(null, ['setTimeout', 'clearTimeout'])

  See Also

  • https://on.cypress.io/clock

• Mocks global clock and all functions.

  Example 1

  // mock clock but do not log this command cy.clock({ log: false })

  See Also

  • https://on.cypress.io/clock

method closest

closest: {
    <K extends keyof HTMLElementTagNameMap>(
        selector: K,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<HTMLElementTagNameMap[K]>>;
    <E extends Node = HTMLElement>(
        selector: string,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<E>>;
};

• Get the first DOM element that matches the selector (whether it be itself or one of its ancestors).

  See Also

  • https://on.cypress.io/closest

method contains

contains: {
    (
        content: string | number | RegExp,
        options?: Partial<Loggable & Timeoutable & CaseMatchable & Shadow>
    ): Chainable<Subject>;
    <E extends Node = HTMLElement>(content: string | number | RegExp): Chainable<
        JQuery<E>
    >;
    <K extends keyof HTMLElementTagNameMap>(
        selector: K,
        text: string | number | RegExp,
        options?: Partial<Loggable & Timeoutable & CaseMatchable & Shadow>
    ): Chainable<JQuery<HTMLElementTagNameMap[K]>>;
    <E extends Node = HTMLElement>(
        selector: string,
        text: string | number | RegExp,
        options?: Partial<Loggable & Timeoutable & CaseMatchable & Shadow>
    ): Chainable<JQuery<E>>;
};

• Get the DOM element containing the text. DOM elements can contain more than the desired text and still match. Additionally, Cypress prefers some DOM elements over the deepest element found.

  Example 1

  // Yield el in .nav containing 'About' cy.get('.nav').contains('About') // Yield first el in document containing 'Hello' cy.contains('Hello') // you can use regular expression cy.contains(/^b\w+/) // yields ... cy.contains('ul', 'apples') // tries to find the given text for up to 1 second cy.contains('my text to find', {timeout: 1000})

  See Also

  • https://on.cypress.io/contains

• Get the child DOM element that contains given text.

  Example 1

  // Yield el in .nav containing 'About' cy.get('.nav').contains('About')

  See Also

  • https://on.cypress.io/contains

• Get the DOM element with name "selector" containing the text or regular expression.

  Example 1

  // yields ... cy.contains('ul', 'apples')

  See Also

  • https://on.cypress.io/contains

• Get the DOM element using CSS "selector" containing the text or regular expression.

  Example 1

  // yields <... class="foo">... apples ...</...> cy.contains('.foo', 'apples')

  See Also

  • https://on.cypress.io/contains

method dblclick

dblclick: {
    (options?: Partial<ClickOptions>): Chainable<Subject>;
    (
        position: PositionType,
        options?: Partial<ClickOptions>
    ): Chainable<Subject>;
    (x: number, y: number, options?: Partial<ClickOptions>): Chainable<Subject>;
};

• Double-click a DOM element.

  See Also

  • https://on.cypress.io/dblclick

• Double-click a DOM element at specific corner / side.

  Parameter position

  The position where the click should be issued. The center position is the default position.

  Example 1

  cy.get('button').dblclick('topRight')

  See Also

  • https://on.cypress.io/dblclick

• Double-click a DOM element at specific coordinates

  Parameter x

  The distance in pixels from the element's left to issue the click.

  Parameter y

  The distance in pixels from the element's top to issue the click.

  Example 1

  ``` // The click below will be issued inside of the element // (15px from the left and 40px from the top). cy.get('button').dblclick(15, 40) ```

  See Also

  • https://on.cypress.io/dblclick

method debug

debug: (options?: Partial<Loggable>) => Chainable<Subject>;

• Set a debugger and log what the previous command yields.

  See Also

  • https://on.cypress.io/debug

method document

document: (options?: Partial<Loggable & Timeoutable>) => Chainable<Document>;

• Get the window.document of the page that is currently active.

  Example 1

  cy.document() .its('contentType') .should('eq', 'text/html')

  See Also

  • https://on.cypress.io/document

method each

each: {
    <E extends Node = HTMLElement>(
        fn: (element: JQuery<E>, index: number, $list: E[]) => void
    ): Chainable<JQuery<E>>;
    (fn: (item: any, index: number, $list: any[]) => void): Chainable<Subject>;
};

• Iterate through an array like structure (arrays or objects with a length property).

  See Also

  • https://on.cypress.io/each

method end

end: () => Chainable<null>;

• End a chain of commands

  See Also

  • https://on.cypress.io/end

method eq

eq: <E extends Node = HTMLElement>(
    index: number,
    options?: Partial<Loggable & Timeoutable>
) => Chainable<JQuery<E>>;

• Get A DOM element at a specific index in an array of elements.

  Parameter index

  A number indicating the index to find the element at within an array of elements. A negative number counts index from the end of the list.

  Example 1

  cy.get('tbody>tr').eq(0) // Yield first 'tr' in 'tbody' cy.get('ul>li').eq('4') // Yield fifth 'li' in 'ul' cy.get('li').eq(-2) // Yields second from last 'li' element

  See Also

  • https://on.cypress.io/eq

method exec

exec: (command: string, options?: Partial<ExecOptions>) => Chainable<Exec>;

• Execute a system command.

  See Also

  • https://on.cypress.io/exec

method filter

filter: {
    <K extends keyof HTMLElementTagNameMap>(
        selector: K,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<HTMLElementTagNameMap[K]>>;
    <E extends Node = HTMLElement>(
        selector: string,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<E>>;
    <E extends Node = HTMLElement>(
        fn: (index: number, element: E) => boolean,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<E>>;
};

• Get the DOM elements that match a specific selector. Opposite of .not()

  See Also

  • https://on.cypress.io/filter

method find

find: {
    <K extends keyof HTMLElementTagNameMap>(
        selector: K,
        options?: Partial<Loggable & Timeoutable & Shadow>
    ): Chainable<JQuery<HTMLElementTagNameMap[K]>>;
    <E extends Node = HTMLElement>(
        selector: string,
        options?: Partial<Loggable & Timeoutable & Shadow>
    ): Chainable<JQuery<E>>;
};

• Get the descendent DOM elements of a specific selector.

  Example 1

  cy.get('.article').find('footer') // Yield 'footer' within '.article'

  See Also

  • https://on.cypress.io/find

• Finds the descendent DOM elements with the given selector.

  Example 1

  // Find the li's within the nav cy.get('.left-nav>.nav').find('>li')

  See Also

  • https://on.cypress.io/find

method first

first: (options?: Partial<Loggable & Timeoutable>) => Chainable<Subject>;

• Get the first DOM element within a set of DOM elements.

  See Also

  • https://on.cypress.io/first

method fixture

fixture: {
    <Contents = any>(
        path: string,
        options?: Partial<Timeoutable>
    ): Chainable<Contents>;
    <Contents = any>(
        path: string,
        encoding: Encodings,
        options?: Partial<Timeoutable>
    ): Chainable<Contents>;
};

• Load a fixed set of data located in a file.

  See Also

  • https://on.cypress.io/fixture

• Load a fixed set of data located in a file with given encoding.

  See Also

  • https://on.cypress.io/fixture

method focus

focus: (options?: Partial<Loggable & Timeoutable>) => Chainable<Subject>;

• Focus on a DOM element.

  Example 1

  cy.get('input').first().focus() // Focus on the first input

  See Also

  • https://on.cypress.io/focus

method focused

focused: (options?: Partial<Loggable & Timeoutable>) => Chainable<JQuery>;

• Get the DOM element that is currently focused.

  Example 1

  // Get the element that is focused cy.focused().then(function($el) { // do something with $el }) // Blur the element with focus cy.focused().blur() // Make an assertion on the focused element cy.focused().should('have.attr', 'name', 'username')

  See Also

  • https://on.cypress.io/focused

method get

get: {
    <K extends keyof HTMLElementTagNameMap>(
        selector: K,
        options?: Partial<Loggable & Timeoutable & Withinable & Shadow>
    ): Chainable<JQuery<HTMLElementTagNameMap[K]>>;
    <E extends Node = HTMLElement>(
        selector: string,
        options?: Partial<Loggable & Timeoutable & Withinable & Shadow>
    ): Chainable<JQuery<E>>;
    <S = any>(
        alias: string,
        options?: Partial<Loggable & Timeoutable & Withinable & Shadow>
    ): Chainable<S>;
};

• Get one or more DOM elements by node name: input, button, etc.

  Example 1

  cy.get('input').should('be.disabled') cy.get('button').should('be.visible')

  See Also

  • https://on.cypress.io/get

• Get one or more DOM elements by selector. The querying behavior of this command matches exactly how $(…) works in jQuery.

  Example 1

  cy.get('.list>li') // Yield the 's in <.list> cy.get('ul li:first').should('have.class', 'active') cy.get('.dropdown-menu').click()

  See Also

  • https://on.cypress.io/get

• Get one or more DOM elements by alias.

  Example 1

  // Get the aliased 'todos' elements cy.get('ul#todos').as('todos') //...hack hack hack... //later retrieve the todos cy.get('@todos')

  See Also

  • https://on.cypress.io/get#Alias

method getAllCookies

getAllCookies: (
    options?: Partial<Loggable & Timeoutable>
) => Chainable<Cookie[]>;

• Get all browser cookies.

  See Also

  • https://on.cypress.io/getallcookies

method getAllLocalStorage

getAllLocalStorage: (options?: Partial<Loggable>) => Chainable<StorageByOrigin>;

• Get local storage for all origins.

  See Also

  • https://on.cypress.io/getalllocalstorage

method getAllSessionStorage

getAllSessionStorage: (
    options?: Partial<Loggable>
) => Chainable<StorageByOrigin>;

• Get session storage for all origins.

  See Also

  • https://on.cypress.io/getallsessionstorage

method getCookie

getCookie: (name: string, options?: CookieOptions) => Chainable<Cookie | null>;

• Get a browser cookie by its name.

  See Also

  • https://on.cypress.io/getcookie

method getCookies

getCookies: (options?: CookieOptions) => Chainable<Cookie[]>;

• Get browser cookies for a domain.

  See Also

  • https://on.cypress.io/getcookies

method go

go: (
    direction: HistoryDirection | number,
    options?: Partial<Loggable & Timeoutable>
) => Chainable<AUTWindow>;

• Navigate back or forward to the previous or next URL in the browser's history.

  See Also

  • https://on.cypress.io/go

method hash

hash: (options?: Partial<Loggable & Timeoutable>) => Chainable<string>;

• Get the current URL hash of the page that is currently active.

  See Also

  • https://on.cypress.io/hash

method invoke

invoke: {
    <
        K extends keyof Subject,
        F extends ((...args: any[]) => any) & Subject[K],
        R = ReturnType<F>
    >(
        functionName: K,
        ...args: any[]
    ): Chainable<R>;
    <
        K extends keyof Subject,
        F extends ((...args: any[]) => any) & Subject[K],
        R = ReturnType<F>
    >(
        options: Partial<Loggable & Timeoutable>,
        functionName: K,
        ...args: any[]
    ): Chainable<R>;
    <T extends (...args: any[]) => any, Subject extends T[]>(
        index: number
    ): Chainable<ReturnType<T>>;
    <T extends (...args: any[]) => any, Subject extends T[]>(
        options: Partial<Loggable & Timeoutable>,
        index: number
    ): Chainable<ReturnType<T>>;
    (propertyPath: string, ...args: any[]): Chainable<any>;
};

• Invoke a function on the previously yielded subject.

  See Also

  • https://on.cypress.io/invoke

• Invoke a function in an array of functions.

  See Also

  • https://on.cypress.io/invoke

• Invoke a function on the previously yielded subject by a property path. Property path invocation cannot be strongly-typed. Invoking by a property path will always result in any.

  See Also

  • https://on.cypress.io/invoke

method its

its: {
    <K extends keyof Subject>(
        propertyName: K,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<NonNullable<Subject[K]>>;
    (
        propertyPath: string,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<any>;
    <T, Subject extends T[]>(
        index: number,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<T>;
};

• Get a property's value on the previously yielded subject.

  Example 1

  // Get the 'width' property cy.wrap({width: '50'}).its('width') // Drill into nested properties by using dot notation cy.wrap({foo: {bar: {baz: 1}}}).its('foo.bar.baz')

  See Also

  • https://on.cypress.io/its

• Get a value by index from an array yielded from the previous command.

  Example 1

  cy.wrap(['a', 'b']).its(1).should('equal', 'b')

  See Also

  • https://on.cypress.io/its

method last

last: <E extends Node = HTMLElement>(
    options?: Partial<Loggable & Timeoutable>
) => Chainable<JQuery<E>>;

• Get the last DOM element within a set of DOM elements.

  See Also

  • https://on.cypress.io/last

method location

location: {
    (options?: Partial<Loggable & Timeoutable>): Chainable<Location>;
    <K extends keyof Location>(
        key: K,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<Location[K]>;
};

• Get the global window.location object of the page that is currently active.

  Example 1

  cy.location() // Get location object

  See Also

  • https://on.cypress.io/location

• Get a part of the global window.location object of the page that is currently active.

  Example 1

  cy.location('host') // Get the host of the location object cy.location('port') // Get the port of the location object // Assert on the href of the location cy.location('href').should('contain', '/tag/tutorials')

  See Also

  • https://on.cypress.io/location

method log

log: (message: string, ...args: any[]) => Chainable<null>;

• Print a message to the Cypress Command Log.

  See Also

  • https://on.cypress.io/log

method next

next: {
    <K extends keyof HTMLElementTagNameMap>(
        selector: K,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<HTMLElementTagNameMap[K]>>;
    <E extends Node = HTMLElement>(
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<E>>;
    <E extends Node = HTMLElement>(
        selector: string,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<E>>;
};

• Get the immediately following sibling of each DOM element within a set of DOM elements.

  See Also

  • https://on.cypress.io/next

• Get the immediately following sibling of each DOM element within a set of DOM elements.

  Example 1

  cy.get('nav a:first').next()

  See Also

  • https://on.cypress.io/next

• Get the immediately following sibling of each DOM element within a set of DOM elements that match selector

  Example 1

  cy.get('nav a:first').next('.menu-item)

  See Also

  • https://on.cypress.io/next

method nextAll

nextAll: {
    <K extends keyof HTMLElementTagNameMap>(
        selector: K,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<HTMLElementTagNameMap[K]>>;
    <E extends HTMLElement = HTMLElement>(
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<E>>;
    <E extends HTMLElement = HTMLElement>(
        selector: string,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<E>>;
};

• Get all following siblings of each DOM element in a set of matched DOM elements.

  See Also

  • https://on.cypress.io/nextall

method nextUntil

nextUntil: {
    <K extends keyof HTMLElementTagNameMap>(
        selector: K,
        filter?: string,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<HTMLElementTagNameMap[K]>>;
    <E extends Node = HTMLElement>(
        selector: string,
        filter?: string,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<E>>;
    <E extends Node = HTMLElement>(
        element: E | JQuery<E>,
        filter?: string,
        options?: Partial<Loggable & Timeoutable>
    ): Chainable<JQuery<E>>;
};