Tweak docs

This commit is contained in:
Daniel Imms
2024-02-02 12:03:08 -08:00
parent b1a72b2e83
commit 8d1771ef64
4 changed files with 16 additions and 34 deletions
-9
View File
@@ -168,15 +168,6 @@ export abstract class CoreTerminal extends Disposable implements ICoreTerminal {
this._writeBuffer.writeSync(data, maxSubsequentCalls); this._writeBuffer.writeSync(data, maxSubsequentCalls);
} }
/**
* Input data to application side.
* The data is treated the same way as typed input at the terminal.
* (will appear in the onData event).
* wasUserInput indicates, whether the input is genuine user input.
* It is true by default and triggers additional actions like prompt focus or selection clearing.
* Set it to false if your data sent does not resemble what a user would have typed
* (e.g. sequence embedded data).
*/
public input(data: string, wasUserInput: boolean = true): void { public input(data: string, wasUserInput: boolean = true): void {
this.coreService.triggerDataEvent(data, wasUserInput); this.coreService.triggerDataEvent(data, wasUserInput);
} }
-9
View File
@@ -81,15 +81,6 @@ export class Terminal extends CoreTerminal {
this._onBell.fire(); this._onBell.fire();
} }
/**
* Input data to application side.
* The data is treated the same way as typed input at the terminal.
* (will appear in the onData event).
* wasUserInput indicates, whether the input is genuine user input.
* It is true by default and triggers additional actions like prompt focus or selection clearing.
* Set it to false if your data sent does not resemble what a user would have typed
* (e.g. sequence embedded data).
*/
public input(data: string, wasUserInput: boolean = true): void { public input(data: string, wasUserInput: boolean = true): void {
this.coreService.triggerDataEvent(data, wasUserInput); this.coreService.triggerDataEvent(data, wasUserInput);
} }
+8 -8
View File
@@ -719,14 +719,14 @@ declare module '@xterm/headless' {
onTitleChange: IEvent<string>; onTitleChange: IEvent<string>;
/** /**
* Input data to application side. * Input data to application side. The data is treated the same way input
* The data is treated the same way as typed input at the terminal * typed into the terminal would (ie. the {@link onData} event will fire).
* (will appear in the onData event). * @param data The data to forward to the application.
* wasUserInput indicates, whether the input is genuine user input. * @param wasUserInput Whether the input is genuine user input. This is true
* It is true by default and triggers additional actions like prompt * by default and triggers additionalbehavior like focus or selection
* focus or selection clearing. * clearing. Set this to false if the data sent should not be treated like
* Set it to false if your data sent does not resemble * user input would, for example passing an escape sequence to the
* what a user would have typed (e.g. sequence embedded data). * application.
*/ */
input(data: string, wasUserInput?: boolean): void; input(data: string, wasUserInput?: boolean): void;
+8 -8
View File
@@ -964,14 +964,14 @@ declare module '@xterm/xterm' {
focus(): void; focus(): void;
/** /**
* Input data to application side. * Input data to application side. The data is treated the same way input
* The data is treated the same way as typed input at the terminal * typed into the terminal would (ie. the {@link onData} event will fire).
* (will appear in the onData event). * @param data The data to forward to the application.
* wasUserInput indicates, whether the input is genuine user input. * @param wasUserInput Whether the input is genuine user input. This is true
* It is true by default and triggers additional actions like prompt * by default and triggers additionalbehavior like focus or selection
* focus or selection clearing. * clearing. Set this to false if the data sent should not be treated like
* Set it to false if your data sent does not resemble * user input would, for example passing an escape sequence to the
* what a user would have typed (e.g. sequence embedded data). * application.
*/ */
input(data: string, wasUserInput?: boolean): void; input(data: string, wasUserInput?: boolean): void;