Skip to content

Commit 7ab235b

Browse files
committed
add custom runtime documentation
1 parent d6f1c95 commit 7ab235b

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,16 @@ If you run into any unexpected compiler failures against our supported TypeScrip
101101

102102
Additionally, our Typescript types are compatible with the ECMAScript standard for our minimum supported Node version. Currently, our Typescript targets es2023.
103103

104+
#### Running in Custom Runtimes
105+
106+
We are working on removing NodeJS as a dependency of the driver, so that in the future it will be possible to use the drive in non-Node environments.
107+
This work is currently in progress, and if you're curious, this is [our first runtime adapter commit](https://github.com/mongodb/node-mongodb-native/commit/d2ad07f20903d86334da81222a6df9717f76faaa).
108+
109+
Some things to keep in mind if you are using a non-Node runtime:
110+
111+
1. Users of Webpack/Vite may need to prevent `crypto` polyfill injection.
112+
2. Auth mechanism SCRAM-SHA-1 has a hard dependency on NodeJS and is not supported in FIPS mode.
113+
104114
## Installation
105115

106116
The recommended way to get started using the Node.js driver is by using the `npm` (Node Package Manager) to install the dependency in your project.

0 commit comments

Comments
 (0)