DBDJS.Mongo


Table Of Contents

- About
- Examples
- Default
- Custom
- API
- Module
- Instance

About

A MongoDB wrapper using mongoose with dbdjs.db like API

Examples

$3

``js
const mongoose = require("mongoose")
const dbdmongo = require("dbdjs.mongo").default

mongoose.connect("mongodb://localhost:27017/database", {
useNewUrlParser: true,
useUnifiedTopology: true,
keepAlive: true
})

dbdmongo.createModel("main")

dbdmongo.set("main", "my_name", "Matthew")
dbdmongo.set("main", "my_house", "USA")

//etc
`

$3

`js
const mongoose = require("mongoose")
const dbdmongo = require("dbdjs.mongo")

;(async () => {
const instance = dbdmongo.create(await mongoose.createConnection("mongodb://localhost:27017/database", {
useNewUrlParser: true,
useUnifiedTopology: true,
keepAlive: true
}))

instance.createModel("main")

dbdmongo.set("main", "my_name", "Matthew")
dbdmongo.set("main", "my_house", "USA")

//etc
})
`

API

$3

- default
- Default dbdjs.mongo instance
- Type: Instance
`js
const dbdmongo = require("dbdjs.mongo").default
`
- create(mongoInstance)
- Create a dbdjs.mongo instance
- Parameters
- mongoInstance: Mongoose | Connection
- Return: Instance
`js
const dbdmongo = require("dbdjs.mongo").create(await mongoose.createConnection(
"mongodb://localhost:27017/database", {
useNewUrlParser: true,
useUnifiedTopology: true,
keepAlive: true
}))
`

$3

- setInstance(mongoInstance)
- Set a mongo instance to the dbdjs.mongo instance
- Paramaters
- mongoInstance: Mongoose | Connection
- Return: void
`js
dbdmongo.setInstance(await mongoose.createConnection(
"mongodb://localhost:27017/database", {
useNewUrlParser: true,
useUnifiedTopology: true,
keepAlive: true
}))
`
- createModel(name)
- Create a model to the dbdjs.mongo instance
- Parameters
- name: string
- Return: void
`js
dbdmongo.createModel("main")
`
- getModel(name)
- Get a model from the dbdjs.mongo instance
- Parameters
- name: string
- Return: Model
`js
dbdmongo.getModel("main")
`
- deleteModel(name)
- Delete a model from the dbdjs.mongo instance
- Parameters
- name: string
- Return: void
`js
dbdmongo.deleteModel("main")
`
- set(model, key, value)
- Set a data to the model
- Parameters
- model: string
- key: string
- value: any
- Return: boolean
`js
dbdmongo.set("main", "my_name", "Matthew")
`
- get(model, key)
- Get a data from the model
- Parameters
- model: string
- key: string
- Return: { key: string, value: any }
`js
dbdmongo.get("main", "my_name")
`
- all(model, options)
- Get all data from the model and filter it
- Parameters
- model: string
- options: object
- filter: (document: { key: string, data: any }) => boolean
- Return: Array<{ key: string, data: any }>
`js
dbdmongo.all("main", { filter: d => d.data === "Matthew" })
`
- delete(model, key)
- Delete a data from the model
- Parameters
- model: string
- key: string
- Return: boolean
`js
dbdmongo.delete("main", "my_name")
``