How to return a value from custom function in Cypress?

Question

I've been struggling with returning a value from my custom function due to the fact that I'm dealing with a promise.

Here's my code:

This is my custom function:

Cypress.Commands.add("myFunction", () => {
   cy.get('#someID').then($container) => {
      const isHidden = $container().children('div:nth-child(3)').is(':hidden');
      console.log(isHidden); // This returns either true or false and that is good  
      return isHidden; // this returns $chainer but I want to return either true or false 
   }

});

Here is my test suite:

context('some description', () => {
  before(function(){
      const result = cy.myFunction();
      console.log(result); // This is $chainer, but I want to get the value of true or false from isHidden variable 
  });

});

Does this answer your question? [How do I return the response from an asynchronous call?](https://stackoverflow.com/questions/14220321/how-do-i-return-the-response-from-an-asynchronous-call) — Taplar, Jul 29 '20 at 18:09
You can't return values like that in cypress. Did you try using aliases? — Muditha Perera, Jul 29 '20 at 18:55

score 6 · Answer 1 · edited Feb 08 '22 at 13:38

6

I am doing this with cy.wrap (see https://docs.cypress.io/api/commands/wrap/#Syntax) which returns a Cypress.Chainable that allows you to use then with the result.

Cypress.Commands.add('myFunction', () => {
    return cy.wrap('myResult');
})

cy.myFunction.then((text) => {
    console.log(text); // myResult
})

edited Feb 08 '22 at 13:38

k.vincent

3,743
8
37
74

answered Mar 23 '21 at 14:47

Verònica Jandrew

452
3
13

1

I have tried this, however, my code never goes inside of the "then" section. – Janpan Jan 25 '23 at 07:34

How to return a value from custom function in Cypress?

1 Answers1