mirror of
https://github.com/strapi/strapi.git
synced 2025-07-21 16:10:18 +00:00
c5275958b0
* Add per hook timeout config Signed-off-by: MattieBelt <mattiasvandenbelt@gmail.com> * Update hook docs with timeout config options Signed-off-by: MattieBelt <mattiasvandenbelt@gmail.com>
94 lines
2.2 KiB
Markdown
94 lines
2.2 KiB
Markdown
# Hooks
|
|
|
|
The hooks are modules that add functionality to the core. They are loaded during the server boot.
|
|
|
|
## Structure
|
|
|
|
### File structure
|
|
|
|
```js
|
|
module.exports = strapi => {
|
|
const hook = {
|
|
/**
|
|
* Default options
|
|
*/
|
|
|
|
defaults: {
|
|
// config object
|
|
},
|
|
|
|
/**
|
|
* Initialize the hook
|
|
*/
|
|
|
|
async initialize() {
|
|
// await someAsyncCode()
|
|
// const settings = {...this.defaults, ...strapi.config.hook.settings.**};
|
|
},
|
|
};
|
|
|
|
return hook;
|
|
};
|
|
```
|
|
|
|
- `defaults` (object): Contains the default configurations.
|
|
- `initialize` (function): Called during the server boot.
|
|
|
|
The [configurations](#configuration-and-activation) of the hook are accessible through `strapi.config.hook.settings.**`.
|
|
|
|
The hooks are accessible through the `strapi.hook` variable.
|
|
|
|
### Node modules
|
|
|
|
Every folder that follows this name pattern `strapi-hook-*` in your `./node_modules` folder will be loaded as a hook.
|
|
|
|
A hook needs to follow the structure below:
|
|
|
|
```
|
|
/strapi-hook-[...]
|
|
└─── lib
|
|
- index.js
|
|
- LICENSE.md
|
|
- package.json
|
|
- README.md
|
|
```
|
|
|
|
The `index.js` is the entry point to your hook. It should look like the example above.
|
|
|
|
### Custom local hooks
|
|
|
|
The framework allows loading hooks from the project directly without having to install them from npm. It's a great way to take advantage of the features of the hooks system for code that doesn't need to be shared between apps. To achieve this, you have to create a `./hooks` folder at the root of your project and put the hooks into it.
|
|
|
|
```
|
|
/project
|
|
└─── admin
|
|
└─── api
|
|
└─── config
|
|
│ - hook.js
|
|
└─── hooks
|
|
│ └─── strapi-documentation
|
|
│ - index.js
|
|
│ └─── strapi-server-side-rendering
|
|
│ - index.js
|
|
└─── public
|
|
- favicon.ico
|
|
- package.json
|
|
- server.js
|
|
```
|
|
|
|
## Configuration and activation
|
|
|
|
To activate and configure hooks with custom options, you need to add/edit your `./config/hook.js` file in your Strapi app. A hook specific timeout value will overwrite the global timeout value, the default `timeout` value is 1000 milliseconds.
|
|
|
|
```js
|
|
module.exports = {
|
|
timeout: 2000,
|
|
settings: {
|
|
'hook-name': {
|
|
enabled: true,
|
|
timeout: 3000,
|
|
},
|
|
},
|
|
};
|
|
```
|