Bigify - Simplified MongoDB Connection for Node.js

🚀 Introduction

Bigify is a lightweight, easy-to-use package that helps developers quickly establish a MongoDB connection in their Node.js applications. With just a single function call, you can set up a secure and optimized connection to your MongoDB database.

📦 Installation

Install Bigify via npm:

npm install bigify

Since mongoose is a peer dependency, you must install it separately if you haven’t already:

npm install mongoose

🔧 Usage

Basic Example

const mongoose = require('mongoose');
const { connectDB } = require('bigify');

connectDB( mongoose, 'mongodb://localhost:27017/mydatabase', {} );

Advanced Usage with Options

const mongoose = require('mongoose');
const { connectDB } = require('bigify');

connectDB(
    mongoose,
    'mongodb://localhost:27017/mydatabase',
    options: {
        serverSelectionTimeoutMS: 5000, // Custom timeout
    }
);

🌟 Features

• 🔥 Zero Configuration – No extra setup required.
• ⚡ Auto-Handles Connection Errors – Prevents app crashes due to database connection failures.
• 🛠️ Custom Configuration Support – Allows passing additional MongoDB connection options.
• 📜 Minimalistic & Efficient – Lightweight package with no unnecessary dependencies.

🛠️ API Reference

connectDB({ mongoose, database, options })

• mongoose (required): Your installed mongoose instance.
• database (string, required): MongoDB connection string.
• options (object, optional): Additional MongoDB connection options. (NOTE : This is a Optional Parameter)

Example:

connectDB(
    mongoose,
    'mongodb://localhost:27017/mydatabase',
    options: { // Allows users to pass extra Mongoose options if needed.
        serverSelectionTimeoutMS: 5000,
        useNewUrlParser: true,
        useUnifiedTopology: true,
        useCreateIndex: true,
        useFindAndModify: false,
    }
);

❓ FAQ

1. Why do I need to install mongoose separately?

Bigify does not include mongoose to give you flexibility in choosing your version. If you haven’t installed it yet, run:

npm install mongoose

2. Can I pass custom connection options?

Yes! Simply provide an options object when calling connectDB.

3. Does this package support MongoDB Atlas?

Absolutely! Just pass the MongoDB Atlas connection string as the database parameter.