aljaz/pear-docs
1
0
Fork 0
mirror of https://github.com/aljazceru/pear-docs.git synced 2025-12-17 14:34:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix pear worker docs (#129)

Browse Source
This commit is contained in:
rafapaezbas
2024-08-15 19:12:03 +02:00
committed by GitHub
parent 928bb27b3e
commit 74a3e1a3f6
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
reference/pear/api.md
View File

@@ -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. Reference counting is handled automatically to manage the sidecar lifecycle.
### `const pipe = Pear.worker.run(key <String>)` ### `const pipe = Pear.worker.run(link <String>, args <Array<String>>)`
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()` ### `const pipe = Pear.worker.pipe()`