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

Merge pull request #232 from prabodhmeshram/master

Browse Source 
Documentation for options added
This commit is contained in:
Haad 2017-09-17 14:56:00 +02:00 committed by GitHub
commit 09ad0f6492
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])** - **iterator([options])**
**options** : It is an object which supports 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 ```javascript
// TODO: add all options - gt, gte, lt, lte, limit, reverse
const all = db.iterator({ limit: -1 }) const all = db.iterator({ limit: -1 })
.collect() .collect()
.map((e) => e.payload.value) .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])** - **iterator([options])**
**options** : It is an object which supports 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 ```javascript
// TODO: add all options - gt, gte, lt, lte, limit, reverse
const all = db.iterator({ limit: -1 }) const all = db.iterator({ limit: -1 })
.collect() .collect()
.map((e) => e.payload.value) .map((e) => e.payload.value)