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

    Interface BashKitShellSession

    Managed byte streams and lifecycle for a stateful BashKit interpreter.

    interface BashKitShellSession {
        bash: Bash;
        capabilities: BashKitShellCapabilities;
        error: Error | undefined;
        exit: Promise<BashKitShellExit>;
        status: BashKitShellStatus;
        transport: TerminalTransport;
        close(): Promise<BashKitShellExit>;
        dispose(): void;
        onStatusChange(listener: (status: BashKitShellStatus) => void): Disposable;
    }

    Hierarchy (View Summary)

    Index
    bash capabilities error exit status transport
    close dispose onStatusChange
    bash: Bash

    Underlying BashKit instance for advanced filesystem and snapshot operations.

    capabilities: BashKitShellCapabilities

    Features callers may use to distinguish BashKit from process-backed shells.

    error: Error | undefined

    Fatal stream or lifecycle error, when status is error.

    exit: Promise<BashKitShellExit>

    Settles for exit commands, graceful closure, disposal, and fatal errors.

    status: BashKitShellStatus

    Current lifecycle state.

    transport: TerminalTransport

    Terminal-compatible byte streams. They may be connected once.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods