Skip to main content

Interface: TerminalStreamOptions

Defined in: lib/k8s/useTerminalStream.ts:51

Options for configuring terminal stream behavior.

Properties​

connectStream​

connectStream: (onData: (data: ArrayBuffer) => void) => Promise<{
  initialMessage?: string;
  stream: any;
}>;

Defined in: lib/k8s/useTerminalStream.ts:53

Function that establishes stream connection

Parameters​

ParameterType
onData(data: ArrayBuffer) => void

Returns​

Promise<{ initialMessage?: string; stream: any; }>

containerRef​

containerRef: HTMLElement | null;

Defined in: lib/k8s/useTerminalStream.ts:58

Terminal container HTML element

detectOS?​

optional detectOS?: boolean;

Defined in: lib/k8s/useTerminalStream.ts:70

Whether to detect Windows OS

enabled?​

optional enabled?: boolean;

Defined in: lib/k8s/useTerminalStream.ts:60

Whether terminal should be active

errorHandlers?​

optional errorHandlers?: object;

Defined in: lib/k8s/useTerminalStream.ts:64

Custom error handlers

isShellNotFound?​

optional isShellNotFound?: (channel: number, text: string) => boolean;
Parameters​
ParameterType
channelnumber
textstring
Returns​

boolean

isSuccessfulExit?​

optional isSuccessfulExit?: (channel: number, text: string) => boolean;
Parameters​
ParameterType
channelnumber
textstring
Returns​

boolean

onConnectionFailed?​

optional onConnectionFailed?: (xtermc: XTerminalConnected) => void;
Parameters​
ParameterType
xtermcXTerminalConnected
Returns​

void

onClose?​

optional onClose?: () => void;

Defined in: lib/k8s/useTerminalStream.ts:62

Callback when terminal is closed

Returns​

void

xtermOptions?​

optional xtermOptions?: object;

Defined in: lib/k8s/useTerminalStream.ts:72

Additional xterm configuration

optional cursorBlink?: boolean;

cursorStyle?​

optional cursorStyle?: "block" | "underline" | "bar";

rows?​

optional rows?: number;

scrollback?​

optional scrollback?: number;

windowsMode?​

optional windowsMode?: boolean;