From aba59e9386cdad27b15a76619912cdeeb741aaca Mon Sep 17 00:00:00 2001
From: Daniel Imms <2193314+Tyriar@users.noreply.github.com>
Date: Thu, 15 Dec 2022 16:41:31 -0800
Subject: [PATCH] Explain object option edge case

Fixes #4124
---
 typings/xterm.d.ts | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts
index 6168ff4b..b652491a 100644
--- a/typings/xterm.d.ts
+++ b/typings/xterm.d.ts
@@ -712,17 +712,30 @@ declare module 'xterm' {
     readonly modes: IModes;
 
     /**
-     * Gets or sets the terminal options. This supports setting multiple options.
+     * Gets or sets the terminal options. This supports setting multiple
+     * options.
      *
      * @example Get a single option
      * ```ts
      * console.log(terminal.options.fontSize);
      * ```
      *
-     * @example Set a single option
+     * @example Set a single option:
      * ```ts
      * terminal.options.fontSize = 12;
      * ```
+     * Note that for options that are object, a new object must be used in order
+     * to take effect as a reference comparison will be done:
+     * ```ts
+     * const newValue = terminal.options.theme;
+     * newValue.background = '#000000';
+     *
+     * // This won't work
+     * terminal.options.theme = newValue;
+     *
+     * // This will work
+     * terminal.options.theme = { ...newValue };
+     * ```
      *
      * @example Set multiple options
      * ```ts