aljaz/pear-docs
1
0
Fork 0
mirror of https://github.com/aljazceru/pear-docs.git synced 2025-12-17 22:44:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix grammar in docs (#49)

Browse Source 
* fix grammar in readme

* fix grammar in compact-encoding

* fix grammar in hyperdht

* fix grammar in hyperdrive

* fix grammar in hypercore

* fix grammar in hyperswarm

* fix grammar in localdrive

* fix grammar in mirrordrive

* fix grammar in sharing-a-pear-app

* tiny fixes
This commit is contained in:
Vivek Singh
2024-02-16 19:16:16 +05:30
committed by GitHub
parent cb9322bbee
commit fac1f73572
12 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
building-blocks/hypercore.md
View File

@@ -345,7 +345,7 @@ await core.clear(4) // clear block 4 from local cache
await core.clear(0, 10) // clear block 0-10 from local cache
```
The core will also 'gossip' with peers it is connected to, that is no longer has these blocks.
The core will also 'gossip' with peers it is connected to, that no longer have these blocks.
#### **`await core.truncate(newLength, [forkId])`**
@@ -385,7 +385,7 @@ A range can have the following properties:
To download the full core continuously (often referred to as non-sparse mode):
```javascript
// Note that this will never be consider downloaded as the range
// Note that this will never be considered downloaded as the range
// will keep waiting for new blocks to be appended.
core.download({ start: 0, end: -1 })
```
@@ -567,7 +567,7 @@ Emitted after the core has initially opened all its internal state.
#### **`core.on('close')`**
Emitted when the core has been fully closed
Emitted when the core has been fully closed.
#### **`core.on('peer-add')`**

2
building-blocks/hyperdht.md
View File

@@ -176,7 +176,7 @@ const encryptedSocket = node.connect(remotePublicKey)
| Property | Description | Type | Default |
| ------------- | -------------------------------------------------------- | ------ | --------------------- |
| **`nodes`** | optional array of close dht nodes to speed up connecting | Array | `[]` |
| **`keyPair`** | optional key pair to use when connection | Object | `node.defaultKeyPair` |
| **`keyPair`** | optional key pair to use when connecting | Object | `node.defaultKeyPair` |
#### Properties

2
building-blocks/hyperdrive.md
View File

@@ -109,7 +109,7 @@ The public key of the [Hyperblobs](https://github.com/holepunchto/hyperblobs) in
#### **`drive.version`**
The number that indicates how many modifications were made, is useful as a version identifier.
The number that indicates how many modifications were made, it is useful as a version identifier.
#### **`drive.supportsMetadata`**

2
building-blocks/hyperswarm.md
View File

@@ -203,7 +203,7 @@ Ban or unban the peer. Banning will prevent any future reconnection attempts, bu
### Peer Discovery
`swarm.join` returns a `PeerDiscovery` instance which allows for both the controlling of discovery behavior and responding to lifesycle changes during discovery.
`swarm.join` returns a `PeerDiscovery` instance which allows for both controlling discovery behavior and responding to lifecycle changes during discovery.
#### Methods