add documentation of close methods"

Author: baileympearson

src/change_stream.ts

@@ -554,6 +554,7 @@ export class ChangeStream<
   /**
    * @beta
    * @experimental
+   * An alias for {@link ChangeStream.close|ChangeStream.close()}.
    */
   declare [Symbol.asyncDispose]: () => Promise<void>;
   /** @internal */
@@ -779,7 +780,9 @@ export class ChangeStream<
     return this[kClosed] || this.cursor.closed;
   }
 
-  /** Close the Change Stream */
+  /**
+   * Frees the internal resources used by the change stream.
+   */
   async close(): Promise<void> {
     this[kClosed] = true;
 

src/cursor/abstract_cursor.ts

@@ -282,6 +282,7 @@ export abstract class AbstractCursor<
   /**
    * @beta
    * @experimental
+   * An alias for {@link AbstractCursor.close|AbstractCursor.close()}.
    */
   declare [Symbol.asyncDispose]: () => Promise<void>;
   /** @internal */
@@ -460,6 +461,9 @@ export abstract class AbstractCursor<
     }
   }
 
+  /**
+   * Frees any client-side resources used by the cursor.
+   */
   async close(): Promise<void> {
     await this.cleanup();
   }

src/mongo_client.ts

@@ -408,6 +408,7 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
   /**
    * @beta
    * @experimental
+   * An alias for {@link MongoClient.close|MongoClient.close()}.
    */
   declare [Symbol.asyncDispose]: () => Promise<void>;
   /** @internal */
@@ -581,7 +582,15 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
   }
 
   /**
-   * Close the client and its underlying connections
+   * Cleans up client-side resources used by the MongoCLient and .  This includes:
+   *
+   * - Closes all open, unused connections (see note).
+   * - Ends all in-use sessions with {@link ClientSession#endSession|ClientSession.endSession()}.
+   * - Ends all unused sessions server-side.
+   * - Cleans up any resources being used for auto encryption if auto encryption is enabled.
+   *
+   * @remarks Any in-progress operations are not killed and any connections used by in progress operations
+   * will be cleaned up lazily as operations finish.
    *
    * @param force - Force close, emitting no events
    */

src/sessions.ts

@@ -259,7 +259,10 @@ export class ClientSession
   }
 
   /**
-   * Ends this session on the server
+   * Frees any client-side resources held by the current session.  If a session is in a transaction,
+   * the transaction is aborted.
+   *
+   * Does not end the session on the server.
    *
    * @param options - Optional settings. Currently reserved for future use
    */
@@ -293,6 +296,7 @@ export class ClientSession
   /**
    * @beta
    * @experimental
+   * An alias for {@link ClientSession.endSession|ClientSession.endSession()}.
    */
   declare [Symbol.asyncDispose]: () => Promise<void>;
   /** @internal */