Xavren Documentation

Basic configuration to get started with Xavren:

import dotenv from "xavren"

dotenv.config({
  env: "/path/to/.env",
  key: process.env.PROJECT_KEY,
  watch: true,
  write: false,
  onSync: (data) => {
    console.log("Sync data received:", data);
  },
  omit: ["PROJECT_KEY"]
})

Set up real-time monitoring for environment variable changes using the onSync callback:

import dotenv from "xavren"

dotenv.config({
  env: "/path/to/.env",
  key: process.env.PROJECT_KEY,
  updateCloud: true,
  sync: false,
  watch: true,
  onSync: (data) => {
    console.log("Environment file reloaded");
    console.log("All env variables:", data.list);
    console.log("Changed variables:", data.changes);
  },
  omit: ["PROJECT_KEY"]
});

onSync: ({ list, changes }) => {
  if (changes["DB_URL"]) {
    console.log("Database URL updated:", changes["DB_URL"]);
    reconnectDatabase(changes["DB_URL"]);
  }
}

Complete example for production environment with MongoDB reconnection on changes:

import mongoose from "mongoose";
import dotenv from "xavren";

let currentUri = process.env.MONGO_URI;

dotenv.config({
  env: ".env.production",
  key: process.env.PROJECT_KEY,
  watch: true,
  onSync: ({ list, changes }) => {
    if (changes["MONGO_URI"]) {
      connectDB(changes["MONGO_URI"]);
    }
    if (changes["API_KEY"]) {
      refreshAPIKey(changes["API_KEY"]);
    }
  },
  omit: ["PROJECT_KEY"]
});

async function connectDB(uri) {
  try {
    if (currentUri === uri && mongoose.connection.readyState === 1) {
      console.log("Already connected to MongoDB");
      return;
    }

    if (mongoose.connection.readyState !== 0) {
      await mongoose.disconnect();
      console.log("Disconnected from previous MongoDB connection");
    }

    await mongoose.connect(uri, { autoIndex: true });
    currentUri = uri;
    console.log("✅ MongoDB connected to new URI");
  } catch (err) {
    console.error("❌ MongoDB connection error:", err);
  }
}

connectDB(currentUri);