mongoose-connection-package
v1.0.2
Published
A simple npm package to connect to MongoDB using Mongoose
Downloads
187
Maintainers
Readme
Mongoose Connection Package
This package is a wrapper for the Mongoose connection object. It provides a simple interface for connecting to a MongoDB database and for managing the connection.
Installation
To install this package, run the following command in your terminal:
npm install mongoose-connection-package
Usage
To use this package, follow these steps:
- Import the package in your project:
const mongooseConnection = require("mongoose-connection-package");
- Create an instance of the
MongooseConnection
class:
const mongooseConnection = new MongooseConnection();
- Connect to the MongoDB database:
mongooseConnection.connect("mongodb://localhost:27017/mydatabase");
- Use the
mongooseConnection
object to perform Mongoose operations:
const mongoose = require("mongoose");
mongooseConnection.connect("mongodb://localhost:27017/mydatabase", (err) => {
if (err) {
console.error("Error connecting to MongoDB:", err);
return;
}
const User = mongoose.model("User", {
name: String,
email: String,
});
const user = new User({ name: "John Doe", email: "[email protected]" });
user.save((err, user) => {
if (err) {
console.error("Error saving user:", err);
return;
}
console.log("User saved:", user);
});
});
Methods
connect(url, callback)
Connects to the MongoDB database using the specified URL.
Parameters
url
(string): The URL of the MongoDB database.callback
(function): A callback function that is called with an error object if there is an error connecting to the database, ornull
if the connection is successful.
Example
mongooseConnection.connect("mongodb://localhost:27017/mydatabase", (err) => {
if (err) {
console.error("Error connecting to MongoDB:", err);
return;
}
console.log("Connected to MongoDB");
});
disconnect()
Disconnects from the MongoDB database.
Example
mongooseConnection.disconnect();
getConnection()
Returns the Mongoose connection object.
Returns
The Mongoose connection object.
Example
const mongooseConnection = new MongooseConnection();
mongooseConnection.connect("mongodb://localhost:27017/mydatabase", (err) => {
if (err) {
console.error("Error connecting to MongoDB:", err);
return;
}
const mongooseConnection = mongooseConnection.getConnection();
console.log("Mongoose connection:", mongooseConnection);
});
getDb()
Returns the MongoDB database object.
Returns
The MongoDB database object.
Example
const mongooseConnection = new MongooseConnection();
mongooseConnection.connect("mongodb://localhost:27017/mydatabase", (err) => {
if (err) {
console.error("Error connecting to MongoDB:", err);
return;
}
const db = mongooseConnection.getDb();
console.log("MongoDB database:", db);
});
getMongoose()
Returns the Mongoose object.
Returns
The Mongoose object.
Example
const mongooseConnection = new MongooseConnection();
mongooseConnection.connect("mongodb://localhost:27017/mydatabase", (err) => {
if (err) {
console.error("Error connecting to MongoDB:", err);
return;
}
const mongoose = mongooseConnection.getMongoose();
console.log("Mongoose:", mongoose);
});
License
This package is licensed under the MIT License. See the LICENSE file for more information.