Human-readable timeouts (callback-timeout-flexible + timestring-notsep)
This module exports one function:
opts
is an options object that supports these keys:
limit
(required): Eitherfalse
to immediately returnfalse
, or a timespan (as string).cb
: Your callback, for delivery of the TimeoutError if triggered.- all other options supported by
callback-timeout-flexible
that aren't about timespans.
The result is not an opaque timer ID or timer object, but instead a callback function that can be used to decide the outcome early.
cb
will carry a timeout
property that holds the timeout control object
(TCO), which in turn has methods like .renew()
and .abandon()
.
- Needs more/better tests and docs.
ISC