mongo-portable
Version:
Portable Pure JS MongoDB - Based on Monglodb (https://github.com/euforic/monglodb.git) by Christian Sullivan (http://RogueSynaptics.com)
105 lines (57 loc) • 1.99 kB
Markdown
[Mongo Portable](../README.md) > [Aggregation](../classes/aggregation.md)
# Class: Aggregation
## Hierarchy
**Aggregation**
## Index
### Constructors
* [constructor](aggregation.md#constructor)
### Properties
* [logger](aggregation.md#logger)
* [pipeline](aggregation.md#pipeline)
### Methods
* [aggregate](aggregation.md#aggregate)
* [validStage](aggregation.md#validstage)
---
## Constructors
<a id="constructor"></a>
### constructor
⊕ **new Aggregation**(pipeline: *`any`*): [Aggregation](aggregation.md)
*Defined in [aggregation/Aggregation.ts:199](https://github.com/EastolfiWebDev/MongoPortable/blob/d5d3826/src/aggregation/Aggregation.ts#L199)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| pipeline | `any` |
**Returns:** [Aggregation](aggregation.md)
___
## Properties
<a id="logger"></a>
### `<Protected>` logger
**● logger**: *`JSWLogger`*
*Defined in [aggregation/Aggregation.ts:199](https://github.com/EastolfiWebDev/MongoPortable/blob/d5d3826/src/aggregation/Aggregation.ts#L199)*
___
<a id="pipeline"></a>
### pipeline
**● pipeline**: *`any`*
*Defined in [aggregation/Aggregation.ts:197](https://github.com/EastolfiWebDev/MongoPortable/blob/d5d3826/src/aggregation/Aggregation.ts#L197)*
___
## Methods
<a id="aggregate"></a>
### aggregate
▸ **aggregate**(collection: *`any`*): `any`
*Defined in [aggregation/Aggregation.ts:207](https://github.com/EastolfiWebDev/MongoPortable/blob/d5d3826/src/aggregation/Aggregation.ts#L207)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| collection | `any` |
**Returns:** `any`
___
<a id="validstage"></a>
### validStage
▸ **validStage**(stage: *`any`*): `string` | `true` | `false`
*Defined in [aggregation/Aggregation.ts:236](https://github.com/EastolfiWebDev/MongoPortable/blob/d5d3826/src/aggregation/Aggregation.ts#L236)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| stage | `any` |
**Returns:** `string` | `true` | `false`
___