Skip to content

Commit ee50713

Browse files
Merge branch 'main' into NODE-6040
2 parents 3ba6c54 + 13bf3c9 commit ee50713

21 files changed

+302
-199
lines changed

.evergreen/run-serverless-tests.sh

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ if [ -z ${SERVERLESS_ATLAS_PASSWORD+omitted} ]; then echo "SERVERLESS_ATLAS_PASS
1212

1313
npx mocha \
1414
--config test/mocha_mongodb.json \
15-
test/integration/crud/crud.spec.test.js \
16-
test/integration/crud/crud.prose.test.js \
17-
test/integration/retryable-reads/retryable_reads.spec.test.js \
15+
test/integration/crud/crud.spec.test.ts \
16+
test/integration/crud/crud.prose.test.ts \
17+
test/integration/retryable-reads/retryable_reads.spec.test.ts \
1818
test/integration/retryable-writes/retryable_writes.spec.test.ts \
1919
test/integration/sessions/sessions.spec.test.ts \
2020
test/integration/sessions/sessions.prose.test.ts \
2121
test/integration/sessions/sessions.test.ts \
22-
test/integration/transactions/transactions.spec.test.js \
22+
test/integration/transactions/transactions.spec.test.ts \
2323
test/integration/transactions/transactions.test.ts \
24-
test/integration/versioned-api/versioned_api.spec.test.js \
25-
test/integration/load-balancers/load_balancers.spec.test.js \
24+
test/integration/versioned-api/versioned_api.spec.test.ts \
25+
test/integration/load-balancers/load_balancers.spec.test.ts \
2626
test/integration/client-side-encryption/client_side_encryption.spec.test.ts \
2727
test/integration/run-command/run_command.spec.test.ts

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ These are the commit types we make use of:
9797
Below are some conventions that aren't enforced by any of our tooling but we nonetheless do our best to adhere to:
9898

9999
- **Disallow `export default` syntax**
100-
- For our use case it is best if all imports / exports remain named.
100+
- For our use case, it is best if all imports / exports remain named.
101101
- **As of 4.0 all code in src is in Typescript**
102102
- Typescript provides a nice developer experience.
103103
As a product of using TS, we should be using ES6 syntax features whenever possible.

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ The following table describes add-on component version compatibility for the Nod
6464

6565
We recommend using the latest version of typescript, however we currently ensure the driver's public types compile against `[email protected]`.
6666
This is the lowest typescript version guaranteed to work with our driver: older versions may or may not work - use at your own risk.
67-
Since typescript [does not restrict breaking changes to major versions](https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes) we consider this support best effort.
68-
If you run into any unexpected compiler failures against our supported TypeScript versions please let us know by filing an issue on our [JIRA](https://jira.mongodb.org/browse/NODE).
67+
Since typescript [does not restrict breaking changes to major versions](https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes), we consider this support best effort.
68+
If you run into any unexpected compiler failures against our supported TypeScript versions, please let us know by filing an issue on our [JIRA](https://jira.mongodb.org/browse/NODE).
6969

7070
## Installation
7171

@@ -153,13 +153,13 @@ Add code to connect to the server and the database **myProject**:
153153

154154
> **NOTE:** Resolving DNS Connection issues
155155
>
156-
> Node.js 18 changed the default DNS resolution ordering from always prioritizing ipv4 to the ordering
156+
> Node.js 18 changed the default DNS resolution ordering from always prioritizing IPv4 to the ordering
157157
> returned by the DNS provider. In some environments, this can result in `localhost` resolving to
158-
> an ipv6 address instead of ipv4 and a consequent failure to connect to the server.
158+
> an IPv6 address instead of IPv4 and a consequent failure to connect to the server.
159159
>
160160
> This can be resolved by:
161161
>
162-
> - specifying the ip address family using the MongoClient `family` option (`MongoClient(<uri>, { family: 4 } )`)
162+
> - specifying the IP address family using the MongoClient `family` option (`MongoClient(<uri>, { family: 4 } )`)
163163
> - launching mongod or mongos with the ipv6 flag enabled ([--ipv6 mongod option documentation](https://www.mongodb.com/docs/manual/reference/program/mongod/#std-option-mongod.--ipv6))
164164
> - using a host of `127.0.0.1` in place of localhost
165165
> - specifying the DNS resolution ordering with the `--dns-resolution-order` Node.js command line argument (e.g. `node --dns-resolution-order=ipv4first`)
@@ -224,7 +224,7 @@ console.log('Found documents =>', findResult);
224224
```
225225

226226
This query returns all the documents in the **documents** collection.
227-
If you add this below the insertMany example you'll see the document's you've inserted.
227+
If you add this below the insertMany example, you'll see the documents you've inserted.
228228

229229
### Find Documents with a Query Filter
230230

@@ -272,7 +272,7 @@ For more detailed information, see the [indexing strategies page](https://www.mo
272272

273273
## Error Handling
274274

275-
If you need to filter certain errors from our driver we have a helpful tree of errors described in [etc/notes/errors.md](https://github.com/mongodb/node-mongodb-native/blob/HEAD/etc/notes/errors.md).
275+
If you need to filter certain errors from our driver, we have a helpful tree of errors described in [etc/notes/errors.md](https://github.com/mongodb/node-mongodb-native/blob/HEAD/etc/notes/errors.md).
276276

277277
It is our recommendation to use `instanceof` checks on errors and to avoid relying on parsing `error.message` and `error.name` strings in your code.
278278
We guarantee `instanceof` checks will pass according to semver guidelines, but errors may be sub-classed or their messages may change at any time, even patch releases, as we see fit to increase the helpfulness of the errors.
@@ -298,14 +298,14 @@ try {
298298

299299
## Nightly releases
300300

301-
If you need to test with a change from the latest `main` branch our `mongodb` npm package has nightly versions released under the `nightly` tag.
301+
If you need to test with a change from the latest `main` branch, our `mongodb` npm package has nightly versions released under the `nightly` tag.
302302

303303
```sh
304304
npm install mongodb@nightly
305305
```
306306

307307
Nightly versions are published regardless of testing outcome.
308-
This means there could be sematic breakages or partially implemented features.
308+
This means there could be semantic breakages or partially implemented features.
309309
The nightly build is not suitable for production use.
310310

311311
## Next Steps

0 commit comments

Comments
 (0)