diff --git a/API.md b/API.md index f9747a1..95f25be 100644 --- a/API.md +++ b/API.md @@ -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)