Skip to content

Commit 15b52d7

Browse files
authored
Update api (#142)
* add missing config options * remove pear dev references * fix headings and typo
1 parent 911cf1b commit 15b52d7

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

reference/pear/api.md

+21-6
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Application storage path.
8787

8888
### `Pear.config.args <Array>`
8989

90-
Command-line application arguments passed like `pear dev . --some arg`.
90+
Command-line application arguments passed like `pear run --dev . --some arg`.
9191

9292
### `Pear.config.release <Number>`
9393

@@ -99,13 +99,12 @@ The current release length as marked by the `pear release` command.
9999

100100
### `Pear.config.link <String>`
101101

102-
The Pear link of an application. Takes the form `pear://<key>/<data>`.
102+
Pear application link. Can be a `pear://` link or a local directory.
103103

104-
In development, `pear://dev/<data>`.
104+
Can include a fragment link eg. `pear://link#fragment`.
105105

106106
**References**
107107
* [Pear.config.linkData](#pearconfiglinkdata-string)
108-
* [`pear dev`](./cli.md)
109108
* [`pear run`](./cli.md)
110109

111110
### `Pear.config.links <Object|Array>`
@@ -114,7 +113,6 @@ Holds trusted Pear application links and domains as specified in the `links` fie
114113

115114
**References**
116115
* [pear.links](./configuration.md#pearlinks-objectarray)
117-
* [`pear dev`](./cli.md)
118116
* [`pear run`](./cli.md)
119117

120118
### `Pear.config.linkData <String>`
@@ -128,7 +126,6 @@ In development, `pear://dev/<data>`.
128126
**References**
129127

130128
* [Pear.config.link](#pearconfiglink-string)
131-
* [`pear dev`](./cli.md)
132129
* [`pear run`](./cli.md)
133130

134131

@@ -154,6 +151,23 @@ Application release sequence integer, `null` in development mode.
154151

155152
Parsed runtime flags. For internal/advanced use.
156153

154+
### `Pear.config.applink <String>`
155+
156+
Pear application link. May be a `pear://` link or a local directory.
157+
Can also include entrypoint and fragment eg. `pear://link#fragment`.
158+
159+
### `Pear.config.dependencies <Object>`
160+
161+
Application dependencies.
162+
163+
### `Pear.config.dir <String>`
164+
165+
Root directory of project.
166+
167+
### `Pear.config.pearDir <String>`
168+
169+
Directory for Pear runtime.
170+
157171
## `Pear.checkpoint(<Any>) => Promise`
158172

159173
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
166180

167181
* [Pear.config.checkpoint()](#pear--config-checkpoint-any)
168182

183+
169184
## Pear.messages([ pattern ], [ listener ]) -> Iterable
170185

171186
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.

0 commit comments

Comments
 (0)