Interface TerminalInterface

Interface for interacting with the terminal from commands.

This interface is passed to command handlers and provides methods for writing output and executing SQL.

interface TerminalInterface {
    clear(): void;
    executeSQL(sql: string): Promise<QueryResult | null>;
    getTheme(): "dark" | "light";
    setTheme(theme: "dark" | "light"): void;
    write(text: string): void;
    writeln(text: string): void;
}

Implemented by

DuckDBTerminal

Index

Methods

clear executeSQL getTheme setTheme write writeln

Methods

clear

clear(): void
Clears the terminal screen.

Returns void
- Defined in types/index.ts:268

executeSQL

executeSQL(sql: string): Promise<QueryResult | null>
Executes a SQL query and returns the result.
Parameters
- sql: string
  The SQL statement to execute
Returns Promise<QueryResult | null>
The query result, or null if an error occurred
- Defined in types/index.ts:274

getTheme

getTheme(): "dark" | "light"
Gets the current theme mode.

Returns "dark" | "light"
The current theme mode
- Defined in types/index.ts:284

setTheme

setTheme(theme: "dark" | "light"): void
Sets the terminal theme.
Parameters
- theme: "dark" | "light"
  The theme to apply ('dark' or 'light')
Returns void
- Defined in types/index.ts:279

write

write(text: string): void
Writes text to the terminal without a newline.
Parameters
- text: string
  The text to write
Returns void
- Defined in types/index.ts:259

writeln

writeln(text: string): void
Writes text to the terminal followed by a newline.
Parameters
- text: string
  The text to write
Returns void
- Defined in types/index.ts:264