All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
- Upgrade mocha and other dependencies in order to avoid github security warnings.
- Transition to automated transparent publishing via GitHub actions. #27
- global Date reference which caused date & time mocking to break convergences
- queued functions retain the previous value when returning undefined
- trailing
always
assertions on Convergence instances default to remaining time instead of always using remaining time
- immediately throw when encountering an async assertion
when
andalways
helpers return thennable functions that can be used as callbacks, or awaited on directly- updated to stable dependencies
- deprecated
once
method - Typescript types
- error when using async functions or returning promises with convergent assertions
- internal docs links
- update
@bigtest/meta
- "stack" terminology to "queue" to better reflect first-in-first-out
when
andalways
helpers to immediately start converging on a single assertion without the need for creating aConvergence
convergeOn
export in favor ofwhen
andalways
- transpiled es module bundle
- typescript definitions
_timeout
totimeout
when providing an options hash to the convergence constructor
docs
script to generate documentation.when()
to replace the.once()
method
- updated inline api docs
Convergence
assertions retain the instance context
.once()
in favor of.when()
- context currying from
convergeOn
- then method to support async / await syntax without calling
.run()
.append()
method to useisConvergence
instead ofinstanceof
- full support for returning promises in
.do()
blocks - timeout error thrown when convergence exceeds timeout
- support for returning convergence in
.do()
blocks isConvergence
helper function
- convergent assertions no longer attempt to resolve or reject before their timeout
- ability to extend the convergence class
- convergence constructor to be more general to allow subclasses to handle their own construction
-
.append()
method to combine convergences together -
"module" entry point to support native consumption of @bigtest/mocha as es module
- correctly remove comments from compiled files