Interface PaginationContext

Interface for the terminal context needed by pagination

interface PaginationContext {
    backspace: () => string;
    clearInput: () => void;
    displayResult: (result: QueryResult, sql: string) => void | Promise<void>;
    getDatabase: () => Database;
    getInputContent: () => string;
    insertChar: (char: string) => string;
    write: (text: string) => void;
    writeln: (text: string) => void;
}

Properties

backspace: () => string

Backspace in input buffer

clearInput: () => void

Clear input buffer

displayResult: (result: QueryResult, sql: string) => void | Promise<void>

Display query result with the SQL statement that produced it

getDatabase: () => Database

Get the database instance

getInputContent: () => string

Get input buffer content

insertChar: (char: string) => string

Insert character into input buffer

write: (text: string) => void

Write text to terminal (no newline)

writeln: (text: string) => void

Write text to terminal with newline