Skip to content

debug.md

Latest commit

 

History

History
91 lines (56 loc) · 1.76 KB

debug.md

File metadata and controls

91 lines (56 loc) · 1.76 KB
title debug

Set a debugger and log what the previous command yields.

{% note warning %} You need to have your Developer Tools open for .debug() to hit the breakpoint. {% endnote %}

Syntax

.debug()
.debug(options)

// ---or---

cy.debug()
cy.debug(options)

Usage

{% fa fa-check-circle green %} Correct Usage

cy.debug().getCookie('app') // Pause to debug at beginning of commands
cy.get('nav').debug()       // Debug the `get` command's yield

Arguments

{% fa fa-angle-right %} options (Object)

Pass in an options object to change the default behavior of .debug().

Option Default Description
log true {% usage_options log %}

Yields {% helper_icon yields %}

{% yields same_subject .debug %}

Examples

Debug

Pause with debugger after .get()

cy.get('a').debug().should('have.attr', 'href')

Rules

Requirements {% helper_icon requirements %}

{% requirements dual .debug %}

Assertions {% helper_icon assertions %}

{% assertions utility .debug %}

Timeouts {% helper_icon timeout %}

{% timeouts none .debug %}

Command Log

Log out the current subject for debugging

cy.get('.ls-btn').click({ force: true }).debug()

The commands above will display in the Command Log as:

{% imgTag /img/api/debug/how-debug-displays-in-command-log.png "Command Log debug" %}

When clicking on the debug command within the command log, the console outputs the following:

{% imgTag /img/api/debug/console-gives-all-debug-info-for-command.png "console.log debug" %}

See also