Skip to content

Commit e4422b1

Browse files
committed
docs(api/process): minor cleanup
1 parent d1b88df commit e4422b1

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

src/glide/browser/base/content/glide.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1358,9 +1358,11 @@ declare global {
13581358
/**
13591359
* Write data to the process's stdin.
13601360
*
1361-
* Accepts either a string (which will be UTF-8 encoded) or a binary array (e.g. ArrayBuffer, Uint8Array etc).
1361+
* Accepts either a string (which will be UTF-8 encoded) or
1362+
* a binary array (e.g. ArrayBuffer, Uint8Array etc).
13621363
*
1363-
* **warning**: you *must* call `.close()` once you are done writing, otherwise the process will never exit
1364+
* **warning**: you *must* call `.close()` once you are done writing,
1365+
* otherwise the process will never exit.
13641366
*/
13651367
write(data: string | ArrayBuffer | glide.TypedArray): Promise<void>;
13661368

@@ -1369,8 +1371,6 @@ declare global {
13691371
*
13701372
* By default, waits for any pending writes to complete before closing.
13711373
* Pass `{ force: true }` to close immediately without waiting.
1372-
*
1373-
* @param opts.force - If true, close immediately without waiting for pending writes
13741374
*/
13751375
close(opts?: { force?: boolean }): Promise<void>;
13761376
};

src/glide/docs/api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1205,18 +1205,18 @@ glide.Process & {
12051205
/**
12061206
* Write data to the process's stdin.
12071207
*
1208-
* Accepts either a string (which will be UTF-8 encoded) or a binary array (e.g. ArrayBuffer, Uint8Array etc).
1208+
* Accepts either a string (which will be UTF-8 encoded) or
1209+
* a binary array (e.g. ArrayBuffer, Uint8Array etc).
12091210
*
1210-
* **warning**: you *must* call `.close()` once you are done writing, otherwise the process will never exit
1211+
* **warning**: you *must* call `.close()` once you are done writing,
1212+
* otherwise the process will never exit.
12111213
*/
12121214
write(data: string | ArrayBuffer | glide.TypedArray): Promise<void>;
12131215
/**
12141216
* Close the stdin pipe, signaling EOF to the process.
12151217
*
12161218
* By default, waits for any pending writes to complete before closing.
12171219
* Pass `{ force: true }` to close immediately without waiting.
1218-
*
1219-
* @param opts.force - If true, close immediately without waiting for pending writes
12201220
*/
12211221
close(opts?: {
12221222
force?: boolean;

0 commit comments

Comments
 (0)