Add additional note to main doc

This commit is contained in:
Daniel Imms
2025-04-22 02:54:14 -07:00
parent a8ead811bf
commit 78fbae3293
2 changed files with 16 additions and 0 deletions
+8
View File
@@ -833,6 +833,10 @@ declare module '@xterm/headless' {
/**
* Write data to the terminal.
*
* Note that the change will not be reflected in the {@link buffer}
* immediately as the data is processed asynchronously. Provide a
* {@link callback} to know when the data was processed.
* @param data The data to write to the terminal. This can either be raw
* bytes given as Uint8Array from the pty or a string. Raw bytes will always
* be treated as UTF-8 encoded, string data as UTF-16.
@@ -844,6 +848,10 @@ declare module '@xterm/headless' {
/**
* Writes data to the terminal, followed by a break line character (\n).
*
* Note that the change will not be reflected in the {@link buffer}
* immediately as the data is processed asynchronously. Provide a
* {@link callback} to know when the data was processed.
* @param data The data to write to the terminal. This can either be raw
* bytes given as Uint8Array from the pty or a string. Raw bytes will always
* be treated as UTF-8 encoded, string data as UTF-16.
+8
View File
@@ -1265,6 +1265,10 @@ declare module '@xterm/xterm' {
/**
* Write data to the terminal.
*
* Note that the change will not be reflected in the {@link buffer}
* immediately as the data is processed asynchronously. Provide a
* {@link callback} to know when the data was processed.
* @param data The data to write to the terminal. This can either be raw
* bytes given as Uint8Array from the pty or a string. Raw bytes will always
* be treated as UTF-8 encoded, string data as UTF-16.
@@ -1276,6 +1280,10 @@ declare module '@xterm/xterm' {
/**
* Writes data to the terminal, followed by a break line character (\n).
*
* Note that the change will not be reflected in the {@link buffer}
* immediately as the data is processed asynchronously. Provide a
* {@link callback} to know when the data was processed.
* @param data The data to write to the terminal. This can either be raw
* bytes given as Uint8Array from the pty or a string. Raw bytes will always
* be treated as UTF-8 encoded, string data as UTF-16.