@directus/errors

Utility functions to help creating and checking against Directus errors.

Installation

``
pnpm add @directus/errors
`

Usage

$3

`
createError(code: string, message: string | (T) => string, status = 500): DirectusErrorConstructor
`

`ts
import { createError } from '@directus/errors';

const ForbiddenError = createError('FORBIDDEN', "You don't have permissions to see this.", 403);

throw new ForbiddenError();
`

You can configure additional extensions for the error class which should be communicated to the end user:

`ts
import { createError } from '@directus/errors';

interface ForbiddenErrorExtensions {
collection: string;
field: string;
}

const ForbiddenError = createError(
'FORBIDDEN',
"You don't have permissions to see this.",
403,
);

throw new ForbiddenError({
collection: 'articles',
field: 'title',
});
`

You can then also use those extensions to generate out the error message:

`ts
import { createError } from '@directus/errors';

interface ForbiddenErrorExtensions {
collection: string;
field: string;
}

const messageConstructor = (extensions: ForbiddenErrorExtensions) =>
You don't have permissions to see "${extensions.field}" in "${extensions.collection}".;

const ForbiddenError = createError('FORBIDDEN', messageConstructor, 403);

throw new ForbiddenError({
collection: 'articles',
field: 'title',
});
`

$3

`ts
import { isDirectusError, createError } from '@directus/errors';

const ForbiddenError = createError('FORBIDDEN', "You don't have permissions to see this.", 403);

isDirectusError(new ForbiddenError()); // true
isDirectusError(new Error()); // false
``