hable

Hable

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()
  }

  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

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 flavor of name hook.

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

Changelog

1.0.0 (2019-02-11)

Features

• rewrite for 1.0.0 (88decae)

BREAKING CHANGES

• api change

<a name="0.0.7"></a>