README

1. BlankDatabaseObject

BlankDatabaseObject is just a blank object literal and a ptr pointing to that literal. By using this package, you are attempting to include "database" in the namespace of your entire application, where database is simply a blank object initially. Your application can then use "database" everywhere even in services files, as long as you import this package in the index.js file of your node application just once like shown below (providing index.js is the first file your app runs)

1.1. Installation

Using npm

npm install @toorieaa/databaseobject

1.2. Usage

import "@toorieaa/databaseobject";

1.3. Optional

See https://www.npmjs.com/package/@toorieaa/retry-promise-mechanism

Used with https://www.npmjs.com/package/@toorieaa/retry-promise-mechanism, but is optional.

Optional combined usage

import "@toorieaa/databaseobject";
import * as RetryMechanism from "@toorieaa/retry-promise-mechanism";
import MongoDb from "mongodb";

const mongoConfig = {
  poolSize: 25,
  // retry to connect for 30 times
  reconnectTries: 30,
  // wait 1 second before retrying
  reconnectInterval: 1000,
};

function* setupDatabasePoolGenerator() {
  const connectToDatabase = async () =>
    MongoDb.connect(
      StringGeneratorDatabaseConnectionConfig.CONN(),
      mongoConfig
    );

  yield "create connect to mongo database async function";
  const setDatabasePool = (result) => {
    database.connection = result;
  };
  yield "set up database pool callback";

  RetryMechanism.default(connectToDatabase, setDatabasePool);
}

const setupAppDatabasePool = setupDatabasePoolGenerator();

for (let poolSetupStep of setupAppDatabasePool) {
  console.log("setup database pool step", poolSetupStep);
}

Your services will also have access to database object. Reference it directly like so

database.connection;

You only need to import "@toorieaa/databaseobject"; once in the index.js file. It will automatically populate your namespace with a database object. Your callback should use this reference because the mongo connect method will return the database pool object required for your services to function properly when it is successful. So will the RetryMechanism.default(...args) ... it will piggyback the successful result of the promise after a certain number of retries. So, in your callback method, you have access to the potential result of the promise, provided the conditions are met described in the documentation for RetryMechanism.default. And since the database object is a global object, it is included in your entire application's namespace, providing you have imported it in your index.js since this file will be executed first.

1.4. Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

1.5. License

[MIT]

Usage no npm install needed!