Interface UseGespenstTerminalResult

Values returned by useGespenstTerminal.

interface UseGespenstTerminalResult {
    ref: RefObject<HTMLDivElement | null>;
    setTerminal: (terminal: BrowserTerminal | null) => void;
    terminal: BrowserTerminal | null;
}

Properties

ref: RefObject<HTMLDivElement | null>

Attach this ref to the element that will host the terminal.

setTerminal: (terminal: BrowserTerminal | null) => void

Updates the terminal exposed to consumers of the hook.

terminal: BrowserTerminal | null

The current terminal, or null before one has been assigned.