Cypress.Commands.add with object argument

[benwiley4000]

What would you like?

I want to be able to do this:

Cypress.Commands.add({
  myCommand(arg) {
    // ...
  },
  myOtherCommand(arg) {
    // ...
  }
});

Why is this needed?

This way we can maintain a commands.js file that looks like this:

export function myCommand(arg) {
  // ...
}

export function myOtherCommand(arg) {
  // ...
}

And we can add them all like this:

import * as commands from './commands';
Cypress.Commands.add(commands);

Other

This will be especially useful for typescript where declaring the function separately from the Cypress.Commands.add(...) call is helpful for maintaining correct typing in Cypress.Chainable.

[BlueWinds]

We already have addAll available and use it inside Cypress. For example: https://github.com/cypress-io/cypress/blob/develop/packages/driver/src/cy/commands/files.ts. Does Cypress.Commands.addAll() work for what you're trying to do?

This isn't documented anywhere at the moment - but if someone wanted to open a PR to add it to the docs, that would be very welcome.

[cypress-bot]

The code for this is done in cypress-io/cypress#20894, but has yet to be released.
We'll update this issue and reference the changelog when it's released.

[cypress-bot]

Released in 9.5.4.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v9.5.4, please open a new issue.