You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-14Lines changed: 4 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,8 @@ MongoDB Client Encryption
3
3
4
4
The Node.js wrapper for [`libmongocrypt`](../../README.md)
5
5
6
+
**Note** This library provides encryption functionality for the MongoDB Node.js driver but is **not intended** to be consumed in isolation. The public API that uses the functionality in this library is available in the `mongodb` package. We reserve the right to make breaking changes to `mongodb-client-encryption` that fall outside of semver.
7
+
6
8
### Installation
7
9
8
10
You can install `mongodb-client-encryption` with the following:
@@ -28,18 +30,6 @@ To lint the Typescript, you can run `npm run check:eslint -- --fix`. To lint th
28
30
29
31
#### Testing
30
32
31
-
Some tests require a standalone server to be running with authentication enabled. Set up a single
32
-
server running with the following conditions:
33
-
34
-
| param | value |
35
-
|-----------|-----------|
36
-
| host | localhost |
37
-
| port | 27017 |
38
-
39
-
This is the standard setup for a standalone server with no authentication.
33
+
The unit tests require the binding to be built. Run `npm run rebuild` to build the addon from the c++ source. Then the tests can be run with `npm test`.
40
34
41
-
Run the test suite using:
42
-
43
-
```bash
44
-
npm test
45
-
```
35
+
Note: changes to c++ source are not automatically re-compiled. One needs to rebuild the bindings after each change.
0 commit comments