From 74a3e1a3f6b8faba77cc36b4cf053f5cb614d0ab Mon Sep 17 00:00:00 2001 From: rafapaezbas <15270736+rafapaezbas@users.noreply.github.com> Date: Thu, 15 Aug 2024 19:12:03 +0200 Subject: [PATCH] fix pear worker docs (#129) --- reference/pear/api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/pear/api.md b/reference/pear/api.md index 896846a..7e8bdc1 100644 --- a/reference/pear/api.md +++ b/reference/pear/api.md @@ -280,9 +280,9 @@ A bidirectional pipe is also created which enables communication between the par Reference counting is handled automatically to manage the sidecar lifecycle. -### `const pipe = Pear.worker.run(key )` +### `const pipe = Pear.worker.run(link , args >)` -Spawns a new process with the specified key as the entry point. Resolves to a `Duplex` stream object representing a pipe. +Runs a Pear Worker by spawning a Pear Terminal Application process from the specified `link` parameter. The Worker uses the flags of the parent application but any application arguments must be passed using the `args` parameter. Returns a pipe (a [`streamx`](https://github.com/mafintosh/streamx) `Duplex` stream) for Worker communication. ### `const pipe = Pear.worker.pipe()`