@clairview/errors
v1.0.1
Published
Create consistent error objects around the codebase
Downloads
4
Readme
@clairview/errors
Utility functions to help creating and checking against Clairview errors.
Installation
pnpm add @clairview/errors
Usage
Creating a new Error class
createError(code: string, message: string | (T) => string, status = 500): ClairviewErrorConstructor<T>
import { createError } from '@clairview/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:
import { createError } from '@clairview/errors';
interface ForbiddenErrorExtensions {
collection: string;
field: string;
}
const ForbiddenError = createError<ForbiddenErrorExtensions>(
'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:
import { createError } from '@clairview/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<ForbiddenErrorExtensions>('FORBIDDEN', messageConstructor, 403);
throw new ForbiddenError({
collection: 'articles',
field: 'title',
});
Checking if a given param is a valid ClairviewError instance
import { isClairviewError, createError } from '@clairview/errors';
const ForbiddenError = createError('FORBIDDEN', "You don't have permissions to see this.", 403);
isClairviewError(new ForbiddenError()); // true
isClairviewError(new Error()); // false