Security News
JavaScript Leaders Demand Oracle Release the JavaScript Trademark
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
before-after-hook
Advanced tools
The before-after-hook npm package allows developers to add before, after, and error hooks to JavaScript functions. This is particularly useful for adding custom pre-processing, post-processing, or error handling logic in a clean and organized manner. It can be used in both Node.js and browser environments.
Creating and using a single hook
This example demonstrates how to create a hook and attach before and after hooks to a function. The before hook logs a message before the main function runs, and the after hook logs a message after the main function completes.
const {Hook} = require('before-after-hook');
const hook = new Hook();
hook.before(addTask, async () => {
console.log('Before adding task');
});
hook.after(addTask, async () => {
console.log('After adding task');
});
async function addTask() {
console.log('Adding task');
}
hook(addTask, []).then(() => {
console.log('Task added');
});
Error handling with hooks
This example shows how to use the error hook to handle errors that may occur in the main function. The error hook logs the error message, providing a centralized way to handle errors.
const {Hook} = require('before-after-hook');
const hook = new Hook();
hook.error(addTask, async (error) => {
console.error('Error occurred:', error.message);
});
async function addTask() {
throw new Error('Failed to add task');
}
hook(addTask, []).catch(err => {
console.log('Error handling complete.');
});
Wrapping functions with multiple hooks
This example illustrates how to use HookCollection to manage multiple hooks for a single named operation. It demonstrates adding before, after, and error hooks for a 'save' operation, providing a comprehensive example of managing complex asynchronous operations.
const {HookCollection} = require('before-after-hook');
const hooks = new HookCollection();
hooks.before('save', async () => {
console.log('Before save');
});
hooks.after('save', async () => {
console.log('After save');
});
hooks.error('save', async (error) => {
console.error('Error during save:', error.message);
});
async function saveData() {
console.log('Saving data');
}
hooks('save', saveData, []).then(() => {
console.log('Data saved');
}).catch(err => {
console.log('Error handling complete.');
});
Similar to before-after-hook, async-hooks provides mechanisms to track asynchronous resources in Node.js. While async-hooks is more focused on the lifecycle and context of asynchronous operations, before-after-hook focuses on adding custom logic before, after, or on errors of specific functions.
This package allows for the use of asynchronous middleware patterns, similar to how before-after-hook allows for pre and post function execution logic. However, middleware-async is more tailored towards use in web server frameworks like Express, providing a more specific use case compared to the more general-purpose before-after-hook.
asynchronous hooks for internal functionality
Recommended for TypeScript
// instantiate singular hook API
const hook = new Hook.Singular()
// Create a hook
function getData (options) {
return hook(options, fetchFromDatabase)
.then(handleData)
.catch(handleGetError)
}
// register before/error/after hooks.
// The methods can be async or return a promise
hook.before(beforeHook)
hook.error(errorHook)
hook.after(afterHook)
getData({id: 123})
// instantiate hook collection API
const hookCollection = new Hook.Collection()
// Create a hook
function getData (options) {
return hookCollection('get', options, fetchFromDatabase)
.then(handleData)
.catch(handleGetError)
}
// register before/error/after hooks.
// The methods can be async or return a promise
hookCollection.before('get', beforeHook)
hookCollection.error('get', errorHook)
hookCollection.after('get', afterHook)
getData({id: 123})
There's no fundamental difference between the Hook.Singular
and Hook.Collection
hooks except for the fact that a hook from a collection requires you to pass along the name. Therefore the following explanation applies to both code snippets as described above.
The methods are executed in the following order
beforeHook
fetchFromDatabase
afterHook
getData
beforeHook
can mutate options
before it’s passed to fetchFromDatabase
.
If an error is thrown in beforeHook
or fetchFromDatabase
then errorHook
is
called next.
If afterHook
throws an error then handleGetError
is called instead
of getData
.
If errorHook
throws an error then handleGetError
is called next, otherwise
afterHook
and getData
.
You can also use hook.wrap
to achieve the same thing as shown above (collection example):
hookCollection.wrap('get', async (getData, options) => {
await beforeHook(options)
try {
const result = getData(options)
} catch (error) {
await errorHook(error, options)
}
await afterHook(result, options)
})
npm install before-after-hook
Or download the latest before-after-hook.min.js
.
The Hook.Singular
constructor has no options and returns a hook
instance with the
methods below:
const hook = new Hook.Singular()
Using the singular hook is recommended for TypeScript
The singular hook is a reference to a single hook. This means that there's no need to pass along any identifier (such as a name
as can be seen in the Hook.Collection API).
The API of a singular hook is exactly the same as a collection hook and we therefore suggest you read the Hook.Collection API and leave out any use of the name
argument. Just skip it like described in this example:
const hook = new Hook.Singular()
// good
hook.before(beforeHook)
hook.after(afterHook)
hook(options, fetchFromDatabase)
// bad
hook.before('get', beforeHook)
hook.after('get', afterHook)
hook('get', options, fetchFromDatabase)
The Hook.Collection
constructor has no options and returns a hookCollection
instance with the
methods below
const hookCollection = new Hook.Collection()
Use the api
property to return the public API:
That way you don’t need to expose the hookCollection() method to consumers of your library
Invoke before and after hooks. Returns a promise.
hookCollection(nameOrNames, [options,] method)
Argument | Type | Description | Required |
---|---|---|---|
name | String or Array of Strings | Hook name, for example 'save' . Or an array of names, see example below. | Yes |
options | Object | Will be passed to all before hooks as reference, so they can mutate it | No, defaults to empty object ({} ) |
method | Function | Callback to be executed after all before hooks finished execution successfully. options is passed as first argument | Yes |
Resolves with whatever method
returns or resolves with.
Rejects with error that is thrown or rejected with by
method
Simple Example
hookCollection('save', record, function (record) {
return store.save(record)
})
// shorter: hookCollection('save', record, store.save)
hookCollection.before('save', function addTimestamps (record) {
const now = new Date().toISOString()
if (record.createdAt) {
record.updatedAt = now
} else {
record.createdAt = now
}
})
Example defining multiple hooks at once.
hookCollection(['add', 'save'], record, function (record) {
return store.save(record)
})
hookCollection.before('add', function addTimestamps (record) {
if (!record.type) {
throw new Error('type property is required')
}
})
hookCollection.before('save', function addTimestamps (record) {
if (!record.type) {
throw new Error('type property is required')
}
})
Defining multiple hooks is helpful if you have similar methods for which you want to define separate hooks, but also an additional hook that gets called for all at once. The example above is equal to this:
hookCollection('add', record, function (record) {
return hookCollection('save', record, function (record) {
return store.save(record)
})
})
Add before hook for given name. Returns hookCollection
instance for chaining.
hookCollection.before(name, method)
Argument | Type | Description | Required |
---|---|---|---|
name | String | Hook name, for example 'save' | Yes |
method | Function |
Executed before the wrapped method. Called with the hook’s
options argument. Before hooks can mutate the passed options
before they are passed to the wrapped method.
| Yes |
Example
hookCollection.before('save', function validate (record) {
if (!record.name) {
throw new Error('name property is required')
}
})
Add error hook for given name. Returns hookCollection
instance for chaining.
hookCollection.error(name, method)
Argument | Type | Description | Required |
---|---|---|---|
name | String | Hook name, for example 'save' | Yes |
method | Function |
Executed when an error occurred in either the wrapped method or a
before hook. Called with the thrown error
and the hook’s options argument. The first method
which does not throw an error will set the result that the after hook
methods will receive.
| Yes |
Example
hookCollection.error('save', function (error, options) {
if (error.ignore) return
throw error
})
Add after hook for given name. Returns hook
instance for chaining.
hookCollection.after(name, method)
Argument | Type | Description | Required |
---|---|---|---|
name | String | Hook name, for example 'save' | Yes |
method | Function |
Executed after wrapped method. Called with what the wrapped method
resolves with the hook’s options argument.
| Yes |
Example
hookCollection.after('save', function (result, options) {
if (result.updatedAt) {
app.emit('update', result)
} else {
app.emit('create', result)
}
})
Add wrap hook for given name. Returns hookCollection
instance for chaining.
hookCollection.wrap(name, method)
Argument | Type | Description | Required |
---|---|---|---|
name | String | Hook name, for example 'save' | Yes |
method | Function | Receives both the wrapped method and the passed options as arguments so it can add logic before and after the wrapped method, it can handle errors and even replace the wrapped method altogether | Yes |
Example
hookCollection.wrap('save', async function (saveInDatabase, options) {
if (!record.name) {
throw new Error('name property is required')
}
try {
const result = await saveInDatabase(options)
if (result.updatedAt) {
app.emit('update', result)
} else {
app.emit('create', result)
}
return result
} catch (error) {
if (error.ignore) return
throw error
}
})
See also: Test mock example
Removes hook for given name. Returns hookCollection
instance for chaining.
hookCollection.remove(name, hookMethod)
Argument | Type | Description | Required |
---|---|---|---|
name | String | Hook name, for example 'save' | Yes |
beforeHookMethod | Function |
Same function that was previously passed to hookCollection.before() , hookCollection.error() , hookCollection.after() or hookCollection.wrap()
| Yes |
Example
hookCollection.remove('save', validateRecord)
This library contains type definitions for TypeScript. When you use TypeScript we highly recommend using the Hook.Singular
constructor for your hooks as this allows you to pass along type information for the options object. For example:
import {Hook} from 'before-after-hook'
interface Foo {
bar: string
num: number;
}
const hook = new Hook.Singular<Foo>();
hook.before(function (foo) {
// typescript will complain about the following mutation attempts
foo.hello = 'world'
foo.bar = 123
// yet this is valid
foo.bar = 'other-string'
foo.num = 123
})
const foo = hook({bar: 'random-string'}, function(foo) {
// handle `foo`
foo.bar = 'another-string'
})
// foo outputs
{
bar: 'another-string',
num: 123
}
An alternative import:
import {Singular, Collection} from 'before-after-hook'
const hook = new Singular<{foo: string}>();
const hookCollection = new Collection();
Since version 1.4 the Hook
constructor has been deprecated in favor of returning Hook.Singular
in the next major release.
Version 1.4 is still 100% backwards-compatible, but if you want to continue using hook collections, we recommend using the Hook.Collection
constructor instead before the next release.
For even more details, check out the PR.
If before-after-hook
is not for you, have a look at one of these alternatives:
FAQs
asynchronous before/error/after hooks for internal functionality
We found that before-after-hook demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.