Terminal API: clarify onData event

[bpasero]

Refs: #48434

I am a bit confused what the onData event for the terminal API actually provides me. It seems to me that each keystroke I do is reflected (even when I press backspace I get some weird [K showing up). I think this deserves more documentation and possibly also a different name. E.g. if this is about notifying whenever something is showing in the integrated terminal, should it be onText or onOutput instead?

[Tyriar]

@bpasero opps I didn't include jsdoc for it.

if this is about notifying whenever something is showing in the integrated terminal, should it be onText or onOutput instead?

This is not what it is, it's data from the raw pty, including escape sequences. That's why #48517 is as expected; because on Windows it redraws the screen whenever you resize. I'll clarify in a comment 👍

[bpasero]

@Tyriar and what is the use case for having this API?

[Tyriar]

	export interface Terminal {
		/**
		 * Fires when the terminal's pty slave pseudo-device is written to. In other words, this
		 * provides access to the raw data stream from the process running within the terminal,
		 * including ANSI sequences.
		 */
		onData: Event<string>;
	}

[Tyriar]

@bpasero enabling multiplexing of the terminal.

[bpasero]

I strongly suggest to stay away from the word slave.

[Tyriar]

@bpasero that's the technical term and helps describe exactly what it does, there is a master and a slave side to the pty https://en.wikipedia.org/wiki/Pseudoterminal

[bpasero]

Dunno, at one point we got bashed for using words such as slave in the code. E.g. we say "master / detail" and not "master / slave".

[Tyriar]

I think this is a little different though as it's an established technical term of which there is no other name, not a UI paradigm we're introducing.