Simplify options API

Fixes #4259
2026-08-05 13:43:48 -07:00 · 2022-12-11 11:33:03 -08:00
parent c7660fb49c
commit 69379ba59b
1 changed files with 4 additions and 9 deletions
@@ -704,29 +704,24 @@ declare module 'xterm' {
     * Gets or sets the terminal options. This supports setting multiple options.
     *
     * @example Get a single option
-     * ```typescript
+     * ```ts
     * console.log(terminal.options.fontSize);
     * ```
-     */
-    get options(): Required<ITerminalOptions>;
-
-    /**
-     * Gets or sets the terminal options. This supports setting multiple options.
     *
     * @example Set a single option
-     * ```typescript
+     * ```ts
     * terminal.options.fontSize = 12;
     * ```
     *
     * @example Set multiple options
-     * ```typescript
+     * ```ts
     * terminal.options = {
     *   fontSize: 12,
     *   fontFamily: 'Arial',
     * };
     * ```
     */
-    set options(options: ITerminalOptions);
+    options: ITerminalOptions;

    /**
     * Natural language strings that can be localized.