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

Update api (#142)

Browse Source 
* add missing config options

* remove pear dev references

* fix headings and typo
This commit is contained in:
Vivek Singh
2024-09-25 12:47:19 +05:30
committed by GitHub
parent 911cf1bda7
commit 15b52d79a5
1 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
reference/pear/api.md
View File

@@ -87,7 +87,7 @@ Application storage path.
### `Pear.config.args <Array>` ### `Pear.config.args <Array>`
Command-line application arguments passed like `pear dev . --some arg`. Command-line application arguments passed like `pear run --dev . --some arg`.
### `Pear.config.release <Number>` ### `Pear.config.release <Number>`
@@ -99,13 +99,12 @@ The current release length as marked by the `pear release` command.
### `Pear.config.link <String>` ### `Pear.config.link <String>`
The Pear link of an application. Takes the form `pear://<key>/<data>`. Pear application link. Can be a `pear://` link or a local directory.
In development, `pear://dev/<data>`. Can include a fragment link eg. `pear://link#fragment`.
**References** **References**
* [Pear.config.linkData](#pearconfiglinkdata-string) * [Pear.config.linkData](#pearconfiglinkdata-string)
* [`pear dev`](./cli.md)
* [`pear run`](./cli.md) * [`pear run`](./cli.md)
### `Pear.config.links <Object|Array>` ### `Pear.config.links <Object|Array>`
@@ -114,7 +113,6 @@ Holds trusted Pear application links and domains as specified in the `links` fie
**References** **References**
* [pear.links](./configuration.md#pearlinks-objectarray) * [pear.links](./configuration.md#pearlinks-objectarray)
* [`pear dev`](./cli.md)
* [`pear run`](./cli.md) * [`pear run`](./cli.md)
### `Pear.config.linkData <String>` ### `Pear.config.linkData <String>`
@@ -128,7 +126,6 @@ In development, `pear://dev/<data>`.
**References** **References**
* [Pear.config.link](#pearconfiglink-string) * [Pear.config.link](#pearconfiglink-string)
* [`pear dev`](./cli.md)
* [`pear run`](./cli.md) * [`pear run`](./cli.md)
@@ -154,6 +151,23 @@ Application release sequence integer, `null` in development mode.
Parsed runtime flags. For internal/advanced use. Parsed runtime flags. For internal/advanced use.
### `Pear.config.applink <String>`
Pear application link. May be a `pear://` link or a local directory.
Can also include entrypoint and fragment eg. `pear://link#fragment`.
### `Pear.config.dependencies <Object>`
Application dependencies.
### `Pear.config.dir <String>`
Root directory of project.
### `Pear.config.pearDir <String>`
Directory for Pear runtime.
## `Pear.checkpoint(<Any>) => Promise` ## `Pear.checkpoint(<Any>) => Promise`
Stores state that will be available as `Pear.config.checkpoint` next time the application starts. Stores state that will be available as `Pear.config.checkpoint` next time the application starts.
@@ -166,6 +180,7 @@ The returned `Promise` will resolve once the checkpoint has been successfully st
* [Pear.config.checkpoint()](#pear--config-checkpoint-any) * [Pear.config.checkpoint()](#pear--config-checkpoint-any)
## Pear.messages([ pattern ], [ listener ]) -> Iterable ## Pear.messages([ pattern ], [ listener ]) -> Iterable
A function which accepts a pattern object and returns an [`Iambus`](https://github.com/holepunchto/iambus) subscriber (which inherits from [`streamx`](https://github.com/mafintosh/streamx) `Readable`) which emits message objects matching a provided pattern object. A function which accepts a pattern object and returns an [`Iambus`](https://github.com/holepunchto/iambus) subscriber (which inherits from [`streamx`](https://github.com/mafintosh/streamx) `Readable`) which emits message objects matching a provided pattern object.