diff --git a/200.html b/200.html index 456adcb..7ff96d0 100644 --- a/200.html +++ b/200.html @@ -3,5 +3,5 @@ -
+
\ No newline at end of file diff --git a/404.html b/404.html index 456adcb..7ff96d0 100644 --- a/404.html +++ b/404.html @@ -3,5 +3,5 @@ -
+
\ No newline at end of file diff --git a/api/_content/cache.1686556462856.json b/api/_content/cache.1686556462856.json deleted file mode 100644 index d621c1f..0000000 --- a/api/_content/cache.1686556462856.json +++ /dev/null @@ -1 +0,0 @@ -{"generatedAt":1686556508963,"generateTime":12,"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 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-f55b83"},"children":[{"type":"text","value":"pnpm"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1e8567"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1e8567"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-205bd4"},"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-f55b83"},"children":[{"type":"text","value":"npm"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1e8567"},"children":[{"type":"text","value":"install"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1e8567"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-205bd4"},"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-f55b83"},"children":[{"type":"text","value":"yarn"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1e8567"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1e8567"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-205bd4"},"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-a1b7c7"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a1b7c7"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-07a57f"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":"modules: [\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1e8567"},"children":[{"type":"text","value":"'nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" ]"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"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-a1b7c7"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a1b7c7"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-07a57f"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-7c33cd"},"children":[{"type":"text","value":"// Options\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"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-7c33cd{color:#6E7781}\n.ct-07a57f{color:#8250DF}\n.ct-a1b7c7{color:#CF222E}\n.ct-205bd4{color:#0550AE}\n.ct-1e8567{color:#0A3069}\n.ct-5d1a64{color:#24292F}\n.ct-f55b83{color:#953800}\n.dark .ct-f55b83{color:#FFA657}\n.dark .ct-5d1a64{color:#C9D1D9}\n.dark .ct-1e8567{color:#A5D6FF}\n.dark .ct-205bd4{color:#79C0FF}\n.dark .ct-a1b7c7{color:#FF7B72}\n.dark .ct-07a57f{color:#D2A8FF}\n.dark .ct-7c33cd{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-d77ca7"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-c600fa"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-d77ca7"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-c600fa"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-6e8a64"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-c600fa"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-c600fa"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":" uri: "}]},{"type":"element","tag":"span","props":{"class":"ct-39678f"},"children":[{"type":"text","value":"'process.env.MONGODB_URI'"}]},{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":" options: {},\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":" modelsDir: "}]},{"type":"element","tag":"span","props":{"class":"ct-39678f"},"children":[{"type":"text","value":"'models'"}]},{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":" devtools: "}]},{"type":"element","tag":"span","props":{"class":"ct-f04568"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-c600fa"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-c600fa"},"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-f04568{color:#0550AE}\n.ct-39678f{color:#0A3069}\n.ct-8705ac{color:#24292F}\n.ct-6e8a64{color:#8250DF}\n.ct-c600fa{color:#953800}\n.ct-d77ca7{color:#CF222E}\n.dark .ct-d77ca7{color:#FF7B72}\n.dark .ct-c600fa{color:#FFA657}\n.dark .ct-6e8a64{color:#D2A8FF}\n.dark .ct-8705ac{color:#C9D1D9}\n.dark .ct-39678f{color:#A5D6FF}\n.dark .ct-f04568{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-4c37ed"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-034eae"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-782e1e"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" name: "}]},{"type":"element","tag":"span","props":{"class":"ct-c966eb"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" schema: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" name: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" type: String,\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-034eae"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":9},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"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-51c9b3"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":12},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"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-4c37ed"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" { defineMongooseModel } "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-c966eb"},"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-4c37ed"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-034eae"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-782e1e"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-c966eb"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":", {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" name: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" type: String,\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-034eae"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"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-51c9b3"},"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-4c37ed"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" { defineMongooseConnection } "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-c966eb"},"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-4c37ed"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-034eae"},"children":[{"type":"text","value":"connection"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-782e1e"},"children":[{"type":"text","value":"defineMongooseConnection"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-c966eb"},"children":[{"type":"text","value":"'mongodb://127.0.0.1/nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":")"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-c966eb{color:#0A3069}\n.ct-782e1e{color:#8250DF}\n.ct-034eae{color:#0550AE}\n.ct-51c9b3{color:#24292F}\n.ct-4c37ed{color:#CF222E}\n.dark .ct-4c37ed{color:#FF7B72}\n.dark .ct-51c9b3{color:#C9D1D9}\n.dark .ct-034eae{color:#79C0FF}\n.dark .ct-782e1e{color:#D2A8FF}\n.dark .ct-c966eb{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.1687080162517.json b/api/_content/cache.1687080162517.json new file mode 100644 index 0000000..f1ffedb --- /dev/null +++ b/api/_content/cache.1687080162517.json @@ -0,0 +1 @@ +{"generatedAt":1687080198257,"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 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-1d152a"},"children":[{"type":"text","value":"pnpm"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4d90c4"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4d90c4"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-063052"},"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-1d152a"},"children":[{"type":"text","value":"npm"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4d90c4"},"children":[{"type":"text","value":"install"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4d90c4"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-063052"},"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-1d152a"},"children":[{"type":"text","value":"yarn"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4d90c4"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4d90c4"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-063052"},"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-112590"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-112590"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-723136"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":"modules: [\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4d90c4"},"children":[{"type":"text","value":"'nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" ]"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"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-112590"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-112590"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-723136"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-838717"},"children":[{"type":"text","value":"// Options\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"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-838717{color:#6E7781}\n.ct-723136{color:#8250DF}\n.ct-112590{color:#CF222E}\n.ct-063052{color:#0550AE}\n.ct-4d90c4{color:#0A3069}\n.ct-526835{color:#24292F}\n.ct-1d152a{color:#953800}\n.dark .ct-1d152a{color:#FFA657}\n.dark .ct-526835{color:#C9D1D9}\n.dark .ct-4d90c4{color:#A5D6FF}\n.dark .ct-063052{color:#79C0FF}\n.dark .ct-112590{color:#FF7B72}\n.dark .ct-723136{color:#D2A8FF}\n.dark .ct-838717{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-94e3b8"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-c024d5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-94e3b8"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-c024d5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-61e900"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-c024d5"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-c024d5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":" uri: "}]},{"type":"element","tag":"span","props":{"class":"ct-34d5d8"},"children":[{"type":"text","value":"'process.env.MONGODB_URI'"}]},{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":" options: {},\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":" modelsDir: "}]},{"type":"element","tag":"span","props":{"class":"ct-34d5d8"},"children":[{"type":"text","value":"'models'"}]},{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":" devtools: "}]},{"type":"element","tag":"span","props":{"class":"ct-270808"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-c024d5"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-c024d5"},"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-270808{color:#0550AE}\n.ct-34d5d8{color:#0A3069}\n.ct-4111dd{color:#24292F}\n.ct-61e900{color:#8250DF}\n.ct-c024d5{color:#953800}\n.ct-94e3b8{color:#CF222E}\n.dark .ct-94e3b8{color:#FF7B72}\n.dark .ct-c024d5{color:#FFA657}\n.dark .ct-61e900{color:#D2A8FF}\n.dark .ct-4111dd{color:#C9D1D9}\n.dark .ct-34d5d8{color:#A5D6FF}\n.dark .ct-270808{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-570a20"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-89e7af"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-952c74"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" name: "}]},{"type":"element","tag":"span","props":{"class":"ct-898311"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" schema: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" name: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" type: String,\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-89e7af"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":9},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"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-5b4ed4"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":12},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"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-570a20"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" { defineMongooseModel } "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-898311"},"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-570a20"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-89e7af"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-952c74"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-898311"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":", {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" name: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" type: String,\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-89e7af"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"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-5b4ed4"},"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-570a20"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" { defineMongooseConnection } "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-898311"},"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-570a20"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-89e7af"},"children":[{"type":"text","value":"connection"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-952c74"},"children":[{"type":"text","value":"defineMongooseConnection"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-898311"},"children":[{"type":"text","value":"'mongodb://127.0.0.1/nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":")"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-898311{color:#0A3069}\n.ct-952c74{color:#8250DF}\n.ct-89e7af{color:#0550AE}\n.ct-5b4ed4{color:#24292F}\n.ct-570a20{color:#CF222E}\n.dark .ct-570a20{color:#FF7B72}\n.dark .ct-5b4ed4{color:#C9D1D9}\n.dark .ct-89e7af{color:#79C0FF}\n.dark .ct-952c74{color:#D2A8FF}\n.dark .ct-898311{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/navigation/u7BbTyuhiE.1686556462856.json b/api/_content/navigation/u7BbTyuhiE.1687080162517.json similarity index 100% rename from api/_content/navigation/u7BbTyuhiE.1686556462856.json rename to api/_content/navigation/u7BbTyuhiE.1687080162517.json diff --git a/api/_content/query/ESs0FnB4WF.1686556462856.json b/api/_content/query/ESs0FnB4WF.1687080162517.json similarity index 100% rename from api/_content/query/ESs0FnB4WF.1686556462856.json rename to api/_content/query/ESs0FnB4WF.1687080162517.json diff --git a/api/_content/query/VvGAWv4HRl.1686556462856.json b/api/_content/query/VvGAWv4HRl.1687080162517.json similarity index 100% rename from api/_content/query/VvGAWv4HRl.1686556462856.json rename to api/_content/query/VvGAWv4HRl.1687080162517.json diff --git a/api/_content/query/XBhGGyCXGR.1686556462856.json b/api/_content/query/XBhGGyCXGR.1687080162517.json similarity index 67% rename from api/_content/query/XBhGGyCXGR.1686556462856.json rename to api/_content/query/XBhGGyCXGR.1687080162517.json index 9b9e9b7..48b9a18 100644 --- a/api/_content/query/XBhGGyCXGR.1686556462856.json +++ b/api/_content/query/XBhGGyCXGR.1687080162517.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-f55b83"},"children":[{"type":"text","value":"pnpm"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1e8567"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1e8567"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-205bd4"},"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-f55b83"},"children":[{"type":"text","value":"npm"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1e8567"},"children":[{"type":"text","value":"install"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1e8567"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-205bd4"},"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-f55b83"},"children":[{"type":"text","value":"yarn"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1e8567"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1e8567"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-205bd4"},"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-a1b7c7"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a1b7c7"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-07a57f"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":"modules: [\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1e8567"},"children":[{"type":"text","value":"'nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" ]"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"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-a1b7c7"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a1b7c7"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-07a57f"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-7c33cd"},"children":[{"type":"text","value":"// Options\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-5d1a64"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-f55b83"},"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-7c33cd{color:#6E7781}\n.ct-07a57f{color:#8250DF}\n.ct-a1b7c7{color:#CF222E}\n.ct-205bd4{color:#0550AE}\n.ct-1e8567{color:#0A3069}\n.ct-5d1a64{color:#24292F}\n.ct-f55b83{color:#953800}\n.dark .ct-f55b83{color:#FFA657}\n.dark .ct-5d1a64{color:#C9D1D9}\n.dark .ct-1e8567{color:#A5D6FF}\n.dark .ct-205bd4{color:#79C0FF}\n.dark .ct-a1b7c7{color:#FF7B72}\n.dark .ct-07a57f{color:#D2A8FF}\n.dark .ct-7c33cd{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-1d152a"},"children":[{"type":"text","value":"pnpm"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4d90c4"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4d90c4"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-063052"},"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-1d152a"},"children":[{"type":"text","value":"npm"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4d90c4"},"children":[{"type":"text","value":"install"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4d90c4"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-063052"},"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-1d152a"},"children":[{"type":"text","value":"yarn"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4d90c4"},"children":[{"type":"text","value":"add"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4d90c4"},"children":[{"type":"text","value":"nuxt-mongoose"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-063052"},"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-112590"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-112590"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-723136"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":"modules: [\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4d90c4"},"children":[{"type":"text","value":"'nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" ]"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"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-112590"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-112590"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-723136"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-838717"},"children":[{"type":"text","value":"// Options\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-526835"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-1d152a"},"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-838717{color:#6E7781}\n.ct-723136{color:#8250DF}\n.ct-112590{color:#CF222E}\n.ct-063052{color:#0550AE}\n.ct-4d90c4{color:#0A3069}\n.ct-526835{color:#24292F}\n.ct-1d152a{color:#953800}\n.dark .ct-1d152a{color:#FFA657}\n.dark .ct-526835{color:#C9D1D9}\n.dark .ct-4d90c4{color:#A5D6FF}\n.dark .ct-063052{color:#79C0FF}\n.dark .ct-112590{color:#FF7B72}\n.dark .ct-723136{color:#D2A8FF}\n.dark .ct-838717{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.1686556462856.json b/api/_content/query/XtgCGvT2xN.1687080162517.json similarity index 100% rename from api/_content/query/XtgCGvT2xN.1686556462856.json rename to api/_content/query/XtgCGvT2xN.1687080162517.json diff --git a/api/_content/query/YIMd7yQcGd.1686556462856.json b/api/_content/query/YIMd7yQcGd.1687080162517.json similarity index 100% rename from api/_content/query/YIMd7yQcGd.1686556462856.json rename to api/_content/query/YIMd7yQcGd.1687080162517.json diff --git a/api/_content/query/brX4CwCJoQ.1686556462856.json b/api/_content/query/brX4CwCJoQ.1687080162517.json similarity index 100% rename from api/_content/query/brX4CwCJoQ.1686556462856.json rename to api/_content/query/brX4CwCJoQ.1687080162517.json diff --git a/api/_content/query/g9pY1CqBBn.1686556462856.json b/api/_content/query/g9pY1CqBBn.1687080162517.json similarity index 79% rename from api/_content/query/g9pY1CqBBn.1686556462856.json rename to api/_content/query/g9pY1CqBBn.1687080162517.json index 6d12e0c..1d7bc02 100644 --- a/api/_content/query/g9pY1CqBBn.1686556462856.json +++ b/api/_content/query/g9pY1CqBBn.1687080162517.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-d77ca7"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-c600fa"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-d77ca7"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-c600fa"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-6e8a64"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-c600fa"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-c600fa"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":" uri: "}]},{"type":"element","tag":"span","props":{"class":"ct-39678f"},"children":[{"type":"text","value":"'process.env.MONGODB_URI'"}]},{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":" options: {},\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":" modelsDir: "}]},{"type":"element","tag":"span","props":{"class":"ct-39678f"},"children":[{"type":"text","value":"'models'"}]},{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":" devtools: "}]},{"type":"element","tag":"span","props":{"class":"ct-f04568"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-8705ac"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-c600fa"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-c600fa"},"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-f04568{color:#0550AE}\n.ct-39678f{color:#0A3069}\n.ct-8705ac{color:#24292F}\n.ct-6e8a64{color:#8250DF}\n.ct-c600fa{color:#953800}\n.ct-d77ca7{color:#CF222E}\n.dark .ct-d77ca7{color:#FF7B72}\n.dark .ct-c600fa{color:#FFA657}\n.dark .ct-6e8a64{color:#D2A8FF}\n.dark .ct-8705ac{color:#C9D1D9}\n.dark .ct-39678f{color:#A5D6FF}\n.dark .ct-f04568{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-94e3b8"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-c024d5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-94e3b8"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-c024d5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-61e900"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-c024d5"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-c024d5"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":"mongoose: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":" uri: "}]},{"type":"element","tag":"span","props":{"class":"ct-34d5d8"},"children":[{"type":"text","value":"'process.env.MONGODB_URI'"}]},{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":" options: {},\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":" modelsDir: "}]},{"type":"element","tag":"span","props":{"class":"ct-34d5d8"},"children":[{"type":"text","value":"'models'"}]},{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":" devtools: "}]},{"type":"element","tag":"span","props":{"class":"ct-270808"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-4111dd"},"children":[{"type":"text","value":" }"}]},{"type":"element","tag":"span","props":{"class":"ct-c024d5"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-c024d5"},"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-270808{color:#0550AE}\n.ct-34d5d8{color:#0A3069}\n.ct-4111dd{color:#24292F}\n.ct-61e900{color:#8250DF}\n.ct-c024d5{color:#953800}\n.ct-94e3b8{color:#CF222E}\n.dark .ct-94e3b8{color:#FF7B72}\n.dark .ct-c024d5{color:#FFA657}\n.dark .ct-61e900{color:#D2A8FF}\n.dark .ct-4111dd{color:#C9D1D9}\n.dark .ct-34d5d8{color:#A5D6FF}\n.dark .ct-270808{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.1686556462856.json b/api/_content/query/kM9p24TYPU.1687080162517.json similarity index 61% rename from api/_content/query/kM9p24TYPU.1686556462856.json rename to api/_content/query/kM9p24TYPU.1687080162517.json index b702adb..c723484 100644 --- a/api/_content/query/kM9p24TYPU.1686556462856.json +++ b/api/_content/query/kM9p24TYPU.1687080162517.json @@ -1 +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 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-4c37ed"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-034eae"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-782e1e"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" name: "}]},{"type":"element","tag":"span","props":{"class":"ct-c966eb"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" schema: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" name: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" type: String,\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-034eae"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":9},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"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-51c9b3"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":12},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"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-4c37ed"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" { defineMongooseModel } "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-c966eb"},"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-4c37ed"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-034eae"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-782e1e"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-c966eb"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":", {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" name: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" type: String,\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-034eae"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"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-51c9b3"},"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-4c37ed"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" { defineMongooseConnection } "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-c966eb"},"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-4c37ed"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-034eae"},"children":[{"type":"text","value":"connection"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-4c37ed"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-782e1e"},"children":[{"type":"text","value":"defineMongooseConnection"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-c966eb"},"children":[{"type":"text","value":"'mongodb://127.0.0.1/nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-51c9b3"},"children":[{"type":"text","value":")"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-c966eb{color:#0A3069}\n.ct-782e1e{color:#8250DF}\n.ct-034eae{color:#0550AE}\n.ct-51c9b3{color:#24292F}\n.ct-4c37ed{color:#CF222E}\n.dark .ct-4c37ed{color:#FF7B72}\n.dark .ct-51c9b3{color:#C9D1D9}\n.dark .ct-034eae{color:#79C0FF}\n.dark .ct-782e1e{color:#D2A8FF}\n.dark .ct-c966eb{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 +{"_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-570a20"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-89e7af"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-952c74"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":"({\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" name: "}]},{"type":"element","tag":"span","props":{"class":"ct-898311"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" schema: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" name: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" type: String,\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-89e7af"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":9},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"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-5b4ed4"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":12},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"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-570a20"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" { defineMongooseModel } "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-898311"},"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-570a20"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-89e7af"},"children":[{"type":"text","value":"User"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-952c74"},"children":[{"type":"text","value":"defineMongooseModel"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-898311"},"children":[{"type":"text","value":"'User'"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":", {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" name: {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" type: String,\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" required: "}]},{"type":"element","tag":"span","props":{"class":"ct-89e7af"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" },\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"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-5b4ed4"},"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-570a20"},"children":[{"type":"text","value":"import"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" { defineMongooseConnection } "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"from"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-898311"},"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-570a20"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-89e7af"},"children":[{"type":"text","value":"connection"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-570a20"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-952c74"},"children":[{"type":"text","value":"defineMongooseConnection"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-898311"},"children":[{"type":"text","value":"'mongodb://127.0.0.1/nuxt-mongoose'"}]},{"type":"element","tag":"span","props":{"class":"ct-5b4ed4"},"children":[{"type":"text","value":")"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-898311{color:#0A3069}\n.ct-952c74{color:#8250DF}\n.ct-89e7af{color:#0550AE}\n.ct-5b4ed4{color:#24292F}\n.ct-570a20{color:#CF222E}\n.dark .ct-570a20{color:#FF7B72}\n.dark .ct-5b4ed4{color:#C9D1D9}\n.dark .ct-89e7af{color:#79C0FF}\n.dark .ct-952c74{color:#D2A8FF}\n.dark .ct-898311{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/nEPUGZ7imQ.1686556462856.json b/api/_content/query/nEPUGZ7imQ.1687080162517.json similarity index 100% rename from api/_content/query/nEPUGZ7imQ.1686556462856.json rename to api/_content/query/nEPUGZ7imQ.1687080162517.json diff --git a/api/_content/query/xWeY3NfYtX.1686556462856.json b/api/_content/query/xWeY3NfYtX.1687080162517.json similarity index 100% rename from api/_content/query/xWeY3NfYtX.1686556462856.json rename to api/_content/query/xWeY3NfYtX.1687080162517.json diff --git a/api/devtools/index.html b/api/devtools/index.html index 19b2b79..7c4ec2e 100644 --- a/api/devtools/index.html +++ b/api/devtools/index.html @@ -7,7 +7,7 @@ - -
+
\ No newline at end of file diff --git a/api/utils/index.html b/api/utils/index.html index bf430f7..7e8d1e3 100644 --- a/api/utils/index.html +++ b/api/utils/index.html @@ -7,38 +7,38 @@ - -

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: {
+
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'
+  },
+})
positional parameters
import { defineMongooseModel } from '#nuxt/mongoose'
 
-export const User = defineMongooseModel('User', {
-  name: {
-    type: String,
-    required: true,
-  },
-}, {
+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'
+})
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 cfd2e3b..6b9c44e 100644 --- a/getting-started/configuration/index.html +++ b/getting-started/configuration/index.html @@ -7,25 +7,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 1c381d9..f1f9cb8 100644 --- a/getting-started/setup/index.html +++ b/getting-started/setup/index.html @@ -7,29 +7,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 5b96ecf..0cca78c 100644 --- a/index.html +++ b/index.html @@ -7,7 +7,7 @@ - -
+
\ No newline at end of file