Skip to content

Improve error handling examples #477

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve error handling examples #477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8141cb5
improve error handling examples
Nitwel Oct 6, 2025
c5e433c
tweak example
Nitwel Oct 6, 2025
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
5 changes: 3 additions & 2 deletions content/_partials/extensions-api-internals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ Learn more about using internal Directus services.
To create errors in API extensions, you can utilize the [`@directus/errors`](https://www.npmjs.com/package/@directus/errors) package which is available to all extensions without installation.

```js
import { createError } from '@directus/errors';
import { createError, ForbiddenError } from '@directus/errors';

const ForbiddenError = createError('FORBIDDEN', "You don't have permissions to see this.", 403);
const CustomError = createError('CUSTOM', "This is a custom error.", 418);

throw new ForbiddenError();
throw new CustomError();
```
11 changes: 11 additions & 0 deletions content/guides/09.extensions/2.api-extensions/2.endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,14 @@ Learn more about the Directus sandbox for API extensions.
::

:partial{content="extensions-api-internals"}

Inside a route, error like this to make sure that the api doesn't crash.

```ts
router.get('/my-endpoint', async (req, res, next) => {
if(checkForError) {
next(new ForbiddenError())
return
}
})
```