mirror of
https://github.com/aljazceru/pear-docs.git
synced 2025-12-17 22:44:21 +01:00
Fix grammar in docs (#49)
* 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:
@@ -32,7 +32,7 @@ An object with the keys`{ start, end, buffer, cache }`.
|
||||
| `start` | Byte offset to start encoding/decoding at. |
|
||||
| `end` | Byte offset indicating the end of the buffer. |
|
||||
| `buffer` | Either a Node.js Buffer or Uint8Array. |
|
||||
| `cache` | Used internally be codecs, starts as `null`. |
|
||||
| `cache` | Used internally by codecs, starts as `null`. |
|
||||
|
||||
> Users can also get a blank state object using`cenc.state()`.
|
||||
|
||||
|
||||
@@ -78,7 +78,7 @@ String with the resolved (absolute) drive path.
|
||||
|
||||
**`drive.supportsMetadata`**
|
||||
|
||||
Boolean that indicates if the drive handles or not metadata. Default `false`.
|
||||
Boolean indicating whether the drive handles metadata. Default `false`.
|
||||
|
||||
If `options.metadata` hooks are passed then `supportsMetadata` becomes `true`.
|
||||
|
||||
|
||||
@@ -71,7 +71,7 @@ console.log(mirror.count) // => { files: 0, add: 0, remove: 0, change: 0 }
|
||||
|
||||
#### **`await mirror.done()`**
|
||||
|
||||
It starts processing all the diffing until is done.
|
||||
It starts processing all the diffing until it is done.
|
||||
|
||||
```javascript
|
||||
const mirror = new MirrorDrive(src, dst)
|
||||
|
||||
Reference in New Issue
Block a user