CopilotKit

CopilotKitCoreRuntimeConnectionStatus

Connection states between CopilotKitCore and the CopilotRuntime.

Overview

CopilotKitCoreRuntimeConnectionStatus represents the state of the connection between CopilotKitCore and its runtime. You encounter it via copilotkit.runtimeConnectionStatus and the onRuntimeConnectionStatusChanged subscriber callback.

Import

import { CopilotKitCoreRuntimeConnectionStatus } from "@copilotkit/core";

Definition

enum CopilotKitCoreRuntimeConnectionStatus {
  Disconnected = "disconnected",
  Connected = "connected",
  Connecting = "connecting",
  Error = "error",
}

Members

Prop

Type

Prop

Type

Prop

Type

Prop

Type

Usage

copilotkit.subscribe({
  onRuntimeConnectionStatusChanged: ({ status }) => {
    if (status === CopilotKitCoreRuntimeConnectionStatus.Connected) {
      enableChat();
    } else if (status === CopilotKitCoreRuntimeConnectionStatus.Error) {
      showConnectionError();
    }
  },
});

Related