@risingstack/async-listener
v1.0.1
Published
Polyfill exporting trevnorris's 0.11+ asyncListener API.
Downloads
6
Readme
process.addAsyncListener polyfill
This is an implementation of Trevor Norris's process.{addAsyncListener,removeAsyncListener} API for adding behavior to async calls. You can see his implementation (currently a work in progress) on Node.js core pull request #6011. This polyfill / shim is intended for use in versions of Node prior to whatever version of Node in which Trevor's changes finally land (anticipated at the time of this writing as 0.11.7).
Here's his documentation of the intended API, which will probably get cleaned up here later:
createAsyncListener(callbacks[, initialStorage])
callbacks
{Object}initialStorage
{Value}
Returns a constructed AsyncListener
object. Which can then be passed to
process.addAsyncListener()
and process.removeAsyncListener()
. Each
function parameter is as follows:
callbacks
: AnObject
which may contain four optional fields:create
: Afunction (storage)
that is called when an asynchronous event is queued. Recives thestorage
attached to the listner.storage
can be created by passing aninitialStorage
argument during costruction, or by returning aValue
fromcreate
which will be attached to the listner and overwrite theinitialStorage
.before
: Afunction (context, storage)
that is called immediately before the asynchronous callback is about to run. It will be passed both thecontext
(i.e.this
) of the calling function and thestorage
.after
: Afunction (context, storage)
called immediately after the asynchronous event's callback is run. Note that if the event's callback throws during execution this will not be called.error
: Afunction (storage, error)
called if the event's callback threw. Iferror
returnstrue
then Node will assume the error has been properly handled and resume execution normally.
initialStorage
: AValue
(i.e. anything) that will be, by default, attached to all new event instances. This will be overwritten if aValue
is returned bycreate()
.
addAsyncListener(callbacks[, initialStorage])
addAsyncListener(asyncListener)
Returns a constructed AsyncListener
object and immediately adds it to the
listening queue.
removeAsyncListener(asyncListener)
Removes the asyncListener
from the listening queue.