Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
j50n committed Jun 7, 2023
1 parent eba2bf0 commit c6fc7db
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions src/command.ts
Original file line number Diff line number Diff line change
Expand Up @@ -272,8 +272,13 @@ export class Process<S> implements Deno.Closer {

/**
* This is the "backdoor" way to write directly to the underlying process `stdin`
* without the overhead of a {@link WritableIterable}. This replaces using `this.stdin`
* entirely.
* without the overhead of a {@link WritableIterable}. Use instead of {@link stdin}
* for streamed data.
*
* {@link stdin} is the way to go if you are passing ad-hoc, non-continuous data to
* process `stdin`. However, it adds a substantial amount of overhead, and it is very
* slow for processing small data. Using this function instead of {@link stdin} greatly
* improves performance where small data is a factor.
*
* @param iter The data being passed to the underlying process `stdin`.
*/
Expand Down

0 comments on commit c6fc7db

Please sign in to comment.