docs: fix fmt, export enum

Author: nbbeeken

src/collection.ts

@@ -262,7 +262,7 @@ export class Collection<TSchema extends Document = Document> {
     this.s.collectionHint = normalizeHintField(v);
   }
 
-  get timeoutMS(): number | undefined {
+  public get timeoutMS(): number | undefined {
     return this.s.options.timeoutMS;
   }
 

src/cursor/abstract_cursor.ts

@@ -61,13 +61,8 @@ export interface CursorStreamOptions {
 /** @public */
 export type CursorFlag = (typeof CURSOR_FLAGS)[number];
 
-/** @public */
-export const CursorTimeoutMode = Object.freeze({
-  ITERATION: 'iteration',
-  LIFETIME: 'cursorLifetime'
-} as const);
-
-/** @public
+/**
+ * @public
  * 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()`.
@@ -85,7 +80,7 @@ export const CursorTimeoutMode = Object.freeze({
  * 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.
  * }
  * ```
  *
@@ -96,6 +91,12 @@ export const CursorTimeoutMode = Object.freeze({
  * const docs = await cursor.toArray(); // This entire line will throw a timeout error if all batches are not fetched and returned within 1000ms.
  * ```
  */
+export const CursorTimeoutMode = Object.freeze({
+  ITERATION: 'iteration',
+  LIFETIME: 'cursorLifetime'
+} as const);
+
+/** @public */
 export type CursorTimeoutMode = (typeof CursorTimeoutMode)[keyof typeof CursorTimeoutMode];
 
 /** @public */
@@ -154,21 +155,19 @@ export interface AbstractCursorOptions extends BSONSerializeOptions {
    * it has the potential to hang on an operation for the entirety of `timeoutMS`.
    *
    * @example
-   * # Example showing use of `'iteration'`
    * ```ts
    * const cursor = collection.find({}, {timeoutMS: 100, timeoutMode: 'iteration'});
    * 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.
    * }
    * ```
    *
-   * # 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.
+   * const docs = await cursor.toArray(); // This line will throw a timeout error if all batches are not fetched and returned within 1000ms.
    * ```
    */
   timeoutMode?: CursorTimeoutMode;

src/cursor/run_command_cursor.ts

@@ -19,11 +19,14 @@ import {
 export type RunCursorCommandOptions = {
   readPreference?: ReadPreferenceLike;
   session?: ClientSession;
-  /** Specifies the time an operation will run until it throws a timeout error. Note that if
+  /**
+   * Specifies the time an operation will run until it throws a timeout error. Note that if
    * `maxTimeMS` is provided in the command in addition to setting `timeoutMS` in the options, then
-   * the original value of `maxTimeMS` will be overwritten. */
+   * the original value of `maxTimeMS` will be overwritten.
+   */
   timeoutMS?: number;
-  /** @public
+  /**
+   * @public
    * 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()`.
@@ -35,7 +38,6 @@ export type RunCursorCommandOptions = {
    * 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) {
@@ -45,8 +47,7 @@ export type RunCursorCommandOptions = {
    * }
    * ```
    *
-   * # 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.

src/gridfs/index.ts

@@ -38,8 +38,10 @@ export interface GridFSBucketOptions extends WriteConcernOptions {
   chunkSizeBytes?: number;
   /** Read preference to be passed to read operations */
   readPreference?: ReadPreference;
-  /** Specifies the lifetime duration of a gridFS stream. If any async operations are in progress
-   * when this timeout expires, the stream will throw a timeout error. */
+  /**
+   * Specifies the lifetime duration of a gridFS stream. If any async operations are in progress
+   * when this timeout expires, the stream will throw a timeout error.
+   */
   timeoutMS?: number;
 }
 

src/index.ts

@@ -37,7 +37,11 @@ export {
   Timestamp,
   UUID
 } from './bson';
-export { AnyBulkWriteOperation, BulkWriteOptions, MongoBulkWriteError } from './bulk/common';
+export {
+  type AnyBulkWriteOperation,
+  type BulkWriteOptions,
+  MongoBulkWriteError
+} from './bulk/common';
 export { ClientEncryption } from './client-side-encryption/client_encryption';
 export { ChangeStreamCursor } from './cursor/change_stream_cursor';
 export {
@@ -111,7 +115,7 @@ export { AutoEncryptionLoggerLevel } from './client-side-encryption/auto_encrypt
 export { GSSAPICanonicalizationValue } from './cmap/auth/gssapi';
 export { AuthMechanism } from './cmap/auth/providers';
 export { Compressor } from './cmap/wire_protocol/compression';
-export { CURSOR_FLAGS, type CursorTimeoutMode } from './cursor/abstract_cursor';
+export { CURSOR_FLAGS, CursorTimeoutMode } from './cursor/abstract_cursor';
 export { MongoErrorLabel } from './error';
 export { ExplainVerbosity } from './explain';
 export { ServerApiVersion } from './mongo_client';

src/operations/operation.ts

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

src/sessions.ts

@@ -711,7 +711,7 @@ export class ClientSession
    * undefined behaviour.
    *
    * **IMPORTANT:** When running an operation inside a `withTransaction` callback, if it is not
-   * provided the explicit session in its options, it will not respect the timeoutMS.
+   * provided the explicit session in its options, it will not be part of the transaction and it will not respect timeoutMS.
    *
    *
    * @remarks

test/integration/client-side-operations-timeout/node_csot.test.ts

@@ -18,6 +18,7 @@ import {
   type CommandStartedEvent,
   type CommandSucceededEvent,
   Connection,
+  CursorTimeoutMode,
   type Db,
   type FindCursor,
   GridFSBucket,
@@ -423,7 +424,7 @@ describe('CSOT driver tests', metadata, () => {
             const cursor = client
               .db('db')
               .collection('coll')
-              .find({}, { batchSize: 3, timeoutMode: 'iteration', timeoutMS: 10 })
+              .find({}, { batchSize: 3, timeoutMode: CursorTimeoutMode.ITERATION, timeoutMS: 10 })
               .limit(3);
 
             const maybeError = await cursor.next().then(

test/unit/index.test.ts

@@ -5,14 +5,7 @@ import { expect } from 'chai';
 import * as mongodb from '../../src/index';
 import { setDifference } from '../mongodb';
 
-/**
- * TS-NODE Adds these keys but they are undefined, they are not present when you import from lib
- * We did not think this strangeness was worth investigating so we just make sure they remain set to undefined
- */
-const TS_NODE_EXPORTS = ['AnyBulkWriteOperation', 'BulkWriteOptions'];
-
 const EXPECTED_EXPORTS = [
-  ...TS_NODE_EXPORTS,
   'AbstractCursor',
   'Admin',
   'AggregationCursor',
@@ -31,11 +24,11 @@ const EXPECTED_EXPORTS = [
   'ClientSession',
   'Code',
   'Collection',
-  'configureExplicitResourceManagement',
   'CommandFailedEvent',
   'CommandStartedEvent',
   'CommandSucceededEvent',
   'Compressor',
+  'configureExplicitResourceManagement',
   'ConnectionCheckedInEvent',
   'ConnectionCheckedOutEvent',
   'ConnectionCheckOutFailedEvent',
@@ -49,12 +42,13 @@ const EXPECTED_EXPORTS = [
   'ConnectionPoolReadyEvent',
   'ConnectionReadyEvent',
   'CURSOR_FLAGS',
+  'CursorTimeoutMode',
   'Db',
   'DBRef',
   'Decimal128',
   'Double',
-  'ExplainVerbosity',
   'ExplainableCursor',
+  'ExplainVerbosity',
   'FindCursor',
   'GridFSBucket',
   'GridFSBucketReadStream',
@@ -102,6 +96,7 @@ const EXPECTED_EXPORTS = [
   'MongoNetworkTimeoutError',
   'MongoNotConnectedError',
   'MongoOIDCError',
+  'MongoOperationTimeoutError',
   'MongoParseError',
   'MongoRuntimeError',
   'MongoServerClosedError',
@@ -111,10 +106,8 @@ const EXPECTED_EXPORTS = [
   'MongoTailableCursorError',
   'MongoTopologyClosedError',
   'MongoTransactionError',
-  'MongoOperationTimeoutError',
   'MongoUnexpectedServerResponseError',
   'MongoWriteConcernError',
-  'WriteConcernErrorResult',
   'ObjectId',
   'OrderedBulkOperation',
   'ProfilingLevel',
@@ -130,6 +123,10 @@ const EXPECTED_EXPORTS = [
   'ServerHeartbeatStartedEvent',
   'ServerHeartbeatSucceededEvent',
   'ServerOpeningEvent',
+  'ServerSelectionEvent',
+  'ServerSelectionFailedEvent',
+  'ServerSelectionStartedEvent',
+  'ServerSelectionSucceededEvent',
   'ServerType',
   'SrvPollingEvent',
   'Timestamp',
@@ -139,12 +136,9 @@ const EXPECTED_EXPORTS = [
   'TopologyType',
   'UnorderedBulkOperation',
   'UUID',
+  'WaitingForSuitableServerEvent',
   'WriteConcern',
-  'ServerSelectionEvent',
-  'ServerSelectionFailedEvent',
-  'ServerSelectionStartedEvent',
-  'ServerSelectionSucceededEvent',
-  'WaitingForSuitableServerEvent'
+  'WriteConcernErrorResult'
 ];
 
 describe('mongodb entrypoint', () => {
@@ -155,12 +149,4 @@ describe('mongodb entrypoint', () => {
   it('exports only the expected keys', () => {
     expect(setDifference(Object.keys(mongodb), EXPECTED_EXPORTS)).to.be.empty;
   });
-
-  it('should export keys added by ts-node as undefined', () => {
-    // If the array is empty, this test would be a no-op so we should remove it
-    expect(TS_NODE_EXPORTS).to.have.length.greaterThan(0);
-    for (const tsNodeExportKey of TS_NODE_EXPORTS) {
-      expect(mongodb).to.have.property(tsNodeExportKey, undefined);
-    }
-  });
 });