(DOCSP-18084) type script cleanup (#249)

biniona-mongodb · nbbeeken · corryroot · web-flow · commit fad7c12792c8 · 2021-09-01T13:28:49.000-04:00
Co-authored-by: Neal Beeken &lt;nbbeeken@users.noreply.github.com&gt;
Co-authored-by: Corry Root &lt;corryroot@users.noreply.github.com&gt;
diff --git a/source/code-snippets/usage-examples/bulkWrite.js b/source/code-snippets/usage-examples/bulkWrite.js
@@ -1,8 +1,7 @@
-const { MongoClient } = require("mongodb");
+import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/bulkWrite.ts b/source/code-snippets/usage-examples/bulkWrite.ts
@@ -1,8 +1,7 @@
 import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/changeStream.js b/source/code-snippets/usage-examples/changeStream.js
@@ -1,8 +1,7 @@
-const { MongoClient } = require("mongodb");
+import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/command.js b/source/code-snippets/usage-examples/command.js
@@ -1,8 +1,7 @@
-const { MongoClient } = require("mongodb");
+import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/count.js b/source/code-snippets/usage-examples/count.js
@@ -1,8 +1,7 @@
-const { MongoClient } = require("mongodb");
+import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/deleteMany.js b/source/code-snippets/usage-examples/deleteMany.js
@@ -1,8 +1,7 @@
-const { MongoClient } = require("mongodb");
+import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/deleteMany.ts b/source/code-snippets/usage-examples/deleteMany.ts
@@ -1,8 +1,7 @@
 import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/deleteOne.js b/source/code-snippets/usage-examples/deleteOne.js
@@ -1,8 +1,7 @@
-const { MongoClient } = require("mongodb");
+import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/distinct.js b/source/code-snippets/usage-examples/distinct.js
@@ -1,8 +1,7 @@
-const { MongoClient } = require("mongodb");
+import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/distinct.ts b/source/code-snippets/usage-examples/distinct.ts
@@ -1,12 +1,11 @@
 import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
-interface Movies {
+interface Movie {
   directors: string;
   year: number;
 }
@@ -17,7 +16,7 @@ async function run() {
 
     // define a database and collection on which to run the method
     const database = client.db("sample_mflix");
-    const movies = database.collection<Movies>("movies");
+    const movies = database.collection<Movie>("movies");
 
     const distinctValues = await movies.distinct("year", {
       directors: "Barbra Streisand",
diff --git a/source/code-snippets/usage-examples/find.js b/source/code-snippets/usage-examples/find.js
@@ -1,8 +1,7 @@
-const { MongoClient } = require("mongodb");
+import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/find.ts b/source/code-snippets/usage-examples/find.ts
@@ -1,8 +1,7 @@
 import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/findOne.js b/source/code-snippets/usage-examples/findOne.js
@@ -1,8 +1,7 @@
-const { MongoClient } = require("mongodb");
+import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/findOne.ts b/source/code-snippets/usage-examples/findOne.ts
@@ -1,8 +1,7 @@
 import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/insertMany.js b/source/code-snippets/usage-examples/insertMany.js
@@ -1,16 +1,15 @@
-const { MongoClient } = require("mongodb");
+import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
 async function run() {
   try {
     await client.connect();
 
-    const database = client.db("insert_db");
+    const database = client.db("insertDB");
     const foods = database.collection("foods");
 
     // create an array of documents to insert
diff --git a/source/code-snippets/usage-examples/insertMany.ts b/source/code-snippets/usage-examples/insertMany.ts
@@ -1,8 +1,7 @@
 import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
@@ -15,7 +14,7 @@ async function run() {
   try {
     await client.connect();
 
-    const database = client.db("insert_db");
+    const database = client.db("insertDB");
     // Specifying a schema is optional, but it enables type hints on
     // finds and inserts
     const foods = database.collection<Food>("foods");
diff --git a/source/code-snippets/usage-examples/insertOne.js b/source/code-snippets/usage-examples/insertOne.js
@@ -1,16 +1,15 @@
-const { MongoClient } = require("mongodb");
+import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
 async function run() {
   try {
     await client.connect();
 
-    const database = client.db("insert_db");
+    const database = client.db("insertDB");
     const haiku = database.collection("haiku");
     // create a document to insert
     const doc = {
diff --git a/source/code-snippets/usage-examples/insertOne.ts b/source/code-snippets/usage-examples/insertOne.ts
@@ -1,8 +1,7 @@
 import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
@@ -15,7 +14,7 @@ async function run() {
   try {
     await client.connect();
 
-    const database = client.db("insert_db");
+    const database = client.db("insertDB");
     // Specifying a Schema is optional, but it enables type hints on
     // finds and inserts
     const haiku = database.collection<Haiku>("haiku");
diff --git a/source/code-snippets/usage-examples/replaceOne.js b/source/code-snippets/usage-examples/replaceOne.js
@@ -1,8 +1,7 @@
-const { MongoClient } = require("mongodb");
+import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/replaceOne.ts b/source/code-snippets/usage-examples/replaceOne.ts
@@ -1,8 +1,7 @@
 import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/updateMany.js b/source/code-snippets/usage-examples/updateMany.js
@@ -1,8 +1,7 @@
-const { MongoClient } = require("mongodb");
+import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/updateMany.ts b/source/code-snippets/usage-examples/updateMany.ts
@@ -1,8 +1,7 @@
 import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/updateOne.js b/source/code-snippets/usage-examples/updateOne.js
@@ -1,8 +1,7 @@
-const { MongoClient } = require("mongodb");
+import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
diff --git a/source/code-snippets/usage-examples/updateOne.ts b/source/code-snippets/usage-examples/updateOne.ts
@@ -1,12 +1,11 @@
 import { MongoClient } from "mongodb";
 
 // Replace the uri string with your MongoDB deployment's connection string.
-const uri =
-  "mongodb+srv://<user>:<password>@<cluster-url>?writeConcern=majority";
+const uri = "<connection string uri>";
 
 const client = new MongoClient(uri);
 
-interface Movies {
+interface Movie {
   plot: string;
   title: string;
 }
@@ -16,7 +15,7 @@ async function run() {
     await client.connect();
 
     const database = client.db("sample_mflix");
-    const movies = database.collection<Movies>("movies");
+    const movies = database.collection<Movie>("movies");
 
     const result = await movies.updateOne(
       { title: "Random Harvest" },
diff --git a/source/usage-examples.txt b/source/usage-examples.txt
@@ -61,6 +61,40 @@ with your instance of MongoDB:
    const uri =
       "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&writeConcern=majority";
 
+All examples use ES module imports. You can
+`enable ES module imports <https://nodejs.org/api/esm.html#esm_enabling>`__
+by adding the following key-value pair to your package.json file:
+
+.. code-block:: json
+
+   "type": "module"
+   
+
+.. note:: CommonJS
+
+   You can use any usage example with CommonJS ``require``. To use CommonJS ``require``, you
+   must swap out the ES module ``import`` statement for your CommonJS ``require``
+   statement.
+   
+   Click on the tabs to see the syntax for importing the driver with ES module
+   ``import`` and CommonJS ``require``:
+
+   .. tabs::
+
+      .. tab:: ES Module
+         :tabid: es-module
+
+         .. code-block:: javascript
+
+            import { MongoClient } from 'mongodb'
+
+      .. tab:: CommonJS Module
+         :tabid: commonjs-module
+
+         .. code-block:: javascript
+
+            const { MongoClient } = require('mongodb')
+
 You can use the :guides:`Atlas Connectivity Guide
 </cloud/connectionstring/>` to enable connectivity to your instance of
 Atlas and find the :manual:`connection string
diff --git a/source/usage-examples/bulkWrite.txt b/source/usage-examples/bulkWrite.txt
@@ -93,7 +93,7 @@ to ``bulkWrite()`` includes examples of ``insertOne``, ``updateMany``, and
          more information, see our guide on
          :ref:`TypeScript in the driver <node-driver-typescript-limitations-dot-notation>`.
 
-When you run the code sample, your output should resemble the following:
+When you run the preceding example, you should see the following output:
 
 .. code-block:: javascript
    :copyable: false
diff --git a/source/usage-examples/changeStream.txt b/source/usage-examples/changeStream.txt
@@ -127,8 +127,7 @@ callback process the event before exiting.
    The JavaScript and TypeScript code snippets above are identical. There are no
    TypeScript specific features of the driver relevant to this use case.
 
-If you run the example above, you should see output similar to the
-following:
+If you run the preceding example, you should see the following output:
 
 .. code-block:: javascript
    :copyable: false
diff --git a/source/usage-examples/command.txt b/source/usage-examples/command.txt
@@ -55,8 +55,7 @@ Example
    The JavaScript and TypeScript code snippets above are identical. There are no
    TypeScript specific features of the driver relevant to this use case.
 
-When you run the above command, you should see output similar to the
-following:
+When you run the preceding command, you should see the following output:
 
 .. code-block:: javascript
    :copyable: false
diff --git a/source/usage-examples/count.txt b/source/usage-examples/count.txt
@@ -70,8 +70,7 @@ collection with ``Canada`` in the ``countries`` field.
    The JavaScript and TypeScript code snippets above are identical. There are no
    TypeScript specific features of the driver relevant to this use case.
 
-If you run the sample code above, you should see output that resembles the
-following:
+If you run the preceding sample code, you should see the following output:
 
 .. code-block:: none
    :copyable: false
diff --git a/source/usage-examples/deleteMany.txt b/source/usage-examples/deleteMany.txt
diff --git a/source/usage-examples/deleteOne.txt b/source/usage-examples/deleteOne.txt
diff --git a/source/usage-examples/distinct.txt b/source/usage-examples/distinct.txt
diff --git a/source/usage-examples/find.txt b/source/usage-examples/find.txt
diff --git a/source/usage-examples/findOne.txt b/source/usage-examples/findOne.txt
diff --git a/source/usage-examples/insertMany.txt b/source/usage-examples/insertMany.txt
diff --git a/source/usage-examples/insertOne.txt b/source/usage-examples/insertOne.txt
diff --git a/source/usage-examples/replaceOne.txt b/source/usage-examples/replaceOne.txt
diff --git a/source/usage-examples/updateMany.txt b/source/usage-examples/updateMany.txt
diff --git a/source/usage-examples/updateOne.txt b/source/usage-examples/updateOne.txt
