diff --git a/200.html b/200.html index c9c21d9..eb583a6 100644 --- a/200.html +++ b/200.html @@ -4,5 +4,5 @@ -
+
\ No newline at end of file diff --git a/404.html b/404.html index c9c21d9..eb583a6 100644 --- a/404.html +++ b/404.html @@ -4,5 +4,5 @@ -
+
\ No newline at end of file diff --git a/api/_content/cache.1687082698783.json b/api/_content/cache.1687082698783.json deleted file mode 100644 index 3bb3521..0000000 --- a/api/_content/cache.1687082698783.json +++ /dev/null @@ -1 +0,0 @@ -{"generatedAt":1687082734668,"generateTime":8,"contents":[{"_path":"/","_dir":"","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Home","description":"","navigation":false,"layout":"page","main":{"fluid":false},"body":{"type":"root","children":[{"type":"element","tag":"ellipsis","props":{"blur":"150px","right":"0px","width":"75%"},"children":[]},{"type":"element","tag":"block-hero","props":{":cta":"[\"Get started\",\"/getting-started/setup\"]",":secondary":"[\"Open on GitHub →\",\"https://github.com/arashsheyda/nuxt-mongoose\"]"},"children":[{"type":"element","tag":"template","props":{"v-slot:title":""},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Nuxt "},{"type":"element","tag":"span","props":{"style":"color: var(--color-primary-500)"},"children":[{"type":"text","value":"Mongoose"}]}]}]},{"type":"element","tag":"template","props":{"v-slot:description":""},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"A Nuxt module for simplifying the use of "},{"type":"element","tag":"a","props":{"href":"https://mongoosejs.com/","rel":["nofollow"]},"children":[{"type":"text","value":"Mongoose"}]},{"type":"text","value":" in your project."}]}]},{"type":"element","tag":"template","props":{"v-slot:support":""},"children":[{"type":"element","tag":"terminal","props":{":content":"[\"npm i nuxt-mongoose -D\"]"},"children":[]}]}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[]}},"_type":"markdown","_id":"content:0.index.md","_source":"content","_file":"0.index.md","_extension":"md"},{"_path":"/getting-started/_dir","_dir":"getting-started","_draft":false,"_partial":true,"_locale":"","icon":"tabler:brand-mongodb","navigation":{"redirect":"/getting-started/setup"},"_id":"content:1.getting-started:_dir.yml","_type":"yaml","title":"Dir","_source":"content","_file":"1.getting-started/_dir.yml","_extension":"yml"},{"_path":"/getting-started/setup","_dir":"getting-started","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Setup","description":"A Nuxt module for simplifying the use of Mongoose in your project.","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"setup"},"children":[{"type":"text","value":"Setup"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"A Nuxt module for simplifying the use of Mongoose in your project."}]},{"type":"element","tag":"h2","props":{"id":"installation"},"children":[{"type":"text","value":"Installation"}]},{"type":"element","tag":"ol","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Install "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"text","value":" to your dependencies."}]}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"pnpm add nuxt-mongoose -D\n","filename":"pnpm","language":"bash","meta":"[pnpm]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":"pnpm"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-47e84e"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-47e84e"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a0d5e7"},"children":[{"type":"text","value":"-D"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"npm install nuxt-mongoose -D\n","filename":"npm","language":"bash","meta":"[npm]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":"npm"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-47e84e"},"children":[{"type":"text","value":"install"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-47e84e"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a0d5e7"},"children":[{"type":"text","value":"-D"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"yarn add nuxt-mongoose -D\n","filename":"yarn","language":"bash","meta":"[yarn]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":"yarn"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-47e84e"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-47e84e"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a0d5e7"},"children":[{"type":"text","value":"-D"}]}]}]}]}]}]},{"type":"element","tag":"ol","props":{"start":2},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Add "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"text","value":" to the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"modules"}]},{"type":"text","value":" section of your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config"}]},{"type":"text","value":" file."}]}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n modules: [\n 'nuxt-mongoose',\n ],\n})\n","filename":"nuxt.config","language":"ts","meta":"[nuxt.config]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-1b7447"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1b7447"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-6cc28b"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":"modules: [\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-47e84e"},"children":[{"type":"text","value":"'nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" ]"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"alert","props":{"type":"success"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"That's it! You can now use Mongoose in your Nuxt app ✨"}]}]},{"type":"element","tag":"h2","props":{"id":"options"},"children":[{"type":"text","value":"Options"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can configure the module by adding a "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"mongoose"}]},{"type":"text","value":" section to your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config"}]},{"type":"text","value":" file.\nread more about "},{"type":"element","tag":"a","props":{"href":"/getting-started/configuration"},"children":[{"type":"text","value":"Mongoose options"}]},{"type":"text","value":"."}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n mongoose: {\n // Options\n },\n})\n","filename":"nuxt.config","language":"ts","meta":"[nuxt.config]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-1b7447"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1b7447"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-6cc28b"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-020ce8"},"children":[{"type":"text","value":"// Options\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"If you want to configure only the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"uri"}]},{"type":"text","value":" just add "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"MONGODB_URI"}]},{"type":"text","value":" in your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":".env"}]},{"type":"text","value":" file."}]},{"type":"element","tag":"code","props":{"code":"MONGODB_URI=YOUR_MONGO_URI\n","language":"env","meta":null},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"MONGODB_URI=YOUR_MONGO_URI"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-020ce8{color:#6E7781}\n.ct-6cc28b{color:#8250DF}\n.ct-1b7447{color:#CF222E}\n.ct-a0d5e7{color:#0550AE}\n.ct-47e84e{color:#0A3069}\n.ct-3be1d1{color:#24292F}\n.ct-5c99d8{color:#953800}\n.dark .ct-5c99d8{color:#FFA657}\n.dark .ct-3be1d1{color:#C9D1D9}\n.dark .ct-47e84e{color:#A5D6FF}\n.dark .ct-a0d5e7{color:#79C0FF}\n.dark .ct-1b7447{color:#FF7B72}\n.dark .ct-6cc28b{color:#D2A8FF}\n.dark .ct-020ce8{color:#8B949E}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"installation","depth":2,"text":"Installation"},{"id":"options","depth":2,"text":"Options"}]}},"_type":"markdown","_id":"content:1.getting-started:1.setup.md","_source":"content","_file":"1.getting-started/1.setup.md","_extension":"md"},{"_path":"/getting-started/configuration","_dir":"getting-started","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Configuration","description":"Configure Nuxt Mongoose with the mongoose property.","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"configuration"},"children":[{"type":"text","value":"Configuration"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Configure Nuxt Mongoose with the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"mongoose"}]},{"type":"text","value":" property."}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n mongoose: {\n uri: 'process.env.MONGODB_URI',\n options: {},\n modelsDir: 'models',\n devtools: true,\n },\n})\n","filename":"nuxt.config","language":"ts","meta":"[nuxt.config]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-1059e8"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-c9f819"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1059e8"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-c9f819"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a65418"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-c9f819"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-c9f819"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":" uri: "}]},{"type":"element","tag":"span","props":{"class":"ct-c14457"},"children":[{"type":"text","value":"'process.env.MONGODB_URI'"}]},{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":" options: {},\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":" modelsDir: "}]},{"type":"element","tag":"span","props":{"class":"ct-c14457"},"children":[{"type":"text","value":"'models'"}]},{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":" devtools: "}]},{"type":"element","tag":"span","props":{"class":"ct-8d4235"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-c9f819"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-c9f819"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"table","props":{},"children":[{"type":"element","tag":"thead","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Key"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Type"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Default"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Description"}]}]}]}]},{"type":"element","tag":"tbody","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"uri"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"string"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"process.env.MONGODB_URI"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Connection Uri String"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"options"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"ConnectOptions"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"{ }"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Connection Options"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"modelsDir"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"string"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"models"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"The models(schema) directory located in "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"server"}]},{"type":"text","value":" for auto-import"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"devtools"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"boolean"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Enable Mongoose module in "},{"type":"element","tag":"a","props":{"href":"https://github.com/nuxt/devtools","rel":["nofollow"]},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"Nuxt Devtools"}]}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-8d4235{color:#0550AE}\n.ct-c14457{color:#0A3069}\n.ct-b07d4d{color:#24292F}\n.ct-a65418{color:#8250DF}\n.ct-c9f819{color:#953800}\n.ct-1059e8{color:#CF222E}\n.dark .ct-1059e8{color:#FF7B72}\n.dark .ct-c9f819{color:#FFA657}\n.dark .ct-a65418{color:#D2A8FF}\n.dark .ct-b07d4d{color:#C9D1D9}\n.dark .ct-c14457{color:#A5D6FF}\n.dark .ct-8d4235{color:#79C0FF}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[]}},"_type":"markdown","_id":"content:1.getting-started:3.configuration.md","_source":"content","_file":"1.getting-started/3.configuration.md","_extension":"md"},{"_path":"/api/_dir","_dir":"api","_draft":false,"_partial":true,"_locale":"","title":"API","icon":"tabler:book","_id":"content:2.api:_dir.yml","_type":"yaml","_source":"content","_file":"2.api/_dir.yml","_extension":"yml"},{"_path":"/api/utils","_dir":"api","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Utils","description":"Discover all available utils.","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"utils"},"children":[{"type":"text","value":"Utils"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Discover all available utils."}]},{"type":"element","tag":"h2","props":{"id":"definemongoosemodel"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"defineMongooseModel"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This function creates a new Mongoose model with schema. Example usage:"}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"export const User = defineMongooseModel({\n name: 'User',\n schema: {\n name: {\n type: String,\n required: true,\n },\n },\n options: {\n\n },\n})\n","filename":"named parameters","language":"ts","meta":"[named parameters]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-40e85d"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-17ea1e"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" name: "}]},{"type":"element","tag":"span","props":{"class":"ct-4a653e"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" schema: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" name: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" type: String,\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-40e85d"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":9},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" options: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":10},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":11},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":12},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"import { defineMongooseModel } from '#nuxt/mongoose'\n\nexport const User = defineMongooseModel('User', {\n name: {\n type: String,\n required: true,\n },\n}, {\n\n})\n","filename":"positional parameters","language":"ts","meta":"[positional parameters]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" { defineMongooseModel } "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4a653e"},"children":[{"type":"text","value":"'#nuxt/mongoose'\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-40e85d"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-17ea1e"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-4a653e"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":", {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" name: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" type: String,\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-40e85d"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":"}, {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":9},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":10},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":"})"}]}]}]}]}]}]},{"type":"element","tag":"h2","props":{"id":"definemongooseconnection"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"defineMongooseConnection"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This function creates a new Mongoose connection."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"text","value":" 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 "},{"type":"element","tag":"a","props":{"href":"https://github.com/arashsheyda/nuxt-mongoose/blob/main/src/runtime/server/plugins/mongoose.db.ts","rel":["nofollow"]},"children":[{"type":"text","value":"here"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Example usage:"}]},{"type":"element","tag":"code","props":{"code":"import { defineMongooseConnection } from '#nuxt/mongoose'\n\nexport const connection = defineMongooseConnection('mongodb://127.0.0.1/nuxt-mongoose')\n","language":"ts","meta":null},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" { defineMongooseConnection } "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4a653e"},"children":[{"type":"text","value":"'#nuxt/mongoose'\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-40e85d"},"children":[{"type":"text","value":"connection"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-17ea1e"},"children":[{"type":"text","value":"defineMongooseConnection"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-4a653e"},"children":[{"type":"text","value":"'mongodb://127.0.0.1/nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":")"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-4a653e{color:#0A3069}\n.ct-17ea1e{color:#8250DF}\n.ct-40e85d{color:#0550AE}\n.ct-685cf2{color:#24292F}\n.ct-aac181{color:#CF222E}\n.dark .ct-aac181{color:#FF7B72}\n.dark .ct-685cf2{color:#C9D1D9}\n.dark .ct-40e85d{color:#79C0FF}\n.dark .ct-17ea1e{color:#D2A8FF}\n.dark .ct-4a653e{color:#A5D6FF}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"definemongoosemodel","depth":2,"text":"defineMongooseModel"},{"id":"definemongooseconnection","depth":2,"text":"defineMongooseConnection"}]}},"_type":"markdown","_id":"content:2.api:1.utils.md","_source":"content","_file":"2.api/1.utils.md","_extension":"md"},{"_path":"/api/devtools","_dir":"api","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Devtools (beta)","description":"nuxt-mongoose comes with a Nuxt Devtools module that allows you to manage your collections and generate api-endpoints & schemas...","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"devtools-beta"},"children":[{"type":"text","value":"Devtools (beta)"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"text","value":" comes with a "},{"type":"element","tag":"a","props":{"href":"https://github.com/nuxt/devtools","rel":["nofollow"]},"children":[{"type":"text","value":"Nuxt Devtools"}]},{"type":"text","value":" module that allows you to manage your collections and generate api-endpoints & schemas..."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Here is a demo video:"}]},{"type":"element","tag":"video-player","props":{"src":"https://www.youtube.com/watch?v=hK0npSfr_Vs"},"children":[]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[]}},"_type":"markdown","_id":"content:2.api:2.devtools.md","_source":"content","_file":"2.api/2.devtools.md","_extension":"md"}],"navigation":[{"title":"Getting Started","_path":"/getting-started","children":[{"title":"Setup","_path":"/getting-started/setup"},{"title":"Configuration","_path":"/getting-started/configuration"}],"icon":"tabler:brand-mongodb","redirect":"/getting-started/setup"},{"title":"API","_path":"/api","children":[{"title":"Utils","_path":"/api/utils"},{"title":"Devtools (beta)","_path":"/api/devtools"}],"icon":"tabler:book"}]} \ No newline at end of file diff --git a/api/_content/cache.1688901730600.json b/api/_content/cache.1688901730600.json new file mode 100644 index 0000000..c78e8cf --- /dev/null +++ b/api/_content/cache.1688901730600.json @@ -0,0 +1 @@ +{"generatedAt":1688901764826,"generateTime":9,"contents":[{"_path":"/","_dir":"","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Home","description":"","navigation":false,"layout":"page","main":{"fluid":false},"body":{"type":"root","children":[{"type":"element","tag":"ellipsis","props":{"blur":"150px","right":"0px","width":"75%"},"children":[]},{"type":"element","tag":"block-hero","props":{":cta":"[\"Get started\",\"/getting-started/setup\"]",":secondary":"[\"Open on GitHub →\",\"https://github.com/arashsheyda/nuxt-mongoose\"]"},"children":[{"type":"element","tag":"template","props":{"v-slot:title":""},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Nuxt "},{"type":"element","tag":"span","props":{"style":"color: var(--color-primary-500)"},"children":[{"type":"text","value":"Mongoose"}]}]}]},{"type":"element","tag":"template","props":{"v-slot:description":""},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"A Nuxt module for simplifying the use of "},{"type":"element","tag":"a","props":{"href":"https://mongoosejs.com/","rel":["nofollow"]},"children":[{"type":"text","value":"Mongoose"}]},{"type":"text","value":" in your project."}]}]},{"type":"element","tag":"template","props":{"v-slot:support":""},"children":[{"type":"element","tag":"terminal","props":{":content":"[\"npm i nuxt-mongoose -D\"]"},"children":[]}]}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[]}},"_type":"markdown","_id":"content:0.index.md","_source":"content","_file":"0.index.md","_extension":"md"},{"_path":"/getting-started/_dir","_dir":"getting-started","_draft":false,"_partial":true,"_locale":"","icon":"tabler:brand-mongodb","navigation":{"redirect":"/getting-started/setup"},"_id":"content:1.getting-started:_dir.yml","_type":"yaml","title":"Dir","_source":"content","_file":"1.getting-started/_dir.yml","_extension":"yml"},{"_path":"/getting-started/setup","_dir":"getting-started","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Setup","description":"A Nuxt module for simplifying the use of Mongoose in your project.","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"setup"},"children":[{"type":"text","value":"Setup"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"A Nuxt module for simplifying the use of Mongoose in your project."}]},{"type":"element","tag":"h2","props":{"id":"installation"},"children":[{"type":"text","value":"Installation"}]},{"type":"element","tag":"ol","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Install "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"text","value":" to your dependencies."}]}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"pnpm add nuxt-mongoose -D\n","filename":"pnpm","language":"bash","meta":"[pnpm]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":"pnpm"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b74885"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b74885"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-875235"},"children":[{"type":"text","value":"-D"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"npm install nuxt-mongoose -D\n","filename":"npm","language":"bash","meta":"[npm]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":"npm"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b74885"},"children":[{"type":"text","value":"install"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b74885"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-875235"},"children":[{"type":"text","value":"-D"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"yarn add nuxt-mongoose -D\n","filename":"yarn","language":"bash","meta":"[yarn]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":"yarn"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b74885"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b74885"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-875235"},"children":[{"type":"text","value":"-D"}]}]}]}]}]}]},{"type":"element","tag":"ol","props":{"start":2},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Add "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"text","value":" to the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"modules"}]},{"type":"text","value":" section of your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config"}]},{"type":"text","value":" file."}]}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n modules: [\n 'nuxt-mongoose',\n ],\n})\n","filename":"nuxt.config","language":"ts","meta":"[nuxt.config]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b84cc"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5b84cc"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-9824b6"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":"modules: [\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b74885"},"children":[{"type":"text","value":"'nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" ]"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"alert","props":{"type":"success"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"That's it! You can now use Mongoose in your Nuxt app ✨"}]}]},{"type":"element","tag":"h2","props":{"id":"options"},"children":[{"type":"text","value":"Options"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can configure the module by adding a "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"mongoose"}]},{"type":"text","value":" section to your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config"}]},{"type":"text","value":" file.\nread more about "},{"type":"element","tag":"a","props":{"href":"/getting-started/configuration"},"children":[{"type":"text","value":"Mongoose options"}]},{"type":"text","value":"."}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n mongoose: {\n // Options\n },\n})\n","filename":"nuxt.config","language":"ts","meta":"[nuxt.config]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b84cc"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5b84cc"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-9824b6"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-afe2a2"},"children":[{"type":"text","value":"// Options\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"If you want to configure only the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"uri"}]},{"type":"text","value":" just add "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"MONGODB_URI"}]},{"type":"text","value":" in your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":".env"}]},{"type":"text","value":" file."}]},{"type":"element","tag":"code","props":{"code":"MONGODB_URI=YOUR_MONGO_URI\n","language":"env","meta":null},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"MONGODB_URI=YOUR_MONGO_URI"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-afe2a2{color:#6E7781}\n.ct-9824b6{color:#8250DF}\n.ct-5b84cc{color:#CF222E}\n.ct-875235{color:#0550AE}\n.ct-b74885{color:#0A3069}\n.ct-827cc5{color:#24292F}\n.ct-926fc4{color:#953800}\n.dark .ct-926fc4{color:#FFA657}\n.dark .ct-827cc5{color:#C9D1D9}\n.dark .ct-b74885{color:#A5D6FF}\n.dark .ct-875235{color:#79C0FF}\n.dark .ct-5b84cc{color:#FF7B72}\n.dark .ct-9824b6{color:#D2A8FF}\n.dark .ct-afe2a2{color:#8B949E}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"installation","depth":2,"text":"Installation"},{"id":"options","depth":2,"text":"Options"}]}},"_type":"markdown","_id":"content:1.getting-started:1.setup.md","_source":"content","_file":"1.getting-started/1.setup.md","_extension":"md"},{"_path":"/getting-started/configuration","_dir":"getting-started","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Configuration","description":"Configure Nuxt Mongoose with the mongoose property.","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"configuration"},"children":[{"type":"text","value":"Configuration"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Configure Nuxt Mongoose with the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"mongoose"}]},{"type":"text","value":" property."}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n mongoose: {\n uri: 'process.env.MONGODB_URI',\n options: {},\n modelsDir: 'models',\n devtools: true,\n },\n})\n","filename":"nuxt.config","language":"ts","meta":"[nuxt.config]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-feb825"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-49b0ce"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-feb825"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-49b0ce"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1c176f"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-49b0ce"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-49b0ce"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":" uri: "}]},{"type":"element","tag":"span","props":{"class":"ct-80cb1b"},"children":[{"type":"text","value":"'process.env.MONGODB_URI'"}]},{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":" options: {},\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":" modelsDir: "}]},{"type":"element","tag":"span","props":{"class":"ct-80cb1b"},"children":[{"type":"text","value":"'models'"}]},{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":" devtools: "}]},{"type":"element","tag":"span","props":{"class":"ct-87f028"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-49b0ce"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-49b0ce"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"table","props":{},"children":[{"type":"element","tag":"thead","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Key"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Type"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Default"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Description"}]}]}]}]},{"type":"element","tag":"tbody","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"uri"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"string"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"process.env.MONGODB_URI"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Connection Uri String"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"options"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"ConnectOptions"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"{ }"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Connection Options"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"modelsDir"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"string"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"models"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"The models(schema) directory located in "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"server"}]},{"type":"text","value":" for auto-import"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"devtools"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"boolean"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Enable Mongoose module in "},{"type":"element","tag":"a","props":{"href":"https://github.com/nuxt/devtools","rel":["nofollow"]},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"Nuxt Devtools"}]}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-87f028{color:#0550AE}\n.ct-80cb1b{color:#0A3069}\n.ct-5905b4{color:#24292F}\n.ct-1c176f{color:#8250DF}\n.ct-49b0ce{color:#953800}\n.ct-feb825{color:#CF222E}\n.dark .ct-feb825{color:#FF7B72}\n.dark .ct-49b0ce{color:#FFA657}\n.dark .ct-1c176f{color:#D2A8FF}\n.dark .ct-5905b4{color:#C9D1D9}\n.dark .ct-80cb1b{color:#A5D6FF}\n.dark .ct-87f028{color:#79C0FF}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[]}},"_type":"markdown","_id":"content:1.getting-started:3.configuration.md","_source":"content","_file":"1.getting-started/3.configuration.md","_extension":"md"},{"_path":"/api/_dir","_dir":"api","_draft":false,"_partial":true,"_locale":"","title":"API","icon":"tabler:book","_id":"content:2.api:_dir.yml","_type":"yaml","_source":"content","_file":"2.api/_dir.yml","_extension":"yml"},{"_path":"/api/utils","_dir":"api","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Utils","description":"Discover all available utils.","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"utils"},"children":[{"type":"text","value":"Utils"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Discover all available utils."}]},{"type":"element","tag":"h2","props":{"id":"definemongoosemodel"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"defineMongooseModel"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This function creates a new Mongoose model with schema. Example usage:"}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"export const User = defineMongooseModel({\n name: 'User',\n schema: {\n email: {\n type: 'string',\n required: true,\n unique: true,\n },\n },\n options: {\n \n },\n hooks(schema) {\n\n },\n})\n","filename":"named parameters","language":"ts","meta":"[named parameters]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a02dd3"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-84b3ee"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" name: "}]},{"type":"element","tag":"span","props":{"class":"ct-9b3feb"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" schema: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" email: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" type: "}]},{"type":"element","tag":"span","props":{"class":"ct-9b3feb"},"children":[{"type":"text","value":"'string'"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-a02dd3"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" unique: "}]},{"type":"element","tag":"span","props":{"class":"ct-a02dd3"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":9},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":10},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" options: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":11},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" \n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":12},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":13},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-84b3ee"},"children":[{"type":"text","value":"hooks"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-60c022"},"children":[{"type":"text","value":"schema"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":") {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":14},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":15},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":16},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"import { defineMongooseModel } from '#nuxt/mongoose'\n\nexport const User = defineMongooseModel('User', {\n email: {\n type: 'string',\n required: true,\n unique: true,\n },\n}, {\n \n}, (schema) => {\n\n})\n","filename":"positional parameters","language":"ts","meta":"[positional parameters]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" { defineMongooseModel } "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-9b3feb"},"children":[{"type":"text","value":"'#nuxt/mongoose'\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a02dd3"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-84b3ee"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-9b3feb"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":", {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" email: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" type: "}]},{"type":"element","tag":"span","props":{"class":"ct-9b3feb"},"children":[{"type":"text","value":"'string'"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-a02dd3"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" unique: "}]},{"type":"element","tag":"span","props":{"class":"ct-a02dd3"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":9},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"}, {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":10},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" \n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":11},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"}, ("}]},{"type":"element","tag":"span","props":{"class":"ct-60c022"},"children":[{"type":"text","value":"schema"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":") "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":12},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":13},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"})"}]}]}]}]}]}]},{"type":"element","tag":"table","props":{},"children":[{"type":"element","tag":"thead","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Key"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Type"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Require"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Description"}]}]}]}]},{"type":"element","tag":"tbody","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"name"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"string"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Name of Model"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"schema"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"a","props":{"href":"https://mongoosejs.com/docs/schematypes.html","rel":["nofollow"]},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"SchemaDefinition"}]}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Schema Definition of Model"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"options"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"a","props":{"href":"https://mongoosejs.com/docs/guide.html#options","rel":["nofollow"]},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"SchemaOptions"}]}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"false"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Schema Options for Model"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"hooks"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"a","props":{"href":"https://mongoosejs.com/docs/middleware.html","rel":["nofollow"]},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"(schema: Schema) => void"}]}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"false"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Schema Hooks Function to customize Model"}]}]}]}]},{"type":"element","tag":"h2","props":{"id":"definemongooseconnection"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"defineMongooseConnection"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This function creates a new Mongoose connection."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"text","value":" 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 "},{"type":"element","tag":"a","props":{"href":"https://github.com/arashsheyda/nuxt-mongoose/blob/main/src/runtime/server/plugins/mongoose.db.ts","rel":["nofollow"]},"children":[{"type":"text","value":"here"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Example usage:"}]},{"type":"element","tag":"code","props":{"code":"import { defineMongooseConnection } from '#nuxt/mongoose'\n\nexport const connection = defineMongooseConnection('mongodb://127.0.0.1/nuxt-mongoose')\n","language":"ts","meta":null},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" { defineMongooseConnection } "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-9b3feb"},"children":[{"type":"text","value":"'#nuxt/mongoose'\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a02dd3"},"children":[{"type":"text","value":"connection"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-84b3ee"},"children":[{"type":"text","value":"defineMongooseConnection"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-9b3feb"},"children":[{"type":"text","value":"'mongodb://127.0.0.1/nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":")"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-60c022{color:#953800}\n.ct-9b3feb{color:#0A3069}\n.ct-84b3ee{color:#8250DF}\n.ct-a02dd3{color:#0550AE}\n.ct-3fd609{color:#24292F}\n.ct-65741e{color:#CF222E}\n.dark .ct-65741e{color:#FF7B72}\n.dark .ct-3fd609{color:#C9D1D9}\n.dark .ct-a02dd3{color:#79C0FF}\n.dark .ct-84b3ee{color:#D2A8FF}\n.dark .ct-9b3feb{color:#A5D6FF}\n.dark .ct-60c022{color:#FFA657}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"definemongoosemodel","depth":2,"text":"defineMongooseModel"},{"id":"definemongooseconnection","depth":2,"text":"defineMongooseConnection"}]}},"_type":"markdown","_id":"content:2.api:1.utils.md","_source":"content","_file":"2.api/1.utils.md","_extension":"md"},{"_path":"/api/devtools","_dir":"api","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Devtools (beta)","description":"nuxt-mongoose comes with a Nuxt Devtools module that allows you to manage your collections and generate api-endpoints & schemas...","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"devtools-beta"},"children":[{"type":"text","value":"Devtools (beta)"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"text","value":" comes with a "},{"type":"element","tag":"a","props":{"href":"https://github.com/nuxt/devtools","rel":["nofollow"]},"children":[{"type":"text","value":"Nuxt Devtools"}]},{"type":"text","value":" module that allows you to manage your collections and generate api-endpoints & schemas..."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Here is a demo video:"}]},{"type":"element","tag":"video-player","props":{"src":"https://www.youtube.com/watch?v=hK0npSfr_Vs"},"children":[]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[]}},"_type":"markdown","_id":"content:2.api:2.devtools.md","_source":"content","_file":"2.api/2.devtools.md","_extension":"md"}],"navigation":[{"title":"Getting Started","_path":"/getting-started","children":[{"title":"Setup","_path":"/getting-started/setup"},{"title":"Configuration","_path":"/getting-started/configuration"}],"icon":"tabler:brand-mongodb","redirect":"/getting-started/setup"},{"title":"API","_path":"/api","children":[{"title":"Utils","_path":"/api/utils"},{"title":"Devtools (beta)","_path":"/api/devtools"}],"icon":"tabler:book"}]} \ No newline at end of file diff --git a/api/_content/navigation/u7BbTyuhiE.1687082698783.json b/api/_content/navigation/u7BbTyuhiE.1688901730600.json similarity index 100% rename from api/_content/navigation/u7BbTyuhiE.1687082698783.json rename to api/_content/navigation/u7BbTyuhiE.1688901730600.json diff --git a/api/_content/query/ESs0FnB4WF.1687082698783.json b/api/_content/query/ESs0FnB4WF.1688901730600.json similarity index 100% rename from api/_content/query/ESs0FnB4WF.1687082698783.json rename to api/_content/query/ESs0FnB4WF.1688901730600.json diff --git a/api/_content/query/VvGAWv4HRl.1687082698783.json b/api/_content/query/VvGAWv4HRl.1688901730600.json similarity index 100% rename from api/_content/query/VvGAWv4HRl.1687082698783.json rename to api/_content/query/VvGAWv4HRl.1688901730600.json diff --git a/api/_content/query/XBhGGyCXGR.1687082698783.json b/api/_content/query/XBhGGyCXGR.1688901730600.json similarity index 67% rename from api/_content/query/XBhGGyCXGR.1687082698783.json rename to api/_content/query/XBhGGyCXGR.1688901730600.json index 054ae5d..470c193 100644 --- a/api/_content/query/XBhGGyCXGR.1687082698783.json +++ b/api/_content/query/XBhGGyCXGR.1688901730600.json @@ -1 +1 @@ -{"_path":"/getting-started/setup","_dir":"getting-started","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Setup","description":"A Nuxt module for simplifying the use of Mongoose in your project.","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"setup"},"children":[{"type":"text","value":"Setup"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"A Nuxt module for simplifying the use of Mongoose in your project."}]},{"type":"element","tag":"h2","props":{"id":"installation"},"children":[{"type":"text","value":"Installation"}]},{"type":"element","tag":"ol","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Install "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"text","value":" to your dependencies."}]}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"pnpm add nuxt-mongoose -D\n","filename":"pnpm","language":"bash","meta":"[pnpm]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":"pnpm"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-47e84e"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-47e84e"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a0d5e7"},"children":[{"type":"text","value":"-D"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"npm install nuxt-mongoose -D\n","filename":"npm","language":"bash","meta":"[npm]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":"npm"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-47e84e"},"children":[{"type":"text","value":"install"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-47e84e"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a0d5e7"},"children":[{"type":"text","value":"-D"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"yarn add nuxt-mongoose -D\n","filename":"yarn","language":"bash","meta":"[yarn]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":"yarn"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-47e84e"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-47e84e"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a0d5e7"},"children":[{"type":"text","value":"-D"}]}]}]}]}]}]},{"type":"element","tag":"ol","props":{"start":2},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Add "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"text","value":" to the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"modules"}]},{"type":"text","value":" section of your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config"}]},{"type":"text","value":" file."}]}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n modules: [\n 'nuxt-mongoose',\n ],\n})\n","filename":"nuxt.config","language":"ts","meta":"[nuxt.config]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-1b7447"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1b7447"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-6cc28b"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":"modules: [\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-47e84e"},"children":[{"type":"text","value":"'nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" ]"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"alert","props":{"type":"success"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"That's it! You can now use Mongoose in your Nuxt app ✨"}]}]},{"type":"element","tag":"h2","props":{"id":"options"},"children":[{"type":"text","value":"Options"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can configure the module by adding a "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"mongoose"}]},{"type":"text","value":" section to your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config"}]},{"type":"text","value":" file.\nread more about "},{"type":"element","tag":"a","props":{"href":"/getting-started/configuration"},"children":[{"type":"text","value":"Mongoose options"}]},{"type":"text","value":"."}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n mongoose: {\n // Options\n },\n})\n","filename":"nuxt.config","language":"ts","meta":"[nuxt.config]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-1b7447"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1b7447"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-6cc28b"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-020ce8"},"children":[{"type":"text","value":"// Options\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-3be1d1"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-5c99d8"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"If you want to configure only the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"uri"}]},{"type":"text","value":" just add "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"MONGODB_URI"}]},{"type":"text","value":" in your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":".env"}]},{"type":"text","value":" file."}]},{"type":"element","tag":"code","props":{"code":"MONGODB_URI=YOUR_MONGO_URI\n","language":"env","meta":null},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"MONGODB_URI=YOUR_MONGO_URI"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-020ce8{color:#6E7781}\n.ct-6cc28b{color:#8250DF}\n.ct-1b7447{color:#CF222E}\n.ct-a0d5e7{color:#0550AE}\n.ct-47e84e{color:#0A3069}\n.ct-3be1d1{color:#24292F}\n.ct-5c99d8{color:#953800}\n.dark .ct-5c99d8{color:#FFA657}\n.dark .ct-3be1d1{color:#C9D1D9}\n.dark .ct-47e84e{color:#A5D6FF}\n.dark .ct-a0d5e7{color:#79C0FF}\n.dark .ct-1b7447{color:#FF7B72}\n.dark .ct-6cc28b{color:#D2A8FF}\n.dark .ct-020ce8{color:#8B949E}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"installation","depth":2,"text":"Installation"},{"id":"options","depth":2,"text":"Options"}]}},"_type":"markdown","_id":"content:1.getting-started:1.setup.md","_source":"content","_file":"1.getting-started/1.setup.md","_extension":"md"} \ No newline at end of file +{"_path":"/getting-started/setup","_dir":"getting-started","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Setup","description":"A Nuxt module for simplifying the use of Mongoose in your project.","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"setup"},"children":[{"type":"text","value":"Setup"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"A Nuxt module for simplifying the use of Mongoose in your project."}]},{"type":"element","tag":"h2","props":{"id":"installation"},"children":[{"type":"text","value":"Installation"}]},{"type":"element","tag":"ol","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Install "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"text","value":" to your dependencies."}]}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"pnpm add nuxt-mongoose -D\n","filename":"pnpm","language":"bash","meta":"[pnpm]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":"pnpm"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b74885"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b74885"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-875235"},"children":[{"type":"text","value":"-D"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"npm install nuxt-mongoose -D\n","filename":"npm","language":"bash","meta":"[npm]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":"npm"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b74885"},"children":[{"type":"text","value":"install"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b74885"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-875235"},"children":[{"type":"text","value":"-D"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"yarn add nuxt-mongoose -D\n","filename":"yarn","language":"bash","meta":"[yarn]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":"yarn"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b74885"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b74885"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-875235"},"children":[{"type":"text","value":"-D"}]}]}]}]}]}]},{"type":"element","tag":"ol","props":{"start":2},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Add "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"text","value":" to the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"modules"}]},{"type":"text","value":" section of your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config"}]},{"type":"text","value":" file."}]}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n modules: [\n 'nuxt-mongoose',\n ],\n})\n","filename":"nuxt.config","language":"ts","meta":"[nuxt.config]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b84cc"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5b84cc"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-9824b6"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":"modules: [\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b74885"},"children":[{"type":"text","value":"'nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" ]"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"alert","props":{"type":"success"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"That's it! You can now use Mongoose in your Nuxt app ✨"}]}]},{"type":"element","tag":"h2","props":{"id":"options"},"children":[{"type":"text","value":"Options"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can configure the module by adding a "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"mongoose"}]},{"type":"text","value":" section to your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt.config"}]},{"type":"text","value":" file.\nread more about "},{"type":"element","tag":"a","props":{"href":"/getting-started/configuration"},"children":[{"type":"text","value":"Mongoose options"}]},{"type":"text","value":"."}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n mongoose: {\n // Options\n },\n})\n","filename":"nuxt.config","language":"ts","meta":"[nuxt.config]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b84cc"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5b84cc"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-9824b6"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-afe2a2"},"children":[{"type":"text","value":"// Options\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-827cc5"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-926fc4"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"If you want to configure only the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"uri"}]},{"type":"text","value":" just add "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"MONGODB_URI"}]},{"type":"text","value":" in your "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":".env"}]},{"type":"text","value":" file."}]},{"type":"element","tag":"code","props":{"code":"MONGODB_URI=YOUR_MONGO_URI\n","language":"env","meta":null},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"MONGODB_URI=YOUR_MONGO_URI"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-afe2a2{color:#6E7781}\n.ct-9824b6{color:#8250DF}\n.ct-5b84cc{color:#CF222E}\n.ct-875235{color:#0550AE}\n.ct-b74885{color:#0A3069}\n.ct-827cc5{color:#24292F}\n.ct-926fc4{color:#953800}\n.dark .ct-926fc4{color:#FFA657}\n.dark .ct-827cc5{color:#C9D1D9}\n.dark .ct-b74885{color:#A5D6FF}\n.dark .ct-875235{color:#79C0FF}\n.dark .ct-5b84cc{color:#FF7B72}\n.dark .ct-9824b6{color:#D2A8FF}\n.dark .ct-afe2a2{color:#8B949E}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"installation","depth":2,"text":"Installation"},{"id":"options","depth":2,"text":"Options"}]}},"_type":"markdown","_id":"content:1.getting-started:1.setup.md","_source":"content","_file":"1.getting-started/1.setup.md","_extension":"md"} \ No newline at end of file diff --git a/api/_content/query/XtgCGvT2xN.1687082698783.json b/api/_content/query/XtgCGvT2xN.1688901730600.json similarity index 100% rename from api/_content/query/XtgCGvT2xN.1687082698783.json rename to api/_content/query/XtgCGvT2xN.1688901730600.json diff --git a/api/_content/query/YIMd7yQcGd.1687082698783.json b/api/_content/query/YIMd7yQcGd.1688901730600.json similarity index 100% rename from api/_content/query/YIMd7yQcGd.1687082698783.json rename to api/_content/query/YIMd7yQcGd.1688901730600.json diff --git a/api/_content/query/brX4CwCJoQ.1687082698783.json b/api/_content/query/brX4CwCJoQ.1688901730600.json similarity index 100% rename from api/_content/query/brX4CwCJoQ.1687082698783.json rename to api/_content/query/brX4CwCJoQ.1688901730600.json diff --git a/api/_content/query/g9pY1CqBBn.1687082698783.json b/api/_content/query/g9pY1CqBBn.1688901730600.json similarity index 79% rename from api/_content/query/g9pY1CqBBn.1687082698783.json rename to api/_content/query/g9pY1CqBBn.1688901730600.json index d62b131..ecdc6d6 100644 --- a/api/_content/query/g9pY1CqBBn.1687082698783.json +++ b/api/_content/query/g9pY1CqBBn.1688901730600.json @@ -1 +1 @@ -{"_path":"/getting-started/configuration","_dir":"getting-started","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Configuration","description":"Configure Nuxt Mongoose with the mongoose property.","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"configuration"},"children":[{"type":"text","value":"Configuration"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Configure Nuxt Mongoose with the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"mongoose"}]},{"type":"text","value":" property."}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n mongoose: {\n uri: 'process.env.MONGODB_URI',\n options: {},\n modelsDir: 'models',\n devtools: true,\n },\n})\n","filename":"nuxt.config","language":"ts","meta":"[nuxt.config]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-1059e8"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-c9f819"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1059e8"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-c9f819"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a65418"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-c9f819"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-c9f819"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":" uri: "}]},{"type":"element","tag":"span","props":{"class":"ct-c14457"},"children":[{"type":"text","value":"'process.env.MONGODB_URI'"}]},{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":" options: {},\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":" modelsDir: "}]},{"type":"element","tag":"span","props":{"class":"ct-c14457"},"children":[{"type":"text","value":"'models'"}]},{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":" devtools: "}]},{"type":"element","tag":"span","props":{"class":"ct-8d4235"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-b07d4d"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-c9f819"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-c9f819"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"table","props":{},"children":[{"type":"element","tag":"thead","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Key"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Type"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Default"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Description"}]}]}]}]},{"type":"element","tag":"tbody","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"uri"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"string"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"process.env.MONGODB_URI"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Connection Uri String"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"options"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"ConnectOptions"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"{ }"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Connection Options"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"modelsDir"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"string"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"models"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"The models(schema) directory located in "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"server"}]},{"type":"text","value":" for auto-import"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"devtools"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"boolean"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Enable Mongoose module in "},{"type":"element","tag":"a","props":{"href":"https://github.com/nuxt/devtools","rel":["nofollow"]},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"Nuxt Devtools"}]}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-8d4235{color:#0550AE}\n.ct-c14457{color:#0A3069}\n.ct-b07d4d{color:#24292F}\n.ct-a65418{color:#8250DF}\n.ct-c9f819{color:#953800}\n.ct-1059e8{color:#CF222E}\n.dark .ct-1059e8{color:#FF7B72}\n.dark .ct-c9f819{color:#FFA657}\n.dark .ct-a65418{color:#D2A8FF}\n.dark .ct-b07d4d{color:#C9D1D9}\n.dark .ct-c14457{color:#A5D6FF}\n.dark .ct-8d4235{color:#79C0FF}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[]}},"_type":"markdown","_id":"content:1.getting-started:3.configuration.md","_source":"content","_file":"1.getting-started/3.configuration.md","_extension":"md"} \ No newline at end of file +{"_path":"/getting-started/configuration","_dir":"getting-started","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Configuration","description":"Configure Nuxt Mongoose with the mongoose property.","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"configuration"},"children":[{"type":"text","value":"Configuration"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Configure Nuxt Mongoose with the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"mongoose"}]},{"type":"text","value":" property."}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n mongoose: {\n uri: 'process.env.MONGODB_URI',\n options: {},\n modelsDir: 'models',\n devtools: true,\n },\n})\n","filename":"nuxt.config","language":"ts","meta":"[nuxt.config]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-feb825"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-49b0ce"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-feb825"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-49b0ce"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1c176f"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-49b0ce"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-49b0ce"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":" uri: "}]},{"type":"element","tag":"span","props":{"class":"ct-80cb1b"},"children":[{"type":"text","value":"'process.env.MONGODB_URI'"}]},{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":" options: {},\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":" modelsDir: "}]},{"type":"element","tag":"span","props":{"class":"ct-80cb1b"},"children":[{"type":"text","value":"'models'"}]},{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":" devtools: "}]},{"type":"element","tag":"span","props":{"class":"ct-87f028"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-5905b4"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-49b0ce"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-49b0ce"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"table","props":{},"children":[{"type":"element","tag":"thead","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Key"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Type"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Default"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Description"}]}]}]}]},{"type":"element","tag":"tbody","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"uri"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"string"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"process.env.MONGODB_URI"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Connection Uri String"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"options"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"ConnectOptions"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"{ }"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Connection Options"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"modelsDir"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"string"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"models"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"The models(schema) directory located in "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"server"}]},{"type":"text","value":" for auto-import"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"devtools"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"boolean"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Enable Mongoose module in "},{"type":"element","tag":"a","props":{"href":"https://github.com/nuxt/devtools","rel":["nofollow"]},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"Nuxt Devtools"}]}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-87f028{color:#0550AE}\n.ct-80cb1b{color:#0A3069}\n.ct-5905b4{color:#24292F}\n.ct-1c176f{color:#8250DF}\n.ct-49b0ce{color:#953800}\n.ct-feb825{color:#CF222E}\n.dark .ct-feb825{color:#FF7B72}\n.dark .ct-49b0ce{color:#FFA657}\n.dark .ct-1c176f{color:#D2A8FF}\n.dark .ct-5905b4{color:#C9D1D9}\n.dark .ct-80cb1b{color:#A5D6FF}\n.dark .ct-87f028{color:#79C0FF}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[]}},"_type":"markdown","_id":"content:1.getting-started:3.configuration.md","_source":"content","_file":"1.getting-started/3.configuration.md","_extension":"md"} \ No newline at end of file diff --git a/api/_content/query/kM9p24TYPU.1687082698783.json b/api/_content/query/kM9p24TYPU.1687082698783.json deleted file mode 100644 index ec39d60..0000000 --- a/api/_content/query/kM9p24TYPU.1687082698783.json +++ /dev/null @@ -1 +0,0 @@ -{"_path":"/api/utils","_dir":"api","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Utils","description":"Discover all available utils.","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"utils"},"children":[{"type":"text","value":"Utils"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Discover all available utils."}]},{"type":"element","tag":"h2","props":{"id":"definemongoosemodel"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"defineMongooseModel"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This function creates a new Mongoose model with schema. Example usage:"}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"export const User = defineMongooseModel({\n name: 'User',\n schema: {\n name: {\n type: String,\n required: true,\n },\n },\n options: {\n\n },\n})\n","filename":"named parameters","language":"ts","meta":"[named parameters]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-40e85d"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-17ea1e"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" name: "}]},{"type":"element","tag":"span","props":{"class":"ct-4a653e"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" schema: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" name: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" type: String,\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-40e85d"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":9},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" options: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":10},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":11},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":12},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"import { defineMongooseModel } from '#nuxt/mongoose'\n\nexport const User = defineMongooseModel('User', {\n name: {\n type: String,\n required: true,\n },\n}, {\n\n})\n","filename":"positional parameters","language":"ts","meta":"[positional parameters]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" { defineMongooseModel } "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4a653e"},"children":[{"type":"text","value":"'#nuxt/mongoose'\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-40e85d"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-17ea1e"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-4a653e"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":", {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" name: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" type: String,\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-40e85d"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":"}, {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":9},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":10},"children":[{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":"})"}]}]}]}]}]}]},{"type":"element","tag":"h2","props":{"id":"definemongooseconnection"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"defineMongooseConnection"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This function creates a new Mongoose connection."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"text","value":" 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 "},{"type":"element","tag":"a","props":{"href":"https://github.com/arashsheyda/nuxt-mongoose/blob/main/src/runtime/server/plugins/mongoose.db.ts","rel":["nofollow"]},"children":[{"type":"text","value":"here"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Example usage:"}]},{"type":"element","tag":"code","props":{"code":"import { defineMongooseConnection } from '#nuxt/mongoose'\n\nexport const connection = defineMongooseConnection('mongodb://127.0.0.1/nuxt-mongoose')\n","language":"ts","meta":null},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" { defineMongooseConnection } "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4a653e"},"children":[{"type":"text","value":"'#nuxt/mongoose'\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-40e85d"},"children":[{"type":"text","value":"connection"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-aac181"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-17ea1e"},"children":[{"type":"text","value":"defineMongooseConnection"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-4a653e"},"children":[{"type":"text","value":"'mongodb://127.0.0.1/nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-685cf2"},"children":[{"type":"text","value":")"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-4a653e{color:#0A3069}\n.ct-17ea1e{color:#8250DF}\n.ct-40e85d{color:#0550AE}\n.ct-685cf2{color:#24292F}\n.ct-aac181{color:#CF222E}\n.dark .ct-aac181{color:#FF7B72}\n.dark .ct-685cf2{color:#C9D1D9}\n.dark .ct-40e85d{color:#79C0FF}\n.dark .ct-17ea1e{color:#D2A8FF}\n.dark .ct-4a653e{color:#A5D6FF}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"definemongoosemodel","depth":2,"text":"defineMongooseModel"},{"id":"definemongooseconnection","depth":2,"text":"defineMongooseConnection"}]}},"_type":"markdown","_id":"content:2.api:1.utils.md","_source":"content","_file":"2.api/1.utils.md","_extension":"md"} \ No newline at end of file diff --git a/api/_content/query/kM9p24TYPU.1688901730600.json b/api/_content/query/kM9p24TYPU.1688901730600.json new file mode 100644 index 0000000..1b9ce6b --- /dev/null +++ b/api/_content/query/kM9p24TYPU.1688901730600.json @@ -0,0 +1 @@ +{"_path":"/api/utils","_dir":"api","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Utils","description":"Discover all available utils.","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"utils"},"children":[{"type":"text","value":"Utils"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Discover all available utils."}]},{"type":"element","tag":"h2","props":{"id":"definemongoosemodel"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"defineMongooseModel"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This function creates a new Mongoose model with schema. Example usage:"}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"export const User = defineMongooseModel({\n name: 'User',\n schema: {\n email: {\n type: 'string',\n required: true,\n unique: true,\n },\n },\n options: {\n \n },\n hooks(schema) {\n\n },\n})\n","filename":"named parameters","language":"ts","meta":"[named parameters]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a02dd3"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-84b3ee"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" name: "}]},{"type":"element","tag":"span","props":{"class":"ct-9b3feb"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" schema: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" email: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" type: "}]},{"type":"element","tag":"span","props":{"class":"ct-9b3feb"},"children":[{"type":"text","value":"'string'"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-a02dd3"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" unique: "}]},{"type":"element","tag":"span","props":{"class":"ct-a02dd3"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":9},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":10},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" options: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":11},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" \n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":12},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":13},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-84b3ee"},"children":[{"type":"text","value":"hooks"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-60c022"},"children":[{"type":"text","value":"schema"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":") {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":14},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":15},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":16},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"import { defineMongooseModel } from '#nuxt/mongoose'\n\nexport const User = defineMongooseModel('User', {\n email: {\n type: 'string',\n required: true,\n unique: true,\n },\n}, {\n \n}, (schema) => {\n\n})\n","filename":"positional parameters","language":"ts","meta":"[positional parameters]"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" { defineMongooseModel } "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-9b3feb"},"children":[{"type":"text","value":"'#nuxt/mongoose'\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a02dd3"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-84b3ee"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-9b3feb"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":", {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" email: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" type: "}]},{"type":"element","tag":"span","props":{"class":"ct-9b3feb"},"children":[{"type":"text","value":"'string'"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-a02dd3"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" unique: "}]},{"type":"element","tag":"span","props":{"class":"ct-a02dd3"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":9},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"}, {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":10},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" \n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":11},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"}, ("}]},{"type":"element","tag":"span","props":{"class":"ct-60c022"},"children":[{"type":"text","value":"schema"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":") "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":12},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":13},"children":[{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"})"}]}]}]}]}]}]},{"type":"element","tag":"table","props":{},"children":[{"type":"element","tag":"thead","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Key"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Type"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Require"}]}]},{"type":"element","tag":"th","props":{"align":null},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Description"}]}]}]}]},{"type":"element","tag":"tbody","props":{},"children":[{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"name"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"string"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Name of Model"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"schema"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"a","props":{"href":"https://mongoosejs.com/docs/schematypes.html","rel":["nofollow"]},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"SchemaDefinition"}]}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Schema Definition of Model"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"options"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"a","props":{"href":"https://mongoosejs.com/docs/guide.html#options","rel":["nofollow"]},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"SchemaOptions"}]}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"false"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Schema Options for Model"}]}]},{"type":"element","tag":"tr","props":{},"children":[{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"hooks"}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"element","tag":"a","props":{"href":"https://mongoosejs.com/docs/middleware.html","rel":["nofollow"]},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"(schema: Schema) => void"}]}]}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"false"}]},{"type":"element","tag":"td","props":{"align":null},"children":[{"type":"text","value":"Schema Hooks Function to customize Model"}]}]}]}]},{"type":"element","tag":"h2","props":{"id":"definemongooseconnection"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"defineMongooseConnection"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This function creates a new Mongoose connection."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"text","value":" 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 "},{"type":"element","tag":"a","props":{"href":"https://github.com/arashsheyda/nuxt-mongoose/blob/main/src/runtime/server/plugins/mongoose.db.ts","rel":["nofollow"]},"children":[{"type":"text","value":"here"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Example usage:"}]},{"type":"element","tag":"code","props":{"code":"import { defineMongooseConnection } from '#nuxt/mongoose'\n\nexport const connection = defineMongooseConnection('mongodb://127.0.0.1/nuxt-mongoose')\n","language":"ts","meta":null},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" { defineMongooseConnection } "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-9b3feb"},"children":[{"type":"text","value":"'#nuxt/mongoose'\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a02dd3"},"children":[{"type":"text","value":"connection"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-65741e"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-84b3ee"},"children":[{"type":"text","value":"defineMongooseConnection"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-9b3feb"},"children":[{"type":"text","value":"'mongodb://127.0.0.1/nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-3fd609"},"children":[{"type":"text","value":")"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-60c022{color:#953800}\n.ct-9b3feb{color:#0A3069}\n.ct-84b3ee{color:#8250DF}\n.ct-a02dd3{color:#0550AE}\n.ct-3fd609{color:#24292F}\n.ct-65741e{color:#CF222E}\n.dark .ct-65741e{color:#FF7B72}\n.dark .ct-3fd609{color:#C9D1D9}\n.dark .ct-a02dd3{color:#79C0FF}\n.dark .ct-84b3ee{color:#D2A8FF}\n.dark .ct-9b3feb{color:#A5D6FF}\n.dark .ct-60c022{color:#FFA657}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"definemongoosemodel","depth":2,"text":"defineMongooseModel"},{"id":"definemongooseconnection","depth":2,"text":"defineMongooseConnection"}]}},"_type":"markdown","_id":"content:2.api:1.utils.md","_source":"content","_file":"2.api/1.utils.md","_extension":"md"} \ No newline at end of file diff --git a/api/_content/query/nEPUGZ7imQ.1687082698783.json b/api/_content/query/nEPUGZ7imQ.1688901730600.json similarity index 100% rename from api/_content/query/nEPUGZ7imQ.1687082698783.json rename to api/_content/query/nEPUGZ7imQ.1688901730600.json diff --git a/api/_content/query/xWeY3NfYtX.1687082698783.json b/api/_content/query/xWeY3NfYtX.1688901730600.json similarity index 100% rename from api/_content/query/xWeY3NfYtX.1687082698783.json rename to api/_content/query/xWeY3NfYtX.1688901730600.json diff --git a/api/devtools/index.html b/api/devtools/index.html index d08d3a8..114bd79 100644 --- a/api/devtools/index.html +++ b/api/devtools/index.html @@ -8,7 +8,7 @@ - -
+
\ No newline at end of file diff --git a/api/utils/index.html b/api/utils/index.html index 399ef90..63fa2b0 100644 --- a/api/utils/index.html +++ b/api/utils/index.html @@ -8,38 +8,47 @@ - -

Utils

Discover all available utils.

defineMongooseModel

This function creates a new Mongoose model with schema. Example usage:

named parameters
export const User = defineMongooseModel({
-  name: 'User',
-  schema: {
-    name: {
-      type: String,
-      required: true,
-    },
-  },
-  options: {
-
-  },
-})
positional parameters
import { defineMongooseModel } from '#nuxt/mongoose'
+
Utils
Discover all available utils.
defineMongooseModel
This function creates a new Mongoose model with schema. Example usage:
named parameters
export const User = defineMongooseModel({
+  name: 'User',
+  schema: {
+    email: {
+      type: 'string',
+      required: true,
+      unique: true,
+    },
+  },
+  options: {
+    
+  },
+  hooks(schema) {
+
+  },
+})
positional parameters
import { defineMongooseModel } from '#nuxt/mongoose'
 
-export const User = defineMongooseModel('User', {
-  name: {
-    type: String,
-    required: true,
-  },
-}, {
-
-})
defineMongooseConnection
This 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 User = defineMongooseModel('User', {
+  email: {
+    type: 'string',
+    required: true,
+    unique: true,
+  },
+}, {
+  
+}, (schema) => {
+
+})
KeyTypeRequireDescription
namestringtrueName of Model
schemaSchemaDefinitiontrueSchema Definition of Model
optionsSchemaOptionsfalseSchema Options for Model
hooks(schema: Schema<T>) => voidfalseSchema Hooks Function to customize Model
defineMongooseConnection
This 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')
 Edit this page on GitHub
Table of Contents
+export const connection = defineMongooseConnection('mongodb://127.0.0.1/nuxt-mongoose')
Edit this page on GitHub
Table of Contents
\ No newline at end of file diff --git a/getting-started/configuration/index.html b/getting-started/configuration/index.html index 032c6b3..915ed1a 100644 --- a/getting-started/configuration/index.html +++ b/getting-started/configuration/index.html @@ -8,25 +8,25 @@ - -

Configuration

Configure Nuxt Mongoose with the mongoose property.

nuxt.config
export default defineNuxtConfig({
-  mongoose: {
-    uri: 'process.env.MONGODB_URI',
-    options: {},
-    modelsDir: 'models',
-    devtools: true,
-  },
-})
KeyTypeDefaultDescription
uristringprocess.env.MONGODB_URIConnection Uri String
optionsConnectOptions{ }Connection Options
modelsDirstringmodelsThe models(schema) directory located in server for auto-import
devtoolsbooleantrueEnable Mongoose module in Nuxt Devtools
Edit this page on GitHub
+

Configuration

Configure Nuxt Mongoose with the mongoose property.

nuxt.config
export default defineNuxtConfig({
+  mongoose: {
+    uri: 'process.env.MONGODB_URI',
+    options: {},
+    modelsDir: 'models',
+    devtools: true,
+  },
+})
KeyTypeDefaultDescription
uristringprocess.env.MONGODB_URIConnection Uri String
optionsConnectOptions{ }Connection Options
modelsDirstringmodelsThe models(schema) directory located in server for auto-import
devtoolsbooleantrueEnable Mongoose module in Nuxt Devtools
Edit this page on GitHub
\ No newline at end of file diff --git a/getting-started/setup/index.html b/getting-started/setup/index.html index b3809a8..89a8b66 100644 --- a/getting-started/setup/index.html +++ b/getting-started/setup/index.html @@ -8,29 +8,29 @@ - -

Setup

A Nuxt module for simplifying the use of Mongoose in your project.

Installation

  1. Install nuxt-mongoose to your dependencies.
pnpm
pnpm add nuxt-mongoose -D
npm
npm install nuxt-mongoose -D
yarn
yarn add nuxt-mongoose -D
  1. Add nuxt-mongoose to the modules section of your nuxt.config file.
nuxt.config
export default defineNuxtConfig({
-  modules: [
-    'nuxt-mongoose',
-  ],
-})
That's it! You can now use Mongoose in your Nuxt app ✨

Options

You can configure the module by adding a mongoose section to your nuxt.config file. -read more about Mongoose options.

nuxt.config
export default defineNuxtConfig({
-  mongoose: {
-    // Options
-  },
-})

If you want to configure only the uri just add MONGODB_URI in your .env file.

MONGODB_URI=YOUR_MONGO_URI
Edit this page on GitHub
Table of Contents
+

Setup

A Nuxt module for simplifying the use of Mongoose in your project.

Installation

  1. Install nuxt-mongoose to your dependencies.
pnpm
pnpm add nuxt-mongoose -D
npm
npm install nuxt-mongoose -D
yarn
yarn add nuxt-mongoose -D
  1. Add nuxt-mongoose to the modules section of your nuxt.config file.
nuxt.config
export default defineNuxtConfig({
+  modules: [
+    'nuxt-mongoose',
+  ],
+})
That's it! You can now use Mongoose in your Nuxt app ✨

Options

You can configure the module by adding a mongoose section to your nuxt.config file. +read more about Mongoose options.

nuxt.config
export default defineNuxtConfig({
+  mongoose: {
+    // Options
+  },
+})

If you want to configure only the uri just add MONGODB_URI in your .env file.

MONGODB_URI=YOUR_MONGO_URI
Edit this page on GitHub
Table of Contents
\ No newline at end of file diff --git a/index.html b/index.html index 7665466..8836ac8 100644 --- a/index.html +++ b/index.html @@ -8,7 +8,7 @@ - -
+
\ No newline at end of file