chore: fixes

Author: nbbeeken

src/cursor/abstract_cursor.ts

@@ -63,6 +63,7 @@ export type CursorFlag = (typeof CURSOR_FLAGS)[number];
 
 /**
  * @public
+ * @experimental
  * Specifies how `timeoutMS` is applied to the cursor. Can be either `'cursorLifeTime'` or `'iteration'`
  * When set to `'iteration'`, the deadline specified by `timeoutMS` applies to each call of
  * `cursor.next()`.
@@ -74,7 +75,6 @@ export type CursorFlag = (typeof CURSOR_FLAGS)[number];
  * definition can have an arbitrarily long lifetime.
  *
  * @example
- * # Example showing use of `'iteration'`
  * ```ts
  * const cursor = collection.find({}, {timeoutMS: 100, timeoutMode: 'iteration'});
  * for await (const doc of cursor) {
@@ -84,8 +84,7 @@ export type CursorFlag = (typeof CURSOR_FLAGS)[number];
  * }
  * ```
  *
- * # Example showing use of `'cursorLifetime'`
- *
+ * @example
  * ```ts
  * const cursor = collection.find({}, { timeoutMS: 1000, timeoutMode: 'cursorLifetime' });
  * const docs = await cursor.toArray(); // This entire line will throw a timeout error if all batches are not fetched and returned within 1000ms.
@@ -146,13 +145,17 @@ export interface AbstractCursorOptions extends BSONSerializeOptions {
   /** Specifies the time an operation will run until it throws a timeout error. See {@link AbstractCursorOptions.timeoutMode} for more details on how this option applies to cursors. */
   timeoutMS?: number;
   /**
+   * @public
+   * @experimental
    * Specifies how `timeoutMS` is applied to the cursor. Can be either `'cursorLifeTime'` or `'iteration'`
    * When set to `'iteration'`, the deadline specified by `timeoutMS` applies to each call of
    * `cursor.next()`.
    * When set to `'cursorLifetime'`, the deadline applies to the life of the entire cursor.
    *
-   * Note that the use of '`cursorLifetime`' should be limited to relatively short-lived cursors as
-   * it has the potential to hang on an operation for the entirety of `timeoutMS`.
+   * Depending on the type of cursor being used, this option has different default values.
+   * For non-tailable cursors, this value defaults to `'cursorLifetime'`
+   * For tailable cursors, this value defaults to `'iteration'` since tailable cursors, by
+   * definition can have an arbitrarily long lifetime.
    *
    * @example
    * ```ts
@@ -167,7 +170,7 @@ export interface AbstractCursorOptions extends BSONSerializeOptions {
    * @example
    * ```ts
    * const cursor = collection.find({}, { timeoutMS: 1000, timeoutMode: 'cursorLifetime' });
-   * const docs = await cursor.toArray(); // This line will throw a timeout error if all batches are not fetched and returned within 1000ms.
+   * const docs = await cursor.toArray(); // This entire line will throw a timeout error if all batches are not fetched and returned within 1000ms.
    * ```
    */
   timeoutMode?: CursorTimeoutMode;

src/cursor/run_command_cursor.ts

@@ -27,6 +27,7 @@ export type RunCursorCommandOptions = {
   timeoutMS?: number;
   /**
    * @public
+   * @experimental
    * Specifies how `timeoutMS` is applied to the cursor. Can be either `'cursorLifeTime'` or `'iteration'`
    * When set to `'iteration'`, the deadline specified by `timeoutMS` applies to each call of
    * `cursor.next()`.
@@ -43,7 +44,7 @@ export type RunCursorCommandOptions = {
    * for await (const doc of cursor) {
    *  // process doc
    *  // This will throw a timeout error if any of the iterator's `next()` calls takes more than 100ms, but
-   * will continue to iterate successfully otherwise, regardless of the number of batches.
+   *  // will continue to iterate successfully otherwise, regardless of the number of batches.
    * }
    * ```
    *

src/db.ts

@@ -222,7 +222,7 @@ export class Db {
     return this.s.namespace.toString();
   }
 
-  get timeoutMS(): number | undefined {
+  public get timeoutMS(): number | undefined {
     return this.s.options?.timeoutMS;
   }
 

src/operations/operation.ts

@@ -61,8 +61,6 @@ export abstract class AbstractOperation<TResult = any> {
 
   options: OperationOptions;
 
-  /** TODO(NODE-6197): remove dead code */
-  timeout?: Timeout;
   /** Specifies the time an operation will run until it throws a timeout error. */
   timeoutMS?: number;