Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: explain usage of async functions in onRequest #548

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: explain usage of async functions in onRequest #548

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/content/en/helpers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,25 @@ export default function ({ $axios, redirect }) {
}
```

Sometimes you might need a asynchronous function to run before every request (e.g. to refresh expired tokens).

Example: (`plugins/axios.js`)

```js
export default function ({ $axios }) {
$axios.onRequest(async (config) => {
try {
await ["your async function"]
} catch (error) {
console.log("An error occured")
}
// it is crucial to return the config option so that the request can continue
return config
})

}
```

When intercepting an error, you can return a resolved promise to prevent the error from propagating.

Example: (`plugins/axios.js`)
Expand Down