gespenst API - v0.1.0
    Preparing search index...

    Module index

    Terminal

    The stable xterm.js 6 public API backed by Ghostty's VT implementation. Use ready whenever work must wait for the asynchronous WASM startup.

    XtermCompatibilityError

    Error thrown when an xterm.js extension point cannot be implemented over Ghostty.

    IBuffer

    Represents a terminal buffer.

    IBufferCell

    Represents a single cell in the terminal's buffer.

    IBufferCellPosition

    A position within a buffer.

    IBufferElementProvider
    IBufferLine

    Represents a line in the terminal's buffer.

    IBufferNamespace

    Represents the terminal's set of buffers.

    IBufferRange

    A range within a buffer.

    IDecoration

    Represents a decoration in the terminal that is associated with a particular marker and DOM element.

    IDecorationOptions
    IDecorationOverviewRulerOptions

    Overview ruler decoration options

    IDisposable

    An object that can be disposed via a dispose function.

    IDisposableWithEvent

    Represents a disposable that tracks is disposed state.

    IEvent

    An event that can be listened to.

    IFunctionIdentifier

    Data type to register a CSI, DCS or ESC callback in the parser in the form: ESC I..I F CSI Prefix P..P I..I F DCS Prefix P..P I..I F data_bytes ST

    A link within the terminal.

    ILinkDecorations

    A set of decorations that can be applied to links.

    ILinkHandler

    A link handler for OSC 8 hyperlinks.

    ILinkProvider

    A custom link provider.

    ILocalizableStrings

    The set of localizable strings.

    ILogger

    A replacement logger for console.

    IMarker

    Represents a specific line in the terminal that is tracked when scrollback is trimmed and lines are added or removed. This is a single line that may be part of a larger wrapped line.

    IModes

    Terminal modes as set by SM/DECSET.

    IOverviewRulerOptions
    IParser

    Allows hooking into the parser for custom handling of escape sequences.

    ITerminalAddon

    An addon that can provide additional functionality to the terminal.

    ITerminalInitOnlyOptions

    An object containing additional options for the terminal that can only be set on start up.

    ITerminalOptions

    An object containing options for the terminal.

    ITheme

    Contains colors to theme the terminal with.

    IUnicodeHandling

    (EXPERIMENTAL) Unicode handling interface.

    IUnicodeVersionProvider

    (EXPERIMENTAL) Unicode version provider. Used to register custom Unicode versions with Terminal.unicode.register.

    IViewportRange

    An object representing a range within the viewport of the terminal.

    IViewportRangePosition

    An object representing a cell position within the viewport of the terminal.

    IWindowOptions

    Enable various window manipulation and report features (CSI Ps ; Ps ; Ps t).

    IWindowsPty

    Pty information for Windows.

    XtermKeyEvent

    Keyboard payload emitted by Terminal.onKey.

    XtermRenderEvent

    Inclusive viewport row range emitted by Terminal.onRender.

    XtermResizeEvent

    Character geometry emitted by Terminal.onResize.

    FontWeight

    A string or number representing text font weight.

    LogLevel

    A string representing log level.

    XTERM_COMPAT_VERSION

    xterm.js API version targeted by this compatibility package.

    toXtermTheme

    Converts a Gespenst theme, including structured colors and legacy palettes, to xterm ITheme.