Instance Properties

isClosed

Instance Methods

close
count
each
nextObject
rewind
toArray

A wrapped Cursor specialized for decompressing index information documents.

Constructor

IndexInfoCursor (
| mongodb.IndexInfoCursor mongoloid ,
) {

Arguments

| mongodb.IndexInfoCursor mongoloid

Native MongoDB IndexInfoCursor 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.
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