declare module 'mongoose' {
import mongodb = require('mongodb');
/** Extract generic type from Aggregate class */
type AggregateExtract
= P extends Aggregate ? T : never;
interface AggregateOptions extends Omit, SessionOption {
[key: string]: any;
}
class Aggregate implements SessionOperation {
/**
* Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js)
* You do not need to call this function explicitly, the JavaScript runtime
* will call it for you.
*/
[Symbol.asyncIterator](): AsyncIterableIterator>;
// Returns a string representation of this aggregation.
[Symbol.toStringTag]: string;
options: AggregateOptions;
/**
* Sets an option on this aggregation. This function will be deprecated in a
* future release.
*
* @deprecated
*/
addCursorFlag(flag: CursorFlag, value: boolean): this;
/**
* Appends a new $addFields operator to this aggregate pipeline.
* Requires MongoDB v3.4+ to work
*/
addFields(arg: PipelineStage.AddFields['$addFields']): this;
/** Sets the allowDiskUse option for the aggregation query */
allowDiskUse(value: boolean): this;
/** Appends new operators to this aggregate pipeline */
append(...args: PipelineStage[]): this;
/**
* Executes the query returning a `Promise` which will be
* resolved with either the doc(s) or rejected with the error.
* Like [`.then()`](#query_Query-then), but only takes a rejection handler.
*/
catch: Promise['catch'];
/** Set the collation. */
collation(options: mongodb.CollationOptions): this;
/** Appends a new $count operator to this aggregate pipeline. */
count(fieldName: PipelineStage.Count['$count']): this;
/** Appends a new $densify operator to this aggregate pipeline */
densify(arg: PipelineStage.Densify['$densify']): this;
/**
* Sets the cursor option for the aggregation query
*/
cursor(options?: Record): Cursor;
/** Executes the aggregate pipeline on the currently bound Model. */
exec(): Promise;
/** Execute the aggregation with explain */
explain(verbosity: mongodb.ExplainVerbosityLike): Promise;
explain(): Promise;
/** Combines multiple aggregation pipelines. */
facet(options: PipelineStage.Facet['$facet']): this;
/** Appends a new $fill operator to this aggregate pipeline */
fill(arg: PipelineStage.Fill['$fill']): this;
/**
* Executes the aggregation returning a `Promise` which will be
* resolved with `.finally()` chained.
*/
finally: Promise['finally'];
/** Appends new custom $graphLookup operator(s) to this aggregate pipeline, performing a recursive search on a collection. */
graphLookup(options: PipelineStage.GraphLookup['$graphLookup']): this;
/** Appends new custom $group operator to this aggregate pipeline. */
group(arg: PipelineStage.Group['$group']): this;
/** Sets the hint option for the aggregation query */
hint(value: Record | string): this;
/**
* Appends a new $limit operator to this aggregate pipeline.
* @param num maximum number of records to pass to the next stage
*/
limit(num: PipelineStage.Limit['$limit']): this;
/** Appends new custom $lookup operator to this aggregate pipeline. */
lookup(options: PipelineStage.Lookup['$lookup']): this;
/**
* Appends a new custom $match operator to this aggregate pipeline.
* @param arg $match operator contents
*/
match(arg: PipelineStage.Match['$match']): this;
/**
* Binds this aggregate to a model.
* @param model the model to which the aggregate is to be bound
*/
model(model: Model): this;
/**
* Returns the current model bound to this aggregate object
*/
model(): Model;
/** Appends a new $geoNear operator to this aggregate pipeline. */
near(arg: PipelineStage.GeoNear['$geoNear']): this;
/** Returns the current pipeline */
pipeline(): PipelineStage[];
/** Appends a new $project operator to this aggregate pipeline. */
project(arg: PipelineStage.Project['$project']): this;
/** Sets the readPreference option for the aggregation query. */
read(pref: mongodb.ReadPreferenceLike): this;
/** Sets the readConcern level for the aggregation query. */
readConcern(level: string): this;
/** Appends a new $redact operator to this aggregate pipeline. */
redact(expression: PipelineStage.Redact['$redact'], thenExpr: '$$DESCEND' | '$$PRUNE' | '$$KEEP' | AnyObject, elseExpr: '$$DESCEND' | '$$PRUNE' | '$$KEEP' | AnyObject): this;
/** Appends a new $replaceRoot operator to this aggregate pipeline. */
replaceRoot(newRoot: PipelineStage.ReplaceRoot['$replaceRoot']['newRoot'] | string): this;
/**
* Helper for [Atlas Text Search](https://www.mongodb.com/docs/atlas/atlas-search/tutorial/)'s
* `$search` stage.
*/
search(options: PipelineStage.Search['$search']): this;
/** Lets you set arbitrary options, for middlewares or plugins. */
option(value: AggregateOptions): this;
/** Appends new custom $sample operator to this aggregate pipeline. */
sample(arg: PipelineStage.Sample['$sample']['size']): this;
/** Sets the session for this aggregation. Useful for [transactions](/docs/transactions.html). */
session(session: mongodb.ClientSession | null): this;
/**
* Appends a new $skip operator to this aggregate pipeline.
* @param num number of records to skip before next stage
*/
skip(num: PipelineStage.Skip['$skip']): this;
/** Appends a new $sort operator to this aggregate pipeline. */
sort(arg: string | Record | PipelineStage.Sort['$sort']): this;
/** Provides promise for aggregate. */
then: Promise['then'];
/**
* Appends a new $sortByCount operator to this aggregate pipeline. Accepts either a string field name
* or a pipeline object.
*/
sortByCount(arg: string | PipelineStage.SortByCount['$sortByCount']): this;
/** Appends new $unionWith operator to this aggregate pipeline. */
unionWith(options: PipelineStage.UnionWith['$unionWith']): this;
/** Appends new custom $unwind operator(s) to this aggregate pipeline. */
unwind(...args: PipelineStage.Unwind['$unwind'][]): this;
}
}