diff --git a/reference/pear/api.md b/reference/pear/api.md index 9310af8..d4fb2a6 100644 --- a/reference/pear/api.md +++ b/reference/pear/api.md @@ -87,7 +87,7 @@ Application storage path. ### `Pear.config.args ` -Command-line application arguments passed like `pear dev . --some arg`. +Command-line application arguments passed like `pear run --dev . --some arg`. ### `Pear.config.release ` @@ -99,13 +99,12 @@ The current release length as marked by the `pear release` command. ### `Pear.config.link ` -The Pear link of an application. Takes the form `pear:///`. +Pear application link. Can be a `pear://` link or a local directory. -In development, `pear://dev/`. +Can include a fragment link eg. `pear://link#fragment`. **References** * [Pear.config.linkData](#pearconfiglinkdata-string) -* [`pear dev`](./cli.md) * [`pear run`](./cli.md) ### `Pear.config.links ` @@ -114,7 +113,6 @@ Holds trusted Pear application links and domains as specified in the `links` fie **References** * [pear.links](./configuration.md#pearlinks-objectarray) -* [`pear dev`](./cli.md) * [`pear run`](./cli.md) ### `Pear.config.linkData ` @@ -128,7 +126,6 @@ In development, `pear://dev/`. **References** * [Pear.config.link](#pearconfiglink-string) -* [`pear dev`](./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. +### `Pear.config.applink ` + +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 ` + +Application dependencies. + +### `Pear.config.dir ` + +Root directory of project. + +### `Pear.config.pearDir ` + +Directory for Pear runtime. + ## `Pear.checkpoint() => Promise` 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.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.