Security News
JSR Working Group Kicks Off with Ambitious Roadmap and Plans for Open Governance
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
@poppinss/hooks
Advanced tools
A no brainer module to execute lifecycle hooks in sequence.
I find myself re-writing the code for hooks in multiple packages, so decided to extract it to it's own module, that can be re-used by other modules of AdonisJS.
The hooks class exposes the API to register
, remove
and exec
lifecycle hooks for any number of actions or events. The class API is meant to be used internally and not by the user facing code and this gives you the chance to improve the hooks DX.
For example: The Lucid models uses this class internally and expose before
and after
methods on the model itself. Doing this, Lucid can control the autocomplete, type checking for the before
and after
methods itself, without relying on this package to expose the generics API.
Also generics increases the number of types Typescript has to generate and it's better to avoid them whenever possible.
Install the package from npm registry as follows:
npm i @poppinss/hooks
# yarn
yarn add @poppinss/hooks
Use it as follows
import { Hooks } from '@poppinss/hooks'
const hooks = new Hooks()
hooks.add('before', 'save', function () {})
// Later invoke before save hooks
await hooks.exec('before', 'save', { id: 1 })
If you want the end user to define IoC container bindings as the hook handler, then you need to pass the IoC
container resolver to the Hooks constructor. Following is the snippet from Lucid models.
import { Ioc } from '@adonisjs/fold'
const ioc = new Ioc()
const resolver = ioc.getResolver(undefined, 'modelHooks', 'App/Models/Hooks')
const hooks = new Hooks(resolver)
The resolver allows the end user to pass the hook reference as string and hooks must live inside App/Models/Hooks
folder.
hooks.add('before', 'save', 'User.encryptPassword')
Add a new hook handler.
hooks.add('before', 'save', (data) => {
console.log(data)
})
Execute a given hook for a selected lifecycle.
hooks.exec('before', 'save', { username: 'virk' })
Remove an earlier registered hook. If you are using the IoC container bindings, then passing the binding string is enough, otherwise you need to store the reference of the function.
function onSave() {}
hooks.add('before', 'save', onSave)
// Later remove it
hooks.remove('before', 'save', onSave)
Clear all hooks for a given lifecycle and optionally an action.
hooks.clear('before')
// Clear just for the save action
hooks.clear('before', 'save')
Merge hooks from an existing hooks instance. Useful during class inheritance.
const hooks = new Hooks()
hooks.add('before', 'save', function () {})
const hooks1 = new Hooks()
hooks1.merge(hooks)
await hooks1.exec('before', 'save', [])
FAQs
A no brainer hooks module for execute before/after lifecycle hooks
The npm package @poppinss/hooks receives a total of 40,768 weekly downloads. As such, @poppinss/hooks popularity was classified as popular.
We found that @poppinss/hooks demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.