Type Alias BusErrorCode

BusErrorCode:
    | "VC_CORE_NO_HANDLER"
    | "VC_CORE_HANDLER_THREW"
    | "VC_CORE_BEFORE_CANCEL"
    | "VC_CORE_NAMING_VIOLATION"
    | "VC_CORE_HANDLER_OVERWRITE"
    | "VC_CORE_REQUEST_TIMEOUT"
    | "VC_CORE_THROTTLED"
    | "VC_CORE_MAX_DEPTH"
    | "VC_CORE_SEALED"
    | "VC_CORE_ABORTED"
    | "VC_PLUGIN_CIRCUIT_OPEN"
    | "VC_PLUGIN_RATE_LIMITED"
    | "VC_PLUGIN_CACHE_MISS"
    | "VC_VALIDATION_FAILED"
    | "VC_WORKFLOW_STEP_FAILED"
    | "VC_WORKFLOW_COMPENSATE_FAILED"
    | "VC_HOOK_ERROR"
    | "VC_LISTENER_ERROR"
    | "VC_UNKNOWN"

Structured error code enum. Every error in vapor-chamber has a unique code.

Naming: VC_{EMITTER}_{DESCRIPTION} — VC = vapor-chamber prefix.

Example

if (result.error instanceof BusError) {
  switch (result.error.code) {
    case 'VC_CORE_NO_HANDLER':    // register a handler
    case 'VC_CORE_BEFORE_CANCEL': // a beforeHook threw
    case 'VC_PLUGIN_CIRCUIT_OPEN': // circuit breaker tripped
  }
}