Devtools (beta)
nuxt-mongoose comes with a Nuxt Devtools module that allows you to manage your collections and generate api-endpoints & schemas...
nuxt-mongoose comes with a Nuxt Devtools module that allows you to manage your collections and generate api-endpoints & schemas...
Discover all available utils.
defineMongooseModelThis function creates a new Mongoose model with schema. Example usage:
export const User = defineMongooseModel({
+ name: 'User',
+ schema: {
+ name: {
+ type: String,
+ required: true,
+ },
+ },
+ options: {
+
+ },
+})defineMongooseConnectionThis function creates a new Mongoose connection.
nuxt-mongoose provides a default connection for you, it auto-register a plugin in nitro, so you don't need to use this function unless you want to create a new connection. more info here.Example usage:
import { defineMongooseConnection } from '#nuxt/mongoose'
+
+export const connection = defineMongooseConnection('mongodb://127.0.0.1/nuxt-mongoose')| - {{ field }} - | -- Actions - | -
|---|---|
| - - - - - {{ document[field] }} - - | -
-
-
-
- |
-
| - - - | -
- |
-
Configure Nuxt Mongoose with the mongoose property.
export default defineNuxtConfig({
+ mongoose: {
+ uri: 'process.env.MONGODB_URI',
+ options: {},
+ modelsDir: 'models',
+ devtools: true,
+ },
+})| Key | Type | Default | Description |
|---|---|---|---|
uri | string | process.env.MONGODB_URI | Connection Uri String |
options | ConnectOptions | { } | Connection Options |
modelsDir | string | models | The models(schema) directory located in server for auto-import |
devtools | boolean | true | Enable Mongoose module in Nuxt Devtools |
A Nuxt module for simplifying the use of Mongoose in your project.
nuxt-mongoose to your dependencies.pnpm add nuxt-mongoose -Dnuxt-mongoose to the modules section of your nuxt.config file.export default defineNuxtConfig({
+ modules: [
+ 'nuxt-mongoose',
+ ],
+})You can configure the module by adding a mongoose section to your nuxt.config file.
+read more about Mongoose options.
export default defineNuxtConfig({
+ mongoose: {
+ // Options
+ },
+})A Nuxt module for simplifying the use of Mongoose in your project.