[{"data":1,"prerenderedAt":493},["ShallowReactive",2],{"navigation":3,"/guide/installation":67,"/guide/installation-surround":490},[4,22,51],{"title":5,"path":6,"stem":7,"children":8,"page":21},"Guide","/guide","1.guide",[9,13,17],{"title":10,"path":11,"stem":12},"Installation","/guide/installation","1.guide/1.installation",{"title":14,"path":15,"stem":16},"Configuration","/guide/configuration","1.guide/2.configuration",{"title":18,"path":19,"stem":20},"Hooks","/guide/hooks","1.guide/3.hooks",false,{"title":23,"path":24,"stem":25,"children":26,"page":21},"Composables","/composables","2.composables",[27,31,35,39,43,47],{"title":28,"path":29,"stem":30},"useSurreal","/composables/use-surreal","2.composables/1.use-surreal",{"title":32,"path":33,"stem":34},"useSurrealAsyncData","/composables/use-surreal-async-data","2.composables/2.use-surreal-async-data",{"title":36,"path":37,"stem":38},"useSurrealQuery","/composables/use-surreal-query","2.composables/3.use-surreal-query",{"title":40,"path":41,"stem":42},"useSurrealSelect","/composables/use-surreal-select","2.composables/4.use-surreal-select",{"title":44,"path":45,"stem":46},"useSurrealAuth","/composables/use-surreal-auth","2.composables/5.use-surreal-auth",{"title":48,"path":49,"stem":50},"Other Composables","/composables/other-composables","2.composables/6.other-composables",{"title":52,"path":53,"stem":54,"children":55,"page":21},"Server","/server","3.server",[56,59,63],{"title":28,"path":57,"stem":58},"/server/use-surreal","3.server/1.use-surreal",{"title":60,"path":61,"stem":62},"useSurrealMemory","/server/use-surreal-memory","3.server/2.use-surreal-memory",{"title":64,"path":65,"stem":66},"useSurrealLocal","/server/use-surreal-local","3.server/3.use-surreal-local",{"id":68,"title":10,"body":69,"description":481,"extension":482,"head":483,"links":483,"meta":484,"navigation":486,"ogImage":483,"path":11,"robots":483,"schemaOrg":483,"seo":487,"sitemap":488,"stem":12,"__hash__":489},"docs/1.guide/1.installation.md",{"type":70,"value":71,"toc":473},"minimark",[72,77,81,90,161,165,175,246,249,391,394,398,405,410,413,427,445,449,452,466,469],[73,74,76],"h1",{"id":75},"setup","Setup",[78,79,10],"h2",{"id":80},"installation",[82,83,84,85,89],"p",{},"Install ",[86,87,88],"code",{},"nuxt-surrealdb"," in your Nuxt application.",[91,92,93,118,133,147],"code-group",{},[94,95,101],"pre",{"className":96,"code":97,"filename":98,"language":99,"meta":100,"style":100},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","pnpm add nuxt-surrealdb\n","pnpm","bash","",[86,102,103],{"__ignoreMap":100},[104,105,108,111,115],"span",{"class":106,"line":107},"line",1,[104,109,98],{"class":110},"sBMFI",[104,112,114],{"class":113},"sfazB"," add",[104,116,117],{"class":113}," nuxt-surrealdb\n",[94,119,122],{"className":96,"code":120,"filename":121,"language":99,"meta":100,"style":100},"npm install nuxt-surrealdb\n","npm",[86,123,124],{"__ignoreMap":100},[104,125,126,128,131],{"class":106,"line":107},[104,127,121],{"class":110},[104,129,130],{"class":113}," install",[104,132,117],{"class":113},[94,134,137],{"className":96,"code":135,"filename":136,"language":99,"meta":100,"style":100},"bun add nuxt-surrealdb\n","bun",[86,138,139],{"__ignoreMap":100},[104,140,141,143,145],{"class":106,"line":107},[104,142,136],{"class":110},[104,144,114],{"class":113},[104,146,117],{"class":113},[94,148,151],{"className":96,"code":149,"filename":150,"language":99,"meta":100,"style":100},"yarn add nuxt-surrealdb\n","yarn",[86,152,153],{"__ignoreMap":100},[104,154,155,157,159],{"class":106,"line":107},[104,156,150],{"class":110},[104,158,114],{"class":113},[104,160,117],{"class":113},[78,162,164],{"id":163},"getting-started","Getting started",[82,166,167,168,170,171,174],{},"Add ",[86,169,88],{}," to your modules in ",[86,172,173],{},"nuxt.config.ts",":",[94,176,180],{"className":177,"code":178,"filename":173,"language":179,"meta":100,"style":100},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","export default defineNuxtConfig({\n  modules: [\n    'nuxt-surrealdb',\n  ],\n})\n","ts",[86,181,182,203,215,229,237],{"__ignoreMap":100},[104,183,184,188,191,195,199],{"class":106,"line":107},[104,185,187],{"class":186},"s7zQu","export",[104,189,190],{"class":186}," default",[104,192,194],{"class":193},"s2Zo4"," defineNuxtConfig",[104,196,198],{"class":197},"sTEyZ","(",[104,200,202],{"class":201},"sMK4o","{\n",[104,204,206,210,212],{"class":106,"line":205},2,[104,207,209],{"class":208},"swJcz","  modules",[104,211,174],{"class":201},[104,213,214],{"class":197}," [\n",[104,216,218,221,223,226],{"class":106,"line":217},3,[104,219,220],{"class":201},"    '",[104,222,88],{"class":113},[104,224,225],{"class":201},"'",[104,227,228],{"class":201},",\n",[104,230,232,235],{"class":106,"line":231},4,[104,233,234],{"class":197},"  ]",[104,236,228],{"class":201},[104,238,240,243],{"class":106,"line":239},5,[104,241,242],{"class":201},"}",[104,244,245],{"class":197},")\n",[82,247,248],{},"Then configure your SurrealDB endpoint:",[94,250,252],{"className":177,"code":251,"filename":173,"language":179,"meta":100,"style":100},"export default defineNuxtConfig({\n  modules: ['nuxt-surrealdb'],\n  surrealdb: {\n    client: {\n      endpoint: 'http://localhost:8000',\n      connectOptions: {\n        namespace: 'my_ns',\n        database: 'my_db',\n      },\n    },\n  },\n})\n",[86,253,254,266,286,296,305,322,332,349,366,372,378,384],{"__ignoreMap":100},[104,255,256,258,260,262,264],{"class":106,"line":107},[104,257,187],{"class":186},[104,259,190],{"class":186},[104,261,194],{"class":193},[104,263,198],{"class":197},[104,265,202],{"class":201},[104,267,268,270,272,275,277,279,281,284],{"class":106,"line":205},[104,269,209],{"class":208},[104,271,174],{"class":201},[104,273,274],{"class":197}," [",[104,276,225],{"class":201},[104,278,88],{"class":113},[104,280,225],{"class":201},[104,282,283],{"class":197},"]",[104,285,228],{"class":201},[104,287,288,291,293],{"class":106,"line":217},[104,289,290],{"class":208},"  surrealdb",[104,292,174],{"class":201},[104,294,295],{"class":201}," {\n",[104,297,298,301,303],{"class":106,"line":231},[104,299,300],{"class":208},"    client",[104,302,174],{"class":201},[104,304,295],{"class":201},[104,306,307,310,312,315,318,320],{"class":106,"line":239},[104,308,309],{"class":208},"      endpoint",[104,311,174],{"class":201},[104,313,314],{"class":201}," '",[104,316,317],{"class":113},"http://localhost:8000",[104,319,225],{"class":201},[104,321,228],{"class":201},[104,323,325,328,330],{"class":106,"line":324},6,[104,326,327],{"class":208},"      connectOptions",[104,329,174],{"class":201},[104,331,295],{"class":201},[104,333,335,338,340,342,345,347],{"class":106,"line":334},7,[104,336,337],{"class":208},"        namespace",[104,339,174],{"class":201},[104,341,314],{"class":201},[104,343,344],{"class":113},"my_ns",[104,346,225],{"class":201},[104,348,228],{"class":201},[104,350,352,355,357,359,362,364],{"class":106,"line":351},8,[104,353,354],{"class":208},"        database",[104,356,174],{"class":201},[104,358,314],{"class":201},[104,360,361],{"class":113},"my_db",[104,363,225],{"class":201},[104,365,228],{"class":201},[104,367,369],{"class":106,"line":368},9,[104,370,371],{"class":201},"      },\n",[104,373,375],{"class":106,"line":374},10,[104,376,377],{"class":201},"    },\n",[104,379,381],{"class":106,"line":380},11,[104,382,383],{"class":201},"  },\n",[104,385,387,389],{"class":106,"line":386},12,[104,388,242],{"class":201},[104,390,245],{"class":197},[82,392,393],{},"That's it! You can now use Nuxt SurrealDB in your Nuxt app.",[78,395,397],{"id":396},"optional-peer-dependencies","Optional peer dependencies",[82,399,400,401,404],{},"The core module uses the ",[86,402,403],{},"surrealdb"," JavaScript SDK to connect to a remote SurrealDB instance. For embedded (in-process) engines, install the optional peer dependencies:",[406,407,409],"h3",{"id":408},"client-side-wasm-engine","Client-side WASM engine",[82,411,412],{},"To run SurrealDB in-memory or with IndexedDB storage on the client side:",[94,414,416],{"className":96,"code":415,"language":99,"meta":100,"style":100},"pnpm add @surrealdb/wasm\n",[86,417,418],{"__ignoreMap":100},[104,419,420,422,424],{"class":106,"line":107},[104,421,98],{"class":110},[104,423,114],{"class":113},[104,425,426],{"class":113}," @surrealdb/wasm\n",[428,429,430],"warning",{},[82,431,432,433,436,437,440,441,444],{},"The IndexedDB (",[86,434,435],{},"indxdb://",") WASM engine is currently not fully supported with ",[86,438,439],{},"SurrealDB 3.0",". In-memory (",[86,442,443],{},"mem://",") mode works as expected.",[406,446,448],{"id":447},"server-side-node-engine","Server-side Node engine",[82,450,451],{},"To run SurrealDB in-memory or with SurrealKV local storage on the server side:",[94,453,455],{"className":96,"code":454,"language":99,"meta":100,"style":100},"pnpm add @surrealdb/node\n",[86,456,457],{"__ignoreMap":100},[104,458,459,461,463],{"class":106,"line":107},[104,460,98],{"class":110},[104,462,114],{"class":113},[104,464,465],{"class":113}," @surrealdb/node\n",[82,467,468],{},"The module auto-detects which packages are available and enables the corresponding features automatically.",[470,471,472],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}",{"title":100,"searchDepth":107,"depth":205,"links":474},[475,476,477],{"id":80,"depth":205,"text":10},{"id":163,"depth":205,"text":164},{"id":396,"depth":205,"text":397,"children":478},[479,480],{"id":408,"depth":217,"text":409},{"id":447,"depth":217,"text":448},"Learn how to install Nuxt SurrealDB in your Nuxt application","md",null,{"icon":485},"i-lucide-arrow-right",true,{"title":10,"description":481},{"loc":11},"3g43naXFvjwYW6RpKLugOUZw1P1F7y1F-i17aZdij9k",[483,491],{"title":14,"path":15,"stem":16,"description":492,"children":-1},"Learn how to configure Nuxt SurrealDB in your Nuxt application",1772382803205]