From 472e410205fb622f617ad8d70fa2c35e5106bb95 Mon Sep 17 00:00:00 2001 From: Daniel Imms <2193314+Tyriar@users.noreply.github.com> Date: Tue, 19 Oct 2021 10:49:01 -0700 Subject: [PATCH] Call out deserialize into same size terminal Fixes #3093 Co-authored-by: Megan Rogge --- .../xterm-addon-serialize/typings/xterm-addon-serialize.d.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/addons/xterm-addon-serialize/typings/xterm-addon-serialize.d.ts b/addons/xterm-addon-serialize/typings/xterm-addon-serialize.d.ts index b55ee303..23290af4 100644 --- a/addons/xterm-addon-serialize/typings/xterm-addon-serialize.d.ts +++ b/addons/xterm-addon-serialize/typings/xterm-addon-serialize.d.ts @@ -24,6 +24,10 @@ declare module 'xterm-addon-serialize' { * the state. The cursor will also be positioned to the correct cell. When restoring a terminal * it is best to do before `Terminal.open` is called to avoid wasting CPU cycles rendering * incomplete frames. + * + * It's recommended that you write the serialized data into a terminal of the same size in which + * it originated from and then resize it after if needed. + * * @param scrollback The number of rows in scrollback buffer to serialize, starting from the * bottom of the scrollback buffer. This defaults to the all available rows in the scrollback * buffer.