Error Handling

Custom error classes are available for throwing specific errors within your actions or routes. These helpers provide more meaningful and standardized error responses across your application while following the familiar throw new Error() pattern.

Available Custom Errors

The following custom error classes are available:

Each error class shares the same common behavior, differing only in the status property. This determines the specific HTTP status code returned in the error response.

Usage

Here's an example of how to use the UnauthorizedError and ForbiddenError classes in an action or route:

import { UnauthorizedError, ForbiddenError } from '@vergestack/api';
 
export const authAction = createAction()
  .input(z.void())
  .output(z.void())
  .handler(async () => {
    if (!isUserAuthenticated()) {
      throw new UnauthorizedError('User is not authenticated');
    }
 
    if (!userHasAccess()) {
      throw new ForbiddenError('User does not have access');
    }
 
    // ... rest of the action logic
  });

Built-in Error Handling

The framework handles the following errors automatically:

export const errorAction = createAction()
  .input(z.void())
  .output(z.void())
  .handler(async () => {
    throw new Error('This is a native error');
  });