before-after-hook

asynchronous hooks for internal functionality

Usage

Singular hook

Recommended for TypeScript

// instantiate singular hook API
const hook = new Hook.Singular()

// Create a hook
function getData (options) {
  return hook(fetchFromDatabase, options)
    .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})

Hook collection

// instantiate hook collection API
const hookCollection = new Hook.Collection()

// Create a hook
function getData (options) {
  return hookCollection('get', fetchFromDatabase, options)
    .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})

Hook.Singular vs Hook.Collection

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

Install

npm install before-after-hook

Or download the latest before-after-hook.min.js.

Singular hook API

Singular constructor
hook.api
hook()
hook.before()
hook.error()
hook.after()
hook.wrap()
hook.remove()

Singular constructor

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

Singular API

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(fetchFromDatabase, options)

// bad
hook.before('get', beforeHook)
hook.after('get', afterHook)
hook('get', fetchFromDatabase, options)

Hook collection API

Collection constructor
collection.api
collection()
collection.before()
collection.error()
collection.after()
collection.wrap()
collection.remove()

Collection constructor

The Hook.Collection constructor has no options and returns a hookCollection instance with the methods below

const hookCollection = new Hook.Collection()

hookCollection.api

Use the api property to return the public API:

hookCollection.before()
hookCollection.after()
hookCollection.error()
hookCollection.wrap()
hookCollection.remove()

That way you don’t need to expose the hookCollection() method to consumers of your library

hookCollection()

Invoke before and after hooks. Returns a promise.

hookCollection(nameOrNames, method /*, options */)

Argument	Type	Description	Required
`name`	String or Array of Strings	Hook name, for example `'save'`. Or an array of names, see example below.	Yes
`method`	Function	Callback to be executed after all before hooks finished execution successfully. `options` is passed as first argument	Yes
`options`	Object	Will be passed to all before hooks as reference, so they can mutate it	No, defaults to empty object (`{}`)

Resolves with whatever method returns or resolves with. Rejects with error that is thrown or rejected with by

Any of the before hooks, whichever rejects / throws first
method
Any of the after hooks, whichever rejects / throws first

Simple Example

hookCollection('save', function (record) {
  return store.save(record)
}, record)
// shorter:  hookCollection('save', store.save, record)

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'], function (record) {
  return store.save(record)
}, 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', function (record) {
  return hookCollection('save', function (record) {
    return store.save(record)
  }, record)
}, record)

hookCollection.before()

Add before hook for given name.

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

hookCollection.error()

Add error hook for given name.

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

hookCollection.after()

Add after hook for given name.

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

hookCollection.wrap()

Add wrap hook for given name.

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

hookCollection.remove()

Removes hook for given name.

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)

TypeScript

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(function(foo) {
  // handle `foo`
  foo.bar = 'another-string'
}, {bar: 'random-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();

Upgrading to 1.4

Since version 1.4 the Hook constructor has been deprecated in favor of returning Hook.Singular in an upcoming breaking 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.

License

Apache 2.0

kuailingmin / before-after-hook Goto Github PK