freeCodeCamp/probot/presolver/node_modules/before-after-hook

before-after-hook

asynchronous before/error/after hooks for internal functionality

Usage

// instantiate hook API
const hook = new Hook()

// Create a hook
hook('get', getData)
  .then(handleData)
  .catch(handleGetError)

// register before/after/error hooks.
// The methods can be asynchronous by returning a Promise
hook.before('get', beforeHook)
hook.error('get', errorHook)
hook.after('get', afterHook)

The methods are executed in the following order

1. beforeHook
2. getData
3. afterHook
4. handleData

If an error is thrown in beforeHook or getData then errorHook is called next.

If afterHook throws an error then handleGetError is called instead of handleData.

If errorHook throws an error then handleGetError is called next, otherwise afterHook and handleData.

Install

npm install before-after-hook

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

API

• Constructor
• hook.api
• hook()
• hook.before()
• hook.error()
• hook.after()
• hook.remove.before()
• hook.remove.error()
• hook.remove.after()

Constructor

The Hook constructor has no options and returns a hook instance with the methods below

const hook = new Hook()

hook.api

Use the api property to return the public API:

• hook.before()
• hook.after()
• hook.error()
• hook.remove.before()
• hook.remove.after()
• hook.remove.error()

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

hook()

Invoke before and after hooks. Returns a promise.

hook(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

1. Any of the before hooks, whichever rejects / throws first
2. method
3. Any of the after hooks, whichever rejects / throws first

Simple Example

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

hook.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.

hook(['add', 'save'], record, function (record) {
  return store.save(record)
})

hook.before('add', function addTimestamps (record) {
  if (!record.type) {
    throw new Error('type property is required')
  }
})

hook.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:

hook('add', record, function (record) {
  return hook('save', record, function (record) {
    return store.save(record)
  })
})

hook.before()

Add before hook for given name. Returns hook instance for chaining.

hook.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

hook.before('save', function validate (record) {
  if (!record.name) {
    throw new Error('name property is required')
  }
})

hook.error()

Add error hook for given name. Returns hook instance for chaining.

hook.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

hook.error('save', function (error, options) {
  if (error.ignore) return
  throw error
})

hook.after()

Add after hook for given name. Returns hook instance for chaining.

hook.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

hook.after('save', function (result, options) {
  if (result.updatedAt) {
    app.emit('update', result)
  } else {
    app.emit('create', result)
  }
})

hook.remove.before()

Removes before hook for given name. Returns hook instance for chaining.

hook.remove.before(name, beforeHookMethod)

Argument	Type	Description	Required
name	String	Hook name, for example 'save'	Yes
beforeHookMethod	Function	Same function that was previously passed to hook.before()	Yes

Example

hook.remove.before('save', validateRecord)

hook.remove.error()

Removes error hook for given name. Returns hook instance for chaining.

hook.remove.error(name, afterHookMethod)

Argument	Type	Description	Required
name	String	Hook name, for example 'save'	Yes
afterHookMethod	Function	Same function that was previously passed to hook.error()	Yes

Example

hook.remove.error('save', handleError)

hook.remove.after()

Removes after hook for given name. Returns hook instance for chaining.

hook.remove.after(name, afterHookMethod)

Argument	Type	Description	Required
name	String	Hook name, for example 'save'	Yes
afterHookMethod	Function	Same function that was previously passed to hook.after()	Yes

Example

hook.remove.after('save', triggerEvents)

See also

If before-after-hook is not for you, have a look at one of these alternatives:

• https://github.com/keystonejs/grappling-hook
• https://github.com/sebelga/promised-hooks
• https://github.com/bnoguchi/hooks-js
• https://github.com/cb1kenobi/hook-emitter

License

Apache 2.0