feat(async/unstable): add waitFor function to wait for condition to be true (#6213)

[acrodrig]

Submitting PR to contribute waitFor function (see #6213). Fixed small type in delay tests as well.

[CLAassistant]

All committers have signed the CLA.

[kt3k]

This timer needs to be cleared at the end of the test case to avoid op leak error

[acrodrig]

Will do, makes sense. I do not know why I did not get the leak when running locally.

[kt3k]

👍

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.52%. Comparing base (b1b8279) to head (32764c1).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6230   +/-   ##
=======================================
  Coverage   96.52%   96.52%           
=======================================
  Files         534      535    +1     
  Lines       40976    40996   +20     
  Branches     6134     6135    +1     
=======================================
+ Hits        39551    39573   +22     
+ Misses       1383     1381    -2     
  Partials       42       42           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

retract

[kt3k]

I just remembered another rule about designing this type of function.

We tend to put the function-type argument at the last of parameters. The examples are Deno.serve, Deno.test, Deno.addSignalListener.

(It is noted in our style guide)

Note: When one of the arguments is a function, you can adjust the order flexibly. See examples like Deno.serve, Deno.test, Deno.addSignalListener. See also this post.

What do you think about changing this to waitFor(timeout, [options,] predicate)? (We need to use type overload to achieve optional 2nd argument).

[acrodrig]

What do you think about changing this to waitFor(timeout, [options,] predicate)? (We need to use type overload to achieve optional 2nd argument).

Sure, makes sense, let me give it a try. I was following the deadline layout which has the Promise as the first argument.