Class ServiceError

constructor

• new ServiceError(parameters: ServiceErrorParams): ServiceError

  Creates a new ServiceError

  Parameters

  • parameters: ServiceErrorParams

    Issues contributing to the error or a message string

  Returns ServiceError

Readonlyid

Readonlyissues

Readonlysource

Readonlystatus

toJsonApi

• toJsonApi(): {
      errors: {
          code: ErrorCode;
          detail?: string;
          id: string;
          source?: { [key: string]: string };
          status: string;
          title: string;
      }[];
  }

  Converts the error to JSON:API format

  Returns {
      errors: {
          code: ErrorCode;
          detail?: string;
          id: string;
          source?: { [key: string]: string };
          status: string;
          title: string;
      }[];
  }

  Object conforming to JSON:API error format

  See

  https://jsonapi.org/format/#error-objects

toString

• toString(): string

  Return string representation of the error for logging.

  Returns string

StaticfromJsonApi

• fromJsonApi(
      jsonApiError: {
          errors: {
              code?: ErrorCode;
              detail?: string;
              id?: string;
              source?: Record<string, string>;
              status?: string;
              title?: string;
          }[];
      },
  ): ServiceError

  Creates a ServiceError from a JSON:API error object

  Parameters

  • jsonApiError: {
        errors: {
            code?: ErrorCode;
            detail?: string;
            id?: string;
            source?: Record<string, string>;
            status?: string;
            title?: string;
        }[];
    }

    JSON:API error object

  Returns ServiceError

  New ServiceError instance

  See

  https://jsonapi.org/format/#error-objects

StaticfromUnknown

• fromUnknown(value: unknown): ServiceError

  Converts an unknown value to a ServiceError. Typically called from catch blocks.

  Parameters

  • value: unknown

    The value to convert, which can be any type

  Returns ServiceError

  If the value is already a ServiceError, returns it unchanged. Otherwise, convert it to a ServiceError.

StaticfromZodError

• fromZodError(error: ZodError, options?: { source?: ErrorSource }): ServiceError

  Converts a ZodError to a ServiceError.

  Parameters

  • error: ZodError

    A ZodError
  • Optionaloptions: { source?: ErrorSource }

  Returns ServiceError

  The converted ServiceError