mongoose-integration

This package is intented to be a help when using Mongoose module to store data from a frontend app into a MongoDB server.

Installation

npm i @lexa79/mongoose-integration

API

import Mongoose from "@lexa79/mongoose-integration";

setOptions( optionsBag )

Use this function to set some basic options before establishing a connection.

• Parameter optionsBag (optional):
  • host (optional): Hostname or IP-address of the running MongoDB server; defaults to "localhost".
  • port (optional): Port of the running MongoDB server; defaults to 27017.
  • username + password (optional): Login credential for the running MongoDB server; is empty by default.
  • databaseName (optional): Name of the database on the MongoDB server which you want to access; is empty by default and has to be given to connect(), then.

const connectionOptions = {
	host: "192.168.100.1",
	username: "testUser",
	password: "secretTestUserPassword",
	databaseName: "testDatabase",
};
Mongoose.setOptions( connectionOptions );

connect( databaseName, optionsBag )

When called for the first time, this function initiates a connection to the MongoDB server. You get the related Mongoose instance as a result. It's typical that the connection might not be established, yet - you can still start working with the data. Mongoose is buffering all requests.

If you call the connect() function again, the already established connection will be used to return the same Mongoose instance as before.

• Parameter databaseName (needed/optional): Name of the database on the MongoDB server which you want to access. This parameter is only needed if you call the function for the first time and haven't set a database-name with setOptions(), before.
• Parameter optionsBag (optional): More settings regarding the connection to the MongoDB server.
  • optionsBag.errorCallback: Give a function here which shall be called in case an error occures inside Mongoose. The error object will be given as argument to that function.
  • optionsBag.returnPending: Normally connect() might resolve while Mongoose is still connecting to the database. That's no problem because Mongoose buffers any request of your app. Still, you can set this option to false and connect() will not resolve before the connection to the MongoDB server was successfully established.

const mongoose = Mongoose.connect();

getError() and popError()

Determines if an error has occured inside Mongoose. With popError() the returned error will be taken out of the stored database state.

const error = Mongoose.getError();