Git Product home page Git Product logo

async-hook's Introduction

#async-hook

Inspect the life of handle objects in node

Documentation

This is high level abstraction of the currently undocumented node API called AsyncWrap. It patches some issues, makes the API more uniform and allows multiply hooks to be created.

I personally hope that most of this will make it into nodecore, but for now it exists as an userland module.

For the details of how AsyncWrap works and by extension how this module works, please see the semi-official AsyncWrap documentation: https://github.com/nodejs/tracing-wg/blob/master/docs/AsyncWrap/README.md

const asyncHook = require('async-hook');

Hooks

The function arguments are:

function init(uid, handle, provider, parentUid, parentHandle) { /* your code */ }
function pre(uid, handle) {  /* your code */ }
function post(uid, handle) {  /* your code */ }
function destroy(uid) {  /* your code */ }

To add hooks:

asyncHook.addHooks({ init, pre, post, destroy });

To remove hooks:

asyncHooks.removeHooks({ init, pre, post, destroy });

All properties in the hooks object that addHooks and removeHooks takes are optional.

Providers

The providers map is exposed as:

asyncHook.providers[provider];

Enable and disable

You can enable and disable all hooks by using asyncHook.enable() and asyncHook.disable(). By default it is disabled.

Be careful about disabling the hooks, this will most likely conflict with other modules that uses async-hook.

async-hook's People

Contributors

andreasmadsen avatar omsmith avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.