@visulima/ansi/dist/xterm.d.mts

ANSI escape codes for some terminal swag.

/**
 * XTerm Key Modifier Options XTMODKEYS.
 * Sets or resets XTerm key modifier resources.
 *
 * Sequence: `CSI > Pp m` (to reset resource Pp)
 * Sequence: `CSI > Pp ; Pv m` (to set resource Pp to value Pv)
 * @param resource The resource parameter (Pp), a non-negative integer.
 * @param value Optional. The value parameter (Pv), a non-negative integer. If omitted, the resource is reset.
 * If provided and not positive, it's treated as if omitted (resource is reset).
 * @returns The ANSI escape sequence.
 * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-_-ordered-by-the-final-character_s_}
 */
export declare const keyModifierOptions: (resource: number, value?: number) => string;
/**
 * Alias for {@link keyModifierOptions}.
 * Provides a shorthand for setting or resetting XTerm key modifier resources.
 * @see keyModifierOptions
 */
export declare const XTMODKEYS: (resource: number, value?: number) => string;
/**
 * Query XTerm Key Modifier Options (XTQMODKEYS).
 * Requests the current setting of an XTerm key modifier resource.
 *
 * Sequence: `CSI ? Pp m`
 * @param resource The resource parameter (Pp), a non-negative integer.
 * @returns The ANSI escape sequence.
 * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-_-ordered-by-the-final-character_s_}
 */
export declare const queryKeyModifierOptions: (resource: number) => string;
/**
 * Resets an XTerm key modifier resource to its initial value.
 * This is an alias for `keyModifierOptions(resource)`.
 * @param resource The resource parameter (Pp).
 */
export declare const resetKeyModifierOptions: (resource: number) => string;
/**
 * Sets an XTerm key modifier resource to a specific value.
 * This is a more explicit alias for `keyModifierOptions(resource, value)`.
 * @param resource The resource parameter (Pp).
 * @param value The value parameter (Pv).
 */
export declare const setKeyModifierOptions: (resource: number, value: number) => string;
/** Alias for {@link queryKeyModifierOptions}. */
export declare const XTQMODKEYS: (resource: number) => string;
/**
 * Set XTerm "modifyOtherKeys" mode to mode 1 (sends modified escape sequences for certain keys).
 * Sequence: `CSI > 4 ; 1 m`
 * @example
 * ```typescript
 * import { setModifyOtherKeys1 } from "@visulima/ansi";
 *
 * process.stdout.write(setModifyOtherKeys1);
 * // Sends: "\x1b[>4;1m"
 * ```
 */
export declare const setModifyOtherKeys1: string;
/**
 * Set XTerm "modifyOtherKeys" mode to mode 2 (alternative modified escape sequences).
 * Sequence: `CSI > 4 ; 2 m`
 * @example
 * ```typescript
 * import { setModifyOtherKeys2 } from "@visulima/ansi";
 *
 * process.stdout.write(setModifyOtherKeys2);
 * // Sends: "\x1b[>4;2m"
 * ```
 */
export declare const setModifyOtherKeys2: string;
/**
 * Reset XTerm "modifyOtherKeys" to its default behavior (mode 0 or initial value).
 * Sequence: `CSI > 4 m` (This effectively sets resource 4, value 0, or resets resource 4).
 * @example
 * ```typescript
 * import { resetModifyOtherKeys } from "@visulima/ansi";
 *
 * process.stdout.write(resetModifyOtherKeys);
 * // Sends: "\x1b[>4m"
 * ```
 */
export declare const resetModifyOtherKeys: string;
/**
 * Query the current XTerm "modifyOtherKeys" mode.
 * Sequence: `CSI ? 4 m`
 * Response: `CSI > 4 ; Ps m` where Ps is 0, 1, or 2.
 * @example
 * ```typescript
 * import { queryModifyOtherKeys } from "@visulima/ansi";
 *
 * process.stdout.write(queryModifyOtherKeys);
 * // Sends: "\x1b[?4m"
 * // Expect a response like: "\x1b[>4;1m" if mode 1 is set.
 * ```
 */
export declare const queryModifyOtherKeys: string;