Interface Aggregation<A>

interface Aggregation<A = unknown> {
    "[toStringTag]": string;
    catch: <TResult = never>(
        onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null,
    ) => Promise<A[] | TResult>;
    finally: (onfinally?: (() => void) | null) => Promise<A[]>;
    options: AggregateOptions;
    then: <TResult1 = A[], TResult2 = never>(
        onfulfilled?: ((value: A[]) => TResult1 | PromiseLike<TResult1>) | null,
        onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null,
    ) => Promise<TResult1 | TResult2>;
    "[asyncIterator]"(): AsyncIterableIterator<A>;
    addCursorFlag(flag: CursorFlag, value: boolean): this;
    addFields(arg: Record<string, any>): this;
    allowDiskUse(value: boolean): this;
    append(...args: PipelineStage[]): this;
    collation(options: CollationOptions): this;
    count(fieldName: string): this;
    countDocuments(): Promise<number>;
    cursor<DocType = any>(options?: Record<string, unknown>): Cursor<DocType>;
    densify(
        arg: {
            field: string;
            partitionByFields?: string[];
            range: {
                bounds: number[] | Date[] | "full" | "partition";
                step: number;
                unit?:
                    | "millisecond"
                    | "second"
                    | "minute"
                    | "hour"
                    | "day"
                    | "week"
                    | "month"
                    | "quarter"
                    | "year";
            };
        },
    ): this;
    exec(cursorOptions?: Record<string, unknown>): Promise<A[]>;
    explain(verbosity: ExplainVerbosityLike): Promise<AnyObject>;
    explain(): Promise<AnyObject>;
    facet(options: Record<string, FacetPipelineStage[]>): this;
    fill(
        arg: {
            output: Record<
                string,
                { value: Expression }
                | { method: "linear" | "locf" },
            >;
            partitionBy?: any;
            partitionByFields?: string[];
            sortBy?: Record<string, -1 | 1>;
        },
    ): this;
    graphLookup(
        options: {
            as: string;
            connectFromField: string;
            connectToField: string;
            depthField?: string;
            from: string;
            maxDepth?: number;
            restrictSearchWithMatch?: AnyObject;
            startWith: any;
        },
    ): this;
    group(arg: { _id: any } | { [key: string]: AccumulatorOperator }): this;
    hint(value: string | Record<string, unknown>): this;
    limit(num: number): this;
    lookup(
        options: {
            as: string;
            foreignField?: string;
            from: string;
            let?: Record<string, any>;
            localField?: string;
            pipeline?: (
                | AddFields
                | Bucket
                | BucketAuto
                | CollStats
                | Count
                | Densify
                | Documents
                | Facet
                | Fill
                | GeoNear
                | GraphLookup
                | Group
                | IndexStats
                | Limit
                | ListSessions
                | Lookup
                | Match
                | PlanCacheStats
                | Project
                | Redact
                | ReplaceRoot
                | ReplaceWith
                | Sample
                | Search
                | SearchMeta
                | Set
                | SetWindowFields
                | Skip
                | Sort
                | SortByCount
                | UnionWith
                | Unset
                | Unwind
                | VectorSearch
            )[];
        },
    ): this;
    match(arg: _QueryFilter<Record<string, any>>): this;
    model(model: Model<any>): Aggregate<A[]>;
    model(): CustomModel<any>;
    near(
        arg: {
            distanceField: string;
            distanceMultiplier?: number;
            includeLocs?: string;
            key?: string;
            maxDistance?: number;
            minDistance?: number;
            near: { coordinates: [number, number]; type: "Point" } | [number, number];
            num?: number;
            query?: AnyObject;
            spherical?: boolean;
        },
    ): this;
    option(value: AggregateOptions): this;
    pipeline(): PipelineStage[];
    project(arg: string | { [field: string]: any }): this;
    read(pref: ReadPreferenceLike): this;
    readConcern(level: string): this;
    redact(
        expression: any,
        thenExpr: AnyObject | "$$DESCEND" | "$$PRUNE" | "$$KEEP",
        elseExpr: AnyObject | "$$DESCEND" | "$$PRUNE" | "$$KEEP",
    ): this;
    replaceRoot(newRoot: any): this;
    sample(arg: number): this;
    search(
        options: {
            highlight?: {
                maxCharsToExamine?: number;
                maxNumPassages?: number;
                path: string | string[] | { multi: string; value: string };
            };
            index?: string;
            [operator: string]: any;
        },
    ): this;
    session(session: ClientSession | null): this;
    skip(num: number): this;
    sort(
        arg: string | Record<string, SortOrder> | Record<string, 1 | -1 | Meta>,
    ): this;
    sortByCount(arg: any): this;
    unionWith(
        options:
            | string
            | {
                coll: string;
                pipeline?: (
                    | AddFields
                    | Bucket
                    | BucketAuto
                    | CollStats
                    | Count
                    | Densify
                    | Documents
                    | Facet
                    | Fill
                    | GeoNear
                    | GraphLookup
                    | Group
                    | IndexStats
                    | Limit
                    | ListSessions
                    | Lookup
                    | Match
                    | PlanCacheStats
                    | Project
                    | Redact
                    | ReplaceRoot
                    | ReplaceWith
                    | Sample
                    | Search
                    | SearchMeta
                    | Set
                    | SetWindowFields
                    | Skip
                    | Sort
                    | SortByCount
                    | UnionWith
                    | Unset
                    | Unwind
                    | VectorSearch
                )[];
            }
            | {
                coll?: string;
                pipeline: (
                    | AddFields
                    | Bucket
                    | BucketAuto
                    | CollStats
                    | Count
                    | Densify
                    | Documents
                    | Facet
                    | Fill
                    | GeoNear
                    | GraphLookup
                    | Group
                    | IndexStats
                    | Limit
                    | ListSessions
                    | Lookup
                    | Match
                    | PlanCacheStats
                    | Project
                    | Redact
                    | ReplaceRoot
                    | ReplaceWith
                    | Sample
                    | Search
                    | SearchMeta
                    | Set
                    | SetWindowFields
                    | Skip
                    | Sort
                    | SortByCount
                    | UnionWith
                    | Unset
                    | Unwind
                    | VectorSearch
                )[];
            },
    ): this;
    unwind(
        ...args: (
            | string
            | {
                includeArrayIndex?: string;
                path: string;
                preserveNullAndEmptyArrays?: boolean;
            }
        )[],
    ): this;
    [key: string]: unknown;
}

Type Parameters

A = unknown

Hierarchy

Omit<ExtendedAggregate<A[]>, "model">
- Aggregation

Indexable

[key: string]: unknown

Properties

[toStringTag]

"[toStringTag]": string

catch

catch: <TResult = never>(
onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null,
) => Promise<A[] | TResult>

Executes the query returning a Promise which will be resolved with either the doc(s) or rejected with the error. Like .then(), but only takes a rejection handler.

Type Declaration

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

finally

finally: (onfinally?: (() => void) | null) => Promise<A[]>

Executes the aggregation returning a Promise which will be resolved with .finally() chained.

Type Declaration

- (onfinally?: (() => void) | null): Promise<A[]>
- Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
  Parameters
  - Optionalonfinally: (() => void) | null
    The callback to execute when the Promise is settled (fulfilled or rejected).
  Returns Promise<A[]>
  A Promise for the completion of the callback.

options

options: AggregateOptions

then

Provides promise for aggregate.

Type Declaration

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

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterableIterator<A>
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 AsyncIterableIterator<A>
Inherited from Omit.[asyncIterator]
- Defined in node_modules/mongoose/types/aggregate.d.ts:17

addCursorFlag

addCursorFlag(flag: CursorFlag, value: boolean): this
Sets an option on this aggregation. This function will be deprecated in a future release.
Parameters
- flag: CursorFlag
- value: boolean
Returns this
Deprecated
Inherited from Omit.addCursorFlag
- Defined in node_modules/mongoose/types/aggregate.d.ts:30

addFields

addFields(arg: Record<string, any>): this
Appends a new $addFields operator to this aggregate pipeline. Requires MongoDB v3.4+ to work
Parameters
- arg: Record<string, any>
Returns this
Inherited from Omit.addFields
- Defined in node_modules/mongoose/types/aggregate.d.ts:36

allowDiskUse

allowDiskUse(value: boolean): this
Sets the allowDiskUse option for the aggregation query
Parameters
- value: boolean
Returns this
Inherited from Omit.allowDiskUse
- Defined in node_modules/mongoose/types/aggregate.d.ts:39

append

append(...args: PipelineStage[]): this
Appends new operators to this aggregate pipeline
Parameters
- ...args: PipelineStage[]
Returns this
Inherited from Omit.append
- Defined in node_modules/mongoose/types/aggregate.d.ts:42

collation

collation(options: CollationOptions): this
Set the collation.
Parameters
- options: CollationOptions
Returns this
Inherited from Omit.collation
- Defined in node_modules/mongoose/types/aggregate.d.ts:52

count

count(fieldName: string): this
Appends a new $count operator to this aggregate pipeline.
Parameters
- fieldName: string
Returns this
Inherited from Omit.count
- Defined in node_modules/mongoose/types/aggregate.d.ts:55

countDocuments

countDocuments(): Promise<number>
Returns Promise<number>
Inherited from Omit.countDocuments
- Defined in src/definitions.ts:4

cursor

cursor<DocType = any>(options?: Record<string, unknown>): Cursor<DocType>
Sets the cursor option for the aggregation query
Type Parameters
- DocType = any
Parameters
- Optionaloptions: Record<string, unknown>
Returns Cursor<DocType>
Inherited from Omit.cursor
- Defined in node_modules/mongoose/types/aggregate.d.ts:63

densify

densify(
    arg: {
        field: string;
        partitionByFields?: string[];
        range: {
            bounds: number[] | Date[] | "full" | "partition";
            step: number;
            unit?:
                | "millisecond"
                | "second"
                | "minute"
                | "hour"
                | "day"
                | "week"
                | "month"
                | "quarter"
                | "year";
        };
    },
): this
Appends a new $densify operator to this aggregate pipeline
Parameters
- arg: {
      field: string;
      partitionByFields?: string[];
      range: {
          bounds: number[] | Date[] | "full" | "partition";
          step: number;
          unit?:
              | "millisecond"
              | "second"
              | "minute"
              | "hour"
              | "day"
              | "week"
              | "month"
              | "quarter"
              | "year";
      };
  }
Returns this
Inherited from Omit.densify
- Defined in node_modules/mongoose/types/aggregate.d.ts:58

exec

exec(cursorOptions?: Record<string, unknown>): Promise<A[]>
Executes the aggregate pipeline on the currently bound Model.
Parameters
- OptionalcursorOptions: Record<string, unknown>
Returns Promise<A[]>
Inherited from Omit.exec
- Defined in src/definitions.ts:5

explain

explain(verbosity: ExplainVerbosityLike): Promise<AnyObject>
Execute the aggregation with explain
Parameters
- verbosity: ExplainVerbosityLike
Returns Promise<AnyObject>
Inherited from Omit.explain
- Defined in node_modules/mongoose/types/aggregate.d.ts:70
explain(): Promise<AnyObject>
Execute the aggregation with explain

Returns Promise<AnyObject>
Inherited from Omit.explain
- Defined in node_modules/mongoose/types/aggregate.d.ts:71

facet(options: Record<string, FacetPipelineStage[]>): this
Combines multiple aggregation pipelines.
Parameters
- options: Record<string, FacetPipelineStage[]>
Returns this
Inherited from Omit.facet
- Defined in node_modules/mongoose/types/aggregate.d.ts:74

fill

fill(
    arg: {
        output: Record<
            string,
            { value: Expression }
            | { method: "linear" | "locf" },
        >;
        partitionBy?: any;
        partitionByFields?: string[];
        sortBy?: Record<string, -1 | 1>;
    },
): this
Appends a new $fill operator to this aggregate pipeline
Parameters
- arg: {
      output: Record<
          string,
          { value: Expression }
          | { method: "linear" | "locf" },
      >;
      partitionBy?: any;
      partitionByFields?: string[];
      sortBy?: Record<string, -1 | 1>;
  }
Returns this
Inherited from Omit.fill
- Defined in node_modules/mongoose/types/aggregate.d.ts:77

graphLookup

graphLookup(
    options: {
        as: string;
        connectFromField: string;
        connectToField: string;
        depthField?: string;
        from: string;
        maxDepth?: number;
        restrictSearchWithMatch?: AnyObject;
        startWith: any;
    },
): this
Appends new custom $graphLookup operator(s) to this aggregate pipeline, performing a recursive search on a collection.
Parameters
- options: {
      as: string;
      connectFromField: string;
      connectToField: string;
      depthField?: string;
      from: string;
      maxDepth?: number;
      restrictSearchWithMatch?: AnyObject;
      startWith: any;
  }
Returns this
Inherited from Omit.graphLookup
- Defined in node_modules/mongoose/types/aggregate.d.ts:86

group

group(arg: { _id: any } | { [key: string]: AccumulatorOperator }): this
Appends new custom $group operator to this aggregate pipeline.
Parameters
- arg: { _id: any } | { [key: string]: AccumulatorOperator }
Returns this
Inherited from Omit.group
- Defined in node_modules/mongoose/types/aggregate.d.ts:89

hint

hint(value: string | Record<string, unknown>): this
Sets the hint option for the aggregation query
Parameters
- value: string | Record<string, unknown>
Returns this
Inherited from Omit.hint
- Defined in node_modules/mongoose/types/aggregate.d.ts:92

limit

limit(num: number): this
Appends a new $limit operator to this aggregate pipeline.
Parameters
- num: number
  maximum number of records to pass to the next stage
Returns this
Inherited from Omit.limit
- Defined in node_modules/mongoose/types/aggregate.d.ts:98

lookup

lookup(
    options: {
        as: string;
        foreignField?: string;
        from: string;
        let?: Record<string, any>;
        localField?: string;
        pipeline?: (
            | AddFields
            | Bucket
            | BucketAuto
            | CollStats
            | Count
            | Densify
            | Documents
            | Facet
            | Fill
            | GeoNear
            | GraphLookup
            | Group
            | IndexStats
            | Limit
            | ListSessions
            | Lookup
            | Match
            | PlanCacheStats
            | Project
            | Redact
            | ReplaceRoot
            | ReplaceWith
            | Sample
            | Search
            | SearchMeta
            | Set
            | SetWindowFields
            | Skip
            | Sort
            | SortByCount
            | UnionWith
            | Unset
            | Unwind
            | VectorSearch
        )[];
    },
): this
Appends new custom $lookup operator to this aggregate pipeline.
Parameters
- options: {
      as: string;
      foreignField?: string;
      from: string;
      let?: Record<string, any>;
      localField?: string;
      pipeline?: (
          | AddFields
          | Bucket
          | BucketAuto
          | CollStats
          | Count
          | Densify
          | Documents
          | Facet
          | Fill
          | GeoNear
          | GraphLookup
          | Group
          | IndexStats
          | Limit
          | ListSessions
          | Lookup
          | Match
          | PlanCacheStats
          | Project
          | Redact
          | ReplaceRoot
          | ReplaceWith
          | Sample
          | Search
          | SearchMeta
          | Set
          | SetWindowFields
          | Skip
          | Sort
          | SortByCount
          | UnionWith
          | Unset
          | Unwind
          | VectorSearch
      )[];
  }
Returns this
Inherited from Omit.lookup
- Defined in node_modules/mongoose/types/aggregate.d.ts:101

match

match(arg: _QueryFilter<Record<string, any>>): this
Appends a new custom $match operator to this aggregate pipeline.
Parameters
- arg: _QueryFilter<Record<string, any>>
  $match operator contents
Returns this
Inherited from Omit.match
- Defined in node_modules/mongoose/types/aggregate.d.ts:107

model

model(model: Model<any>): Aggregate<A[]>
Parameters
- model: Model<any>
Returns Aggregate<A[]>
- Defined in src/definitions.ts:10
model(): CustomModel<any>
Returns CustomModel<any>
- Defined in src/definitions.ts:12

near

near(
    arg: {
        distanceField: string;
        distanceMultiplier?: number;
        includeLocs?: string;
        key?: string;
        maxDistance?: number;
        minDistance?: number;
        near: { coordinates: [number, number]; type: "Point" } | [number, number];
        num?: number;
        query?: AnyObject;
        spherical?: boolean;
    },
): this
Appends a new $geoNear operator to this aggregate pipeline.
Parameters
- arg: {
      distanceField: string;
      distanceMultiplier?: number;
      includeLocs?: string;
      key?: string;
      maxDistance?: number;
      minDistance?: number;
      near: { coordinates: [number, number]; type: "Point" } | [number, number];
      num?: number;
      query?: AnyObject;
      spherical?: boolean;
  }
  - distanceField: string
  - OptionaldistanceMultiplier?: number
  - OptionalincludeLocs?: string
  - Optionalkey?: string
  - OptionalmaxDistance?: number
  - OptionalminDistance?: number
  - near: { coordinates: [number, number]; type: "Point" } | [number, number]
  - Optionalnum?: number
    Deprecated. Use only with MondoDB below 4.2 (removed in 4.2)
    
    Deprecated
  - Optionalquery?: AnyObject
  - Optionalspherical?: boolean
Returns this
Inherited from Omit.near
- Defined in node_modules/mongoose/types/aggregate.d.ts:121

option

option(value: AggregateOptions): this
Lets you set arbitrary options, for middlewares or plugins.
Parameters
- value: AggregateOptions
Returns this
Inherited from Omit.option
- Defined in node_modules/mongoose/types/aggregate.d.ts:148

pipeline

pipeline(): PipelineStage[]
Returns the current pipeline

Returns PipelineStage[]
Inherited from Omit.pipeline
- Defined in node_modules/mongoose/types/aggregate.d.ts:124

project

project(arg: string | { [field: string]: any }): this
Appends a new $project operator to this aggregate pipeline.
Parameters
- arg: string | { [field: string]: any }
Returns this
Inherited from Omit.project
- Defined in node_modules/mongoose/types/aggregate.d.ts:127

read

read(pref: ReadPreferenceLike): this
Sets the readPreference option for the aggregation query.
Parameters
- pref: ReadPreferenceLike
Returns this
Inherited from Omit.read
- Defined in node_modules/mongoose/types/aggregate.d.ts:130

readConcern

readConcern(level: string): this
Sets the readConcern level for the aggregation query.
Parameters
- level: string
Returns this
Inherited from Omit.readConcern
- Defined in node_modules/mongoose/types/aggregate.d.ts:133

redact

redact(
    expression: any,
    thenExpr: AnyObject | "$$DESCEND" | "$$PRUNE" | "$$KEEP",
    elseExpr: AnyObject | "$$DESCEND" | "$$PRUNE" | "$$KEEP",
): this
Appends a new $redact operator to this aggregate pipeline.
Parameters
- expression: any
- thenExpr: AnyObject | "$$DESCEND" | "$$PRUNE" | "$$KEEP"
- elseExpr: AnyObject | "$$DESCEND" | "$$PRUNE" | "$$KEEP"
Returns this
Inherited from Omit.redact
- Defined in node_modules/mongoose/types/aggregate.d.ts:136

replaceRoot

replaceRoot(newRoot: any): this
Appends a new $replaceRoot operator to this aggregate pipeline.
Parameters
- newRoot: any
Returns this
Inherited from Omit.replaceRoot
- Defined in node_modules/mongoose/types/aggregate.d.ts:139

sample

sample(arg: number): this
Appends new custom $sample operator to this aggregate pipeline.
Parameters
- arg: number
Returns this
Inherited from Omit.sample
- Defined in node_modules/mongoose/types/aggregate.d.ts:151

search

search(
    options: {
        highlight?: {
            maxCharsToExamine?: number;
            maxNumPassages?: number;
            path: string | string[] | { multi: string; value: string };
        };
        index?: string;
        [operator: string]: any;
    },
): this
Helper for Atlas Text Search's $search stage.
Parameters
- options: {
      highlight?: {
          maxCharsToExamine?: number;
          maxNumPassages?: number;
          path: string | string[] | { multi: string; value: string };
      };
      index?: string;
      [operator: string]: any;
  }
Returns this
Inherited from Omit.search
- Defined in node_modules/mongoose/types/aggregate.d.ts:145

session

session(session: ClientSession | null): this
Sets the session for this aggregation. Useful for transactions.
Parameters
- session: ClientSession | null
Returns this
Inherited from Omit.session
- Defined in node_modules/mongoose/types/aggregate.d.ts:154

skip

skip(num: number): this
Appends a new $skip operator to this aggregate pipeline.
Parameters
- num: number
  number of records to skip before next stage
Returns this
Inherited from Omit.skip
- Defined in node_modules/mongoose/types/aggregate.d.ts:160

sort

sort(
arg: string | Record<string, SortOrder> | Record<string, 1 | -1 | Meta>,
): this
Appends a new $sort operator to this aggregate pipeline.
Parameters
- arg: string | Record<string, SortOrder> | Record<string, 1 | -1 | Meta>
Returns this
Inherited from Omit.sort
- Defined in node_modules/mongoose/types/aggregate.d.ts:163

sortByCount

sortByCount(arg: any): this
Appends a new $sortByCount operator to this aggregate pipeline. Accepts either a string field name or a pipeline object.
Parameters
- arg: any
Returns this
Inherited from Omit.sortByCount
- Defined in node_modules/mongoose/types/aggregate.d.ts:172

unionWith

unionWith(
    options:
        | string
        | {
            coll: string;
            pipeline?: (
                | AddFields
                | Bucket
                | BucketAuto
                | CollStats
                | Count
                | Densify
                | Documents
                | Facet
                | Fill
                | GeoNear
                | GraphLookup
                | Group
                | IndexStats
                | Limit
                | ListSessions
                | Lookup
                | Match
                | PlanCacheStats
                | Project
                | Redact
                | ReplaceRoot
                | ReplaceWith
                | Sample
                | Search
                | SearchMeta
                | Set
                | SetWindowFields
                | Skip
                | Sort
                | SortByCount
                | UnionWith
                | Unset
                | Unwind
                | VectorSearch
            )[];
        }
        | {
            coll?: string;
            pipeline: (
                | AddFields
                | Bucket
                | BucketAuto
                | CollStats
                | Count
                | Densify
                | Documents
                | Facet
                | Fill
                | GeoNear
                | GraphLookup
                | Group
                | IndexStats
                | Limit
                | ListSessions
                | Lookup
                | Match
                | PlanCacheStats
                | Project
                | Redact
                | ReplaceRoot
                | ReplaceWith
                | Sample
                | Search
                | SearchMeta
                | Set
                | SetWindowFields
                | Skip
                | Sort
                | SortByCount
                | UnionWith
                | Unset
                | Unwind
                | VectorSearch
            )[];
        },
): this
Appends new $unionWith operator to this aggregate pipeline.
Parameters
- options:
      | string
      | {
          coll: string;
          pipeline?: (
              | AddFields
              | Bucket
              | BucketAuto
              | CollStats
              | Count
              | Densify
              | Documents
              | Facet
              | Fill
              | GeoNear
              | GraphLookup
              | Group
              | IndexStats
              | Limit
              | ListSessions
              | Lookup
              | Match
              | PlanCacheStats
              | Project
              | Redact
              | ReplaceRoot
              | ReplaceWith
              | Sample
              | Search
              | SearchMeta
              | Set
              | SetWindowFields
              | Skip
              | Sort
              | SortByCount
              | UnionWith
              | Unset
              | Unwind
              | VectorSearch
          )[];
      }
      | {
          coll?: string;
          pipeline: (
              | AddFields
              | Bucket
              | BucketAuto
              | CollStats
              | Count
              | Densify
              | Documents
              | Facet
              | Fill
              | GeoNear
              | GraphLookup
              | Group
              | IndexStats
              | Limit
              | ListSessions
              | Lookup
              | Match
              | PlanCacheStats
              | Project
              | Redact
              | ReplaceRoot
              | ReplaceWith
              | Sample
              | Search
              | SearchMeta
              | Set
              | SetWindowFields
              | Skip
              | Sort
              | SortByCount
              | UnionWith
              | Unset
              | Unwind
              | VectorSearch
          )[];
      }
Returns this
Inherited from Omit.unionWith
- Defined in node_modules/mongoose/types/aggregate.d.ts:175

unwind

unwind(
    ...args: (
        | string
        | {
            includeArrayIndex?: string;
            path: string;
            preserveNullAndEmptyArrays?: boolean;
        }
    )[],
): this
Appends new custom $unwind operator(s) to this aggregate pipeline.
Parameters
- ...args: (
      | string
      | {
          includeArrayIndex?: string;
          path: string;
          preserveNullAndEmptyArrays?: boolean;
      }
  )[]
Returns this
Inherited from Omit.unwind
- Defined in node_modules/mongoose/types/aggregate.d.ts:178

Interface Aggregation<A>

Type Parameters

Hierarchy

Indexable

Index

Properties

Methods

Properties

[toStringTag]

catch

Type Declaration

Type Parameters

Parameters

Returns Promise<A[] | TResult>

finally

Type Declaration

Parameters

Returns Promise<A[]>

options

then

Type Declaration

Type Parameters

Parameters

Returns Promise<TResult1 | TResult2>

Methods

[asyncIterator]

Returns AsyncIterableIterator<A>

addCursorFlag

Parameters

Returns this

Deprecated

addFields

Parameters

Returns this

allowDiskUse

Parameters

Returns this

append

Parameters

Returns this

collation

Parameters

Returns this

count

Parameters

Returns this

countDocuments

Returns Promise<number>

cursor

Type Parameters

Parameters

Returns Cursor<DocType>

densify

Parameters

Returns this

exec

Parameters

Returns Promise<A[]>

explain

Parameters

Returns Promise<AnyObject>

Returns Promise<AnyObject>

facet

Parameters

Returns this

fill

Parameters

Returns this

graphLookup

Parameters

Returns this

group

Parameters

Returns this

hint

Parameters

Returns this

limit

Parameters

Returns this

`Optional`distanceMultiplier?: number

`Optional`includeLocs?: string

`Optional`key?: string

`Optional`maxDistance?: number

`Optional`minDistance?: number

`Optional`num?: number

`Optional`query?: AnyObject

`Optional`spherical?: boolean