t

io.scalajs.npm.mongodb

AggregationCursor

trait AggregationCursor[T] extends Object with Readable

Aggregation Cursor

Annotations
@RawJSType() @native()
Linear Supertypes
Readable, IEventEmitter, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AggregationCursor
  2. Readable
  3. IEventEmitter
  4. Object
  5. Any
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def _read(size: Int): Unit
    Definition Classes
    Readable
  5. def _readableState: ReadableState
    Definition Classes
    Readable
  6. def addListener(eventName: String, listener: Function): AggregationCursor.this.type
    Definition Classes
    IEventEmitter
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def batchSize(size: Int): AggregationCursor.this.type

    Sets the batch size parameter of this cursor to the given value.

    Sets the batch size parameter of this cursor to the given value.

    size

    the new batch size.

    Example:

    1. batchSize(batchSize[, callback])

  9. def clone(): AggregationCursor.this.type

    Clone the cursor

    Clone the cursor

    Definition Classes
    AggregationCursor → AnyRef
  10. def close(callback: MongoCallback1[AggregationCursor.this.type] = js.native): Promise[AggregationCursor.this.type]

    Close the cursor, sending a AggregationCursor command and emitting close.

    Close the cursor, sending a AggregationCursor command and emitting close.

    callback

    this optional callbak will be called after executing this method. The first parameter will always contain null while; The second parameter will contain a reference to this cursor.

  11. val domain: String
    Definition Classes
    IEventEmitter
  12. def each(callback: MongoCallback1[T]): Unit

    Iterates over all the documents for this cursor.

    Iterates over all the documents for this cursor. As with {cursor.toArray}, not all of the elements will be iterated if this cursor had been previouly accessed. In that case, {cursor.rewind} can be used to reset the cursor. However, unlike {cursor.toArray}, the cursor will only hold a maximum of batch size elements at any given time if batch size is specified. Otherwise, the caller is responsible for making sure that the entire result can fit the memory.

    callback

    this will be called for while iterating every document of the query result. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the document.

  13. def emit(name: String, args: Any*): Any
    Definition Classes
    IEventEmitter
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def explain(callback: MongoCallback1[Any]): Unit

    Gets a detailed information about how the query is performed on this cursor and how long it took the database to process it.

    Gets a detailed information about how the query is performed on this cursor and how long it took the database to process it.

    callback

    this will be called after executing this method. The first parameter will always be null while the second parameter will be an object containing the details.

    Example:

    1. explain(callback)

  17. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  19. def getMaxListeners(): Int
    Definition Classes
    IEventEmitter
  20. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  22. def isClosed(): Boolean

    Check if the cursor is closed or open.

    Check if the cursor is closed or open.

    returns

    the state of the cursor.

  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def isPaused(): Boolean
    Definition Classes
    Readable
  25. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  26. def listenerCount(eventName: String): Int
    Definition Classes
    IEventEmitter
  27. def listeners(eventName: String): Array[Function]
    Definition Classes
    IEventEmitter
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  31. def on(eventName: String, listener: Function): AggregationCursor.this.type
    Definition Classes
    IEventEmitter
  32. def once(eventName: String, listener: Function): AggregationCursor.this.type
    Definition Classes
    IEventEmitter
  33. def pause(): AggregationCursor.this.type
    Definition Classes
    Readable
  34. def pipe(destination: Writable, options: |[ReadablePipeOptions, RawOptions]): AggregationCursor.this.type
    Definition Classes
    Readable
  35. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  36. def push(chunk: Buffer): Boolean
    Definition Classes
    Readable
  37. def push(chunk: String, encoding: String): Boolean
    Definition Classes
    Readable
  38. def read[T](size: Int): T
    Definition Classes
    Readable
  39. def removeAllListeners(): AggregationCursor.this.type
    Definition Classes
    IEventEmitter
  40. def removeAllListeners(eventName: String): AggregationCursor.this.type
    Definition Classes
    IEventEmitter
  41. def removeListener(eventName: String, listener: Function): AggregationCursor.this.type
    Definition Classes
    IEventEmitter
  42. def resume(): AggregationCursor.this.type
    Definition Classes
    Readable
  43. def setEncoding(encoding: String): AggregationCursor.this.type
    Definition Classes
    Readable
  44. def setMaxListeners(n: Int): AggregationCursor.this.type
    Definition Classes
    IEventEmitter
  45. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  46. def toArray(callback: MongoCallback1[Array[T]] = js.native): Promise[Array[T]]

    Returns an array of documents.

    Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contain partial results when this cursor had been previouly accessed. In that case, cursor.rewind() can be used to reset the cursor.

    callback

    This will be called after executing this method successfully. The first parameter will contain the Error object if an error occurred, or null otherwise. The second parameter will contain an array of BSON deserialized objects as a result of the query.

    returns

    a promise of the results

  47. def toLocaleString(): String
    Definition Classes
    Object
  48. def toString(): String
    Definition Classes
    AnyRef → Any
  49. def unpipe(destination: Writable): Unit
    Definition Classes
    Readable
  50. def unshift(chunk: Any): Unit
    Definition Classes
    Readable
  51. val usingDomains: Boolean
    Definition Classes
    IEventEmitter
  52. def valueOf(): Any
    Definition Classes
    Object
  53. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. def wrap(stream: Any): Unit
    Definition Classes
    Readable

Inherited from Readable

Inherited from IEventEmitter

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped