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 spelling mistakes (#150)

Browse Source
This commit is contained in:
Sean Zellmer
2024-10-22 08:07:06 -05:00
committed by GitHub
parent b4ad921fde
commit c0956c273d
4 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
guide/releasing-a-pear-app.md
View File

@@ -74,7 +74,7 @@ A development application link can be shared among trusted peers. At that point,
While using different channel names is sensible, using `pear stage dev` and `pear stage production` on the same machine has practical implications. While using different channel names is sensible, using `pear stage dev` and `pear stage production` on the same machine has practical implications.
A dump-stage-release strategy seperates the concerns between development and production, by using a different machine for each. A dump-stage-release strategy separates the concerns between development and production, by using a different machine for each.
On the machine that holds the production link, run: On the machine that holds the production link, run:

2
guide/sharing-a-pear-app.md
View File

@@ -154,7 +154,7 @@ When Pear loads an application from a peer the staged files are sparsely replica
The command signature for `pear seed` is `pear seed <channel|link> [dir]`. The command signature for `pear seed` is `pear seed <channel|link> [dir]`.
If the application was staged on the machine, it will seed the appliction from the machine. If the application was staged on the machine, it will seed the application from the machine.
Otherwise, passing an application link to `pear seed` will reseed the application from that link. Otherwise, passing an application link to `pear seed` will reseed the application from that link.

4
howto/share-append-only-databases-with-hyperbee.md
View File

@@ -123,7 +123,7 @@ const bee = new Hyperbee(core, {
valueEncoding: 'utf-8' valueEncoding: 'utf-8'
}) })
// wait till the hypercore properties to be intialized // wait till the hypercore properties to be initialized
await core.ready() await core.ready()
// logging the public key of the hypercore instance // logging the public key of the hypercore instance
@@ -154,7 +154,7 @@ pear run --dev . -- <SUPPLY KEY HERE>
Query the database by entering a key to lookup into the `bee-reader-app` terminal and hitting return. Query the database by entering a key to lookup into the `bee-reader-app` terminal and hitting return.
Each application has dedicated storage at `Pear.config.storage`. Try logging out `Pear.config.storage` for the `bee-reader-app` and then look at the disk space for that storage path after each query. notice that it's significantly smaller than `writer-storage`! This is because Hyperbee only downloads the Hypercore blocks it needs to satisfy each query, a feature we call **sparse downloading.** Each application has dedicated storage at `Pear.config.storage`. Try logging out `Pear.config.storage` for the `bee-reader-app` and then look at the disk space for that storage path after each query. Notice that it's significantly smaller than `writer-storage`! This is because Hyperbee only downloads the Hypercore blocks it needs to satisfy each query, a feature we call **sparse downloading.**
Importantly, a Hyperbee is **just** a Hypercore, where the tree nodes are stored as Hypercore blocks. Importantly, a Hyperbee is **just** a Hypercore, where the tree nodes are stored as Hypercore blocks.

14
reference/pear/api.md
View File

@@ -6,7 +6,7 @@ The Pear API enables applications to interact with Pear platform features.
Most application peer-to-peer functionality is provided by ecosystem modules rather than the API. Most application peer-to-peer functionality is provided by ecosystem modules rather than the API.
Platform APIs are unchangable. Compatiblity cannot break. So the Pear API surface aims to be (and remain) Platform APIs are unchangeable. Compatibility cannot break. So the Pear API surface aims to be (and remain)
as small as possible. as small as possible.
## `global.Pear` ## `global.Pear`
@@ -187,7 +187,7 @@ A function which accepts a pattern object and returns an [`Iambus`](https://gith
If no pattern object or an empty pattern object is provided all messages will be emitted. A pattern object is an object (typically) containing a subset of matching values for a given target object. Message objects can be user generated or platform generated. If no pattern object or an empty pattern object is provided all messages will be emitted. A pattern object is an object (typically) containing a subset of matching values for a given target object. Message objects can be user generated or platform generated.
The subscriber stream has a `data` event which can be listened to, it can also be consumed with `for await` and an listener function can be passed in addition to pattern (`message(pattern, listener)`) or as a single argument (`messages(listener)`) (indicateding a catch-all pattern). The subscriber stream has a `data` event which can be listened to, it can also be consumed with `for await` and an listener function can be passed in addition to pattern (`message(pattern, listener)`) or as a single argument (`messages(listener)`) (indicating a catch-all pattern).
A message object may have any properties. Platform-generated messages are given a `type` property. A message object may have any properties. Platform-generated messages are given a `type` property.
@@ -573,7 +573,7 @@ Resolves to: `{x <Integer>, y <Integer>, width <Integer>, height <Integer>} | nu
The height, width, horizontal (`x`), vertical (`y`) position of the window relative to the screen. The height, width, horizontal (`x`), vertical (`y`) position of the window relative to the screen.
All units ar (pixels) All units are (pixels)
If the window is closed this will resolve to `null`. If the window is closed this will resolve to `null`.
@@ -739,7 +739,7 @@ Resolves to: `{x <Integer>, y <Integer>, width <Integer>, height <Integer>} | nu
The height, width, horizontal (`x`), vertical (`y`) position of the window relative to the screen. The height, width, horizontal (`x`), vertical (`y`) position of the window relative to the screen.
All units ar (pixels) All units are (pixels)
If the Window is closed this will resolve to `null`. If the Window is closed this will resolve to `null`.
@@ -877,7 +877,7 @@ Whether the current window is maximized. Throws a `TypeError` if `self` is a vie
Resolves to: `<Boolean>` Resolves to: `<Boolean>`
Whether the current window is minmized. Throws a `TypeError` if `self` is a view. Whether the current window is minimized. Throws a `TypeError` if `self` is a view.
### `const { parent } = Pear.Window` `const { parent } = Pear.View` ### `const { parent } = Pear.Window` `const { parent } = Pear.View`
@@ -970,7 +970,7 @@ Whether the parent window is maximized. Throws a `TypeError` if `parent` is a vi
Resolves to: `<Boolean>` Resolves to: `<Boolean>`
Whether the parent window is minmized. Throws a `TypeError` if `parent` is a view. Whether the parent window is minimized. Throws a `TypeError` if `parent` is a view.
## Web APIs ## Web APIs
@@ -987,7 +987,7 @@ In browsers, `window.open` opens a new browser window. The opened window belongs
In Pear, `window.open` loads the URL in the **default system browser**. It does *not* create a new application window (use `Pear.Window` to create application windows). In Pear, `window.open` loads the URL in the **default system browser**. It does *not* create a new application window (use `Pear.Window` to create application windows).
Therefore Pear's `window.open` only supports a single url argument. The `target` and `windowFeatures` parameters that browsers support are discarded. Therefore Pear's `window.open` only supports a single URL argument. The `target` and `windowFeatures` parameters that browsers support are discarded.
### Scripts and Modules ### Scripts and Modules