@visulima/ansi/dist/finalterm.d.ts

ANSI escape codes for some terminal swag.

/**
 * Returns a FinalTerm shell-integration sequence (`OSC 133`).
 *
 * The FinalTerm protocol lets shells mark the structure of their output — where
 * the prompt starts, where the user's command begins, where its output starts
 * and when it finished — so terminals can offer features like jump-to-prompt,
 * command status and selection of command output.
 *
 * Sequence: `OSC 133 ; Pt BEL`
 * @param pm The semicolon-delimited parameters of the sequence.
 * @returns The `OSC 133` escape sequence.
 * @see {@link https://iterm2.com/documentation-shell-integration.html}
 */
declare const finalTerm: (...pm: string[]) => string;
/**
 * Marks the start of the shell prompt. Sent just before the prompt is printed.
 *
 * Sequence: `OSC 133 ; A ; Pt BEL`
 * @param pm Additional parameters appended after the `A` marker.
 * @returns The `OSC 133 ; A` escape sequence.
 */
declare const finalTermPrompt: (...pm: string[]) => string;
/**
 * Marks the end of the prompt and the start of the user's command input.
 *
 * Sequence: `OSC 133 ; B ; Pt BEL`
 * @param pm Additional parameters appended after the `B` marker.
 * @returns The `OSC 133 ; B` escape sequence.
 */
declare const finalTermCmdStart: (...pm: string[]) => string;
/**
 * Marks the start of the command output (the command is about to be executed).
 *
 * Sequence: `OSC 133 ; C ; Pt BEL`
 * @param pm Additional parameters appended after the `C` marker.
 * @returns The `OSC 133 ; C` escape sequence.
 */
declare const finalTermCmdExecuted: (...pm: string[]) => string;
/**
 * Marks the end of the command output. May carry the command's exit code.
 *
 * Sequence: `OSC 133 ; D ; Pt BEL`
 * @param pm Additional parameters appended after the `D` marker (e.g. the exit code).
 * @returns The `OSC 133 ; D` escape sequence.
 */
declare const finalTermCmdFinished: (...pm: string[]) => string;
export { finalTerm, finalTermCmdExecuted, finalTermCmdFinished, finalTermCmdStart, finalTermPrompt };