Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "index"

Index

References

Functions

References

Aggregator

Re-exports Aggregator

Query

Re-exports Query

Functions

aggregate

  • Return the result collection after running the aggregation pipeline for the given collection. Shorthand for (new Aggregator(pipeline, options)).run(collection)

    Parameters

    • collection: Source

      Collection or stream of objects

    • pipeline: Array<RawObject>

      The pipeline operators to use

    • Optional options: Options

    Returns RawArray

    New array of results

find

  • Performs a query on a collection and returns a cursor object. Shorthand for Query(criteria).find(collection, projection)

    Parameters

    Returns Cursor

    A cursor of results

remove

  • Returns a new array without objects which match the criteria

    Parameters

    Returns RawObject[]

    New filtered array

Generated using TypeDoc