Skip to content

Commit 4353bcf

Browse files
authored
chore: add note about install Node.js type definitions (#2982)
1 parent 3915ea8 commit 4353bcf

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ The official [MongoDB](https://www.mongodb.com/) driver for Node.js.
99
| what | where |
1010
| ------------- | ------------------------------------------------------------------------------------------------------ |
1111
| documentation | [docs.mongodb.com/drivers/node](https://docs.mongodb.com/drivers/node) |
12-
| api-doc | [mongodb.github.io/node-mongodb-native/4.0/](https://mongodb.github.io/node-mongodb-native/4.0/) |
12+
| api-doc | [mongodb.github.io/node-mongodb-native/4.1/](https://mongodb.github.io/node-mongodb-native/4.1/) |
1313
| npm package | [www.npmjs.com/package/mongodb](https://www.npmjs.com/package/mongodb) |
1414
| source | [github.com/mongodb/node-mongodb-native](https://github.com/mongodb/node-mongodb-native) |
1515
| mongodb | [www.mongodb.com](https://www.mongodb.com) |
1616
| changelog | [HISTORY.md](https://github.com/mongodb/node-mongodb-native/blob/4.1/HISTORY.md) |
17-
| upgrade to v4 | [docs/CHANGES_4.0.0.md](https://github.com/mongodb/node-mongodb-native/blob/4.0/docs/CHANGES_4.0.0.md) |
17+
| upgrade to v4 | [docs/CHANGES_4.0.0.md](https://github.com/mongodb/node-mongodb-native/blob/4.1/docs/CHANGES_4.0.0.md) |
1818

1919
### Bugs / Feature Requests
2020

@@ -34,7 +34,7 @@ For issues with, questions about, or feedback for the Node.js driver, please loo
3434

3535
### Change Log
3636

37-
Change history can be found in [`HISTORY.md`](https://github.com/mongodb/node-mongodb-native/blob/4.0/HISTORY.md).
37+
Change history can be found in [`HISTORY.md`](https://github.com/mongodb/node-mongodb-native/blob/4.1/HISTORY.md).
3838

3939
### Compatibility
4040

@@ -51,7 +51,7 @@ If you run into any unexpected compiler failures please let us know and we will
5151

5252
## Installation
5353

54-
The recommended way to get started using the Node.js 4.0 driver is by using the `npm` (Node Package Manager) to install the dependency in your project.
54+
The recommended way to get started using the Node.js 4.x driver is by using the `npm` (Node Package Manager) to install the dependency in your project.
5555

5656
After you've created your own project using `npm init`, you can run:
5757

@@ -63,6 +63,12 @@ yarn add mongodb
6363

6464
This will download the MongoDB driver and add a dependency entry in your `package.json` file.
6565

66+
If you are a Typescript user, you will need the Node.js type definitions to use the driver's definitions:
67+
68+
```sh
69+
npm install -D @types/node
70+
```
71+
6672
## Troubleshooting
6773

6874
The MongoDB driver depends on several other packages. These are:

0 commit comments

Comments
 (0)