TerminalApi
Host operations keep their return convention across execution actors.
Type Parameters
Section titled “Type Parameters”Mode extends "sync" | "async" = "sync" | "async"
Properties
Section titled “Properties”appearance
Section titled “appearance”
readonlyappearance:TerminalAppearance
canvas
Section titled “canvas”
readonlycanvas:HTMLCanvasElement|undefined
diagnostics
Section titled “diagnostics”
readonlydiagnostics:GhosttyWebGpuTerminalDiagnostics
element
Section titled “element”
readonlyelement:HTMLDivElement|undefined
hasPendingFrame
Section titled “hasPendingFrame”
readonlyhasPendingFrame:boolean
hasPendingLinkResolution
Section titled “hasPendingLinkResolution”
readonlyhasPendingLinkResolution:boolean
hasPendingTimer
Section titled “hasPendingTimer”
readonlyhasPendingTimer:boolean
inputModes
Section titled “inputModes”
readonlyinputModes:TerminalInputModes
lifecycle
Section titled “lifecycle”
readonlylifecycle:GhosttyWebGpuTerminalLifecycle
submittedFrame
Section titled “submittedFrame”
readonlysubmittedFrame:TerminalSubmittedFrame|undefined
textarea
Section titled “textarea”
readonlytextarea:HTMLTextAreaElement|undefined
Methods
Section titled “Methods”blur()
Section titled “blur()”blur():
void
Returns
Section titled “Returns”void
captureViewport()
Section titled “captureViewport()”captureViewport():
TerminalResult<Mode,string|undefined>
Returns
Section titled “Returns”TerminalResult<Mode, string | undefined>
clearSelection()
Section titled “clearSelection()”clearSelection():
TerminalResult<Mode,boolean>
Returns
Section titled “Returns”TerminalResult<Mode, boolean>
clearTextureAtlas()
Section titled “clearTextureAtlas()”clearTextureAtlas():
TerminalResult<Mode,void>
Returns
Section titled “Returns”TerminalResult<Mode, void>
connectInput()
Section titled “connectInput()”connectInput(
handler):TerminalResult<Mode,TerminalInputConnection>
Parameters
Section titled “Parameters”handler
Section titled “handler”TerminalInputHandler
Returns
Section titled “Returns”TerminalResult<Mode, TerminalInputConnection>
dispose()
Section titled “dispose()”dispose():
TerminalResult<Mode,void>
Returns
Section titled “Returns”TerminalResult<Mode, void>
focus()
Section titled “focus()”focus():
void
Returns
Section titled “Returns”void
focusNextLink()
Section titled “focusNextLink()”focusNextLink():
Promise<boolean>
Returns
Section titled “Returns”Promise<boolean>
frameSnapshot()
Section titled “frameSnapshot()”frameSnapshot():
TerminalResult<Mode,RendererFrameSnapshot|undefined>
Returns
Section titled “Returns”TerminalResult<Mode, RendererFrameSnapshot | undefined>
geometry()
Section titled “geometry()”geometry():
TerminalResult<Mode,TerminalGeometry>
Returns
Section titled “Returns”TerminalResult<Mode, TerminalGeometry>
getSelection()
Section titled “getSelection()”getSelection(
options?):TerminalResult<Mode,string|undefined>
Parameters
Section titled “Parameters”options?
Section titled “options?”TerminalSelectionFormatOptions
Returns
Section titled “Returns”TerminalResult<Mode, string | undefined>
key(
input):TerminalResult<Mode,TerminalInputResult>
Parameters
Section titled “Parameters”TerminalKeyInput
Returns
Section titled “Returns”TerminalResult<Mode, TerminalInputResult>
lineCount()
Section titled “lineCount()”lineCount():
TerminalResult<Mode,number>
Returns
Section titled “Returns”TerminalResult<Mode, number>
measure()
Section titled “measure()”measure(
text):TerminalResult<Mode,number>
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”TerminalResult<Mode, number>
measureTexts()
Section titled “measureTexts()”measureTexts(
texts):TerminalResult<Mode,TerminalTextMeasurement>
Parameters
Section titled “Parameters”readonly string[]
Returns
Section titled “Returns”TerminalResult<Mode, TerminalTextMeasurement>
on<
Type>(type,listener):EventSubscription
Type Parameters
Section titled “Type Parameters”Type extends keyof GhosttyWebGpuTerminalEventMap
Parameters
Section titled “Parameters”Type
listener
Section titled “listener”GhosttyWebGpuTerminalListener<Type>
Returns
Section titled “Returns”EventSubscription
onData()
Section titled “onData()”onData(
listener):EventSubscription
Parameters
Section titled “Parameters”listener
Section titled “listener”GhosttyWebGpuTerminalListener<"data">
Returns
Section titled “Returns”EventSubscription
onFrame()
Section titled “onFrame()”onFrame(
listener):EventSubscription
Parameters
Section titled “Parameters”listener
Section titled “listener”GhosttyWebGpuTerminalListener<"frame">
Returns
Section titled “Returns”EventSubscription
onResize()
Section titled “onResize()”onResize(
listener):EventSubscription
Parameters
Section titled “Parameters”listener
Section titled “listener”GhosttyWebGpuTerminalListener<"resize">
Returns
Section titled “Returns”EventSubscription
onText()
Section titled “onText()”onText(
listener):EventSubscription
Parameters
Section titled “Parameters”listener
Section titled “listener”(text) => void
Returns
Section titled “Returns”EventSubscription
open()
Section titled “open()”open(
parent):Promise<void>
Parameters
Section titled “Parameters”parent
Section titled “parent”HTMLElement
Returns
Section titled “Returns”Promise<void>
paste()
Section titled “paste()”paste(
data):TerminalResult<Mode,TerminalInputResult>
Parameters
Section titled “Parameters”TerminalInputData
Returns
Section titled “Returns”TerminalResult<Mode, TerminalInputResult>
readLines()
Section titled “readLines()”readLines(
start,end,options?):TerminalResult<Mode, readonlyTerminalLine[]>
Parameters
Section titled “Parameters”number
number
options?
Section titled “options?”ReadLinesOptions
Returns
Section titled “Returns”TerminalResult<Mode, readonly TerminalLine[]>
refresh()
Section titled “refresh()”refresh(
startRow,endRow):TerminalResult<Mode,void>
Parameters
Section titled “Parameters”startRow
Section titled “startRow”number
endRow
Section titled “endRow”number
Returns
Section titled “Returns”TerminalResult<Mode, void>
registerLinkProvider()
Section titled “registerLinkProvider()”registerLinkProvider(
provider):LinkProviderRegistration
Parameters
Section titled “Parameters”provider
Section titled “provider”LinkProvider<Event>
Returns
Section titled “Returns”LinkProviderRegistration
reset()
Section titled “reset()”reset():
TerminalResult<Mode,TerminalMutationResult>
Returns
Section titled “Returns”TerminalResult<Mode, TerminalMutationResult>
scrollBy()
Section titled “scrollBy()”scrollBy(
delta):TerminalResult<Mode,TerminalMutationResult>
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”TerminalResult<Mode, TerminalMutationResult>
scrollToBottom()
Section titled “scrollToBottom()”scrollToBottom():
TerminalResult<Mode,TerminalMutationResult>
Returns
Section titled “Returns”TerminalResult<Mode, TerminalMutationResult>
scrollToRow()
Section titled “scrollToRow()”scrollToRow(
row):TerminalResult<Mode,TerminalMutationResult>
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”TerminalResult<Mode, TerminalMutationResult>
scrollToTop()
Section titled “scrollToTop()”scrollToTop():
TerminalResult<Mode,TerminalMutationResult>
Returns
Section titled “Returns”TerminalResult<Mode, TerminalMutationResult>
selectAll()
Section titled “selectAll()”selectAll():
TerminalResult<Mode,boolean>
Returns
Section titled “Returns”TerminalResult<Mode, boolean>
selectionCoordinates()
Section titled “selectionCoordinates()”selectionCoordinates():
TerminalResult<Mode,Readonly<SelectionCoordinates> |undefined>
Returns
Section titled “Returns”TerminalResult<Mode, Readonly<SelectionCoordinates> | undefined>
selectLines()
Section titled “selectLines()”selectLines(
startRow,endRow):TerminalResult<Mode,boolean>
Parameters
Section titled “Parameters”startRow
Section titled “startRow”number
endRow
Section titled “endRow”number
Returns
Section titled “Returns”TerminalResult<Mode, boolean>
selectRange()
Section titled “selectRange()”selectRange(
start,end):TerminalResult<Mode,boolean>
Parameters
Section titled “Parameters”SelectionPoint
SelectionPoint
Returns
Section titled “Returns”TerminalResult<Mode, boolean>
sendGeneratedInput()
Section titled “sendGeneratedInput()”sendGeneratedInput(
input):TerminalResult<Mode,TerminalInputResult>
Parameters
Section titled “Parameters”TerminalGeneratedInput
Returns
Section titled “Returns”TerminalResult<Mode, TerminalInputResult>
sendInput()
Section titled “sendInput()”sendInput(
data):TerminalResult<Mode,TerminalInputResult>
Parameters
Section titled “Parameters”TerminalInputData
Returns
Section titled “Returns”TerminalResult<Mode, TerminalInputResult>
setAccessibilityEnabled()
Section titled “setAccessibilityEnabled()”setAccessibilityEnabled(
enabled):boolean
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
Returns
Section titled “Returns”boolean
setAppearance()
Section titled “setAppearance()”setAppearance(
options):TerminalResult<Mode,TerminalMutationResult>
Parameters
Section titled “Parameters”options
Section titled “options”TerminalAppearanceOptions
Returns
Section titled “Returns”TerminalResult<Mode, TerminalMutationResult>
setColorScheme()
Section titled “setColorScheme()”setColorScheme(
colorScheme):TerminalResult<Mode,TerminalMutationResult>
Parameters
Section titled “Parameters”colorScheme
Section titled “colorScheme”TerminalColorScheme
Returns
Section titled “Returns”TerminalResult<Mode, TerminalMutationResult>
setCursor()
Section titled “setCursor()”setCursor(
cursor):TerminalResult<Mode,TerminalMutationResult>
Parameters
Section titled “Parameters”cursor
Section titled “cursor”Partial<TerminalCursorSettings>
Returns
Section titled “Returns”TerminalResult<Mode, TerminalMutationResult>
setCursorInactiveStyle()
Section titled “setCursorInactiveStyle()”setCursorInactiveStyle(
style):TerminalResult<Mode,boolean>
Parameters
Section titled “Parameters”InactiveCursorStyle | undefined
Returns
Section titled “Returns”TerminalResult<Mode, boolean>
setFont()
Section titled “setFont()”setFont(
font):TerminalResult<Mode,TerminalMutationResult>
Parameters
Section titled “Parameters”Partial<TerminalFontSettings>
Returns
Section titled “Returns”TerminalResult<Mode, TerminalMutationResult>
setTheme()
Section titled “setTheme()”setTheme(
theme):TerminalResult<Mode,TerminalMutationResult>
Parameters
Section titled “Parameters”TerminalTheme
Returns
Section titled “Returns”TerminalResult<Mode, TerminalMutationResult>
use<
Api>(extension):TerminalResult<Mode,ExtensionHandle<Api>>
Type Parameters
Section titled “Type Parameters”Api = void
Parameters
Section titled “Parameters”extension
Section titled “extension”Extension<Api>
Returns
Section titled “Returns”TerminalResult<Mode, ExtensionHandle<Api>>
visibleLines()
Section titled “visibleLines()”visibleLines(): readonly
string[]
Returns
Section titled “Returns”readonly string[]
write()
Section titled “write()”write(
data):TerminalResult<Mode,TerminalMutationResult>
Parameters
Section titled “Parameters”TerminalInputData
Returns
Section titled “Returns”TerminalResult<Mode, TerminalMutationResult>
writeAndReadGeometry()
Section titled “writeAndReadGeometry()”writeAndReadGeometry(
data):TerminalResult<Mode,TerminalGeometry>
Parameters
Section titled “Parameters”TerminalInputData
Returns
Section titled “Returns”TerminalResult<Mode, TerminalGeometry>
writeln()
Section titled “writeln()”writeln(
data):TerminalResult<Mode,TerminalMutationResult>
Parameters
Section titled “Parameters”TerminalInputData
Returns
Section titled “Returns”TerminalResult<Mode, TerminalMutationResult>