hable
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published

    Hable

    CircleCI Codecov npm npm size

    Awaitable hooks for Node.js

    Install

    Using yarn:

    yarn add hable

    Using npm:

    npm install hable

    Usage

    Extend your base class from Hable:

    import Hookable from 'hable'
     
    export default class Foo extends Hookable {
      constructor() {
        // Call to parent to initialize
        super()
        // Initialize Hookable with custom logger
        // super(consola)
      }
     
      async someFunction() {
        // Call and wait for `hook1` hooks (if any) sequential
        await this.callHook('hook1')
     
        // Call and wait for `hook2` hooks (if any) in parallel
        await this.callHookParallel('hook2')
      }
    }

    Inside plugins, register for any hook:

    const lib = newFooLib()
     
    // Register a handler for `hook2`
    lib.hook('hook2', async () => { /* ... */ })
     
    // Register multiply handlers at once
    lib.hookObj({
      hook1: async () => { /* ... */ },
      hook2: [ /* can be also an array */ ]
    })

    Hookable class

    constructor(logger)

    Custom logger. Default logger is console but you can use your own or consola.

    It should be an object implementing following functions:

    • warn
    • error
    • fatal (optional)

    hook (name, fn)

    Register a handler for a specific hook. fn can be a single function or an array.

    addHooks(configHooks)

    Flatten and register hooks object.

    Example:

    hookable.addHooks({
      test: {
        before: () => {},
        after: () => {}
      }
    })
     

    This registers test:before and test:after hooks at bulk.

    async callHook (name, ...args)

    Used by class itself to sequentially call handlers of a specific hook.

    deprecateHook (old, name)

    Deprecate hook called old in favor of name hook.

    deprecateHooks (deprecatedHooks)

    Deprecate all hooks from an object (keys are old and values or newer ones).

    clearHook (name)

    Clear all hooks for a specific hook.

    clearHooks ()

    Clear all hooks registered in the class.

    flatHooks (hooksObj)

    Register many hooks using an object.

    Credits

    Extracted from Nuxt.js hooks system. Original author: Sébastien Chopin.

    License

    MIT

    Install

    npm i hable

    DownloadsWeekly Downloads

    355,134

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    27.8 kB

    Total Files

    13

    Last publish

    Collaborators

    • pi0