document wonky usage of Terminal.reset

This commit is contained in:
Jörg Breitbart
2019-07-08 00:55:26 +02:00
parent 8654133b15
commit 5122fdc441
+6 -1
View File
@@ -1824,7 +1824,12 @@ export class Terminal extends Disposable implements ITerminal, IDisposable, IInp
}
/**
* Full reset of the terminal.
* Reset terminal.
* Note: Calling this directly from JS is synchronous but does not clear
* input buffers and does not reset the parser, thus the terminal will
* continue to apply pending input data.
* If you need in band reset (synchronous with input data) consider
* using DECSTR (soft reset, CSI ! p) or RIS instead (hard reset, ESC c).
*/
public reset(): void {
/**