Module "operators/pipeline/project"

Index

Functions

Functions

$project

$project(collection: Iterator, expr: RawObject, options?: Options): Iterator

- Defined in src/operators/pipeline/project.ts:35
Reshapes a document stream. $project can rename, add, or remove fields as well as create computed values and sub-documents.

Parameters
- collection: Iterator
- expr: RawObject
- Optional options: Options
Returns Iterator

processObject

processObject(obj: RawObject, expr: RawObject, options: Options, expressionKeys: string[], idOnlyExcluded: boolean): RawObject

- Defined in src/operators/pipeline/project.ts:75
Process the expression value for $project operators

Parameters
- obj: RawObject
  
  The object to use as options
- expr: RawObject
  
  The experssion object of $project operator
- options: Options
- expressionKeys: string[]
  
  The key in the 'expr' object
- idOnlyExcluded: boolean
  
  Boolean value indicating whether only the ID key is excluded
Returns RawObject

validateExpression

validateExpression(expr: RawObject, options?: Options): void

- Defined in src/operators/pipeline/project.ts:215
Validate inclusion and exclusion values in expression

Parameters
- expr: RawObject
  
  The expression given for the projection
- Optional options: Options
Returns void

Generated using TypeDoc