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

Added Documentation for Options for Eventlog and Feed Api

Browse Source
This commit is contained in:
Prabodh Meshram 2017-09-17 16:02:07 +05:30
parent aa5dd07470
commit 89c2077fda
1 changed files with 29 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
API.md
View File

@ -155,8 +155,22 @@ After creating an instance of `orbitd-db`, you can now access the different data
```
- **iterator([options])**
**options** : It is an object which supported the following properties
`gt` - (String) Greater than
`gte` - (String) Greater than or equal to
`lt` - (String) Less than
`lte` - (String) Less than or equal to
`limit` - (Integer) Limiting the entries of result
`reverse` - (Boolean) If set to true will result in reversing the result.
```javascript
// TODO: add all options - gt, gte, lt, lte, limit, reverse
const all = db.iterator({ limit: -1 })
.collect()
.map((e) => e.payload.value)
@ -205,8 +219,21 @@ After creating an instance of `orbitd-db`, you can now access the different data
```
- **iterator([options])**
**options** : It is an object which supported the following properties
`gt` - (String) Greater than
`gte` - (String) Greater than or equal to
`lt` - (String) Less than
`lte` - (String) Less than or equal to
`limit` - (Integer) Limiting the entries of result
`reverse` - (Boolean) If set to true will result in reversing the result.
```javascript
// TODO: add all options - gt, gte, lt, lte, limit, reverse
const all = db.iterator({ limit: -1 })
.collect()
.map((e) => e.payload.value)