addHook(hook)

Adds a hook.

Hook is added to the end of the list. See getHooks method and hooks in plugins.

Arguments

  1. hook (Hook): An object with event and handler properties. See plugins for more info.

Throws

  1. If event is not a string, it will throw an error Hook's event must be a string.

  2. If event doesn't begin with pre or post, it will throw an error Hook's event must start with 'pre' or 'post'.

  3. If handler is not a function, it will throw an error Hook's handler must be a function.

Example

// assuming that you already have cache instance prepared
const hook = {
    event: 'preGetItem',
    handler: () => { ... } // some function that does something, not relevant here
}

cache.addHook(hook);

Last updated