tmux.ts - v0.1.3
    Preparing search index...

    Variable clearHistoryConst

    clearHistory: (
        options?: { clearHyperlinks?: boolean; targetPane?: string },
    ) => Effect<
        string,
        TmuxCommandOptionsError
        | TmuxProcessRunError,
        TmuxProcess,
    > = ...

    Clear a tmux pane's scrollback history (tmux clear-history).

    Type Declaration

      • (
            options?: { clearHyperlinks?: boolean; targetPane?: string },
        ): Effect<
            string,
            TmuxCommandOptionsError
            | TmuxProcessRunError,
            TmuxProcess,
        >
      • Parameters

        • Optionaloptions: { clearHyperlinks?: boolean; targetPane?: string }
          • Optional ReadonlyclearHyperlinks?: boolean

            Also remove all hyperlinks in addition to the pane history (-H).

          • Optional ReadonlytargetPane?: string

            Pane whose scrollback history is removed and freed (-t).

        Returns Effect<string, TmuxCommandOptionsError | TmuxProcessRunError, TmuxProcess>

        An empty string on success.

    await tmux.clearHistory({ targetPane: "work:1.0" });

    await tmux.clearHistory({ clearHyperlinks: true, targetPane: "work:1.0" });