This is the internal API for controlling what get’s printed to the Command Log.
Useful when writing your own custom commands.
WIPThis page is currently a work in progress and is not fully documented.
Syntax
Cypress.log(options)
Arguments
options (Object)
Pass in an options object to Cypress.log().
| Option | Default | Description |
|---|---|---|
$el | undefined | |
name | name of the command | |
displayName | name of the command | Overrides name only for display purposes. |
message | command args | |
consoleProps | function() {} |
Examples
Cypress.Commands.add('myCustomCommand', (arg1, arg2) => {
const log = Cypress.log({
consoleProps: () => {
// return an object literal which will
// be printed to the dev tools console
// on click
return {
'Some': 'values',
'For': 'debugging'
}
}
})
})