From 3b537c7e9fd94a989fc26fc20cfba8789ff3a71f Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Fri, 13 Sep 2019 09:32:38 -0700 Subject: [PATCH] Improve api jsdoc --- typings/xterm.d.ts | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts index faa83d72..44ef66bd 100644 --- a/typings/xterm.d.ts +++ b/typings/xterm.d.ts @@ -651,21 +651,21 @@ declare module 'xterm' { /** * Write data to the terminal. - * `data` 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. - * `callback` is an optional callback that gets called once the data - * chunk was processed by the parser. - * @param data The data to write to the terminal. - * @param callback Optional callback when 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. + * @param callback Optional callback that fires when the data was processed + * by the parser. */ write(data: string | Uint8Array, callback?: () => void): void; /** * Writes data to the terminal, followed by a break line character (\n). - * `callback` is an optional callback that gets called once the data - * chunk was processed by the parser. - * @param data The data to write to the terminal. - * @param callback Optional callback when 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. + * @param callback Optional callback that fires when the data was processed + * by the parser. */ writeln(data: string | Uint8Array, callback?: () => void): void;