Convex · Schema

FunctionErrorResponse

BackendDatabaseFunctionsReal-TimeReactiveServerlessTypeScript

Properties

Name Type Description
status string Indicates the function encountered an error during execution.
errorMessage string A human-readable description of the error that occurred during function execution.
errorData object Additional structured data about the error, present when the function throws a ConvexError with associated data. The shape depends on the application-specific error definition.
logLines array An array of strings representing console output produced by the function prior to the error.
View JSON Schema on GitHub

JSON Schema

convex-functionerrorresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FunctionErrorResponse",
  "title": "FunctionErrorResponse",
  "type": "object",
  "required": [
    "status",
    "errorMessage",
    "logLines"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Indicates the function encountered an error during execution.",
      "enum": [
        "error"
      ]
    },
    "errorMessage": {
      "type": "string",
      "description": "A human-readable description of the error that occurred during function execution."
    },
    "errorData": {
      "type": "object",
      "description": "Additional structured data about the error, present when the function throws a ConvexError with associated data. The shape depends on the application-specific error definition.",
      "additionalProperties": true
    },
    "logLines": {
      "type": "array",
      "description": "An array of strings representing console output produced by the function prior to the error.",
      "items": {
        "type": "string"
      }
    }
  }
}