@xterm/headless 5.6.0-beta.101 → 5.6.0-beta.103
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +2 -2
- package/typings/xterm-headless.d.ts +12 -2
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xterm/headless",
|
|
3
3
|
"description": "A headless terminal component that runs in Node.js",
|
|
4
|
-
"version": "5.6.0-beta.
|
|
4
|
+
"version": "5.6.0-beta.103",
|
|
5
5
|
"main": "lib-headless/xterm-headless.js",
|
|
6
6
|
"module": "lib/xterm.mjs",
|
|
7
7
|
"types": "typings/xterm-headless.d.ts",
|
|
@@ -22,5 +22,5 @@
|
|
|
22
22
|
"webgl",
|
|
23
23
|
"xterm"
|
|
24
24
|
],
|
|
25
|
-
"commit": "
|
|
25
|
+
"commit": "2af170dbc91f4b1981bad5ca3f8dced6c0184790"
|
|
26
26
|
}
|
|
@@ -833,21 +833,31 @@ declare module '@xterm/headless' {
|
|
|
833
833
|
|
|
834
834
|
/**
|
|
835
835
|
* Write data to the terminal.
|
|
836
|
+
*
|
|
837
|
+
* Note that the change will not be reflected in the {@link buffer}
|
|
838
|
+
* immediately as the data is processed asynchronously. Provide a
|
|
839
|
+
* {@link callback} to know when the data was processed.
|
|
836
840
|
* @param data The data to write to the terminal. This can either be raw
|
|
837
841
|
* bytes given as Uint8Array from the pty or a string. Raw bytes will always
|
|
838
842
|
* be treated as UTF-8 encoded, string data as UTF-16.
|
|
839
843
|
* @param callback Optional callback that fires when the data was processed
|
|
840
|
-
* by the parser.
|
|
844
|
+
* by the parser. This callback must be provided and awaited in order for
|
|
845
|
+
* {@link buffer} to reflect the change in the write.
|
|
841
846
|
*/
|
|
842
847
|
write(data: string | Uint8Array, callback?: () => void): void;
|
|
843
848
|
|
|
844
849
|
/**
|
|
845
850
|
* Writes data to the terminal, followed by a break line character (\n).
|
|
851
|
+
*
|
|
852
|
+
* Note that the change will not be reflected in the {@link buffer}
|
|
853
|
+
* immediately as the data is processed asynchronously. Provide a
|
|
854
|
+
* {@link callback} to know when the data was processed.
|
|
846
855
|
* @param data The data to write to the terminal. This can either be raw
|
|
847
856
|
* bytes given as Uint8Array from the pty or a string. Raw bytes will always
|
|
848
857
|
* be treated as UTF-8 encoded, string data as UTF-16.
|
|
849
858
|
* @param callback Optional callback that fires when the data was processed
|
|
850
|
-
* by the parser.
|
|
859
|
+
* by the parser. This callback must be provided and awaited in order for
|
|
860
|
+
* {@link buffer} to reflect the change in the write.
|
|
851
861
|
*/
|
|
852
862
|
writeln(data: string | Uint8Array, callback?: () => void): void;
|
|
853
863
|
|