Aggregate | Documentation

Type Parameters

ResultType

Hierarchy

Aggregate

Implements

SessionOperation

Index

Constructors

constructor

Properties

Constructors

constructor

new Aggregate<ResultType>(): Aggregate<ResultType>

Type Parameters
- ResultType
Returns Aggregate<ResultType>

Methods

[asyncIterator]

[asyncIterator](): <internal>.AsyncIterableIterator<Unpacked<ResultType>>

- Defined in node_modules/mongoose/types/aggregate.d.ts:77
Returns an asyncIterator for use with for/await/of loops You do not need to call this function explicitly, the JavaScript runtime will call it for you.

Returns <internal>.AsyncIterableIterator<Unpacked<ResultType>>

addCursorFlag

addCursorFlag(flag: CursorFlag, value: boolean): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:87
Sets an option on this aggregation. This function will be deprecated in a future release.

deprecated
Parameters
- flag: CursorFlag
- value: boolean
Returns Aggregate<ResultType>

addFields

addFields(arg: <internal>.Record<string, any>): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:93
Appends a new $addFields operator to this aggregate pipeline. Requires MongoDB v3.4+ to work

Parameters
- arg: <internal>.Record<string, any>
Returns Aggregate<ResultType>

allowDiskUse

allowDiskUse(value: boolean): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:96
Sets the allowDiskUse option for the aggregation query

Parameters
- value: boolean
Returns Aggregate<ResultType>

append

append(...args: PipelineStage[]): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:99
Appends new operators to this aggregate pipeline

Parameters
- Rest ...args: PipelineStage[]
Returns Aggregate<ResultType>

collation

collation(options: CollationOptions): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:109
Set the collation.

Parameters
- options: CollationOptions
Returns Aggregate<ResultType>

count

count(fieldName: string): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:112
Appends a new $count operator to this aggregate pipeline.

Parameters
- fieldName: string
Returns Aggregate<ResultType>

densify

densify(arg: { field: string; partitionByFields?: string[]; range: { step: number; unit?: "millisecond" | "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"; bounds: number[] | Date[] | "full" | "partition" } }): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:115
Appends a new $densify operator to this aggregate pipeline

Parameters
- arg: { field: string; partitionByFields?: string[]; range: { step: number; unit?: "millisecond" | "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"; bounds: number[] | Date[] | "full" | "partition" } }
  - field: string
  - Optional partitionByFields?: string[]
  - range: { step: number; unit?: "millisecond" | "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"; bounds: number[] | Date[] | "full" | "partition" }
    - step: number
    - Optional unit?: "millisecond" | "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"
    - bounds: number[] | Date[] | "full" | "partition"
Returns Aggregate<ResultType>

cursor

cursor<DocType>(options?: <internal>.Record<string, unknown>): Cursor<DocType, never>

- Defined in node_modules/mongoose/types/aggregate.d.ts:120
Sets the cursor option for the aggregation query

Type Parameters
- DocType = any
Parameters
- Optional options: <internal>.Record<string, unknown>
Returns Cursor<DocType, never>

exec

exec(callback: <internal>.Callback<ResultType>): void
exec(): Promise<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:124
Executes the aggregate pipeline on the currently bound Model.

Parameters
- callback: <internal>.Callback<ResultType>
Returns void
- Defined in node_modules/mongoose/types/aggregate.d.ts:125
Returns Promise<ResultType>

explain

explain(verbosity: ExplainVerbosityLike, callback: <internal>.Callback<AnyObject>): void
explain(verbosity: ExplainVerbosityLike): Promise<AnyObject>
explain(callback: <internal>.Callback<AnyObject>): void
explain(): Promise<AnyObject>

- Defined in node_modules/mongoose/types/aggregate.d.ts:128
Execute the aggregation with explain

Parameters
- verbosity: ExplainVerbosityLike
- callback: <internal>.Callback<AnyObject>
Returns void
- Defined in node_modules/mongoose/types/aggregate.d.ts:129
Parameters
- verbosity: ExplainVerbosityLike
Returns Promise<AnyObject>
- Defined in node_modules/mongoose/types/aggregate.d.ts:130
Parameters
- callback: <internal>.Callback<AnyObject>
Returns void
- Defined in node_modules/mongoose/types/aggregate.d.ts:131
Returns Promise<AnyObject>

facet

facet(options: <internal>.Record<string, FacetPipelineStage[]>): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:134
Combines multiple aggregation pipelines.

Parameters
- options: <internal>.Record<string, FacetPipelineStage[]>
Returns Aggregate<ResultType>

fill

fill(arg: { partitionBy?: any; partitionByFields?: string[]; sortBy?: <internal>.Record<string, 1 | -1>; output: <internal>.Record<string, { value: any } | { method: "linear" | "locf" }> }): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:137
Appends a new $fill operator to this aggregate pipeline

Parameters
- arg: { partitionBy?: any; partitionByFields?: string[]; sortBy?: <internal>.Record<string, 1 | -1>; output: <internal>.Record<string, { value: any } | { method: "linear" | "locf" }> }
  - Optional partitionBy?: any
  - Optional partitionByFields?: string[]
  - Optional sortBy?: <internal>.Record<string, 1 | -1>
  - output: <internal>.Record<string, { value: any } | { method: "linear" | "locf" }>
Returns Aggregate<ResultType>

graphLookup

graphLookup(options: { from: string; startWith: any; connectFromField: string; connectToField: string; as: string; maxDepth?: number; depthField?: string; restrictSearchWithMatch?: AnyObject }): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:140
Appends new custom $graphLookup operator(s) to this aggregate pipeline, performing a recursive search on a collection.

Parameters
- options: { from: string; startWith: any; connectFromField: string; connectToField: string; as: string; maxDepth?: number; depthField?: string; restrictSearchWithMatch?: AnyObject }
  - from: string
  - startWith: any
  - connectFromField: string
  - connectToField: string
  - as: string
  - Optional maxDepth?: number
  - Optional depthField?: string
  - Optional restrictSearchWithMatch?: AnyObject
Returns Aggregate<ResultType>

group

group(arg: { _id: any } | {}): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:143
Appends new custom $group operator to this aggregate pipeline.

Parameters
- arg: { _id: any } | {}
Returns Aggregate<ResultType>

hint

hint(value: string | <internal>.Record<string, unknown>): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:146
Sets the hint option for the aggregation query

Parameters
- value: string | <internal>.Record<string, unknown>
Returns Aggregate<ResultType>

limit

limit(num: number): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:152
Appends a new $limit operator to this aggregate pipeline.

Parameters
- num: number
  
  maximum number of records to pass to the next stage
Returns Aggregate<ResultType>

lookup

lookup(options: { from: string; as: string; localField?: string; foreignField?: string; let?: <internal>.Record<string, any>; pipeline?: (AddFields | Bucket | BucketAuto | <internal>.PipelineStage.CollStats | <internal>.PipelineStage.Count | Densify | Facet | Fill | GeoNear | GraphLookup | Group | IndexStats | Limit | ListSessions | Lookup | Match | PlanCacheStats | Project | Redact | ReplaceRoot | ReplaceWith | Sample | Search | Set | SetWindowFields | Skip | <internal>.PipelineStage.Sort | SortByCount | UnionWith | Unset | Unwind)[] }): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:155
Appends new custom $lookup operator to this aggregate pipeline.

Parameters
- options: { from: string; as: string; localField?: string; foreignField?: string; let?: <internal>.Record<string, any>; pipeline?: (AddFields | Bucket | BucketAuto | <internal>.PipelineStage.CollStats | <internal>.PipelineStage.Count | Densify | Facet | Fill | GeoNear | GraphLookup | Group | IndexStats | Limit | ListSessions | Lookup | Match | PlanCacheStats | Project | Redact | ReplaceRoot | ReplaceWith | Sample | Search | Set | SetWindowFields | Skip | <internal>.PipelineStage.Sort | SortByCount | UnionWith | Unset | Unwind)[] }
  - from: string
  - as: string
  - Optional localField?: string
  - Optional foreignField?: string
  - Optional let?: <internal>.Record<string, any>
  - Optional pipeline?: (AddFields | Bucket | BucketAuto | <internal>.PipelineStage.CollStats | <internal>.PipelineStage.Count | Densify | Facet | Fill | GeoNear | GraphLookup | Group | IndexStats | Limit | ListSessions | Lookup | Match | PlanCacheStats | Project | Redact | ReplaceRoot | ReplaceWith | Sample | Search | Set | SetWindowFields | Skip | <internal>.PipelineStage.Sort | SortByCount | UnionWith | Unset | Unwind)[]
Returns Aggregate<ResultType>

match

match(arg: FilterQuery<any>): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:161
Appends a new custom $match operator to this aggregate pipeline.

Parameters
- arg: FilterQuery<any>
  
  $match operator contents
Returns Aggregate<ResultType>

model

model(model: <internal>.Model<any, {}, {}, {}, any>): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:167
Binds this aggregate to a model.

Parameters
- model: <internal>.Model<any, {}, {}, {}, any>
  
  the model to which the aggregate is to be bound
Returns Aggregate<ResultType>

near

near(arg: { near?: number[]; distanceField: string; maxDistance?: number; query?: <internal>.Record<string, any>; includeLocs?: string; num?: number; uniqueDocs?: boolean }): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:173
Append a new $near operator to this aggregation pipeline

Parameters
- arg: { near?: number[]; distanceField: string; maxDistance?: number; query?: <internal>.Record<string, any>; includeLocs?: string; num?: number; uniqueDocs?: boolean }
  
  $near operator contents
  - Optional near?: number[]
  - distanceField: string
  - Optional maxDistance?: number
  - Optional query?: <internal>.Record<string, any>
  - Optional includeLocs?: string
  - Optional num?: number
  - Optional uniqueDocs?: boolean
Returns Aggregate<ResultType>

pipeline

pipeline(): PipelineStage[]

- Defined in node_modules/mongoose/types/aggregate.d.ts:176
Returns the current pipeline

Returns PipelineStage[]

project

project(arg: {}): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:179
Appends a new $project operator to this aggregate pipeline.

Parameters
- arg: {}
  - [field: string]: AnyExpression | Expression | Project["$project"]
Returns Aggregate<ResultType>

read

read(pref: ReadPreferenceLike): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:182
Sets the readPreference option for the aggregation query.

Parameters
- pref: ReadPreferenceLike
Returns Aggregate<ResultType>

readConcern

readConcern(level: string): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:185
Sets the readConcern level for the aggregation query.

Parameters
- level: string
Returns Aggregate<ResultType>

redact

redact(expression: any, thenExpr: AnyObject | "$$DESCEND" | "$$PRUNE" | "$$KEEP", elseExpr: AnyObject | "$$DESCEND" | "$$PRUNE" | "$$KEEP"): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:188
Appends a new $redact operator to this aggregate pipeline.

Parameters
- expression: any
- thenExpr: AnyObject | "$$DESCEND" | "$$PRUNE" | "$$KEEP"
- elseExpr: AnyObject | "$$DESCEND" | "$$PRUNE" | "$$KEEP"
Returns Aggregate<ResultType>

replaceRoot

replaceRoot(newRoot: any): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:191
Appends a new $replaceRoot operator to this aggregate pipeline.

Parameters
- newRoot: any
Returns Aggregate<ResultType>

search

search(options: { index?: string; highlight?: { path: string | string[] | { value: string; multi: string }; maxCharsToExamine?: number; maxNumPassages?: number } }): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:197
Helper for Atlas Text Search's $search stage.

Parameters
- options: { index?: string; highlight?: { path: string | string[] | { value: string; multi: string }; maxCharsToExamine?: number; maxNumPassages?: number } }
  - [operator: string]: any
  - Optional index?: string
  - Optional highlight?: { path: string | string[] | { value: string; multi: string }; maxCharsToExamine?: number; maxNumPassages?: number }
    - path: string | string[] | { value: string; multi: string }
      
      highlightPath reference
    - Optional maxCharsToExamine?: number
    - Optional maxNumPassages?: number
Returns Aggregate<ResultType>

option

option(value: <internal>.AggregateOptions): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:200
Lets you set arbitrary options, for middlewares or plugins.

Parameters
- value: <internal>.AggregateOptions
Returns Aggregate<ResultType>

sample

sample(arg: number): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:203
Appends new custom $sample operator to this aggregate pipeline.

Parameters
- arg: number
Returns Aggregate<ResultType>

session

session(session: ClientSession): Aggregate<ResultType>

Implementation of SessionOperation.session
- Defined in node_modules/mongoose/types/aggregate.d.ts:206
Sets the session for this aggregation. Useful for transactions.

Parameters
- session: ClientSession
Returns Aggregate<ResultType>

skip

skip(num: number): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:212
Appends a new $skip operator to this aggregate pipeline.

Parameters
- num: number
  
  number of records to skip before next stage
Returns Aggregate<ResultType>

sort

sort(arg: string | <internal>.Record<string, SortOrder> | <internal>.Record<string, 1 | -1 | <internal>.Meta>): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:215
Appends a new $sort operator to this aggregate pipeline.

Parameters
- arg: string | <internal>.Record<string, SortOrder> | <internal>.Record<string, 1 | -1 | <internal>.Meta>
Returns Aggregate<ResultType>

sortByCount

sortByCount(arg: any): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:224
Appends a new $sortByCount operator to this aggregate pipeline. Accepts either a string field name or a pipeline object.

Parameters
- arg: any
Returns Aggregate<ResultType>

unionWith

unionWith(options: string | { coll: string; pipeline?: (AddFields | Bucket | BucketAuto | <internal>.PipelineStage.CollStats | <internal>.PipelineStage.Count | Densify | Facet | Fill | GeoNear | GraphLookup | Group | IndexStats | Limit | ListSessions | Lookup | Match | PlanCacheStats | Project | Redact | ReplaceRoot | ReplaceWith | Sample | Search | Set | SetWindowFields | Skip | <internal>.PipelineStage.Sort | SortByCount | UnionWith | Unset | Unwind)[] }): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:227
Appends new $unionWith operator to this aggregate pipeline.

Parameters
- options: string | { coll: string; pipeline?: (AddFields | Bucket | BucketAuto | <internal>.PipelineStage.CollStats | <internal>.PipelineStage.Count | Densify | Facet | Fill | GeoNear | GraphLookup | Group | IndexStats | Limit | ListSessions | Lookup | Match | PlanCacheStats | Project | Redact | ReplaceRoot | ReplaceWith | Sample | Search | Set | SetWindowFields | Skip | <internal>.PipelineStage.Sort | SortByCount | UnionWith | Unset | Unwind)[] }
Returns Aggregate<ResultType>

unwind

unwind(...args: (string | { path: string; includeArrayIndex?: string; preserveNullAndEmptyArrays?: boolean })[]): Aggregate<ResultType>

- Defined in node_modules/mongoose/types/aggregate.d.ts:230
Appends new custom $unwind operator(s) to this aggregate pipeline.

Parameters
- Rest ...args: (string | { path: string; includeArrayIndex?: string; preserveNullAndEmptyArrays?: boolean })[]
Returns Aggregate<ResultType>

Properties

options

options: <internal>.AggregateOptions

catch

catch: (<TResult>(onrejected?: ((reason: any) => TResult | <internal>.PromiseLike<TResult>)) => Promise<ResultType | TResult>)

Type declaration

- <TResult>(onrejected?: ((reason: any) => TResult | <internal>.PromiseLike<TResult>)): Promise<ResultType | TResult>
- Attaches a callback for only the rejection of the Promise.
  
  Type Parameters
  - TResult = never
  Parameters
  - Optional onrejected: ((reason: any) => TResult | <internal>.PromiseLike<TResult>)
    
    The callback to execute when the Promise is rejected.
    - - (reason: any): TResult | <internal>.PromiseLike<TResult>
      - Parameters
        reason: any
        Returns TResult | <internal>.PromiseLike<TResult>
  Returns Promise<ResultType | TResult>
  A Promise for the completion of the callback.

then

then: (<TResult1, TResult2>(onfulfilled?: ((value: ResultType) => TResult1 | <internal>.PromiseLike<TResult1>), onrejected?: ((reason: any) => TResult2 | <internal>.PromiseLike<TResult2>)) => Promise<TResult1 | TResult2>)

Type declaration

- <TResult1, TResult2>(onfulfilled?: ((value: ResultType) => TResult1 | <internal>.PromiseLike<TResult1>), onrejected?: ((reason: any) => TResult2 | <internal>.PromiseLike<TResult2>)): Promise<TResult1 | TResult2>
- Attaches callbacks for the resolution and/or rejection of the Promise.
  
  Type Parameters
  - TResult1 = ResultType
  - TResult2 = never
  Parameters
  - Optional onfulfilled: ((value: ResultType) => TResult1 | <internal>.PromiseLike<TResult1>)
    
    The callback to execute when the Promise is resolved.
    - - (value: ResultType): TResult1 | <internal>.PromiseLike<TResult1>
      - Parameters
        value: ResultType
        Returns TResult1 | <internal>.PromiseLike<TResult1>
  - Optional onrejected: ((reason: any) => TResult2 | <internal>.PromiseLike<TResult2>)
    
    The callback to execute when the Promise is rejected.
    - - (reason: any): TResult2 | <internal>.PromiseLike<TResult2>
      - Parameters
        reason: any
        Returns TResult2 | <internal>.PromiseLike<TResult2>
  Returns Promise<TResult1 | TResult2>
  A Promise for the completion of which ever callback is executed.

Type Parameters

ResultType

Hierarchy

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Type Parameters

ResultType

Returns Aggregate<ResultType>

Methods

[asyncIterator]

Returns <internal>.AsyncIterableIterator<Unpacked<ResultType>>

addCursorFlag

Parameters

flag: CursorFlag

value: boolean

Returns Aggregate<ResultType>

addFields

Parameters

arg: <internal>.Record<string, any>

Returns Aggregate<ResultType>

allowDiskUse

Parameters

value: boolean

Returns Aggregate<ResultType>

append

Parameters

Rest ...args: PipelineStage[]

Returns Aggregate<ResultType>

collation

Parameters

options: CollationOptions

Returns Aggregate<ResultType>

count

Parameters

fieldName: string

Returns Aggregate<ResultType>

densify

Parameters

arg: { field: string; partitionByFields?: string[]; range: { step: number; unit?: "millisecond" | "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"; bounds: number[] | Date[] | "full" | "partition" } }

field: string

Optional partitionByFields?: string[]

range: { step: number; unit?: "millisecond" | "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"; bounds: number[] | Date[] | "full" | "partition" }

step: number

Optional unit?: "millisecond" | "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"

bounds: number[] | Date[] | "full" | "partition"

Returns Aggregate<ResultType>

cursor

Type Parameters

DocType = any

Parameters

Optional options: <internal>.Record<string, unknown>

Returns Cursor<DocType, never>

exec

Parameters

callback: <internal>.Callback<ResultType>

Returns void

Returns Promise<ResultType>

explain

Parameters

verbosity: ExplainVerbosityLike

callback: <internal>.Callback<AnyObject>

Returns void

Parameters

verbosity: ExplainVerbosityLike

Returns Promise<AnyObject>

Parameters

callback: <internal>.Callback<AnyObject>

Returns void

Returns Promise<AnyObject>

facet

Parameters

options: <internal>.Record<string, FacetPipelineStage[]>

Returns Aggregate<ResultType>

fill

Parameters