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

Merge pull request #3512 from Tyriar/serialize_doc

Browse Source 
Call out deserialize into same size terminal
This commit is contained in:
Daniel Imms
2021-10-19 10:50:10 -07:00
committed by GitHub
parent 80d4742ded e9f6636df1
commit 1b3eb412b8
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 options Custom options to allow control over what gets serialized.
*/
public serialize(options?: ISerializeOptions): string;