Instance Properties

isClosed

Instance Methods

close
count
each
explain
nextObject
rewind
toArray

A wrapped cursor with inline decompression.

Constructor

Cursor (
| mongodb.Cursor mongoloid ,
) {

Arguments

| mongodb.Cursor mongoloid

Native MongoDB cursor to wrap.

Instance Properties

Instance Methods

close (
callback ,
) {

Close the cursor session and abandon selected documents on the database.

Arguments

count (
[ doSkip ] ,
callback ,
) {

Retrieve the number of selected documents.

Arguments

optional
| Boolean doSkip

Apply skip and limit options before counting.
each (
callback ,
) {

Iterate over every selected document.

Arguments

callback (
| Error | undefined err ,
| Object | undefined rec ,
) {

Arguments

| Object | undefined rec

If all documents have been consumed, rec is undefined.
explain (
callback ,
) {

Requests a metadocument of processing info for this query. Index names containing underscores are assumed to be of the format generated automatically by MongoDB and an attempt will be made to decompress key names.

Arguments

nextObject (
callback ,
) {

Retrieve the next single document.

Arguments

callback (
| Error | undefined err ,
| Object | undefined rec ,
) {

Arguments

| Object | undefined rec

If all documents have been consumed, rec is undefined.
rewind ( ) {

Rewind this cursor to the first selected document.
toArray (
callback ,
) {

Assemble every selected document into an Array. Note that using toArray carelessly is an excellent way to run a process out of memory.

Arguments