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

    Variable displayMessageConst

    displayMessage: (
        ...args: [
            message: string,
            options?: {
                all?: boolean;
                continueUpdate?: boolean;
                delay?: number;
                format?: string;
                ignoreKeys?: boolean;
                literal?: boolean;
                print?: boolean;
                targetClient?: string;
                targetPane?: string;
                verbose?: boolean;
            },
        ],
    ) => Effect<
        string,
        TmuxCommandOptionsError
        | TmuxProcessRunError,
        TmuxProcess,
    > = ...

    Display a message or evaluate a tmux format (tmux display-message).

    Type Declaration

      • (
            ...args: [
                message: string,
                options?: {
                    all?: boolean;
                    continueUpdate?: boolean;
                    delay?: number;
                    format?: string;
                    ignoreKeys?: boolean;
                    literal?: boolean;
                    print?: boolean;
                    targetClient?: string;
                    targetPane?: string;
                    verbose?: boolean;
                },
            ],
        ): Effect<
            string,
            TmuxCommandOptionsError
            | TmuxProcessRunError,
            TmuxProcess,
        >
      • Parameters

        • ...args: [
              message: string,
              options?: {
                  all?: boolean;
                  continueUpdate?: boolean;
                  delay?: number;
                  format?: string;
                  ignoreKeys?: boolean;
                  literal?: boolean;
                  print?: boolean;
                  targetClient?: string;
                  targetPane?: string;
                  verbose?: boolean;
              },
          ]

        Returns Effect<string, TmuxCommandOptionsError | TmuxProcessRunError, TmuxProcess>

        The printed message when { print: true }, otherwise an empty string.

    await tmux.displayMessage("deploy finished");

    const name = await tmux.displayMessage("#{session_name}", { print: true });