clean-jsdoc-theme TypeDoc APIv0.0.0

ApiErrorResponse

interface ApiErrorResponse { error: ApiError; success: false; }

Source: api.ts:113

API error response wrapper

Example

CODE
const error: ApiErrorResponse = {
  success: false,
  error: {
    code: 'VALIDATION_ERROR',
    message: 'Invalid email format',
    details: [{ field: 'email', message: 'Must be a valid email' }]
  }
}

Properties

error: ApiError

Error details

success: false

Always false for error responses