github/directus
1
0
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-01-22 20:47:54 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add "require('axios')" in API hooks examples (#6360)

Browse Source 
* Docs: Add "require('axios')" in API hooks examples

* Move "require('axios')" to top
This commit is contained in:
Pascal Jufer
2021-06-18 15:28:12 +02:00
committed by GitHub
parent 980be7cb53
commit 4a2ea9a03e
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/guides/api-hooks.md
View File

@@ -111,6 +111,8 @@ provide a cron statement in the event scope as follows: `cron(<statement>)`, for
on day-of-month 1) or `cron(5 4 * * sun)` (at 04:05 on Sunday). See example below:
```js
const axios = require('axios');
module.exports = function registerHook() {
return {
'cron(*/15 * * * *)': async function () {
@@ -125,6 +127,8 @@ module.exports = function registerHook() {
Each custom hook is registered to its event scope using a function with the following format:
```js
const axios = require('axios');
module.exports = function registerHook() {
return {
'items.create': function () {
@@ -188,10 +192,12 @@ To deploy your hook, simply restart the API by running:
npx directus start
```
## Full Example:
## Full Example
`extensions/hooks/sync-with-external/index.js`:
```js
// extensions/hooks/sync-with-external/index.js
const axios = require('axios');
module.exports = function registerHook({ services, exceptions }) {
const { MailService } = services;