4.0.15 • Published 2 years ago

@kth/mongo v4.0.15

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

@kth/mongo

Database connection wrapping Mongoose (for MongoDB)

This module connects to mongoDB using Mongoose default connection.

To use this module

Connect to database

  1. Import module
    const nodeMongo =require(@kth/mongo')

  2. Connect to mongoDB : nodeMongo.connect(options)

  3. Use Mongoose schema and model to interact with mongoDB

Function connect() returns a promise to be resolved upon completed connection or rejected on error.

Options

  • dbUsername (required) Credentials, the database user

  • dbPassword (required) Credentials, the password for the database user

  • dbUri (required) The URI for the mongoDb to connect to

  • logger (optional) A logger to use, defaults to stdout(console.log)

SSL(TLS) Options

  • ssl (optional) Boolean flag if database connection shoold be encrypted or not

Example without secure database connction

nodeMongo
  .connect({
    dbUsername: 'user',
    dbPassword: 'himligt',
    dbUri: 'mongodb://localhost/le_database?authSource=authDB',
    logger: log,
  })
  .then(() => log.debug('Connected to Mongo'))
  .catch(err => log.error(err))

Example with secure database connction

nodeMongo
  .connect({
    dbUsername: 'user',
    dbPassword: 'himligt',
    dbUri: 'mongodb://localhost/le_database',
    logger: log,
    ssl: true,
  })
  .then(() => log.debug('Connected to Mongo'))
  .catch(err => log.error(err))

Check status of connection

  1. Import module
    const nodeMongo =require('@kth/mongo')

  2. Check connection:

    if (nodeMongo.isOk()) {
      // OK
    } else {
      // ERROR
    }
5.0.0-0

2 years ago

4.0.15

2 years ago

4.0.14

2 years ago

5.0.0-alpha.0

2 years ago

4.0.13

2 years ago

4.0.12

3 years ago

4.0.9

3 years ago

4.0.10

3 years ago

4.0.11

3 years ago

4.0.8

3 years ago

4.0.5

3 years ago

4.0.7

3 years ago

4.0.6

3 years ago

4.0.4

3 years ago

4.0.3

3 years ago

4.0.2

3 years ago

4.0.1

3 years ago

4.0.0

3 years ago