Interface MongoDbWrapperInterface

Hierarchy

MongoDbWrapperInterface

Implemented by

MongoDbWrapper

Index

Methods

connect count deleteMany deleteOne disconnect find findOne findOneAndDelete findOneAndUpdate getClient getCollection getDb insertMany insertOne updateMany updateOne

Methods

connect

connect(url: string, options?: MongoClientOptions): Promise<void>
Connects to a MongoDB server.
Parameters
- url: string
  
  The connection string for the MongoDB server.
- Optional options: MongoClientOptions
  
  Optional settings for the MongoDB driver.
Returns Promise<void>
- Defined in src/mongo-wrapper.ts:21

count

count<T>(collectionName: string, query: Partial<T>): Promise<number>
Returns the count of documents in a MongoDB collection that match the specified query.

Returns
A promise that resolves to the number of documents matching the query.
Type Parameters
- T extends {
  _id: any;
  }
Parameters
- collectionName: string
  
  The name of the collection to count.
- query: Partial<T>
  
  The query to search for.
Returns Promise<number>
- Defined in src/mongo-wrapper.ts:145

deleteMany

deleteMany<T>(collectionName: string, query: Partial<T>): Promise<number>
Deletes multiple documents from a MongoDB collection that match the specified query.

Returns
A promise that resolves to the number of documents deleted.
Type Parameters
- T extends {
  _id: any;
  }
Parameters
- collectionName: string
  
  The name of the collection to delete from.
- query: Partial<T>
  
  The query to search for.
Returns Promise<number>
- Defined in src/mongo-wrapper.ts:134

deleteOne

deleteOne<T>(collectionName: string, query: Partial<T>): Promise<number>
Deletes a single document from a MongoDB collection that matches the specified query.

Returns
A promise that resolves to the number of documents deleted.
Type Parameters
- T extends {
  _id: any;
  }
Parameters
- collectionName: string
  
  The name of the collection to delete from.
- query: Partial<T>
  
  The query to search for.
Returns Promise<number>
- Defined in src/mongo-wrapper.ts:109

disconnect

disconnect(): Promise<void>
Disconnects from the MongoDB server.

Returns Promise<void>
- Defined in src/mongo-wrapper.ts:26

find

find<T>(collectionName: string, query: Partial<T>): Promise<T[]>
Returns an array of documents from a MongoDB collection that match the specified query.

Returns
A promise that resolves to an array of matching documents.
Type Parameters
- T extends {
  _id: any;
  }
Parameters
- collectionName: string
  
  The name of the collection to search.
- query: Partial<T>
  
  The query to search for.
Returns Promise<T[]>
- Defined in src/mongo-wrapper.ts:156

findOne

findOne<T>(collectionName: string, query: Partial<T>): Promise<null | T>
Finds a single document in a MongoDB collection that matches the specified query.

Returns
A promise that resolves to the matching document, or null if no document is found.
Type Parameters
- T extends {
  _id: any;
  }
Parameters
- collectionName: string
  
  The name of the collection to search.
- query: Partial<T>
  
  The query to search for.
Returns Promise<null | T>
- Defined in src/mongo-wrapper.ts:83

findOneAndDelete

findOneAndDelete<T>(collectionName: string, query: Partial<T>): Promise<null | T>
Finds a single document from a MongoDB collection that matches the specified query and deletes it.

Returns
A promise that resolves to the deleted document or null if no document was found.
Type Parameters
- T extends {
  _id: any;
  }
Parameters
- collectionName: string
  
  The name of the collection to delete from.
- query: Partial<T>
  
  The query to search for.
Returns Promise<null | T>
- Defined in src/mongo-wrapper.ts:182

findOneAndUpdate

findOneAndUpdate<T>(collectionName: string, query: Partial<T>, update: Partial<any>, options?: {
returnOriginal?: boolean;
}): Promise<null | T>
Finds a single document from a MongoDB collection that matches the specified query and updates it.

Returns
A promise that resolves to the updated document or null if no document was found.
Type Parameters
- T extends {
  _id: any;
  }
Parameters
- collectionName: string
  
  The name of the collection to update.
- query: Partial<T>
  
  The query to search for.
- update: Partial<any>
  
  The update operation to apply.
- Optional options: {
  returnOriginal?: boolean;
  }
  
  Optional settings for the update operation.
  - Optional returnOriginal?: boolean
Returns Promise<null | T>
- Defined in src/mongo-wrapper.ts:169

getClient

getClient(): MongoClient
Returns the MongoDB MongoClient instance.

Throws
Will throw an error if the client is not connected.

Returns
The MongoDB MongoClient instance.

Returns MongoClient
- Defined in src/mongo-wrapper.ts:50

getCollection

getCollection<T>(name: string): Collection<T>
Returns the specified MongoDB collection.

Returns
The MongoDB Collection instance.
Type Parameters
- T extends Document<T>
Parameters
- name: string
  
  The name of the collection to retrieve.
Returns Collection<T>
- Defined in src/mongo-wrapper.ts:42

getDb

getDb(): Db
Returns the MongoDB Db instance.

Throws
Will throw an error if the database is not connected.

Returns
The MongoDB Db instance.

Returns Db
- Defined in src/mongo-wrapper.ts:34

insertMany

insertMany<T>(collectionName: string, documents: OptionalId<T>[]): Promise<InsertManyResult<T>>
Inserts multiple documents into a MongoDB collection.

Returns
A promise that resolves to the InsertManyResult.
Type Parameters
- T extends {
  _id: any;
  }
Parameters
- collectionName: string
  
  The name of the collection to insert the documents into.
- documents: OptionalId<T>[]
  
  An array of documents to insert.
Returns Promise<InsertManyResult<T>>
- Defined in src/mongo-wrapper.ts:71

insertOne

insertOne<T>(collectionName: string, document: OptionalUnlessRequiredId<T>): Promise<InsertOneResult<T>>
Inserts a single document into a MongoDB collection.

Returns
A promise that resolves to the InsertOneResult.
Type Parameters
- T extends {
  _id: any;
  }
Parameters
- collectionName: string
  
  The name of the collection to insert the document into.
- document: OptionalUnlessRequiredId<T>
  
  The document to insert.
Returns Promise<InsertOneResult<T>>
- Defined in src/mongo-wrapper.ts:59

updateMany

updateMany<T>(collectionName: string, query: Partial<T>, update: Partial<any>): Promise<number>
Updates multiple documents in a MongoDB collection that match the specified query.

Returns
A promise that resolves to the number of documents updated.
Type Parameters
- T extends {
  _id: any;
  }
Parameters
- collectionName: string
  
  The name of the collection to update.
- query: Partial<T>
  
  The query to search for.
- update: Partial<any>
  
  The update operation to apply.
Returns Promise<number>
- Defined in src/mongo-wrapper.ts:122

updateOne

updateOne<T>(collectionName: string, query: Partial<T>, update: Partial<any>): Promise<number>
Updates a single document in a MongoDB collection that matches the specified query.

Returns
A promise that resolves to the number of documents updated.
Type Parameters
- T extends {
  _id: any;
  }
Parameters
- collectionName: string
  
  The name of the collection to update.
- query: Partial<T>
  
  The query to search for.
- update: Partial<any>
  
  The update to apply.
Returns Promise<number>
- Defined in src/mongo-wrapper.ts:96

Interface MongoDbWrapperInterface

Hierarchy

Implemented by

Index

Methods

Methods

connect

Parameters

url: string

Optional options: MongoClientOptions

Returns Promise<void>

count

Returns

Type Parameters

T extends { _id: any; }

Parameters

collectionName: string

query: Partial<T>

Returns Promise<number>

deleteMany

Returns

Type Parameters

T extends { _id: any; }

Parameters

collectionName: string

query: Partial<T>

Returns Promise<number>

deleteOne

Returns

Type Parameters

T extends { _id: any; }

Parameters

collectionName: string

query: Partial<T>

Returns Promise<number>

disconnect

Returns Promise<void>

find

Returns

Type Parameters

T extends { _id: any; }

Parameters

collectionName: string

query: Partial<T>

Returns Promise<T[]>

findOne

Returns

Type Parameters

T extends { _id: any; }

Parameters

collectionName: string

query: Partial<T>

Returns Promise<null | T>

findOneAndDelete

Returns

Type Parameters

T extends { _id: any; }

Parameters

collectionName: string

query: Partial<T>

Returns Promise<null | T>

findOneAndUpdate

Returns

Type Parameters

T extends { _id: any; }

Parameters

collectionName: string

query: Partial<T>

update: Partial<any>

Optional options: { returnOriginal?: boolean; }

Optional returnOriginal?: boolean

Returns Promise<null | T>

getClient

Throws

Returns

Returns MongoClient

getCollection

Returns

Type Parameters

T extends Document<T>

`Optional` options: MongoClientOptions

T extends {
_id: any;
}

T extends {
_id: any;
}

T extends {
_id: any;
}

T extends {
_id: any;
}

T extends {
_id: any;
}

T extends {
_id: any;
}

T extends {
_id: any;
}

`Optional` options: {
returnOriginal?: boolean;
}

`Optional` returnOriginal?: boolean

T extends {
_id: any;
}

T extends {
_id: any;
}

T extends {
_id: any;
}

T extends {
_id: any;
}