Interface: TerminalStreamOptions
Options for configuring terminal stream behavior.
Properties
connectStream()
connectStream: (onData: (data: ArrayBuffer) => void) => Promise<object>;
Function that establishes stream connection
Parameters
| Parameter | Type |
|---|---|
onData | (data: ArrayBuffer) => void |
Returns
Promise<object>
initialMessage?
optional initialMessage: string;
stream
stream: any;
Defined in
src/lib/k8s/useTerminalStream.ts:53
containerRef
containerRef: null | HTMLElement;
Terminal container HTML element
Defined in
src/lib/k8s/useTerminalStream.ts:58
detectOS?
optional detectOS: boolean;
Whether to detect Windows OS
Defined in
src/lib/k8s/useTerminalStream.ts:70
enabled?
optional enabled: boolean;
Whether terminal should be active
Defined in
src/lib/k8s/useTerminalStream.ts:60
errorHandlers?
optional errorHandlers: object;
Custom error handlers
isShellNotFound()?
optional isShellNotFound: (channel: number, text: string) => boolean;
Parameters
| Parameter | Type |
|---|---|
channel | number |
text | string |
Returns
boolean
isSuccessfulExit()?
optional isSuccessfulExit: (channel: number, text: string) => boolean;
Parameters
| Parameter | Type |
|---|---|
channel | number |
text | string |
Returns
boolean
onConnectionFailed()?
optional onConnectionFailed: (xtermc: XTerminalConnected) => void;
Parameters
| Parameter | Type |
|---|---|
xtermc | XTerminalConnected |
Returns
void
Defined in
src/lib/k8s/useTerminalStream.ts:64
onClose()?
optional onClose: () => void;
Callback when terminal is closed
Returns
void
Defined in
src/lib/k8s/useTerminalStream.ts:62
xtermOptions?
optional xtermOptions: object;
Additional xterm configuration
cursorBlink?
optional cursorBlink: boolean;
cursorStyle?
optional cursorStyle: "block" | "underline" | "bar";
rows?
optional rows: number;
scrollback?
optional scrollback: number;
windowsMode?
optional windowsMode: boolean;