waveterm/xterm.js
0
0
Fork 0
mirror of https://github.com/wavetermdev/xterm.js.git synced 2026-08-05 13:43:48 -07:00
Code Issues Packages Projects Releases Wiki Activity

Call out deserialize into same size terminal

Browse Source 
Fixes #3093

Co-authored-by: Megan Rogge <merogge@microsoft.com>
This commit is contained in:
Daniel Imms
2021-10-19 10:49:01 -07:00
co-authored by Megan Rogge
parent be7fcbe485
commit 472e410205
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
addons/xterm-addon-serialize/typings/xterm-addon-serialize.d.ts
Vendored
+4
View File
@@ -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.