test: clarify findAsCursor return type

mongoist · Mar 30, 2020 · 3a65f38 · 3a65f38
1 parent b172775
commit 3a65f38
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -114,6 +114,12 @@ db.collection('foo').find(...);
 // find everything in mycollection returned as array
 const documents = await db.mycollection.find();
 
+// find everything in mycollection returned as a Cursor (no intermediate Promise)
+const documentsCursor = db.mycollection.findAsCursor();
+
+// take the first document from the cursor
+const document = await documentsCursor.next();
+
 // find everything in mycollection, but sort by name
 const sortedDocuments = await db.mycollection.findAsCursor().sort({name: 1}).toArray();