mirror of
https://github.com/aljazceru/pear-docs.git
synced 2025-12-17 14:34:19 +01:00
@@ -261,6 +261,24 @@ async function logPrefUpdates () {
|
||||
logPrefUpdates().catch(console.error)
|
||||
```
|
||||
|
||||
## `Pear.worker <Object>`
|
||||
|
||||
Pear Worker is used to spawn processes and facilitate communication between the parent and child processes in the Pear Runtime.
|
||||
|
||||
The spawned worker process inherits standard input, output, and error from the parent process.
|
||||
|
||||
A bidirectional pipe is also created which enables communication between the parent and worker process.
|
||||
|
||||
Reference counting is handled automatically to manage the sidecar lifecycle.
|
||||
|
||||
### `const pipe = Pear.worker.run(key <String>)`
|
||||
|
||||
Spawns a new process with the specified key as the entry point. Resolves to a `Duplex` stream object representing a pipe.
|
||||
|
||||
### `const pipe = Pear.worker.pipe()`
|
||||
|
||||
Returns the communication pipe created to the worker process. Resolves to a `Duplex` stream object representing a pipe.
|
||||
|
||||
## `Pear.media <Object>`
|
||||
|
||||
Media interface
|
||||
|
||||
@@ -120,6 +120,14 @@ Enable transparency. Must be set for opacity to work.
|
||||
|
||||
Background color (Hex, RGB, RGBA, HSL, HSLA, CSS color).
|
||||
|
||||
### `pear.links <Object|Array>`
|
||||
|
||||
An array or object containing trusted Pear application keys.
|
||||
|
||||
#### `pear.links.worker <String>`
|
||||
|
||||
The key of the Pear application that contains the worker script. For more info, please check the [terminal](https://github.com/holepunchto/pear/blob/main/examples/terminal/index.js#L21) and [desktop](https://github.com/holepunchto/pear/blob/main/examples/desktop/app.js#L27) examples.
|
||||
|
||||
### `pear.stage <Object>`
|
||||
|
||||
Staging configuration options.
|
||||
|
||||
Reference in New Issue
Block a user