Mirroristas/orbitdb
2
0
Fork 0
mirror of https://github.com/orbitdb/orbitdb.git synced 2025-03-30 15:08:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add store.load param

Browse Source
This commit is contained in:
Kia Rahimian 2018-07-18 13:42:15 -04:00
parent 88ebe6a459
commit a7ab7c4d4a
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
API.md
View File

@ -58,7 +58,7 @@ const db = await orbitdb.keyvalue('profile')
- [OrbitDB.parseAddress(address)](#parseaddressaddress)
**[Store API](#store)**
- [store.load()](#storeload)
- [store.load()](#storeloadamount)
- [store.close()](#storeclose)
- [store.drop()](#storedrop)
- [store.key](#storekey)
@ -387,9 +387,9 @@ OrbitDB.parseAddress('/orbitdb/Qmdgwt7w4uBsw8LXduzCd18zfGXeTmBsiR8edQ1hSfzcJC/fi
Every database (store) has the following methods available in addition to their specific methods.
#### store.load()
#### store.load([amount])
Load the locally persisted database state to memory.
Load the locally persisted database state to memory. Use the optional `amount` argument to limit the number of entries loaded into memory, starting from the head(s) (Default: `-1` will load all entries)
With events:
```javascript

2
README.md
View File

@ -178,7 +178,7 @@ After creating an `OrbitDB` instance , you can access the different data stores.
- [OrbitDB.parseAddress(address)](https://github.com/orbitdb/orbit-db/blob/master/API.md#parseaddressaddress)
**[Store API](https://github.com/orbitdb/orbit-db/blob/master/API.md#store)**
- [load()](https://github.com/orbitdb/orbit-db/blob/master/API.md#storeload)
- [load()](https://github.com/orbitdb/orbit-db/blob/master/API.md#storeloadamount)
- [close()](https://github.com/orbitdb/orbit-db/blob/master/API.md#storeclose)
- [drop()](https://github.com/orbitdb/orbit-db/blob/master/API.md#storedrop)
- [key](https://github.com/orbitdb/orbit-db/blob/master/API.md#storekey)