From a95e451227511704df6e3f90d2ea4d2d0b4b94f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Breitbart?= Date: Fri, 13 Sep 2019 13:19:33 +0200 Subject: [PATCH] add params in doc --- typings/xterm.d.ts | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts index 8e279f8c..faa83d72 100644 --- a/typings/xterm.d.ts +++ b/typings/xterm.d.ts @@ -655,6 +655,8 @@ declare module 'xterm' { * 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. */ write(data: string | Uint8Array, callback?: () => void): void; @@ -662,12 +664,16 @@ declare module 'xterm' { * 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. */ writeln(data: string | Uint8Array, callback?: () => void): void; /** - * Write UTF8 data to the terminal. Deprecated, use `.write` instead. - * @deprecated + * Write UTF8 data to the terminal. + * @param data The data to write to the terminal. + * @param callback Optional callback when data was processed. + * @deprecated use `write` instead */ writeUtf8(data: Uint8Array, callback?: () => void): void;