Skip to content

Commit caee483

Browse files
Jeff Shamleydavideast
authored andcommitted
docs(querying lists): added query options to the docs.
1 parent ff5429d commit caee483

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/4-querying-lists.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,20 @@ const queryObservable = af.database.list('/items', {
1717
});
1818
```
1919

20+
**Query Options:**
21+
| method | purpose |
22+
| ---------|--------------------|
23+
| orderByChild | specify a child to order by |
24+
| orderByKey | boolean to order by Firebase keys |
25+
| orderByPriority | boolean to order by Firebase priority |
26+
| orderByValue | specify a value to order by |
27+
| equalTo | limit list to items that contain certain value |
28+
| limitToFirst | limit response to x items starting at the beginning |
29+
| limitToLast | limit response to x items starting at the end |
30+
| startAt | key of item to start at |
31+
| endAt | key of item to end at |
32+
| shallow | boolean to only return item keys |
33+
2034
## Invalid query combinations
2135

2236
**Queries can only be ordered by one method.** This means you can only specify

0 commit comments

Comments
 (0)