Class MongoCollection

Hierarchy

MongoCollection

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MongoCollection(mongo: MongoManager, collectionName: string, model?: Model): MongoCollection

- Defined in api/helpers/mongo-collection.ts:20
Parameters
- mongo: MongoManager
- collectionName: string
- Optional model: Model
Returns MongoCollection

Properties

Private collectionName

collectionName: string

Private Optional model

model: Model

Private mongo

mongo: MongoManager

Methods

aggregate

aggregate(pipeline: any[], options?: CollectionAggregationOptions): Promise<AggregationCursor>

- Defined in api/helpers/mongo-collection.ts:61
Parameters
- pipeline: any[]
- Optional options: CollectionAggregationOptions
Returns Promise<AggregationCursor>

countDocuments

countDocuments(filter?: any, options?: MongoCountPreferences): Promise<number>

- Defined in api/helpers/mongo-collection.ts:75
Parameters
- Optional filter: any
- Optional options: MongoCountPreferences
Returns Promise<number>

deleteMany

deleteMany(filter?: any, options?: CommonOptions): Promise<DeleteWriteOpResultObject>

- Defined in api/helpers/mongo-collection.ts:103
Parameters
- Optional filter: any
- Optional options: CommonOptions
Returns Promise<DeleteWriteOpResultObject>

deleteOne

deleteOne(filter?: any, options?: CommonOptions): Promise<DeleteWriteOpResultObject>

- Defined in api/helpers/mongo-collection.ts:96
Parameters
- Optional filter: any
- Optional options: CommonOptions
Returns Promise<DeleteWriteOpResultObject>

distinct

distinct(key: string, filter?: any, options?: undefined | object): Promise<any>

- Defined in api/helpers/mongo-collection.ts:68
Parameters
- key: string
- Optional filter: any
- Optional options: undefined | object
Returns Promise<any>

find

find(filter?: any, options?: FindOneOptions): Promise<Cursor>

- Defined in api/helpers/mongo-collection.ts:54
Parameters
- Optional filter: any
- Optional options: FindOneOptions
Returns Promise<Cursor>

findOne

findOne(filter?: any, options?: FindOneOptions): Promise<any>

- Defined in api/helpers/mongo-collection.ts:47
Parameters
- Optional filter: any
- Optional options: FindOneOptions
Returns Promise<any>

insertMany

insertMany(data: any[], options?: CollectionInsertManyOptions): Promise<InsertWriteOpResult>

- Defined in api/helpers/mongo-collection.ts:37
Parameters
- data: any[]
- Optional options: CollectionInsertManyOptions
Returns Promise<InsertWriteOpResult>

insertOne

insertOne(data: any, options?: CollectionInsertManyOptions): Promise<InsertOneWriteOpResult>

- Defined in api/helpers/mongo-collection.ts:27
Parameters
- data: any
- Optional options: CollectionInsertManyOptions
Returns Promise<InsertOneWriteOpResult>

updateMany

updateMany(filter?: any, update: any, options?: UpdateManyOptions): Promise<UpdateWriteOpResult>

- Defined in api/helpers/mongo-collection.ts:89
Parameters
- Default value filter: any = {}
- update: any
- Optional options: UpdateManyOptions
Returns Promise<UpdateWriteOpResult>

updateOne

updateOne(filter?: any, update: any, options?: UpdateManyOptions): Promise<UpdateWriteOpResult>

- Defined in api/helpers/mongo-collection.ts:82
Parameters
- Default value filter: any = {}
- update: any
- Optional options: UpdateManyOptions
Returns Promise<UpdateWriteOpResult>

Generated using TypeDoc