Skip to content
This repository was archived by the owner on Sep 30, 2023. It is now read-only.

Commit 4ba73f1

Browse files
committed
Update README
1 parent 4beeea9 commit 4ba73f1

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Base class for [orbit-db](https://github.com/orbitdb/orbit-db) data stores. You
1919

2020
#### Public methods
2121

22-
##### `load()`
22+
##### `load(amount)`
2323

24-
Load the database using locally persisted state.
24+
Load the database using locally persisted state. Can specify how many entries to load with `amount` argument.
2525

2626
##### `saveSnapshot()`
2727

@@ -71,6 +71,15 @@ Remove all items from the local store. This doesn't remove or delete any entries
7171
console.log(db.type) // "eventlog"
7272
```
7373

74+
##### `replicationStatus`
75+
76+
Get database replication status information such as total number of entries and loading progress.
77+
78+
```javascript
79+
console.log(db.replicationStatus)
80+
// { buffered: 0, queued: 0, progress: 2, max: 5 }
81+
```
82+
7483
### Events
7584

7685
Store has an `events` ([EventEmitter](https://nodejs.org/api/events.html)) object that emits events that describe what's happening in the database.

0 commit comments

Comments
 (0)