Errors

In Bunicorn, we have two types of errors sent to client;

• BunicorError, mostly sent from validation issues, not found or by hand.
• Regular errors, which could be happened by external libraries you are using, instead, Bunicorn sends status 500 without definiton.

Declaration might help you understand the usage:

class HttpError<TData> extends Error {
  message: string; // base of message
  data?: TData; // data to send to client, can be null
  status: number; // status code to send to client, default is 500
  type: ErrorType; // type of error, default is "default"
}

export type ErrorType = "default" | "validation" | "notFound";

// Sent when validation fails
// You can also send that when you want to send 403 for a reason.
class HttpValidationError extends HttpError<FormattedIssue[]> {}

// Sent when not found, such as requested path.
// You can also send that when you want to send 404 for a reason.
class HttpNotFoundError extends HttpError<undefined> {}

Custom Errors

You can create your own errors either by extending HttpError class or sending default error with function. Here is an example:

export class CustomError<TPayload> extends HttpError<TPayload> {
  constructor(payload: TPayload) {
    super({ message: "Custom error message", data: payload, status: 400, type: "customErrorType" });
  }
}

Or

export function newCustomError<TPayload>(payload: TPayload): HttpError<TPayload> {
  return new HttpError({ message: "Custom error message", data: payload, status: 400, type: "customErrorType" });
}

For the next steps, I recommend you to check client errors page.