mongo-driverify 1.0.0 | Documentation

mongo-driverify

1.0.0

makeConnection
MongoDBManager ▸
- Static members
- .INSTANCE
- .configure
- .configure
- .getInstance
- Instance members
- #insertDoc
- #insertDocProm
- #getAllDocuments
- #getDocumentsBy
- #getDocumentsByProm
- #getDocumentsParamProm
- #getDistinctDocumentsProm
- #getAggregate
- #getMax
- #updateOneDoc
- #updateOneDocProm
- #deleteDocument
- #deleteOneDocProm
client
db

Need help reading this?

makeConnection

Creates connection with mongodb, if fails, throws error

makeConnection

Parameters

onConnection (any)

onConnectionFail (any)

Returns

Promise<MongoClient>: MongoClient Promise

MongoDBManager

Static Members

▸ INSTANCE

INSTANCE

Type: MongoDBManager

▸ configure(attr)

configure(attr: any)

Parameters

attr

(any
            = {})

▸ configure(attr)

Configures mongoclient.

configure(attr: MongoDBManagerConfiguration)

Parameters

attr

(MongoDBManagerConfiguration
            = {})

Attrubites for configuration

▸ getInstance()

Returns MongoDBManager instance.

getInstance(): MongoDBManager

Returns

MongoDBManager:

Instance Members

▸ insertDoc(doc, collectionName, onDocInsertSuccess, onDocInsertFail)

Inserts single document in given collection.

insertDoc(doc: any, collectionName: string, onDocInsertSuccess: Function, onDocInsertFail: Function)

Parameters

doc (any) Any type of object to store

collectionName (string) name of collection

onDocInsertSuccess (Function) Callback for success

onDocInsertFail (Function) Callback for fail

▸ insertDocProm(doc, collectionName, dbObj)

Inserts single document in given collection.

insertDocProm(doc: any, collectionName: string, dbObj: Db)

Parameters

doc (any) Any type of object to store

collectionName (string) name of collection

dbObj (Db) Database connection object

▸ getAllDocuments(collectionName, successCb, failCb)

Fetches all documents in given collection

getAllDocuments(collectionName: string, successCb: Function, failCb: Function)

Parameters

collectionName (string) name of collection

successCb (Function) Callback for success

failCb (Function) Callback for fail

▸ getDocumentsBy(collectionName, query, successCb, failCb)

Fetches all documents in given collection

getDocumentsBy(collectionName: string, query: Object, successCb: Function, failCb: Function)

Parameters

collectionName (string) name of collection

query (Object) any type of mongodb query

successCb (Function) Callback for success

failCb (Function) Callback for fail

▸ getDocumentsByProm(collectionName, query, dbObj)

Fetches all documents in given collection

getDocumentsByProm(collectionName: string, query: Object, dbObj: Db): Promise<Array<any>>

Parameters

collectionName (string) name of collection

query (Object) any type of mongodb query

dbObj (Db) Database connection object

Returns

Promise<Array<any>>: Return all documents in array form

▸ getDocumentsParamProm(collectionName, params, dbObj)

Fetches all documents in given collection

getDocumentsParamProm(collectionName: string, params: Object, dbObj: Db): Promise<Array<any>>

Parameters

collectionName (string) name of collection

params (Object) any type of mongodb query

dbObj (Db) Database connection object

Returns

Promise<Array<any>>: Return all documents in array form

▸ getDistinctDocumentsProm(collectionName, params, dbObj)

Fetches all documents in given collection

getDistinctDocumentsProm(collectionName: string, params: Object, dbObj: Db): Promise<Array<any>>

Parameters

collectionName (string) name of collection

params (Object) any type of mongodb query

dbObj (Db) Database connection object

Returns

Promise<Array<any>>: Return all documents in array form

▸ getAggregate(collectionName, aggquery, dbObj)

Get aggregation result in promise.

getAggregate(collectionName: string, aggquery: Array<object>, dbObj: Db): Promise<Array<any>>

Parameters

collectionName (string) name of collection

aggquery (Array<object>) Aggregate query

dbObj (Db) Database connection object

Returns

Promise<Array<any>>: Return all documents in array form

▸ getMax(collectionName, fieldName, idField, dbObj, aggquery)

Get max of given field from collection.

getMax(collectionName: string, fieldName: any, idField: any, dbObj: Db, aggquery: Array<object>): Promise<number>

Parameters

collectionName (string) name of collection

fieldName (any)

idField (any)

dbObj (Db) Database connection object

aggquery (Array<object>) Aggregate query

Returns

Promise<number>: Return maximum number 1 if no documents are matched/available

▸ updateOneDoc(collectionName, query, newVal, onSuccess, onFail)

Updates one document from collection.

updateOneDoc(collectionName: string, query: any, newVal: any, onSuccess: Function, onFail: Function)

Parameters

collectionName (string) name of collection

query (any) Object containing query checks

newVal (any) Object containing new updated values

onSuccess (Function) Callback for success

onFail (Function) Callback for fail

▸ updateOneDocProm(collectionName, query, newVal, dbObj)

Updates one document from collection.

updateOneDocProm(collectionName: string, query: any, newVal: any, dbObj: Db): Promise<CommandResult>

Parameters

collectionName (string) name of collection

query (any) Object containing query checks

newVal (any) Object containing new updated values

dbObj (Db) Database connection object

Returns

Promise<CommandResult>: Command result promise

▸ deleteDocument(collectionName, query, params, dbObj)

Updates one document from collection.

deleteDocument(collectionName: string, query: any, params: any, dbObj: Db): Promise<CommandResult>

Parameters

collectionName (string) name of collection

query (any) Object containing query checks

params (any) Object delete options

dbObj (Db) Database connection object

Returns

Promise<CommandResult>: Command result promise

▸ deleteOneDocProm(collectionName, query, params, dbObj)

Updates one document from collection.

deleteOneDocProm(collectionName: string, query: Object, params: Object, dbObj: Db): Promise<DeleteWriteOpResultObject>

Parameters

collectionName (string) name of collection

query (Object) Object containing query checks

params (Object) Object delete options

dbObj (Db) Database connection object

Returns

Promise<DeleteWriteOpResultObject>: Command result promise

client

Type: MongoClient