A Node.js engine for the SurrealDB JavaScript SDK.
\n\n \n\n
\n \n \n \n \n \n
\n\n
\n \n \n \n \n \n \n \n
\n\n# @surrealdb/node\n\nA Node.js engine for the SurrealDB [JavaScript SDK](https://github.com/surrealdb/surrealdb.js).\n\nThis library is a plugin for the SurrealDB JavaScript SDK, which can be used to run SurrealDB as an embedded database within a Node.js server side environment.\n\nIt enables SurrealDB to be run in-memory, or to persist data by running on top of SurrealKV. It allows for a consistent JavaScript and TypeScript API when using the `surrealdb.js` library by adding support for embedded storage engines (`memory`, `surrealkv`) alongside the remote connection protocols (`http`, `https`, `ws`, `wss`).\n\n## Example usage\n\n```js\nimport { Surreal } from 'surrealdb';\nimport { surrealdbNodeEngines } from '@surrealdb/node';\n\n// Enable the WebAssembly engines\nconst db = new Surreal({\n engines: surrealdbNodeEngines(),\n});\n\n// Now we can start SurrealDB as an in-memory database\nawait db.connect(\"mem://\");\n// Or we can start a persisted SurrealKV database\nawait db.connect(\"surrealkv://demo\");\n\n// Now use the JavaScript SDK as normal.\n```\n","readmeFilename":"README.md"}
![](\"https://raw.githubusercontent.com/surrealdb/icons/main/surreal.svg\"){kind=icon}
\n \n ![](\"https://raw.githubusercontent.com/surrealdb/icons/main/nodejs.svg\"){kind=icon}
\n![](\"https://img.shields.io/badge/status-beta-ff00bb.svg?style=flat-square\"){kind=icon}
\n \n ![](\"https://img.shields.io/badge/docs-view-44cc11.svg?style=flat-square\"){kind=icon}
\n \n ![](\"https://img.shields.io/npm/v/surrealdb.node?style=flat-square\")
![](\"https://img.shields.io/discord/902568124350599239?label=discord&style=flat-square&color=5a66f6\")
![](\"https://img.shields.io/badge/twitter-follow_us-1d9bf0.svg?style=flat-square\"){kind=icon}
\n \n ![](\"https://img.shields.io/badge/linkedin-connect_with_us-0a66c2.svg?style=flat-square\"){kind=icon}
\n \n ![](\"https://img.shields.io/badge/youtube-subscribe-fc1c1c.svg?style=flat-square\"){kind=icon}
\n