peach a19a732be8 commit message | 2 năm trước cách đây | |
---|---|---|
.. | ||
dist | 2 năm trước cách đây | |
src | 2 năm trước cách đây | |
CHANGELOG.md | 2 năm trước cách đây | |
LICENSE.md | 2 năm trước cách đây | |
README.md | 2 năm trước cách đây | |
index.d.ts | 2 năm trước cách đây | |
package.json | 2 năm trước cách đây |
Awaitable hooks for Node.js
Using yarn:
yarn add hable
Using npm:
npm install hable
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 */ ]
})
constructor(logger)
Custom logger. Default logger is console
but you can use your own or consola.
It should be an object implementing following functions:
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.
Extracted from Nuxt.js hooks system. Original author: Sébastien Chopin.
MIT