clean-jsdoc-theme TypeDoc APIv0.0.0

createErrorResponse

createErrorResponse( code: string, message: string, status?: HttpStatusCode, details?: ErrorDetail[], ): ApiErrorResponse

Source: api.ts:483

Creates an error response

Parameters

  • code (string) — Error code
  • message (string) — Error message
  • status (HttpStatusCode, optional) — HTTP status code
  • details (ErrorDetail[], optional) — Optional error details

Returns

Example

CODE
return createErrorResponse(
  'NOT_FOUND',
  'User not found',
  404
)