manual: add Deno.run example (#1811)

1 files changed, 13 insertions, 1 deletions

diff --git a/js/process.ts b/js/process.ts
index c47a5b5dd..2f60e5c4a 100644
--- a/js/process.ts
+++ b/js/process.ts
@@ -8,7 +8,7 @@ import { ReadCloser, WriteCloser } from "./io";
 import { readAll } from "./buffer";
 import { assert, unreachable } from "./util";
 
-/** How to handle subsubprocess stdio.
+/** How to handle subprocess stdio.
  *
  * "inherit" The default if unspecified. The child inherits from the
  * corresponding parent descriptor.
@@ -101,6 +101,18 @@ function stdioMap(s: ProcessStdio): msg.ProcessStdio {
   }
 }
 
+/**
+ * Spawns new subprocess.
+ *
+ * Subprocess uses same working directory as parent process unless `opt.cwd`
+ * is specified.
+ *
+ * Environmental variables for subprocess can be specified using `opt.env`
+ * mapping.
+ *
+ * By default subprocess inherits stdio of parent process. To change that
+ * `opt.stdout`, `opt.stderr` and `opt.stdin` can be specified independently.
+ */
 export function run(opt: RunOptions): Process {
   const builder = flatbuffers.createBuilder();
   const argsOffset = msg.Run.createArgsVector(