Rename setting to experimentalBufferLineImpl, expose in d.ts

2018-09-09 07:20:13 -07:00
parent d4d1426bff
commit 7447a8d08d
5 changed files with 15 additions and 5 deletions
@@ -99,6 +99,17 @@ declare module 'xterm' {
     */
    experimentalCharAtlas?: 'none' | 'static' | 'dynamic';

+    /**
+     * (EXPERIMENTAL) Defines which implementation to use for buffer lines.
+     *
+     * - 'JsArray': The default/stable implementation.
+     * - 'TypedArray': The new experimental implementation based on TypedArrays that is expected to
+     *   significantly boost performance and memory consumption. Use at your own risk.
+     *
+     * This option will be removed in the future.
+     */
+    experimentalBufferLineImpl?: 'JsArray' | 'TypedArray';
+
    /**
     * The font size used to render text.
     */