Skip to content

Commit 51ee464

Browse files
committed
Fix documentation
1 parent da9227d commit 51ee464

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

index.d.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,24 +259,30 @@ export type Options<EncodingType = string> = {
259259
/**
260260
Write some input to the `stdin` of your binary.
261261
262-
Tip: If the input is a file, use the `inputFile` option instead.
262+
If the input is a file, use the `inputFile` option instead.
263263
*/
264264
readonly input?: string | Buffer | ReadableStream;
265265

266266
/**
267267
Use a file as input to the the `stdin` of your binary.
268+
269+
If the input is not a file, use the `input` option instead.
268270
*/
269271
readonly inputFile?: string;
270272
} & CommonOptions<EncodingType>;
271273

272274
export type SyncOptions<EncodingType = string> = {
273275
/**
274276
Write some input to the `stdin` of your binary.
277+
278+
If the input is a file, use the `inputFile` option instead.
275279
*/
276280
readonly input?: string | Buffer;
277281

278282
/**
279283
Use a file as input to the the `stdin` of your binary.
284+
285+
If the input is not a file, use the `input` option instead.
280286
*/
281287
readonly inputFile?: string;
282288
} & CommonOptions<EncodingType>;

readme.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -497,12 +497,16 @@ Type: `string | Buffer | stream.Readable`
497497
Write some input to the `stdin` of your binary.\
498498
Streams are not allowed when using the synchronous methods.
499499

500+
If the input is a file, use the [`inputFile` option](#inputfile) instead.
501+
500502
#### inputFile
501503

502504
Type: `string`
503505

504506
Use a file as input to the the `stdin` of your binary.
505507

508+
If the input is not a file, use the [`input` option](#input) instead.
509+
506510
#### stdin
507511

508512
Type: `string | number | Stream | undefined`\

0 commit comments

Comments
 (0)