diff --git a/docs/6.10/classes/AbstractCursor.html b/docs/6.10/classes/AbstractCursor.html index 06d29590504..f1be9d56541 100644 --- a/docs/6.10/classes/AbstractCursor.html +++ b/docs/6.10/classes/AbstractCursor.html @@ -1,4 +1,4 @@ -AbstractCursor | mongodb

Class AbstractCursor<TSchema, CursorEvents>Abstract

Type Parameters

Hierarchy (view full)

Implements

Properties

[asyncDispose] +AbstractCursor | mongodb

Class AbstractCursor<TSchema, CursorEvents>Abstract

Type Parameters

Hierarchy (view full)

Implements

Properties

[asyncDispose] captureRejections captureRejectionSymbol CLOSE @@ -503,4 +503,4 @@

Deprecat

Parameters

  • Optionaln: number

    A non-negative number. The maximum number of listeners per EventTarget event.

  • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

Returns void

Since

v15.4.0

-

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
+

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
diff --git a/docs/6.10/classes/Admin.html b/docs/6.10/classes/Admin.html index 543457ae983..6a0d35feadc 100644 --- a/docs/6.10/classes/Admin.html +++ b/docs/6.10/classes/Admin.html @@ -1,4 +1,4 @@ -Admin | mongodb

Class Admin

The Admin class is an internal class that allows convenient access to +Admin | mongodb

Class Admin

The Admin class is an internal class that allows convenient access to the admin functionality and commands for MongoDB.

ADMIN Cannot directly be instantiated

Example

import { MongoClient } from 'mongodb';

const client = new MongoClient('mongodb://localhost:27017');
const admin = client.db().admin();
const dbInfo = await admin.listDatabases();
for (const db of dbInfo.databases) {
  console.log(db.name);
}
@@ -52,4 +52,4 @@

Returns Promise<Document>

validateCollection

  • validateCollection(collectionName, options?): Promise<Document>

  • Validate an existing collection

    Parameters

    • collectionName: string

      The name of the collection to validate.

    • options: ValidateCollectionOptions = {}

      Optional settings for the command

      -

    Returns Promise<Document>

Settings

Member Visibility

On This Page

Methods
+

Returns Promise<Document>

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/6.10/classes/AggregationCursor.html b/docs/6.10/classes/AggregationCursor.html index 1573d1c5c60..a030dd85720 100644 --- a/docs/6.10/classes/AggregationCursor.html +++ b/docs/6.10/classes/AggregationCursor.html @@ -1,4 +1,4 @@ -AggregationCursor | mongodb

Class AggregationCursor<TSchema>

The AggregationCursor class is an internal class that embodies an aggregation cursor on MongoDB +AggregationCursor | mongodb

Class AggregationCursor<TSchema>

The AggregationCursor class is an internal class that embodies an aggregation cursor on MongoDB allowing for iteration over the results returned from the underlying query. It supports one by one document iteration, conversion to an array or can be iterated as a Node 4.X or higher stream

@@ -550,4 +550,4 @@

Deprecat

Parameters

  • Optionaln: number

    A non-negative number. The maximum number of listeners per EventTarget event.

  • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

Returns void

Since

v15.4.0

-

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
+

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
diff --git a/docs/6.10/classes/BSON.BSONError.html b/docs/6.10/classes/BSON.BSONError.html index 688178d6c57..a7fd8ce93f6 100644 --- a/docs/6.10/classes/BSON.BSONError.html +++ b/docs/6.10/classes/BSON.BSONError.html @@ -1,4 +1,4 @@ -BSONError | mongodb

Class BSONError

Hierarchy (view full)

Constructors

constructor +BSONError | mongodb

Class BSONError

Hierarchy (view full)

Constructors

constructor

Properties

cause? message stack? @@ -14,4 +14,4 @@ This method can assist with determining if an error originates from the BSON library even if it does not pass an instanceof check against this class' constructor.

Parameters

  • value: unknown

    any javascript value that needs type checking

    -

Returns value is BSONError

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns value is BSONError

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/6.10/classes/BSON.BSONOffsetError.html b/docs/6.10/classes/BSON.BSONOffsetError.html index cebd304592e..a8cb2660874 100644 --- a/docs/6.10/classes/BSON.BSONOffsetError.html +++ b/docs/6.10/classes/BSON.BSONOffsetError.html @@ -1,4 +1,4 @@ -BSONOffsetError | mongodb

Class BSONOffsetErrorExperimental

Hierarchy (view full)

Constructors

constructor +BSONOffsetError | mongodb

Class BSONOffsetErrorExperimental

Hierarchy (view full)

Constructors

constructor

Properties

cause? message offset @@ -15,4 +15,4 @@ This method can assist with determining if an error originates from the BSON library even if it does not pass an instanceof check against this class' constructor.

Parameters

  • value: unknown

    any javascript value that needs type checking

    -

Returns value is BSONError

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns value is BSONError

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/6.10/classes/BSON.BSONRegExp.html b/docs/6.10/classes/BSON.BSONRegExp.html index a68c47bbd5d..36861009f48 100644 --- a/docs/6.10/classes/BSON.BSONRegExp.html +++ b/docs/6.10/classes/BSON.BSONRegExp.html @@ -1,4 +1,4 @@ -BSONRegExp | mongodb

Class BSONRegExp

A class representation of the BSON RegExp type.

+BSONRegExp | mongodb

Class BSONRegExp

A class representation of the BSON RegExp type.

Hierarchy (view full)

Constructors

constructor

Properties

options pattern @@ -9,4 +9,4 @@
  • Optionaloptions: string

    The regular expression options

    • Returns BSONRegExp

    Properties

    options

    options: string

    pattern

    pattern: string

    Accessors

    _bsontype

    • get _bsontype(): "BSONRegExp"

    • Returns "BSONRegExp"

    Methods

    inspect

    • inspect(depth?, options?, inspect?): string

    • Prints a human-readable string of BSON value information If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

      -

      Parameters

      • Optionaldepth: number
      • Optionaloptions: unknown
      • Optionalinspect: InspectFn

      Returns string

    StaticparseOptions

    • parseOptions(options?): string

    • Parameters

      • Optionaloptions: string

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • Optionaldepth: number
    • Optionaloptions: unknown
    • Optionalinspect: InspectFn

    Returns string

    StaticparseOptions

    • parseOptions(options?): string

    • Parameters

      • Optionaloptions: string

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.BSONRuntimeError.html b/docs/6.10/classes/BSON.BSONRuntimeError.html index b96646419e2..e0bedf90160 100644 --- a/docs/6.10/classes/BSON.BSONRuntimeError.html +++ b/docs/6.10/classes/BSON.BSONRuntimeError.html @@ -1,4 +1,4 @@ -BSONRuntimeError | mongodb

    Class BSONRuntimeError

    Hierarchy (view full)

    Constructors

    constructor +BSONRuntimeError | mongodb

    Class BSONRuntimeError

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? message stack? @@ -14,4 +14,4 @@ This method can assist with determining if an error originates from the BSON library even if it does not pass an instanceof check against this class' constructor.

    Parameters

    • value: unknown

      any javascript value that needs type checking

      -

    Returns value is BSONError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns value is BSONError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.BSONSymbol.html b/docs/6.10/classes/BSON.BSONSymbol.html index 4bed71005f6..c5e6d3cfad3 100644 --- a/docs/6.10/classes/BSON.BSONSymbol.html +++ b/docs/6.10/classes/BSON.BSONSymbol.html @@ -1,4 +1,4 @@ -BSONSymbol | mongodb

    Class BSONSymbol

    A class representation of the BSON Symbol type.

    +BSONSymbol | mongodb

    Class BSONSymbol

    A class representation of the BSON Symbol type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    value

    Accessors

    _bsontype @@ -11,4 +11,4 @@ If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

    Parameters

    • Optionaldepth: number
    • Optionaloptions: unknown
    • Optionalinspect: InspectFn

    Returns string

    toJSON

    • toJSON(): string

    • Returns string

    toString

    • toString(): string

    • Returns a string representation of an object.

      Returns string

    valueOf

    • valueOf(): string

    • Access the wrapped string value.

      -

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.BSONValue.html b/docs/6.10/classes/BSON.BSONValue.html index e64e520768e..f2603d09699 100644 --- a/docs/6.10/classes/BSON.BSONValue.html +++ b/docs/6.10/classes/BSON.BSONValue.html @@ -1,6 +1,6 @@ -BSONValue | mongodb

    Class BSONValueAbstract

    Hierarchy (view full)

    Constructors

    constructor +BSONValue | mongodb

    Class BSONValueAbstract

    Hierarchy (view full)

    Constructors

    constructor

    Accessors

    _bsontype

    Methods

    inspect

    Constructors

    constructor

    Accessors

    Abstract_bsontype

    • get _bsontype(): string

    • Returns string

    Methods

    Abstractinspect

    • inspect(depth?, options?, inspect?): string

    • Prints a human-readable string of BSON value information If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

      -

      Parameters

      • Optionaldepth: number
      • Optionaloptions: unknown
      • Optionalinspect: InspectFn

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Parameters

    • Optionaldepth: number
    • Optionaloptions: unknown
    • Optionalinspect: InspectFn

    Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.BSONVersionError.html b/docs/6.10/classes/BSON.BSONVersionError.html index a007a383e2b..59a47ded6c1 100644 --- a/docs/6.10/classes/BSON.BSONVersionError.html +++ b/docs/6.10/classes/BSON.BSONVersionError.html @@ -1,4 +1,4 @@ -BSONVersionError | mongodb

    Class BSONVersionError

    Hierarchy (view full)

    Constructors

    constructor +BSONVersionError | mongodb

    Class BSONVersionError

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? message stack? @@ -14,4 +14,4 @@ This method can assist with determining if an error originates from the BSON library even if it does not pass an instanceof check against this class' constructor.

    Parameters

    • value: unknown

      any javascript value that needs type checking

      -

    Returns value is BSONError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns value is BSONError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.Binary.html b/docs/6.10/classes/BSON.Binary.html index de76b46cceb..e07a1843d63 100644 --- a/docs/6.10/classes/BSON.Binary.html +++ b/docs/6.10/classes/BSON.Binary.html @@ -1,4 +1,4 @@ -Binary | mongodb

    Class Binary

    A class representation of the BSON Binary type.

    +Binary | mongodb

    Class Binary

    A class representation of the BSON Binary type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    buffer position @@ -56,4 +56,4 @@
  • offset: number

    specify the binary of where to write the content.

    • Returns void

    StaticcreateFromBase64

    • createFromBase64(base64, subType?): Binary

    • Creates an Binary instance from a base64 string

      Parameters

      • base64: string
      • OptionalsubType: number

      Returns Binary

    StaticcreateFromHexString

    • createFromHexString(hex, subType?): Binary

    • Creates an Binary instance from a hex digit string

      -

      Parameters

      • hex: string
      • OptionalsubType: number

      Returns Binary

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • hex: string
    • OptionalsubType: number

    Returns Binary

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.Code.html b/docs/6.10/classes/BSON.Code.html index 222b496053a..6eda7ce6838 100644 --- a/docs/6.10/classes/BSON.Code.html +++ b/docs/6.10/classes/BSON.Code.html @@ -1,4 +1,4 @@ -Code | mongodb

    Class Code

    A class representation of the BSON Code type.

    +Code | mongodb

    Class Code

    A class representation of the BSON Code type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    code scope @@ -9,4 +9,4 @@
  • Optionalscope: null | Document

    an optional scope for the function.

    • Returns Code

    Properties

    code

    code: string

    scope

    scope: null | Document

    Accessors

    _bsontype

    • get _bsontype(): "Code"

    • Returns "Code"

    Methods

    inspect

    • inspect(depth?, options?, inspect?): string

    • Prints a human-readable string of BSON value information If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

      -

      Parameters

      • Optionaldepth: number
      • Optionaloptions: unknown
      • Optionalinspect: InspectFn

      Returns string

    toJSON

    • toJSON(): {
          code: string;
          scope?: Document;
      }

    • Returns {
          code: string;
          scope?: Document;
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • Optionaldepth: number
    • Optionaloptions: unknown
    • Optionalinspect: InspectFn

    Returns string

    toJSON

    • toJSON(): {
          code: string;
          scope?: Document;
      }

    • Returns {
          code: string;
          scope?: Document;
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.DBRef.html b/docs/6.10/classes/BSON.DBRef.html index 7fae8ee83e9..fc5a372d058 100644 --- a/docs/6.10/classes/BSON.DBRef.html +++ b/docs/6.10/classes/BSON.DBRef.html @@ -1,4 +1,4 @@ -DBRef | mongodb

    Class DBRef

    A class representation of the BSON DBRef type.

    +DBRef | mongodb

    Class DBRef

    A class representation of the BSON DBRef type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    collection db? @@ -12,4 +12,4 @@
  • Optionaldb: string

    optional db name, if omitted the reference is local to the current db.

  • Optionalfields: Document

    • Returns DBRef

    Properties

    collection

    collection: string

    Optionaldb

    db?: string

    fields

    fields: Document

    oid

    oid: ObjectId

    Accessors

    _bsontype

    • get _bsontype(): "DBRef"

    • Returns "DBRef"

    Methods

    inspect

    • inspect(depth?, options?, inspect?): string

    • Prints a human-readable string of BSON value information If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

      -

      Parameters

      • Optionaldepth: number
      • Optionaloptions: unknown
      • Optionalinspect: InspectFn

      Returns string

    toJSON

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • Optionaldepth: number
    • Optionaloptions: unknown
    • Optionalinspect: InspectFn

    Returns string

    toJSON

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.Decimal128.html b/docs/6.10/classes/BSON.Decimal128.html index 628ce7de919..3b843950960 100644 --- a/docs/6.10/classes/BSON.Decimal128.html +++ b/docs/6.10/classes/BSON.Decimal128.html @@ -1,4 +1,4 @@ -Decimal128 | mongodb

    Class Decimal128

    A class representation of the BSON Decimal128 type.

    +Decimal128 | mongodb

    Class Decimal128

    A class representation of the BSON Decimal128 type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    bytes

    Accessors

    _bsontype @@ -20,4 +20,4 @@

    Returns Decimal128

    Example: Example of a number that will be rounded

    > let d = Decimal128.fromString('37.499999999999999196428571428571375')
    Uncaught:
    BSONError: "37.499999999999999196428571428571375" is not a valid Decimal128 string - inexact rounding
    at invalidErr (/home/wajames/js-bson/lib/bson.cjs:1402:11)
    at Decimal128.fromStringInternal (/home/wajames/js-bson/lib/bson.cjs:1633:25)
    at Decimal128.fromString (/home/wajames/js-bson/lib/bson.cjs:1424:27)

    > d = Decimal128.fromStringWithRounding('37.499999999999999196428571428571375')
    new Decimal128("37.49999999999999919642857142857138")
    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.Double.html b/docs/6.10/classes/BSON.Double.html index 0ac044b313b..c1178df3afd 100644 --- a/docs/6.10/classes/BSON.Double.html +++ b/docs/6.10/classes/BSON.Double.html @@ -1,4 +1,4 @@ -Double | mongodb

    Class Double

    A class representation of the BSON Double type.

    +Double | mongodb

    Class Double

    A class representation of the BSON Double type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    value

    Accessors

    _bsontype @@ -24,4 +24,4 @@

    Strings with leading zeros, however, are also allowed

    Parameters

    • value: string

      the string we want to represent as a double.

      -

    Returns Double

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns Double

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.Int32.html b/docs/6.10/classes/BSON.Int32.html index c04828cf1a1..ae843a50fb1 100644 --- a/docs/6.10/classes/BSON.Int32.html +++ b/docs/6.10/classes/BSON.Int32.html @@ -1,4 +1,4 @@ -Int32 | mongodb

    Class Int32

    A class representation of a BSON Int32 type.

    +Int32 | mongodb

    Class Int32

    A class representation of a BSON Int32 type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    value

    Accessors

    _bsontype @@ -24,4 +24,4 @@

    Strings with leading zeros, however, are allowed.

    Parameters

    • value: string

      the string we want to represent as an int32.

      -

    Returns Int32

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns Int32

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.Long.html b/docs/6.10/classes/BSON.Long.html index 0b51f0437e3..8191c0909ab 100644 --- a/docs/6.10/classes/BSON.Long.html +++ b/docs/6.10/classes/BSON.Long.html @@ -1,4 +1,4 @@ -Long | mongodb

    Class Long

    A class representing a 64-bit integer

    +Long | mongodb

    Class Long

    A class representing a 64-bit integer

    Remarks

    The internal representation of a long is the two given signed, 32-bit values. We use 32-bit pieces because these are the size of integers on which Javascript performs bit-operations. For operations like addition and @@ -334,4 +334,4 @@

    StaticfromValue

    • fromValue(val, unsigned?): Long

    • Converts the specified value to a Long.

      Parameters

      • val: string | number | {
            high: number;
            low: number;
            unsigned?: boolean;
        }
      • Optionalunsigned: boolean

        Whether unsigned or not, defaults to signed

      Returns Long

    StaticisLong

    • isLong(value): value is Long

    • Tests if the specified object is a Long.

      -

      Parameters

      • value: unknown

      Returns value is Long

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns value is Long

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.MaxKey.html b/docs/6.10/classes/BSON.MaxKey.html index 1b884ed71a4..c24465a32ca 100644 --- a/docs/6.10/classes/BSON.MaxKey.html +++ b/docs/6.10/classes/BSON.MaxKey.html @@ -1,7 +1,7 @@ -MaxKey | mongodb

    Class MaxKey

    A class representation of the BSON MaxKey type.

    +MaxKey | mongodb

    Class MaxKey

    A class representation of the BSON MaxKey type.

    Hierarchy (view full)

    Constructors

    constructor

    Accessors

    _bsontype

    Methods

    inspect

    Constructors

    constructor

    Accessors

    _bsontype

    • get _bsontype(): "MaxKey"

    • Returns "MaxKey"

    Methods

    inspect

    • inspect(): string

    • Prints a human-readable string of BSON value information If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

      -

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.MinKey.html b/docs/6.10/classes/BSON.MinKey.html index e89e8f2381e..096a882a930 100644 --- a/docs/6.10/classes/BSON.MinKey.html +++ b/docs/6.10/classes/BSON.MinKey.html @@ -1,7 +1,7 @@ -MinKey | mongodb

    Class MinKey

    A class representation of the BSON MinKey type.

    +MinKey | mongodb

    Class MinKey

    A class representation of the BSON MinKey type.

    Hierarchy (view full)

    Constructors

    constructor

    Accessors

    _bsontype

    Methods

    inspect

    Constructors

    constructor

    Accessors

    _bsontype

    • get _bsontype(): "MinKey"

    • Returns "MinKey"

    Methods

    inspect

    • inspect(): string

    • Prints a human-readable string of BSON value information If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

      -

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.ObjectId.html b/docs/6.10/classes/BSON.ObjectId.html index 3d7330ad8ed..9d3687c5e65 100644 --- a/docs/6.10/classes/BSON.ObjectId.html +++ b/docs/6.10/classes/BSON.ObjectId.html @@ -1,4 +1,4 @@ -ObjectId | mongodb

    Class ObjectId

    A class representation of the BSON ObjectId type.

    +ObjectId | mongodb

    Class ObjectId

    A class representation of the BSON ObjectId type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cacheHexString

    Accessors

    _bsontype @@ -47,4 +47,4 @@

    Parameters

    • Optionaltime: number

      pass in a second based timestamp.

    Returns Uint8Array

    StaticisValid

    • isValid(id): boolean

    • Checks if a value can be used to create a valid bson ObjectId

      Parameters

      • id:
            | string
            | number
            | Uint8Array
            | ObjectId
            | ObjectIdLike

        any JS value

        -

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.Timestamp.html b/docs/6.10/classes/BSON.Timestamp.html index 16f87accce4..e58a5c56a89 100644 --- a/docs/6.10/classes/BSON.Timestamp.html +++ b/docs/6.10/classes/BSON.Timestamp.html @@ -1,4 +1,4 @@ -Timestamp | mongodb

    Class Timestamp

    Hierarchy (view full)

    Constructors

    constructor +Timestamp | mongodb

    Class Timestamp

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    __isLong__ add and @@ -162,4 +162,4 @@

    Parameters

    • value: number

    Returns Timestamp

    StaticfromString

    • fromString(str, optRadix): Timestamp

    • Returns a Timestamp from the given string, optionally using the given radix.

      Parameters

      • str: string

        the textual representation of the Timestamp.

      • optRadix: number

        the radix in which the text is written.

        -

      Returns Timestamp

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns Timestamp

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BSON.UUID.html b/docs/6.10/classes/BSON.UUID.html index c5dd31e764a..00443a96fee 100644 --- a/docs/6.10/classes/BSON.UUID.html +++ b/docs/6.10/classes/BSON.UUID.html @@ -1,4 +1,4 @@ -UUID | mongodb

    Class UUID

    A class representation of the BSON UUID type.

    +UUID | mongodb

    Class UUID

    A class representation of the BSON UUID type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    buffer position @@ -74,4 +74,4 @@

    Returns UUID

    Staticgenerate

    • generate(): Uint8Array

    • Generates a populated buffer containing a v4 uuid

      Returns Uint8Array

    StaticisValid

    • isValid(input): boolean

    • Checks if a value is a valid bson UUID

      Parameters

      • input:
            | string
            | Uint8Array
            | Binary
            | UUID

        UUID, string or Buffer to validate.

        -

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/Batch.html b/docs/6.10/classes/Batch.html index 99dd2d64fe2..089dad2664a 100644 --- a/docs/6.10/classes/Batch.html +++ b/docs/6.10/classes/Batch.html @@ -1,4 +1,4 @@ -Batch | mongodb

    Class Batch<T>

    Keeps the state of a unordered batch so we can rewrite the results +Batch | mongodb

    Class Batch<T>

    Keeps the state of a unordered batch so we can rewrite the results correctly after command execution

    Type Parameters

    Constructors

    constructor

    Properties

    batchType @@ -8,4 +8,4 @@ originalZeroIndex size sizeBytes -

    Constructors

    constructor

    Properties

    batchType

    batchType: BatchType

    currentIndex

    currentIndex: number

    operations

    operations: T[]

    originalIndexes

    originalIndexes: number[]

    originalZeroIndex

    originalZeroIndex: number

    size

    size: number

    sizeBytes

    sizeBytes: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    batchType

    batchType: BatchType

    currentIndex

    currentIndex: number

    operations

    operations: T[]

    originalIndexes

    originalIndexes: number[]

    originalZeroIndex

    originalZeroIndex: number

    size

    size: number

    sizeBytes

    sizeBytes: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/docs/6.10/classes/BulkOperationBase.html b/docs/6.10/classes/BulkOperationBase.html index 63aa02258ca..9b5d6c4e98c 100644 --- a/docs/6.10/classes/BulkOperationBase.html +++ b/docs/6.10/classes/BulkOperationBase.html @@ -1,4 +1,4 @@ -BulkOperationBase | mongodb

    Class BulkOperationBaseAbstract

    Hierarchy (view full)

    Properties

    isOrdered +BulkOperationBase | mongodb

    Class BulkOperationBaseAbstract

    Hierarchy (view full)

    Properties

    isOrdered operationId?

    Accessors

    batches bsonOptions @@ -19,4 +19,4 @@

    raw

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/BulkWriteResult.html b/docs/6.10/classes/BulkWriteResult.html index 3efdccd24a5..8f3d0ba2e12 100644 --- a/docs/6.10/classes/BulkWriteResult.html +++ b/docs/6.10/classes/BulkWriteResult.html @@ -1,4 +1,4 @@ -BulkWriteResult | mongodb

    Class BulkWriteResult

    The result of a bulk write.

    +BulkWriteResult | mongodb

    Class BulkWriteResult

    The result of a bulk write.

    Properties

    deletedCount insertedCount insertedIds @@ -31,4 +31,4 @@

    Parameters

    • index: number

    Returns undefined | WriteError

    getWriteErrorCount

    • getWriteErrorCount(): number

    • Returns the number of write errors off the bulk operation

      Returns number

    getWriteErrors

    hasWriteErrors

    • hasWriteErrors(): boolean

    • Returns true if the bulk operation contains a write error

      -

      Returns boolean

    isOk

    toString

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Returns boolean

    isOk

    toString

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/CancellationToken.html b/docs/6.10/classes/CancellationToken.html index 183fad485de..a1a21ec1b8d 100644 --- a/docs/6.10/classes/CancellationToken.html +++ b/docs/6.10/classes/CancellationToken.html @@ -1,4 +1,4 @@ -CancellationToken | mongodb

    Class CancellationToken

    Hierarchy (view full)

    Constructors

    constructor +CancellationToken | mongodb

    Class CancellationToken

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    captureRejections captureRejectionSymbol defaultMaxListeners @@ -419,4 +419,4 @@

    Deprecated

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/6.10/classes/ChangeStream.html b/docs/6.10/classes/ChangeStream.html index 4c5759c0f06..37d48c09bbc 100644 --- a/docs/6.10/classes/ChangeStream.html +++ b/docs/6.10/classes/ChangeStream.html @@ -1,4 +1,4 @@ -ChangeStream | mongodb

    Class ChangeStream<TSchema, TChange>

    Creates a new Change Stream instance. Normally created using Collection.watch().

    +ChangeStream | mongodb

    Class ChangeStream<TSchema, TChange>

    Creates a new Change Stream instance. Normally created using Collection.watch().

    Type Parameters

    Hierarchy (view full)

    Implements

    Properties

    [asyncDispose] namespace options @@ -462,4 +462,4 @@

    Deprecated

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/ClientEncryption.html b/docs/6.10/classes/ClientEncryption.html index b24ad5d7d4a..c422a1cb5b0 100644 --- a/docs/6.10/classes/ClientEncryption.html +++ b/docs/6.10/classes/ClientEncryption.html @@ -1,4 +1,4 @@ -ClientEncryption | mongodb

    Class ClientEncryption

    The public interface for explicit in-use encryption

    +ClientEncryption | mongodb

    Class ClientEncryption

    The public interface for explicit in-use encryption

    Constructors

    constructor

    Accessors

    libmongocryptVersion

    Methods

    addKeyAltName @@ -116,4 +116,4 @@

    ExampleExample

    // attempting to rewrap all data keys with no matches
    const filter = { _id: new Binary() } // assume _id matches no documents in the database
    const result = await clientEncryption.rewrapManyDataKey(filter);

    if (result.bulkWriteResult == null) {
     // no keys matched, `bulkWriteResult` does not exist on the result object
    }
    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/6.10/classes/ClientSession.html b/docs/6.10/classes/ClientSession.html index a29cc7dc074..5be8b2cdeb3 100644 --- a/docs/6.10/classes/ClientSession.html +++ b/docs/6.10/classes/ClientSession.html @@ -1,4 +1,4 @@ -ClientSession | mongodb

    Class ClientSession

    A class representing a client session on the server

    +ClientSession | mongodb

    Class ClientSession

    A class representing a client session on the server

    NOTE: not meant to be instantiated directly.

    Hierarchy (view full)

    Implements

    Properties

    [asyncDispose] clientOptions? @@ -496,4 +496,4 @@

    Deprecated

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/Collection.html b/docs/6.10/classes/Collection.html index 7f2c4571434..2f03d62937c 100644 --- a/docs/6.10/classes/Collection.html +++ b/docs/6.10/classes/Collection.html @@ -1,4 +1,4 @@ -Collection | mongodb

    Class Collection<TSchema>

    The Collection class is an internal class that embodies a MongoDB collection +Collection | mongodb

    Class Collection<TSchema>

    The Collection class is an internal class that embodies a MongoDB collection allowing for insert/find/update/delete and other command operation on that MongoDB collection.

    COLLECTION Cannot directly be instantiated

    Example

    import { MongoClient } from 'mongodb';

    interface Pet {
      name: string;
      kind: 'dog' | 'cat' | 'fish';
    }

    const client = new MongoClient('mongodb://localhost:27017');
    const pets = client.db().collection<Pet>('pets');

    const petCursor = pets.find();

    for await (const pet of petCursor) {
      console.log(`${pet.name} is a ${pet.kind}!`);
    }
@@ -273,4 +273,4 @@ 
    Examplecollection
      .watch<Schema, ChangeStreamInsertDocument<Schema> & { comment: string }>([
        { $addFields: { comment: 'big changes' } },
        { $match: { operationType: 'insert' } }
      ])
      .on('change', change => {
        change.comment.startsWith('big');
        change.operationType === 'insert';
        // No need to narrow in code because the generics did that for us!
        expectType<Schema>(change.fullDocument);
      });
    -

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods
    diff --git a/docs/6.10/classes/CommandFailedEvent.html b/docs/6.10/classes/CommandFailedEvent.html index f1192679621..c0ae4904820 100644 --- a/docs/6.10/classes/CommandFailedEvent.html +++ b/docs/6.10/classes/CommandFailedEvent.html @@ -1,4 +1,4 @@ -CommandFailedEvent | mongodb

    Class CommandFailedEvent

    An event indicating the failure of a given command

    +CommandFailedEvent | mongodb

    Class CommandFailedEvent

    An event indicating the failure of a given command

    Properties

    address commandName connectionId? @@ -11,4 +11,4 @@

    Properties

    address

    address: string

    commandName

    commandName: string

    OptionalconnectionId

    connectionId?: string | number

    Driver generated connection id

    duration

    duration: number

    failure

    failure: Error

    requestId

    requestId: number

    serverConnectionId

    serverConnectionId: null | bigint

    Server generated connection id Distinct from the connection id and is returned by the hello or legacy hello response as "connectionId" from the server on 4.2+.

    -

    OptionalserviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    +

    OptionalserviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    diff --git a/docs/6.10/classes/CommandStartedEvent.html b/docs/6.10/classes/CommandStartedEvent.html index fd5056ab331..1e04959e1c6 100644 --- a/docs/6.10/classes/CommandStartedEvent.html +++ b/docs/6.10/classes/CommandStartedEvent.html @@ -1,4 +1,4 @@ -CommandStartedEvent | mongodb

    Class CommandStartedEvent

    An event indicating the start of a given command

    +CommandStartedEvent | mongodb

    Class CommandStartedEvent

    An event indicating the start of a given command

    Properties

    address command commandName @@ -13,4 +13,4 @@

    databaseName

    databaseName: string

    requestId

    requestId: number

    serverConnectionId

    serverConnectionId: null | bigint

    Server generated connection id Distinct from the connection id and is returned by the hello or legacy hello response as "connectionId" from the server on 4.2+.

    -

    OptionalserviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    +

    OptionalserviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    diff --git a/docs/6.10/classes/CommandSucceededEvent.html b/docs/6.10/classes/CommandSucceededEvent.html index 74af8e90db4..6cabcf73fdc 100644 --- a/docs/6.10/classes/CommandSucceededEvent.html +++ b/docs/6.10/classes/CommandSucceededEvent.html @@ -1,4 +1,4 @@ -CommandSucceededEvent | mongodb

    Class CommandSucceededEvent

    An event indicating the success of a given command

    +CommandSucceededEvent | mongodb

    Class CommandSucceededEvent

    An event indicating the success of a given command

    Properties

    address commandName connectionId? @@ -11,4 +11,4 @@

    Properties

    address

    address: string

    commandName

    commandName: string

    OptionalconnectionId

    connectionId?: string | number

    Driver generated connection id

    duration

    duration: number

    reply

    reply: unknown

    requestId

    requestId: number

    serverConnectionId

    serverConnectionId: null | bigint

    Server generated connection id Distinct from the connection id and is returned by the hello or legacy hello response as "connectionId" from the server on 4.2+.

    -

    OptionalserviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    +

    OptionalserviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    diff --git a/docs/6.10/classes/ConnectionCheckOutFailedEvent.html b/docs/6.10/classes/ConnectionCheckOutFailedEvent.html index 74552ce638e..b29db06bbff 100644 --- a/docs/6.10/classes/ConnectionCheckOutFailedEvent.html +++ b/docs/6.10/classes/ConnectionCheckOutFailedEvent.html @@ -1,4 +1,4 @@ -ConnectionCheckOutFailedEvent | mongodb

    Class ConnectionCheckOutFailedEvent

    An event published when a request to check a connection out fails

    +ConnectionCheckOutFailedEvent | mongodb

    Class ConnectionCheckOutFailedEvent

    An event published when a request to check a connection out fails

    Hierarchy (view full)

    Properties

    address durationMS reason @@ -10,4 +10,4 @@ and emitting this event as part of the same check out.

    reason

    reason: string

    The reason the attempt to check out failed

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ConnectionCheckOutStartedEvent.html b/docs/6.10/classes/ConnectionCheckOutStartedEvent.html index 6053ec32407..e1ddcdb6316 100644 --- a/docs/6.10/classes/ConnectionCheckOutStartedEvent.html +++ b/docs/6.10/classes/ConnectionCheckOutStartedEvent.html @@ -1,6 +1,6 @@ -ConnectionCheckOutStartedEvent | mongodb

    Class ConnectionCheckOutStartedEvent

    An event published when a request to check a connection out begins

    +ConnectionCheckOutStartedEvent | mongodb

    Class ConnectionCheckOutStartedEvent

    An event published when a request to check a connection out begins

    Hierarchy (view full)

    Properties

    address time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ConnectionCheckedInEvent.html b/docs/6.10/classes/ConnectionCheckedInEvent.html index 333eb5a65d6..8dc0c30b50a 100644 --- a/docs/6.10/classes/ConnectionCheckedInEvent.html +++ b/docs/6.10/classes/ConnectionCheckedInEvent.html @@ -1,8 +1,8 @@ -ConnectionCheckedInEvent | mongodb

    Class ConnectionCheckedInEvent

    An event published when a connection is checked into the connection pool

    +ConnectionCheckedInEvent | mongodb

    Class ConnectionCheckedInEvent

    An event published when a connection is checked into the connection pool

    Hierarchy (view full)

    Properties

    address connectionId time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    connectionId

    connectionId: number | "<monitor>"

    The id of the connection

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ConnectionCheckedOutEvent.html b/docs/6.10/classes/ConnectionCheckedOutEvent.html index de839f93b6a..71ae4e436e3 100644 --- a/docs/6.10/classes/ConnectionCheckedOutEvent.html +++ b/docs/6.10/classes/ConnectionCheckedOutEvent.html @@ -1,4 +1,4 @@ -ConnectionCheckedOutEvent | mongodb

    Class ConnectionCheckedOutEvent

    An event published when a connection is checked out of the connection pool

    +ConnectionCheckedOutEvent | mongodb

    Class ConnectionCheckedOutEvent

    An event published when a connection is checked out of the connection pool

    Hierarchy (view full)

    Properties

    address connectionId durationMS @@ -10,4 +10,4 @@ emitting a ConnectionCheckOutStartedEvent and emitting this event as part of the same checking out.

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ConnectionClosedEvent.html b/docs/6.10/classes/ConnectionClosedEvent.html index cd5dcb8f87b..400ff9fcb2b 100644 --- a/docs/6.10/classes/ConnectionClosedEvent.html +++ b/docs/6.10/classes/ConnectionClosedEvent.html @@ -1,4 +1,4 @@ -ConnectionClosedEvent | mongodb

    Class ConnectionClosedEvent

    An event published when a connection is closed

    +ConnectionClosedEvent | mongodb

    Class ConnectionClosedEvent

    An event published when a connection is closed

    Hierarchy (view full)

    Properties

    address connectionId reason @@ -8,4 +8,4 @@

    connectionId

    connectionId: number | "<monitor>"

    The id of the connection

    reason

    reason: string

    The reason the connection was closed

    OptionalserviceId

    serviceId?: ObjectId

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ConnectionCreatedEvent.html b/docs/6.10/classes/ConnectionCreatedEvent.html index f8d90f01575..e82bf363160 100644 --- a/docs/6.10/classes/ConnectionCreatedEvent.html +++ b/docs/6.10/classes/ConnectionCreatedEvent.html @@ -1,8 +1,8 @@ -ConnectionCreatedEvent | mongodb

    Class ConnectionCreatedEvent

    An event published when a connection pool creates a new connection

    +ConnectionCreatedEvent | mongodb

    Class ConnectionCreatedEvent

    An event published when a connection pool creates a new connection

    Hierarchy (view full)

    Properties

    address connectionId time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    connectionId

    connectionId: number | "<monitor>"

    A monotonically increasing, per-pool id for the newly created connection

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ConnectionPoolClearedEvent.html b/docs/6.10/classes/ConnectionPoolClearedEvent.html index 4a2f019ee75..ab08e82f809 100644 --- a/docs/6.10/classes/ConnectionPoolClearedEvent.html +++ b/docs/6.10/classes/ConnectionPoolClearedEvent.html @@ -1,7 +1,7 @@ -ConnectionPoolClearedEvent | mongodb

    Class ConnectionPoolClearedEvent

    An event published when a connection pool is cleared

    +ConnectionPoolClearedEvent | mongodb

    Class ConnectionPoolClearedEvent

    An event published when a connection pool is cleared

    Hierarchy (view full)

    Properties

    address interruptInUseConnections? time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    OptionalinterruptInUseConnections

    interruptInUseConnections?: boolean

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ConnectionPoolClosedEvent.html b/docs/6.10/classes/ConnectionPoolClosedEvent.html index d05a80e9552..e6e82217711 100644 --- a/docs/6.10/classes/ConnectionPoolClosedEvent.html +++ b/docs/6.10/classes/ConnectionPoolClosedEvent.html @@ -1,6 +1,6 @@ -ConnectionPoolClosedEvent | mongodb

    Class ConnectionPoolClosedEvent

    An event published when a connection pool is closed

    +ConnectionPoolClosedEvent | mongodb

    Class ConnectionPoolClosedEvent

    An event published when a connection pool is closed

    Hierarchy (view full)

    Properties

    address time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ConnectionPoolCreatedEvent.html b/docs/6.10/classes/ConnectionPoolCreatedEvent.html index f2ffa318266..fadd913adce 100644 --- a/docs/6.10/classes/ConnectionPoolCreatedEvent.html +++ b/docs/6.10/classes/ConnectionPoolCreatedEvent.html @@ -1,8 +1,8 @@ -ConnectionPoolCreatedEvent | mongodb

    Class ConnectionPoolCreatedEvent

    An event published when a connection pool is created

    +ConnectionPoolCreatedEvent | mongodb

    Class ConnectionPoolCreatedEvent

    An event published when a connection pool is created

    Hierarchy (view full)

    Properties

    address options time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    options

    options: Pick<ConnectionPoolOptions,
        | "maxConnecting"
        | "maxIdleTimeMS"
        | "maxPoolSize"
        | "minPoolSize"
        | "waitQueueTimeoutMS">

    The options used to create this connection pool

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ConnectionPoolMonitoringEvent.html b/docs/6.10/classes/ConnectionPoolMonitoringEvent.html index 747f9347e6c..8219e109913 100644 --- a/docs/6.10/classes/ConnectionPoolMonitoringEvent.html +++ b/docs/6.10/classes/ConnectionPoolMonitoringEvent.html @@ -1,6 +1,6 @@ -ConnectionPoolMonitoringEvent | mongodb

    Class ConnectionPoolMonitoringEventAbstract

    The base export class for all monitoring events published from the connection pool

    +ConnectionPoolMonitoringEvent | mongodb

    Class ConnectionPoolMonitoringEventAbstract

    The base export class for all monitoring events published from the connection pool

    Hierarchy (view full)

    Properties

    address time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ConnectionPoolReadyEvent.html b/docs/6.10/classes/ConnectionPoolReadyEvent.html index ac5206aaf69..7b8dc8133d8 100644 --- a/docs/6.10/classes/ConnectionPoolReadyEvent.html +++ b/docs/6.10/classes/ConnectionPoolReadyEvent.html @@ -1,6 +1,6 @@ -ConnectionPoolReadyEvent | mongodb

    Class ConnectionPoolReadyEvent

    An event published when a connection pool is ready

    +ConnectionPoolReadyEvent | mongodb

    Class ConnectionPoolReadyEvent

    An event published when a connection pool is ready

    Hierarchy (view full)

    Properties

    address time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ConnectionReadyEvent.html b/docs/6.10/classes/ConnectionReadyEvent.html index 499ab56be59..8a49ab4b2ef 100644 --- a/docs/6.10/classes/ConnectionReadyEvent.html +++ b/docs/6.10/classes/ConnectionReadyEvent.html @@ -1,4 +1,4 @@ -ConnectionReadyEvent | mongodb

    Class ConnectionReadyEvent

    An event published when a connection is ready for use

    +ConnectionReadyEvent | mongodb

    Class ConnectionReadyEvent

    An event published when a connection is ready for use

    Hierarchy (view full)

    Properties

    address connectionId durationMS @@ -14,4 +14,4 @@ this duration is not greater than ConnectionCheckedOutEvent.duration.

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/Db.html b/docs/6.10/classes/Db.html index 0909a8c2e0f..0bad4dd4e6b 100644 --- a/docs/6.10/classes/Db.html +++ b/docs/6.10/classes/Db.html @@ -1,4 +1,4 @@ -Db | mongodb

    Class Db

    The Db class is a class that represents a MongoDB Database.

    +Db | mongodb

    Class Db

    The Db class is a class that represents a MongoDB Database.

    Example

    import { MongoClient } from 'mongodb';

    interface Pet {
      name: string;
      kind: 'dog' | 'cat' | 'fish';
    }

    const client = new MongoClient('mongodb://localhost:27017');
    const db = client.db();

    // Create a collection that validates our union
    await db.createCollection<Pet>('pets', {
      validator: { $expr: { $in: ['$kind', ['dog', 'cat', 'fish']] } }
    })
    @@ -130,4 +130,4 @@
  • The first is to provide the schema that may be defined for all the collections within this database
  • The second is to override the shape of the change stream document entirely, if it is not provided the type will default to ChangeStreamDocument of the first argument
    • -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/FindCursor.html b/docs/6.10/classes/FindCursor.html index 4e83903ac4c..b083edeb8f7 100644 --- a/docs/6.10/classes/FindCursor.html +++ b/docs/6.10/classes/FindCursor.html @@ -1,4 +1,4 @@ -FindCursor | mongodb

    Class FindCursor<TSchema>

    Type Parameters

    • TSchema = any

    Hierarchy (view full)

    Properties

    [asyncDispose] +FindCursor | mongodb

    Class FindCursor<TSchema>

    Type Parameters

    • TSchema = any

    Hierarchy (view full)

    Properties

    [asyncDispose] captureRejections captureRejectionSymbol CLOSE @@ -566,4 +566,4 @@

    Deprecat

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/FindOperators.html b/docs/6.10/classes/FindOperators.html index 3b0e0e30d1d..0b7f6d0445b 100644 --- a/docs/6.10/classes/FindOperators.html +++ b/docs/6.10/classes/FindOperators.html @@ -1,4 +1,4 @@ -FindOperators | mongodb

    Class FindOperators

    A builder object that is returned from BulkOperationBase#find. +FindOperators | mongodb

    Class FindOperators

    A builder object that is returned from BulkOperationBase#find. Is used to build a write operation that involves a query filter.

    Properties

    bulkOperation

    Methods

    arrayFilters @@ -19,4 +19,4 @@

    Parameters

    Returns BulkOperationBase

    update

    updateOne

    upsert

    • upsert(): this

    • Upsert modifier for update bulk operation, noting that this operation is an upsert.

      -

      Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/docs/6.10/classes/GridFSBucket.html b/docs/6.10/classes/GridFSBucket.html index 9aa3b6e6bd1..7f60dd271bb 100644 --- a/docs/6.10/classes/GridFSBucket.html +++ b/docs/6.10/classes/GridFSBucket.html @@ -1,4 +1,4 @@ -GridFSBucket | mongodb

    Class GridFSBucket

    Constructor for a streaming GridFS interface

    +GridFSBucket | mongodb

    Class GridFSBucket

    Constructor for a streaming GridFS interface

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    captureRejections captureRejectionSymbol @@ -455,4 +455,4 @@

    Deprecated

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/6.10/classes/GridFSBucketReadStream.html b/docs/6.10/classes/GridFSBucketReadStream.html index 7dad012880e..2e4fd47d721 100644 --- a/docs/6.10/classes/GridFSBucketReadStream.html +++ b/docs/6.10/classes/GridFSBucketReadStream.html @@ -1,4 +1,4 @@ -GridFSBucketReadStream | mongodb

    Class GridFSBucketReadStream

    A readable stream that enables you to read buffers from GridFS.

    +GridFSBucketReadStream | mongodb

    Class GridFSBucketReadStream

    A readable stream that enables you to read buffers from GridFS.

    Do not instantiate this class directly. Use openDownloadStream() instead.

    Hierarchy

    • Readable
      • GridFSBucketReadStream

    Properties

    closed destroyed @@ -1169,4 +1169,4 @@

    Deprecated

  • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    • Returns void

    Since

    v15.4.0

    StatictoWeb

    • toWeb(streamReadable): ReadableStream<any>
    • Experimental

      A utility method for creating a web ReadableStream from a Readable.

      Parameters

      • streamReadable: Readable

      Returns ReadableStream<any>

      Since

      v17.0.0

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/docs/6.10/classes/GridFSBucketWriteStream.html b/docs/6.10/classes/GridFSBucketWriteStream.html index 7b71582cef2..76a22dfd1f5 100644 --- a/docs/6.10/classes/GridFSBucketWriteStream.html +++ b/docs/6.10/classes/GridFSBucketWriteStream.html @@ -1,4 +1,4 @@ -GridFSBucketWriteStream | mongodb

    Class GridFSBucketWriteStream

    A writable stream that enables you to write buffers to GridFS.

    +GridFSBucketWriteStream | mongodb

    Class GridFSBucketWriteStream

    A writable stream that enables you to write buffers to GridFS.

    Do not instantiate this class directly. Use openUploadStream() instead.

    Hierarchy

    • Writable
      • GridFSBucketWriteStream

    Properties

    bucket bufToStore @@ -948,4 +948,4 @@

    Deprecated

  • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    • Returns void

    Since

    v15.4.0

    StatictoWeb

    • toWeb(streamWritable): WritableStream<any>
    • Experimental

      A utility method for creating a web WritableStream from a Writable.

      Parameters

      • streamWritable: Writable

      Returns WritableStream<any>

      Since

      v17.0.0

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/docs/6.10/classes/HostAddress.html b/docs/6.10/classes/HostAddress.html index 5285b0a5ec0..55cd67db391 100644 --- a/docs/6.10/classes/HostAddress.html +++ b/docs/6.10/classes/HostAddress.html @@ -1,4 +1,4 @@ -HostAddress | mongodb

    Class HostAddress

    Constructors

    constructor +HostAddress | mongodb

    Class HostAddress

    Constructors

    constructor

    Properties

    host isIPv6 port @@ -9,4 +9,4 @@ fromHostPort fromSrvRecord fromString -

    Constructors

    constructor

    Properties

    host

    host: undefined | string = undefined

    isIPv6

    isIPv6: boolean = false

    port

    port: undefined | number = undefined

    socketPath

    socketPath: undefined | string = undefined

    Methods

    inspect

    toHostPort

    • toHostPort(): {
          host: string;
          port: number;
      }

    • Returns {
          host: string;
          port: number;
      }

      • host: string
      • port: number

    toString

    StaticfromHostPort

    StaticfromSrvRecord

    StaticfromString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    host

    host: undefined | string = undefined

    isIPv6

    isIPv6: boolean = false

    port

    port: undefined | number = undefined

    socketPath

    socketPath: undefined | string = undefined

    Methods

    inspect

    toHostPort

    • toHostPort(): {
          host: string;
          port: number;
      }

    • Returns {
          host: string;
          port: number;
      }

      • host: string
      • port: number

    toString

    StaticfromHostPort

    StaticfromSrvRecord

    StaticfromString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/6.10/classes/ListCollectionsCursor.html b/docs/6.10/classes/ListCollectionsCursor.html index 4f519380b90..1fd7e4ef218 100644 --- a/docs/6.10/classes/ListCollectionsCursor.html +++ b/docs/6.10/classes/ListCollectionsCursor.html @@ -1,4 +1,4 @@ -ListCollectionsCursor | mongodb

    Class ListCollectionsCursor<T>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +ListCollectionsCursor | mongodb

    Class ListCollectionsCursor<T>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    [asyncDispose] filter options? @@ -507,4 +507,4 @@

    Deprecat

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/ListIndexesCursor.html b/docs/6.10/classes/ListIndexesCursor.html index 7a4904e033e..5aa9f4dce2e 100644 --- a/docs/6.10/classes/ListIndexesCursor.html +++ b/docs/6.10/classes/ListIndexesCursor.html @@ -1,4 +1,4 @@ -ListIndexesCursor | mongodb

    Class ListIndexesCursor

    Hierarchy (view full)

    Constructors

    constructor +ListIndexesCursor | mongodb

    Class ListIndexesCursor

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    [asyncDispose] options? parent @@ -506,4 +506,4 @@

    Deprecat

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/ListSearchIndexesCursor.html b/docs/6.10/classes/ListSearchIndexesCursor.html index 64eb0d31572..13b3b9c4155 100644 --- a/docs/6.10/classes/ListSearchIndexesCursor.html +++ b/docs/6.10/classes/ListSearchIndexesCursor.html @@ -1,4 +1,4 @@ -ListSearchIndexesCursor | mongodb

    Class ListSearchIndexesCursor

    Hierarchy (view full)

    Properties

    [asyncDispose] +ListSearchIndexesCursor | mongodb

    Class ListSearchIndexesCursor

    Hierarchy (view full)

    Properties

    [asyncDispose] pipeline captureRejections captureRejectionSymbol @@ -546,4 +546,4 @@

    Deprecat

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoAPIError.html b/docs/6.10/classes/MongoAPIError.html index 748d935db5c..f04a4d2b499 100644 --- a/docs/6.10/classes/MongoAPIError.html +++ b/docs/6.10/classes/MongoAPIError.html @@ -1,4 +1,4 @@ -MongoAPIError | mongodb

    Class MongoAPIError

    An error generated when the driver API is used incorrectly

    +MongoAPIError | mongodb

    Class MongoAPIError

    An error generated when the driver API is used incorrectly

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoAWSError.html b/docs/6.10/classes/MongoAWSError.html index d8fd71c4f77..cc5c5e1c4c4 100644 --- a/docs/6.10/classes/MongoAWSError.html +++ b/docs/6.10/classes/MongoAWSError.html @@ -1,4 +1,4 @@ -MongoAWSError | mongodb

    Class MongoAWSError

    A error generated when the user attempts to authenticate +MongoAWSError | mongodb

    Class MongoAWSError

    A error generated when the user attempts to authenticate via AWS, but fails

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoAzureError.html b/docs/6.10/classes/MongoAzureError.html index 45bd9b2c236..71a02105fbd 100644 --- a/docs/6.10/classes/MongoAzureError.html +++ b/docs/6.10/classes/MongoAzureError.html @@ -1,4 +1,4 @@ -MongoAzureError | mongodb

    Class MongoAzureError

    A error generated when the user attempts to authenticate +MongoAzureError | mongodb

    Class MongoAzureError

    A error generated when the user attempts to authenticate via Azure, but fails.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoBatchReExecutionError.html b/docs/6.10/classes/MongoBatchReExecutionError.html index cef755c4699..9bfce9210b5 100644 --- a/docs/6.10/classes/MongoBatchReExecutionError.html +++ b/docs/6.10/classes/MongoBatchReExecutionError.html @@ -1,4 +1,4 @@ -MongoBatchReExecutionError | mongodb

    Class MongoBatchReExecutionError

    An error generated when a batch command is re-executed after one of the commands in the batch +MongoBatchReExecutionError | mongodb

    Class MongoBatchReExecutionError

    An error generated when a batch command is re-executed after one of the commands in the batch has failed

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoBulkWriteError.html b/docs/6.10/classes/MongoBulkWriteError.html index 33b9305f2de..01433a1fcbf 100644 --- a/docs/6.10/classes/MongoBulkWriteError.html +++ b/docs/6.10/classes/MongoBulkWriteError.html @@ -1,4 +1,4 @@ -MongoBulkWriteError | mongodb

    Class MongoBulkWriteError

    An error indicating an unsuccessful Bulk Write

    +MongoBulkWriteError | mongodb

    Class MongoBulkWriteError

    An error indicating an unsuccessful Bulk Write

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -49,4 +49,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoChangeStreamError.html b/docs/6.10/classes/MongoChangeStreamError.html index 308aba32b0e..cc3c1b9d54c 100644 --- a/docs/6.10/classes/MongoChangeStreamError.html +++ b/docs/6.10/classes/MongoChangeStreamError.html @@ -1,4 +1,4 @@ -MongoChangeStreamError | mongodb

    Class MongoChangeStreamError

    An error generated when a ChangeStream operation fails to execute.

    +MongoChangeStreamError | mongodb

    Class MongoChangeStreamError

    An error generated when a ChangeStream operation fails to execute.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoClient.html b/docs/6.10/classes/MongoClient.html index f0dd474abac..8065d04eefb 100644 --- a/docs/6.10/classes/MongoClient.html +++ b/docs/6.10/classes/MongoClient.html @@ -1,4 +1,4 @@ -MongoClient | mongodb

    Class MongoClient

    The MongoClient class is a class that allows for making Connections to MongoDB.

    +MongoClient | mongodb

    Class MongoClient

    The MongoClient class is a class that allows for making Connections to MongoDB.

    Remarks

    The programmatically provided options take precedence over the URI options.

    Example

    import { MongoClient } from 'mongodb';

    // Enable command monitoring for debugging
    const client = new MongoClient('mongodb://localhost:27017', { monitorCommands: true });

    client.on('commandStarted', started => console.log(started));
    client.db().collection('pets');
    await client.insertOne({ name: 'spot', kind: 'dog' });
    @@ -483,4 +483,4 @@

    Deprecated

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoClientBulkWriteCursorError.html b/docs/6.10/classes/MongoClientBulkWriteCursorError.html index 5c44d096406..6ef6f43d93e 100644 --- a/docs/6.10/classes/MongoClientBulkWriteCursorError.html +++ b/docs/6.10/classes/MongoClientBulkWriteCursorError.html @@ -1,4 +1,4 @@ -MongoClientBulkWriteCursorError | mongodb

    Class MongoClientBulkWriteCursorError

    An error indicating that an error occurred when processing bulk write results.

    +MongoClientBulkWriteCursorError | mongodb

    Class MongoClientBulkWriteCursorError

    An error indicating that an error occurred when processing bulk write results.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoClientBulkWriteError.html b/docs/6.10/classes/MongoClientBulkWriteError.html index 49bdd932cec..610dc001545 100644 --- a/docs/6.10/classes/MongoClientBulkWriteError.html +++ b/docs/6.10/classes/MongoClientBulkWriteError.html @@ -1,4 +1,4 @@ -MongoClientBulkWriteError | mongodb

    Class MongoClientBulkWriteError

    An error indicating that an error occurred when executing the bulk write.

    +MongoClientBulkWriteError | mongodb

    Class MongoClientBulkWriteError

    An error indicating that an error occurred when executing the bulk write.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -39,4 +39,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoClientBulkWriteExecutionError.html b/docs/6.10/classes/MongoClientBulkWriteExecutionError.html index 2ad3ff2ab0f..77b9343b3b2 100644 --- a/docs/6.10/classes/MongoClientBulkWriteExecutionError.html +++ b/docs/6.10/classes/MongoClientBulkWriteExecutionError.html @@ -1,4 +1,4 @@ -MongoClientBulkWriteExecutionError | mongodb

    Class MongoClientBulkWriteExecutionError

    An error indicating that an error occurred on the client when executing a client bulk write.

    +MongoClientBulkWriteExecutionError | mongodb

    Class MongoClientBulkWriteExecutionError

    An error indicating that an error occurred on the client when executing a client bulk write.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoCompatibilityError.html b/docs/6.10/classes/MongoCompatibilityError.html index e0601997172..423f48df500 100644 --- a/docs/6.10/classes/MongoCompatibilityError.html +++ b/docs/6.10/classes/MongoCompatibilityError.html @@ -1,4 +1,4 @@ -MongoCompatibilityError | mongodb

    Class MongoCompatibilityError

    An error generated when a feature that is not enabled or allowed for the current server +MongoCompatibilityError | mongodb

    Class MongoCompatibilityError

    An error generated when a feature that is not enabled or allowed for the current server configuration is used

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoCredentials.html b/docs/6.10/classes/MongoCredentials.html index d7d2d7c60bc..cc4338fdc6c 100644 --- a/docs/6.10/classes/MongoCredentials.html +++ b/docs/6.10/classes/MongoCredentials.html @@ -1,5 +1,5 @@ -MongoCredentials | mongodb

    Class MongoCredentials

    A representation of the credentials used by MongoDB

    -

    Constructors

    constructor +MongoCredentials | mongodb

    Class MongoCredentials

    A representation of the credentials used by MongoDB

    +

    Constructors

    constructor

    Properties

    mechanism mechanismProperties password @@ -9,13 +9,13 @@ resolveAuthMechanism validate merge -

    Constructors

    constructor

    Properties

    Readonlymechanism

    mechanism: AuthMechanism

    The method used to authenticate

    -

    ReadonlymechanismProperties

    mechanismProperties: AuthMechanismProperties

    Special properties used by some types of auth mechanisms

    -

    Readonlypassword

    password: string

    The password used for authentication

    -

    Readonlysource

    source: string

    The database that the user should authenticate against

    -

    Readonlyusername

    username: string

    The username used for authentication

    -

    Methods

    equals

    resolveAuthMechanism

    • resolveAuthMechanism(hello): MongoCredentials

    • If the authentication mechanism is set to "default", resolves the authMechanism +

    Constructors

    constructor

    Properties

    Readonlymechanism

    mechanism: AuthMechanism

    The method used to authenticate

    +

    ReadonlymechanismProperties

    mechanismProperties: AuthMechanismProperties

    Special properties used by some types of auth mechanisms

    +

    Readonlypassword

    password: string

    The password used for authentication

    +

    Readonlysource

    source: string

    The database that the user should authenticate against

    +

    Readonlyusername

    username: string

    The username used for authentication

    +

    Methods

    equals

    resolveAuthMechanism

    validate

    Staticmerge

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns MongoCredentials

    validate

    Staticmerge

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/6.10/classes/MongoCryptAzureKMSRequestError.html b/docs/6.10/classes/MongoCryptAzureKMSRequestError.html index f5c3ec06ff4..8575315d941 100644 --- a/docs/6.10/classes/MongoCryptAzureKMSRequestError.html +++ b/docs/6.10/classes/MongoCryptAzureKMSRequestError.html @@ -1,4 +1,4 @@ -MongoCryptAzureKMSRequestError | mongodb

    Class MongoCryptAzureKMSRequestError

    An error indicating that mongodb-client-encryption failed to auto-refresh Azure KMS credentials.

    +MongoCryptAzureKMSRequestError | mongodb

    Class MongoCryptAzureKMSRequestError

    An error indicating that mongodb-client-encryption failed to auto-refresh Azure KMS credentials.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    body? cause? @@ -28,4 +28,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoCryptCreateDataKeyError.html b/docs/6.10/classes/MongoCryptCreateDataKeyError.html index 594d92fbf98..fa646c6c44a 100644 --- a/docs/6.10/classes/MongoCryptCreateDataKeyError.html +++ b/docs/6.10/classes/MongoCryptCreateDataKeyError.html @@ -1,4 +1,4 @@ -MongoCryptCreateDataKeyError | mongodb

    Class MongoCryptCreateDataKeyError

    An error indicating that ClientEncryption.createEncryptedCollection() failed to create data keys

    +MongoCryptCreateDataKeyError | mongodb

    Class MongoCryptCreateDataKeyError

    An error indicating that ClientEncryption.createEncryptedCollection() failed to create data keys

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoCryptCreateEncryptedCollectionError.html b/docs/6.10/classes/MongoCryptCreateEncryptedCollectionError.html index 5c4201b7249..f396599baba 100644 --- a/docs/6.10/classes/MongoCryptCreateEncryptedCollectionError.html +++ b/docs/6.10/classes/MongoCryptCreateEncryptedCollectionError.html @@ -1,4 +1,4 @@ -MongoCryptCreateEncryptedCollectionError | mongodb

    Class MongoCryptCreateEncryptedCollectionError

    An error indicating that ClientEncryption.createEncryptedCollection() failed to create a collection

    +MongoCryptCreateEncryptedCollectionError | mongodb

    Class MongoCryptCreateEncryptedCollectionError

    An error indicating that ClientEncryption.createEncryptedCollection() failed to create a collection

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoCryptError.html b/docs/6.10/classes/MongoCryptError.html index ed2c5315c68..84322196c2c 100644 --- a/docs/6.10/classes/MongoCryptError.html +++ b/docs/6.10/classes/MongoCryptError.html @@ -1,4 +1,4 @@ -MongoCryptError | mongodb

    Class MongoCryptError

    An error indicating that something went wrong specifically with MongoDB Client Encryption

    +MongoCryptError | mongodb

    Class MongoCryptError

    An error indicating that something went wrong specifically with MongoDB Client Encryption

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoCryptInvalidArgumentError.html b/docs/6.10/classes/MongoCryptInvalidArgumentError.html index 34e1828d5b3..4e6d9939589 100644 --- a/docs/6.10/classes/MongoCryptInvalidArgumentError.html +++ b/docs/6.10/classes/MongoCryptInvalidArgumentError.html @@ -1,4 +1,4 @@ -MongoCryptInvalidArgumentError | mongodb

    Class MongoCryptInvalidArgumentError

    An error indicating an invalid argument was provided to an encryption API.

    +MongoCryptInvalidArgumentError | mongodb

    Class MongoCryptInvalidArgumentError

    An error indicating an invalid argument was provided to an encryption API.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoCryptKMSRequestNetworkTimeoutError.html b/docs/6.10/classes/MongoCryptKMSRequestNetworkTimeoutError.html index 12a19a22c07..beaad1a437e 100644 --- a/docs/6.10/classes/MongoCryptKMSRequestNetworkTimeoutError.html +++ b/docs/6.10/classes/MongoCryptKMSRequestNetworkTimeoutError.html @@ -1,4 +1,4 @@ -MongoCryptKMSRequestNetworkTimeoutError | mongodb

    Class MongoCryptKMSRequestNetworkTimeoutError

    Hierarchy (view full)

    Constructors

    constructor +MongoCryptKMSRequestNetworkTimeoutError | mongodb

    Class MongoCryptKMSRequestNetworkTimeoutError

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? connectionGeneration? @@ -25,4 +25,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoCursorExhaustedError.html b/docs/6.10/classes/MongoCursorExhaustedError.html index 5f93b75c50f..b151e1336ea 100644 --- a/docs/6.10/classes/MongoCursorExhaustedError.html +++ b/docs/6.10/classes/MongoCursorExhaustedError.html @@ -1,4 +1,4 @@ -MongoCursorExhaustedError | mongodb

    Class MongoCursorExhaustedError

    An error thrown when an attempt is made to read from a cursor that has been exhausted

    +MongoCursorExhaustedError | mongodb

    Class MongoCursorExhaustedError

    An error thrown when an attempt is made to read from a cursor that has been exhausted

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoCursorInUseError.html b/docs/6.10/classes/MongoCursorInUseError.html index 25f93a740f0..43f5e4729fe 100644 --- a/docs/6.10/classes/MongoCursorInUseError.html +++ b/docs/6.10/classes/MongoCursorInUseError.html @@ -1,4 +1,4 @@ -MongoCursorInUseError | mongodb

    Class MongoCursorInUseError

    An error thrown when the user attempts to add options to a cursor that has already been +MongoCursorInUseError | mongodb

    Class MongoCursorInUseError

    An error thrown when the user attempts to add options to a cursor that has already been initialized

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoDBCollectionNamespace.html b/docs/6.10/classes/MongoDBCollectionNamespace.html index 1b1f0533870..ff1e6642043 100644 --- a/docs/6.10/classes/MongoDBCollectionNamespace.html +++ b/docs/6.10/classes/MongoDBCollectionNamespace.html @@ -1,4 +1,4 @@ -MongoDBCollectionNamespace | mongodb

    Class MongoDBCollectionNamespace

    A class representing a collection's namespace. This class enforces (through Typescript) that +MongoDBCollectionNamespace | mongodb

    Class MongoDBCollectionNamespace

    A class representing a collection's namespace. This class enforces (through Typescript) that the collection portion of the namespace is defined and should only be used in scenarios where this can be guaranteed.

    Hierarchy (view full)

    Constructors

    constructor @@ -9,4 +9,4 @@ fromString

    Constructors

    constructor

    Properties

    collection

    collection: string

    collection name

    db

    db: string

    database name

    -

    Methods

    toString

    withCollection

    StaticfromString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Methods

    toString

    withCollection

    StaticfromString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/6.10/classes/MongoDBNamespace.html b/docs/6.10/classes/MongoDBNamespace.html index 099ef11eedf..0127515f314 100644 --- a/docs/6.10/classes/MongoDBNamespace.html +++ b/docs/6.10/classes/MongoDBNamespace.html @@ -1,4 +1,4 @@ -MongoDBNamespace | mongodb

    Class MongoDBNamespace

    Hierarchy (view full)

    Constructors

    constructor +MongoDBNamespace | mongodb

    Class MongoDBNamespace

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    collection? db

    Methods

    toString @@ -9,4 +9,4 @@
  • Optionalcollection: string

    collection name

    • Returns MongoDBNamespace

    Properties

    Optionalcollection

    collection?: string

    collection name

    db

    db: string

    database name

    -

    Methods

    toString

    withCollection

    StaticfromString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Methods

    toString

    withCollection

    StaticfromString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/6.10/classes/MongoDecompressionError.html b/docs/6.10/classes/MongoDecompressionError.html index 7c25c70abf7..a1a901943f5 100644 --- a/docs/6.10/classes/MongoDecompressionError.html +++ b/docs/6.10/classes/MongoDecompressionError.html @@ -1,4 +1,4 @@ -MongoDecompressionError | mongodb

    Class MongoDecompressionError

    An error generated when the driver fails to decompress +MongoDecompressionError | mongodb

    Class MongoDecompressionError

    An error generated when the driver fails to decompress data received from the server.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoDriverError.html b/docs/6.10/classes/MongoDriverError.html index 138c2475152..fa2daa917f8 100644 --- a/docs/6.10/classes/MongoDriverError.html +++ b/docs/6.10/classes/MongoDriverError.html @@ -1,4 +1,4 @@ -MongoDriverError | mongodb

    Class MongoDriverError

    An error generated by the driver

    +MongoDriverError | mongodb

    Class MongoDriverError

    An error generated by the driver

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoError.html b/docs/6.10/classes/MongoError.html index 21b5680b1d7..f2179b0f880 100644 --- a/docs/6.10/classes/MongoError.html +++ b/docs/6.10/classes/MongoError.html @@ -1,4 +1,4 @@ -MongoError | mongodb

    Class MongoError

    Hierarchy (view full)

    Constructors

    constructor +MongoError | mongodb

    Class MongoError

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? connectionGeneration? @@ -25,4 +25,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoExpiredSessionError.html b/docs/6.10/classes/MongoExpiredSessionError.html index 096a23bf2fe..279686e69e6 100644 --- a/docs/6.10/classes/MongoExpiredSessionError.html +++ b/docs/6.10/classes/MongoExpiredSessionError.html @@ -1,4 +1,4 @@ -MongoExpiredSessionError | mongodb

    Class MongoExpiredSessionError

    An error generated when the user attempts to operate +MongoExpiredSessionError | mongodb

    Class MongoExpiredSessionError

    An error generated when the user attempts to operate on a session that has expired or has been closed.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoGCPError.html b/docs/6.10/classes/MongoGCPError.html index 1d52b5db5bc..57908765ceb 100644 --- a/docs/6.10/classes/MongoGCPError.html +++ b/docs/6.10/classes/MongoGCPError.html @@ -1,4 +1,4 @@ -MongoGCPError | mongodb

    Class MongoGCPError

    A error generated when the user attempts to authenticate +MongoGCPError | mongodb

    Class MongoGCPError

    A error generated when the user attempts to authenticate via GCP, but fails.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoGridFSChunkError.html b/docs/6.10/classes/MongoGridFSChunkError.html index 2b1a1943c52..83c866ee67b 100644 --- a/docs/6.10/classes/MongoGridFSChunkError.html +++ b/docs/6.10/classes/MongoGridFSChunkError.html @@ -1,4 +1,4 @@ -MongoGridFSChunkError | mongodb

    Class MongoGridFSChunkError

    An error generated when a malformed or invalid chunk is +MongoGridFSChunkError | mongodb

    Class MongoGridFSChunkError

    An error generated when a malformed or invalid chunk is encountered when reading from a GridFSStream.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoGridFSStreamError.html b/docs/6.10/classes/MongoGridFSStreamError.html index 987c7b206e0..8eef6d468ac 100644 --- a/docs/6.10/classes/MongoGridFSStreamError.html +++ b/docs/6.10/classes/MongoGridFSStreamError.html @@ -1,4 +1,4 @@ -MongoGridFSStreamError | mongodb

    Class MongoGridFSStreamError

    An error generated when a GridFSStream operation fails to execute.

    +MongoGridFSStreamError | mongodb

    Class MongoGridFSStreamError

    An error generated when a GridFSStream operation fails to execute.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoInvalidArgumentError.html b/docs/6.10/classes/MongoInvalidArgumentError.html index 390d217efdf..9b455ca76a1 100644 --- a/docs/6.10/classes/MongoInvalidArgumentError.html +++ b/docs/6.10/classes/MongoInvalidArgumentError.html @@ -1,4 +1,4 @@ -MongoInvalidArgumentError | mongodb

    Class MongoInvalidArgumentError

    An error generated when the user supplies malformed or unexpected arguments +MongoInvalidArgumentError | mongodb

    Class MongoInvalidArgumentError

    An error generated when the user supplies malformed or unexpected arguments or when a required argument or field is not provided.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoKerberosError.html b/docs/6.10/classes/MongoKerberosError.html index 623c4d8a69c..4395da78a7e 100644 --- a/docs/6.10/classes/MongoKerberosError.html +++ b/docs/6.10/classes/MongoKerberosError.html @@ -1,4 +1,4 @@ -MongoKerberosError | mongodb

    Class MongoKerberosError

    A error generated when the user attempts to authenticate +MongoKerberosError | mongodb

    Class MongoKerberosError

    A error generated when the user attempts to authenticate via Kerberos, but fails to connect to the Kerberos client.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoMissingCredentialsError.html b/docs/6.10/classes/MongoMissingCredentialsError.html index 7e71bd149bf..8d3686bb02f 100644 --- a/docs/6.10/classes/MongoMissingCredentialsError.html +++ b/docs/6.10/classes/MongoMissingCredentialsError.html @@ -1,4 +1,4 @@ -MongoMissingCredentialsError | mongodb

    Class MongoMissingCredentialsError

    An error generated when the user fails to provide authentication credentials before attempting +MongoMissingCredentialsError | mongodb

    Class MongoMissingCredentialsError

    An error generated when the user fails to provide authentication credentials before attempting to connect to a mongo server instance.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoMissingDependencyError.html b/docs/6.10/classes/MongoMissingDependencyError.html index 5fe6cffc4d6..f20b69d4a95 100644 --- a/docs/6.10/classes/MongoMissingDependencyError.html +++ b/docs/6.10/classes/MongoMissingDependencyError.html @@ -1,4 +1,4 @@ -MongoMissingDependencyError | mongodb

    Class MongoMissingDependencyError

    An error generated when a required module or dependency is not present in the local environment

    +MongoMissingDependencyError | mongodb

    Class MongoMissingDependencyError

    An error generated when a required module or dependency is not present in the local environment

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause code? @@ -28,4 +28,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoNetworkError.html b/docs/6.10/classes/MongoNetworkError.html index 2b393092eaa..0639bb709ab 100644 --- a/docs/6.10/classes/MongoNetworkError.html +++ b/docs/6.10/classes/MongoNetworkError.html @@ -1,4 +1,4 @@ -MongoNetworkError | mongodb

    Class MongoNetworkError

    An error indicating an issue with the network, including TCP errors and timeouts.

    +MongoNetworkError | mongodb

    Class MongoNetworkError

    An error indicating an issue with the network, including TCP errors and timeouts.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoNetworkTimeoutError.html b/docs/6.10/classes/MongoNetworkTimeoutError.html index e451e629294..6d1517b3bb1 100644 --- a/docs/6.10/classes/MongoNetworkTimeoutError.html +++ b/docs/6.10/classes/MongoNetworkTimeoutError.html @@ -1,4 +1,4 @@ -MongoNetworkTimeoutError | mongodb

    Class MongoNetworkTimeoutError

    An error indicating a network timeout occurred

    +MongoNetworkTimeoutError | mongodb

    Class MongoNetworkTimeoutError

    An error indicating a network timeout occurred

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoNotConnectedError.html b/docs/6.10/classes/MongoNotConnectedError.html index 0f7153e51d1..3bc6254aa64 100644 --- a/docs/6.10/classes/MongoNotConnectedError.html +++ b/docs/6.10/classes/MongoNotConnectedError.html @@ -1,4 +1,4 @@ -MongoNotConnectedError | mongodb

    Class MongoNotConnectedError

    An error thrown when the user attempts to operate on a database or collection through a MongoClient +MongoNotConnectedError | mongodb

    Class MongoNotConnectedError

    An error thrown when the user attempts to operate on a database or collection through a MongoClient that has not yet successfully called the "connect" method

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoOIDCError.html b/docs/6.10/classes/MongoOIDCError.html index 107edf3ce66..8292b4ccd4e 100644 --- a/docs/6.10/classes/MongoOIDCError.html +++ b/docs/6.10/classes/MongoOIDCError.html @@ -1,4 +1,4 @@ -MongoOIDCError | mongodb

    Class MongoOIDCError

    A error generated when the user attempts to authenticate +MongoOIDCError | mongodb

    Class MongoOIDCError

    A error generated when the user attempts to authenticate via OIDC callbacks, but fails.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoParseError.html b/docs/6.10/classes/MongoParseError.html index e1a39b41fb4..9395bf3983a 100644 --- a/docs/6.10/classes/MongoParseError.html +++ b/docs/6.10/classes/MongoParseError.html @@ -1,4 +1,4 @@ -MongoParseError | mongodb

    Class MongoParseError

    An error used when attempting to parse a value (like a connection string)

    +MongoParseError | mongodb

    Class MongoParseError

    An error used when attempting to parse a value (like a connection string)

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoRuntimeError.html b/docs/6.10/classes/MongoRuntimeError.html index a65d5da28b7..02576d9f0c7 100644 --- a/docs/6.10/classes/MongoRuntimeError.html +++ b/docs/6.10/classes/MongoRuntimeError.html @@ -1,4 +1,4 @@ -MongoRuntimeError | mongodb

    Class MongoRuntimeError

    An error generated when the driver encounters unexpected input +MongoRuntimeError | mongodb

    Class MongoRuntimeError

    An error generated when the driver encounters unexpected input or reaches an unexpected/invalid internal state

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoServerClosedError.html b/docs/6.10/classes/MongoServerClosedError.html index 1e76f14892b..12f60d86978 100644 --- a/docs/6.10/classes/MongoServerClosedError.html +++ b/docs/6.10/classes/MongoServerClosedError.html @@ -1,4 +1,4 @@ -MongoServerClosedError | mongodb

    Class MongoServerClosedError

    An error generated when an attempt is made to operate +MongoServerClosedError | mongodb

    Class MongoServerClosedError

    An error generated when an attempt is made to operate on a closed/closing server.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoServerError.html b/docs/6.10/classes/MongoServerError.html index 031959efed8..fbaab63efd6 100644 --- a/docs/6.10/classes/MongoServerError.html +++ b/docs/6.10/classes/MongoServerError.html @@ -1,4 +1,4 @@ -MongoServerError | mongodb

    Class MongoServerError

    An error coming from the mongo server

    +MongoServerError | mongodb

    Class MongoServerError

    An error coming from the mongo server

    Hierarchy (view full)

    Indexable

    • [key: string]: any

    Constructors

    constructor

    Properties

    cause? code? @@ -32,4 +32,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoServerSelectionError.html b/docs/6.10/classes/MongoServerSelectionError.html index 9e2f2b79e5d..c3fa3d02b02 100644 --- a/docs/6.10/classes/MongoServerSelectionError.html +++ b/docs/6.10/classes/MongoServerSelectionError.html @@ -1,4 +1,4 @@ -MongoServerSelectionError | mongodb

    Class MongoServerSelectionError

    An error signifying a client-side server selection error

    +MongoServerSelectionError | mongodb

    Class MongoServerSelectionError

    An error signifying a client-side server selection error

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -28,4 +28,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoSystemError.html b/docs/6.10/classes/MongoSystemError.html index 96f86deae69..1a5a7a5d71b 100644 --- a/docs/6.10/classes/MongoSystemError.html +++ b/docs/6.10/classes/MongoSystemError.html @@ -1,4 +1,4 @@ -MongoSystemError | mongodb

    Class MongoSystemError

    An error signifying a general system issue

    +MongoSystemError | mongodb

    Class MongoSystemError

    An error signifying a general system issue

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -28,4 +28,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoTailableCursorError.html b/docs/6.10/classes/MongoTailableCursorError.html index e0d3ab751ce..540f73adf53 100644 --- a/docs/6.10/classes/MongoTailableCursorError.html +++ b/docs/6.10/classes/MongoTailableCursorError.html @@ -1,4 +1,4 @@ -MongoTailableCursorError | mongodb

    Class MongoTailableCursorError

    An error thrown when the user calls a function or method not supported on a tailable cursor

    +MongoTailableCursorError | mongodb

    Class MongoTailableCursorError

    An error thrown when the user calls a function or method not supported on a tailable cursor

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoTopologyClosedError.html b/docs/6.10/classes/MongoTopologyClosedError.html index e28fb0c65e3..bf08374f06d 100644 --- a/docs/6.10/classes/MongoTopologyClosedError.html +++ b/docs/6.10/classes/MongoTopologyClosedError.html @@ -1,4 +1,4 @@ -MongoTopologyClosedError | mongodb

    Class MongoTopologyClosedError

    An error generated when an attempt is made to operate on a +MongoTopologyClosedError | mongodb

    Class MongoTopologyClosedError

    An error generated when an attempt is made to operate on a dropped, or otherwise unavailable, database.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoTransactionError.html b/docs/6.10/classes/MongoTransactionError.html index 63ca53a8370..5b7d8b23988 100644 --- a/docs/6.10/classes/MongoTransactionError.html +++ b/docs/6.10/classes/MongoTransactionError.html @@ -1,4 +1,4 @@ -MongoTransactionError | mongodb

    Class MongoTransactionError

    An error generated when the user makes a mistake in the usage of transactions. +MongoTransactionError | mongodb

    Class MongoTransactionError

    An error generated when the user makes a mistake in the usage of transactions. (e.g. attempting to commit a transaction with a readPreference other than primary)

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoUnexpectedServerResponseError.html b/docs/6.10/classes/MongoUnexpectedServerResponseError.html index 005f522f875..5fd3336cb67 100644 --- a/docs/6.10/classes/MongoUnexpectedServerResponseError.html +++ b/docs/6.10/classes/MongoUnexpectedServerResponseError.html @@ -1,4 +1,4 @@ -MongoUnexpectedServerResponseError | mongodb

    Class MongoUnexpectedServerResponseError

    An error generated when a parsable unexpected response comes from the server. +MongoUnexpectedServerResponseError | mongodb

    Class MongoUnexpectedServerResponseError

    An error generated when a parsable unexpected response comes from the server. This is generally an error where the driver in a state expecting a certain behavior to occur in the next message from MongoDB but it receives something else. This error does not represent an issue with wire message formatting.

    @@ -34,4 +34,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Example
    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Example
    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/MongoWriteConcernError.html b/docs/6.10/classes/MongoWriteConcernError.html index 89463a7ac1a..e32270958b2 100644 --- a/docs/6.10/classes/MongoWriteConcernError.html +++ b/docs/6.10/classes/MongoWriteConcernError.html @@ -1,4 +1,4 @@ -MongoWriteConcernError | mongodb

    Class MongoWriteConcernError

    An error thrown when the server reports a writeConcernError

    +MongoWriteConcernError | mongodb

    Class MongoWriteConcernError

    An error thrown when the server reports a writeConcernError

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -34,4 +34,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/OrderedBulkOperation.html b/docs/6.10/classes/OrderedBulkOperation.html index d74709aa226..510a5bc01af 100644 --- a/docs/6.10/classes/OrderedBulkOperation.html +++ b/docs/6.10/classes/OrderedBulkOperation.html @@ -1,4 +1,4 @@ -OrderedBulkOperation | mongodb

    Class OrderedBulkOperation

    Hierarchy (view full)

    Properties

    isOrdered +OrderedBulkOperation | mongodb

    Class OrderedBulkOperation

    Hierarchy (view full)

    Properties

    isOrdered operationId?

    Accessors

    batches bsonOptions @@ -19,4 +19,4 @@

    raw

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/ReadConcern.html b/docs/6.10/classes/ReadConcern.html index 4dab43d7936..5ab2e956a40 100644 --- a/docs/6.10/classes/ReadConcern.html +++ b/docs/6.10/classes/ReadConcern.html @@ -1,4 +1,4 @@ -ReadConcern | mongodb

    Class ReadConcern

    The MongoDB ReadConcern, which allows for control of the consistency and isolation properties +ReadConcern | mongodb

    Class ReadConcern

    The MongoDB ReadConcern, which allows for control of the consistency and isolation properties of the data read from replica sets and replica set shards.

    See

    https://www.mongodb.com/docs/manual/reference/read-concern/index.html

    Constructors

    constructor @@ -12,4 +12,4 @@

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    StaticAVAILABLE

    StaticLINEARIZABLE

    StaticMAJORITY

    StaticSNAPSHOT

    Methods

    toJSON

    StaticfromOptions

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns undefined | ReadConcern

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/ReadPreference.html b/docs/6.10/classes/ReadPreference.html index 314572727fa..e03599073b4 100644 --- a/docs/6.10/classes/ReadPreference.html +++ b/docs/6.10/classes/ReadPreference.html @@ -1,4 +1,4 @@ -ReadPreference | mongodb

    Class ReadPreference

    The ReadPreference class is a class that represents a MongoDB ReadPreference and is +ReadPreference | mongodb

    Class ReadPreference

    The ReadPreference class is a class that represents a MongoDB ReadPreference and is used to construct connections.

    See

    https://www.mongodb.com/docs/manual/core/read-preference/

    Constructors

    constructor @@ -41,4 +41,4 @@

    Returns undefined | ReadPreference

    StaticfromString

    StaticisValid

    • isValid(mode): boolean

    • Validate if a mode is legal

      Parameters

      • mode: string

        The string representing the read preference mode.

      Returns boolean

    Statictranslate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns ReadPreferenceLikeOptions

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/RunCommandCursor.html b/docs/6.10/classes/RunCommandCursor.html index da732f4415b..71109c22151 100644 --- a/docs/6.10/classes/RunCommandCursor.html +++ b/docs/6.10/classes/RunCommandCursor.html @@ -1,4 +1,4 @@ -RunCommandCursor | mongodb

    Class RunCommandCursor

    Hierarchy (view full)

    Properties

    [asyncDispose] +RunCommandCursor | mongodb

    Class RunCommandCursor

    Hierarchy (view full)

    Properties

    [asyncDispose] command getMoreOptions captureRejections @@ -509,4 +509,4 @@

    Deprecat

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/ServerCapabilities.html b/docs/6.10/classes/ServerCapabilities.html index c1b6f911de7..96b735c42a4 100644 --- a/docs/6.10/classes/ServerCapabilities.html +++ b/docs/6.10/classes/ServerCapabilities.html @@ -1,4 +1,4 @@ -ServerCapabilities | mongodb

    Class ServerCapabilities

    Constructors

    constructor +ServerCapabilities | mongodb

    Class ServerCapabilities

    Constructors

    constructor

    Properties

    maxWireVersion minWireVersion

    Accessors

    commandsTakeCollation @@ -10,4 +10,4 @@ hasTextSearch hasWriteCommands supportsSnapshotReads -

    Constructors

    constructor

    Properties

    maxWireVersion

    maxWireVersion: number

    minWireVersion

    minWireVersion: number

    Accessors

    commandsTakeCollation

    commandsTakeWriteConcern

    hasAggregationCursor

    hasAuthCommands

    hasListCollectionsCommand

    hasListIndexesCommand

    hasTextSearch

    hasWriteCommands

    supportsSnapshotReads

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    +

    Constructors

    constructor

    Properties

    maxWireVersion

    maxWireVersion: number

    minWireVersion

    minWireVersion: number

    Accessors

    commandsTakeCollation

    commandsTakeWriteConcern

    hasAggregationCursor

    hasAuthCommands

    hasListCollectionsCommand

    hasListIndexesCommand

    hasTextSearch

    hasWriteCommands

    supportsSnapshotReads

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    diff --git a/docs/6.10/classes/ServerClosedEvent.html b/docs/6.10/classes/ServerClosedEvent.html index a99759d4bef..57d6f64ce2d 100644 --- a/docs/6.10/classes/ServerClosedEvent.html +++ b/docs/6.10/classes/ServerClosedEvent.html @@ -1,6 +1,6 @@ -ServerClosedEvent | mongodb

    Class ServerClosedEvent

    Emitted when server is closed.

    +ServerClosedEvent | mongodb

    Class ServerClosedEvent

    Emitted when server is closed.

    Properties

    address topologyId

    Properties

    address

    address: string

    The address (host/port pair) of the server

    topologyId

    topologyId: number

    A unique identifier for the topology

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ServerDescription.html b/docs/6.10/classes/ServerDescription.html index 12520307557..3ea76ad180f 100644 --- a/docs/6.10/classes/ServerDescription.html +++ b/docs/6.10/classes/ServerDescription.html @@ -1,4 +1,4 @@ -ServerDescription | mongodb

    Class ServerDescription

    The client's view of a single server, based on the most recent hello outcome.

    +ServerDescription | mongodb

    Class ServerDescription

    The client's view of a single server, based on the most recent hello outcome.

    Internal type, not meant to be directly instantiated

    Properties

    $clusterTime? address @@ -39,6 +39,6 @@

    minWireVersion

    minWireVersion: number

    passives

    passives: string[]

    primary

    primary: null | string

    roundTripTime

    roundTripTime: number

    setName

    setName: null | string

    setVersion

    setVersion: null | number

    tags

    tags: TagSet

    topologyVersion

    topologyVersion: null | TopologyVersion

    type

    type: ServerType

    Accessors

    allHosts

    host

    hostAddress

    isDataBearing

    isReadable

    isWritable

    port

    Methods

    equals

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Returns boolean

    port

    Methods

    equals

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/ServerDescriptionChangedEvent.html b/docs/6.10/classes/ServerDescriptionChangedEvent.html index 6435e44a042..ace2b441648 100644 --- a/docs/6.10/classes/ServerDescriptionChangedEvent.html +++ b/docs/6.10/classes/ServerDescriptionChangedEvent.html @@ -1,4 +1,4 @@ -ServerDescriptionChangedEvent | mongodb

    Class ServerDescriptionChangedEvent

    Emitted when server description changes, but does NOT include changes to the RTT.

    +ServerDescriptionChangedEvent | mongodb

    Class ServerDescriptionChangedEvent

    Emitted when server description changes, but does NOT include changes to the RTT.

    Properties

    address name newDescription @@ -8,4 +8,4 @@

    name

    name: "serverDescriptionChanged" = SERVER_DESCRIPTION_CHANGED

    newDescription

    newDescription: ServerDescription

    The new server description

    previousDescription

    previousDescription: ServerDescription

    The previous server description

    topologyId

    topologyId: number

    A unique identifier for the topology

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ServerHeartbeatFailedEvent.html b/docs/6.10/classes/ServerHeartbeatFailedEvent.html index 709bf46a4f8..487be9524c2 100644 --- a/docs/6.10/classes/ServerHeartbeatFailedEvent.html +++ b/docs/6.10/classes/ServerHeartbeatFailedEvent.html @@ -1,4 +1,4 @@ -ServerHeartbeatFailedEvent | mongodb

    Class ServerHeartbeatFailedEvent

    Emitted when the server monitor’s hello fails, either with an “ok: 0” or a socket exception.

    +ServerHeartbeatFailedEvent | mongodb

    Class ServerHeartbeatFailedEvent

    Emitted when the server monitor’s hello fails, either with an “ok: 0” or a socket exception.

    Properties

    awaited connectionId duration @@ -7,4 +7,4 @@

    connectionId

    connectionId: string

    The connection id for the command

    duration

    duration: number

    The execution time of the event in ms

    failure

    failure: Error

    The command failure

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ServerHeartbeatStartedEvent.html b/docs/6.10/classes/ServerHeartbeatStartedEvent.html index 0d76dc11b04..8d28b3cc231 100644 --- a/docs/6.10/classes/ServerHeartbeatStartedEvent.html +++ b/docs/6.10/classes/ServerHeartbeatStartedEvent.html @@ -1,7 +1,7 @@ -ServerHeartbeatStartedEvent | mongodb

    Class ServerHeartbeatStartedEvent

    Emitted when the server monitor’s hello command is started - immediately before +ServerHeartbeatStartedEvent | mongodb

    Class ServerHeartbeatStartedEvent

    Emitted when the server monitor’s hello command is started - immediately before the hello command is serialized into raw BSON and written to the socket.

    Properties

    awaited connectionId

    Properties

    awaited

    awaited: boolean

    Is true when using the streaming protocol

    connectionId

    connectionId: string

    The connection id for the command

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ServerHeartbeatSucceededEvent.html b/docs/6.10/classes/ServerHeartbeatSucceededEvent.html index 180a3da4d6f..8adefce0028 100644 --- a/docs/6.10/classes/ServerHeartbeatSucceededEvent.html +++ b/docs/6.10/classes/ServerHeartbeatSucceededEvent.html @@ -1,4 +1,4 @@ -ServerHeartbeatSucceededEvent | mongodb

    Class ServerHeartbeatSucceededEvent

    Emitted when the server monitor’s hello succeeds.

    +ServerHeartbeatSucceededEvent | mongodb

    Class ServerHeartbeatSucceededEvent

    Emitted when the server monitor’s hello succeeds.

    Properties

    awaited connectionId duration @@ -7,4 +7,4 @@

    connectionId

    connectionId: string

    The connection id for the command

    duration

    duration: number

    The execution time of the event in ms

    reply

    reply: Document

    The command reply

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ServerOpeningEvent.html b/docs/6.10/classes/ServerOpeningEvent.html index 65ce7e4e793..4d3e8f41168 100644 --- a/docs/6.10/classes/ServerOpeningEvent.html +++ b/docs/6.10/classes/ServerOpeningEvent.html @@ -1,6 +1,6 @@ -ServerOpeningEvent | mongodb

    Class ServerOpeningEvent

    Emitted when server is initialized.

    +ServerOpeningEvent | mongodb

    Class ServerOpeningEvent

    Emitted when server is initialized.

    Properties

    address topologyId

    Properties

    address

    address: string

    The address (host/port pair) of the server

    topologyId

    topologyId: number

    A unique identifier for the topology

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/ServerSession.html b/docs/6.10/classes/ServerSession.html index a5ae6de28bd..1c0e0165532 100644 --- a/docs/6.10/classes/ServerSession.html +++ b/docs/6.10/classes/ServerSession.html @@ -1,4 +1,4 @@ -ServerSession | mongodb

    Class ServerSession

    Reflects the existence of a session on the server. Can be reused by the session pool. +ServerSession | mongodb

    Class ServerSession

    Reflects the existence of a session on the server. Can be reused by the session pool. WARNING: not meant to be instantiated directly. For internal use only.

    Properties

    id isDirty @@ -7,4 +7,4 @@

    Methods

    hasTimedOut

    Properties

    id

    id: ServerSessionId

    isDirty

    isDirty: boolean

    lastUse

    lastUse: number

    txnNumber

    txnNumber: number

    Methods

    hasTimedOut

    • hasTimedOut(sessionTimeoutMinutes): boolean

    • Determines if the server session has timed out.

      Parameters

      • sessionTimeoutMinutes: number

        The server's "logicalSessionTimeoutMinutes"

        -

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/docs/6.10/classes/StreamDescription.html b/docs/6.10/classes/StreamDescription.html index c49b3fab36d..4c03f6c3ba9 100644 --- a/docs/6.10/classes/StreamDescription.html +++ b/docs/6.10/classes/StreamDescription.html @@ -1,4 +1,4 @@ -StreamDescription | mongodb

    Class StreamDescription

    Constructors

    constructor +StreamDescription | mongodb

    Class StreamDescription

    Constructors

    constructor

    Properties

    __nodejs_mock_server__? address compressor? @@ -16,4 +16,4 @@ zlibCompressionLevel?

    Methods

    parseServerConnectionID receiveResponse -

    Constructors

    constructor

    Properties

    Optional__nodejs_mock_server__

    __nodejs_mock_server__?: boolean

    address

    address: string

    Optionalcompressor

    compressor?:
        | "none"
        | "snappy"
        | "zlib"
        | "zstd"

    compressors

    compressors: (
        | "none"
        | "snappy"
        | "zlib"
        | "zstd")[]

    hello

    hello: null | Document = null

    loadBalanced

    loadBalanced: boolean

    OptionallogicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    maxBsonObjectSize

    maxBsonObjectSize: number

    maxMessageSizeBytes

    maxMessageSizeBytes: number

    OptionalmaxWireVersion

    maxWireVersion?: number

    maxWriteBatchSize

    maxWriteBatchSize: number

    OptionalminWireVersion

    minWireVersion?: number

    serverConnectionId

    serverConnectionId: null | bigint

    type

    type: ServerType

    OptionalzlibCompressionLevel

    zlibCompressionLevel?: number

    Methods

    parseServerConnectionID

    receiveResponse

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    Optional__nodejs_mock_server__

    __nodejs_mock_server__?: boolean

    address

    address: string

    Optionalcompressor

    compressor?:
        | "none"
        | "snappy"
        | "zlib"
        | "zstd"

    compressors

    compressors: (
        | "none"
        | "snappy"
        | "zlib"
        | "zstd")[]

    hello

    hello: null | Document = null

    loadBalanced

    loadBalanced: boolean

    OptionallogicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    maxBsonObjectSize

    maxBsonObjectSize: number

    maxMessageSizeBytes

    maxMessageSizeBytes: number

    OptionalmaxWireVersion

    maxWireVersion?: number

    maxWriteBatchSize

    maxWriteBatchSize: number

    OptionalminWireVersion

    minWireVersion?: number

    serverConnectionId

    serverConnectionId: null | bigint

    type

    type: ServerType

    OptionalzlibCompressionLevel

    zlibCompressionLevel?: number

    Methods

    parseServerConnectionID

    receiveResponse

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/6.10/classes/TopologyClosedEvent.html b/docs/6.10/classes/TopologyClosedEvent.html index 9fefa566d5e..e5a8932df29 100644 --- a/docs/6.10/classes/TopologyClosedEvent.html +++ b/docs/6.10/classes/TopologyClosedEvent.html @@ -1,4 +1,4 @@ -TopologyClosedEvent | mongodb

    Class TopologyClosedEvent

    Emitted when topology is closed.

    +TopologyClosedEvent | mongodb

    Class TopologyClosedEvent

    Emitted when topology is closed.

    Properties

    topologyId

    Properties

    topologyId

    topologyId: number

    A unique identifier for the topology

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/TopologyDescription.html b/docs/6.10/classes/TopologyDescription.html index 3236259eb4c..5c089fcda63 100644 --- a/docs/6.10/classes/TopologyDescription.html +++ b/docs/6.10/classes/TopologyDescription.html @@ -1,4 +1,4 @@ -TopologyDescription | mongodb

    Class TopologyDescription

    Representation of a deployment of servers

    +TopologyDescription | mongodb

    Class TopologyDescription

    Representation of a deployment of servers

    Constructors

    constructor

    Properties

    commonWireVersion compatibilityError? @@ -22,4 +22,4 @@

    Returns boolean

    Methods

    toJSON

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns Document

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/TopologyDescriptionChangedEvent.html b/docs/6.10/classes/TopologyDescriptionChangedEvent.html index deecc2b8c8f..89d7c552651 100644 --- a/docs/6.10/classes/TopologyDescriptionChangedEvent.html +++ b/docs/6.10/classes/TopologyDescriptionChangedEvent.html @@ -1,8 +1,8 @@ -TopologyDescriptionChangedEvent | mongodb

    Class TopologyDescriptionChangedEvent

    Emitted when topology description changes.

    +TopologyDescriptionChangedEvent | mongodb

    Class TopologyDescriptionChangedEvent

    Emitted when topology description changes.

    Properties

    newDescription previousDescription topologyId

    Properties

    newDescription

    newDescription: TopologyDescription

    The new topology description

    previousDescription

    previousDescription: TopologyDescription

    The old topology description

    topologyId

    topologyId: number

    A unique identifier for the topology

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/TopologyOpeningEvent.html b/docs/6.10/classes/TopologyOpeningEvent.html index 9e8780ad7c7..262c5c436fa 100644 --- a/docs/6.10/classes/TopologyOpeningEvent.html +++ b/docs/6.10/classes/TopologyOpeningEvent.html @@ -1,4 +1,4 @@ -TopologyOpeningEvent | mongodb

    Class TopologyOpeningEvent

    Emitted when topology is initialized.

    +TopologyOpeningEvent | mongodb

    Class TopologyOpeningEvent

    Emitted when topology is initialized.

    Properties

    topologyId

    Properties

    topologyId

    topologyId: number

    A unique identifier for the topology

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/classes/Transaction.html b/docs/6.10/classes/Transaction.html index 07c1d921bee..11b9d22ca7f 100644 --- a/docs/6.10/classes/Transaction.html +++ b/docs/6.10/classes/Transaction.html @@ -1,4 +1,4 @@ -Transaction | mongodb

    Class Transaction

    A class maintaining state related to a server transaction. Internal Only

    +Transaction | mongodb

    Class Transaction

    A class maintaining state related to a server transaction. Internal Only

    Properties

    options

    Accessors

    isActive isCommitted @@ -7,4 +7,4 @@ recoveryToken

    Properties

    options

    options: TransactionOptions

    Accessors

    isActive

    • get isActive(): boolean

    • Returns boolean

      Whether this session is presently in a transaction

    isCommitted

    isPinned

    isStarting

    recoveryToken

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    +

    recoveryToken

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    diff --git a/docs/6.10/classes/TypedEventEmitter.html b/docs/6.10/classes/TypedEventEmitter.html index 7760f77ffde..c1a4ab64bd9 100644 --- a/docs/6.10/classes/TypedEventEmitter.html +++ b/docs/6.10/classes/TypedEventEmitter.html @@ -1,4 +1,4 @@ -TypedEventEmitter | mongodb

    Class TypedEventEmitter<Events>

    Typescript type safe event emitter

    +TypedEventEmitter | mongodb

    Class TypedEventEmitter<Events>

    Typescript type safe event emitter

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    captureRejections captureRejectionSymbol @@ -420,4 +420,4 @@

    Deprecated

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/6.10/classes/UnorderedBulkOperation.html b/docs/6.10/classes/UnorderedBulkOperation.html index 3d7d41b2e9f..95fd37be175 100644 --- a/docs/6.10/classes/UnorderedBulkOperation.html +++ b/docs/6.10/classes/UnorderedBulkOperation.html @@ -1,4 +1,4 @@ -UnorderedBulkOperation | mongodb

    Class UnorderedBulkOperation

    Hierarchy (view full)

    Properties

    isOrdered +UnorderedBulkOperation | mongodb

    Class UnorderedBulkOperation

    Hierarchy (view full)

    Properties

    isOrdered operationId?

    Accessors

    batches bsonOptions @@ -19,4 +19,4 @@

    raw

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/classes/WriteConcern.html b/docs/6.10/classes/WriteConcern.html index d44443370b0..56d8f301bd3 100644 --- a/docs/6.10/classes/WriteConcern.html +++ b/docs/6.10/classes/WriteConcern.html @@ -1,4 +1,4 @@ -WriteConcern | mongodb

    Class WriteConcern

    A MongoDB WriteConcern, which describes the level of acknowledgement +WriteConcern | mongodb

    Class WriteConcern

    A MongoDB WriteConcern, which describes the level of acknowledgement requested from MongoDB for write operations.

    See

    https://www.mongodb.com/docs/manual/reference/write-concern/

    Constructors

    constructor @@ -27,4 +27,4 @@

    Optional ReadonlywtimeoutMS

    wtimeoutMS?: number

    Specify a time limit to prevent write operations from blocking indefinitely

    Methods

    Staticapply

    StaticfromOptions

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns undefined | WriteConcern

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/6.10/classes/WriteConcernError.html b/docs/6.10/classes/WriteConcernError.html index 979687cbc8e..f8f2cf62dd5 100644 --- a/docs/6.10/classes/WriteConcernError.html +++ b/docs/6.10/classes/WriteConcernError.html @@ -1,4 +1,4 @@ -WriteConcernError | mongodb

    Class WriteConcernError

    An error representing a failure by the server to apply the requested write concern to the bulk operation.

    +WriteConcernError | mongodb

    Class WriteConcernError

    An error representing a failure by the server to apply the requested write concern to the bulk operation.

    Constructors

    constructor

    Accessors

    code errInfo @@ -8,4 +8,4 @@

    Constructors

    constructor

    Accessors

    code

    • get code(): undefined | number

    • Write concern error code.

      Returns undefined | number

    errInfo

    errmsg

    • get errmsg(): undefined | string

    • Write concern error message.

      -

      Returns undefined | string

    Methods

    toJSON

    toString

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Returns undefined | string

    Methods

    toJSON

    toString

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/6.10/classes/WriteError.html b/docs/6.10/classes/WriteError.html index ce013718bd7..f1ddd423f51 100644 --- a/docs/6.10/classes/WriteError.html +++ b/docs/6.10/classes/WriteError.html @@ -1,4 +1,4 @@ -WriteError | mongodb

    Class WriteError

    An error that occurred during a BulkWrite on the server.

    +WriteError | mongodb

    Class WriteError

    An error that occurred during a BulkWrite on the server.

    Constructors

    constructor

    Properties

    err

    Accessors

    code @@ -13,4 +13,4 @@

    Returns undefined | Document

    errmsg

    • get errmsg(): undefined | string

    • WriteError message.

      Returns undefined | string

    index

    Methods

    getOperation

    toJSON

    • toJSON(): {
          code: number;
          errmsg?: string;
          index: number;
          op: Document;
      }

    • Returns {
          code: number;
          errmsg?: string;
          index: number;
          op: Document;
      }

      • code: number
      • Optionalerrmsg?: string
      • index: number
      • op: Document

    toString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns Document

    toJSON

    • toJSON(): {
          code: number;
          errmsg?: string;
          index: number;
          op: Document;
      }

    • Returns {
          code: number;
          errmsg?: string;
          index: number;
          op: Document;
      }

      • code: number
      • Optionalerrmsg?: string
      • index: number
      • op: Document

    toString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/6.10/functions/BSON.calculateObjectSize.html b/docs/6.10/functions/BSON.calculateObjectSize.html index baacc1645a8..54fda2522f9 100644 --- a/docs/6.10/functions/BSON.calculateObjectSize.html +++ b/docs/6.10/functions/BSON.calculateObjectSize.html @@ -1,4 +1,4 @@ -calculateObjectSize | mongodb

    Function calculateObjectSize

    • calculateObjectSize(object, options?): number

    • Calculate the bson size for a passed in Javascript object.

      +calculateObjectSize | mongodb

      Function calculateObjectSize

      • calculateObjectSize(object, options?): number

      • Calculate the bson size for a passed in Javascript object.

        Parameters

        Returns number

        size of BSON object in bytes

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/6.10/functions/BSON.deserialize.html b/docs/6.10/functions/BSON.deserialize.html index 83ef7a4a7bb..dfb5689ae73 100644 --- a/docs/6.10/functions/BSON.deserialize.html +++ b/docs/6.10/functions/BSON.deserialize.html @@ -1,4 +1,4 @@ -deserialize | mongodb

    Function deserialize

    • deserialize(buffer, options?): Document

    • Deserialize data as BSON.

      +deserialize | mongodb

      Function deserialize

      • deserialize(buffer, options?): Document

      • Deserialize data as BSON.

        Parameters

        • buffer: Uint8Array

          the buffer containing the serialized set of BSON documents.

        • Optionaloptions: DeserializeOptions

        Returns Document

        returns the deserialized Javascript Object.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/6.10/functions/BSON.deserializeStream.html b/docs/6.10/functions/BSON.deserializeStream.html index ee0b8cf1547..7032367f814 100644 --- a/docs/6.10/functions/BSON.deserializeStream.html +++ b/docs/6.10/functions/BSON.deserializeStream.html @@ -1,4 +1,4 @@ -deserializeStream | mongodb

    Function deserializeStream

    • deserializeStream(data, startIndex, numberOfDocuments, documents, docStartIndex, options): number

    • Deserialize stream data as BSON documents.

      +deserializeStream | mongodb

      Function deserializeStream

      • deserializeStream(data, startIndex, numberOfDocuments, documents, docStartIndex, options): number

      • Deserialize stream data as BSON documents.

        Parameters

        • data: Uint8Array | ArrayBuffer

          the buffer containing the serialized set of BSON documents.

        • startIndex: number

          the start index in the data Buffer where the deserialization is to start.

        • numberOfDocuments: number

          number of documents to deserialize.

          @@ -6,4 +6,4 @@
        • docStartIndex: number

          the index in the documents array from where to start inserting documents.

        • options: DeserializeOptions

          additional options used for the deserialization.

        Returns number

        next index in the buffer after deserialization x numbers of documents.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/6.10/functions/BSON.serialize.html b/docs/6.10/functions/BSON.serialize.html index 1a045d57e90..2719561be05 100644 --- a/docs/6.10/functions/BSON.serialize.html +++ b/docs/6.10/functions/BSON.serialize.html @@ -1,4 +1,4 @@ -serialize | mongodb

    Function serialize

    • serialize(object, options?): Uint8Array

    • Serialize a Javascript object.

      +serialize | mongodb

      Function serialize

      • serialize(object, options?): Uint8Array

      • Serialize a Javascript object.

        Parameters

        Returns Uint8Array

        Buffer object containing the serialized object.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/6.10/functions/BSON.serializeWithBufferAndIndex.html b/docs/6.10/functions/BSON.serializeWithBufferAndIndex.html index d7a386f5611..e299dc0e0da 100644 --- a/docs/6.10/functions/BSON.serializeWithBufferAndIndex.html +++ b/docs/6.10/functions/BSON.serializeWithBufferAndIndex.html @@ -1,6 +1,6 @@ -serializeWithBufferAndIndex | mongodb

    Function serializeWithBufferAndIndex

    • serializeWithBufferAndIndex(object, finalBuffer, options?): number

    • Serialize a Javascript object using a predefined Buffer and index into the buffer, +serializeWithBufferAndIndex | mongodb

      Function serializeWithBufferAndIndex

      • serializeWithBufferAndIndex(object, finalBuffer, options?): number

      • Serialize a Javascript object using a predefined Buffer and index into the buffer, useful when pre-allocating the space for serialization.

        Parameters

        • object: Document

          the Javascript object to serialize.

        • finalBuffer: Uint8Array

          the Buffer you pre-allocated to store the serialized BSON object.

        • Optionaloptions: SerializeOptions

        Returns number

        the index pointing to the last written byte in the buffer.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/6.10/functions/BSON.setInternalBufferSize.html b/docs/6.10/functions/BSON.setInternalBufferSize.html index d67e865fd78..a4867231fe0 100644 --- a/docs/6.10/functions/BSON.setInternalBufferSize.html +++ b/docs/6.10/functions/BSON.setInternalBufferSize.html @@ -1,3 +1,3 @@ -setInternalBufferSize | mongodb

    Function setInternalBufferSize

    • setInternalBufferSize(size): void

    • Sets the size of the internal serialization buffer.

      +setInternalBufferSize | mongodb

      Function setInternalBufferSize

      • setInternalBufferSize(size): void

      • Sets the size of the internal serialization buffer.

        Parameters

        • size: number

          The desired size for the internal serialization buffer in bytes

          -

        Returns void

      Settings

      Member Visibility
      +

    Returns void

    Settings

    Member Visibility
    diff --git a/docs/6.10/functions/configureExplicitResourceManagement.html b/docs/6.10/functions/configureExplicitResourceManagement.html index b0c4345528a..8a6126a18a1 100644 --- a/docs/6.10/functions/configureExplicitResourceManagement.html +++ b/docs/6.10/functions/configureExplicitResourceManagement.html @@ -1,4 +1,4 @@ -configureExplicitResourceManagement | mongodb

    Function configureExplicitResourceManagement

    • configureExplicitResourceManagement(): void
    • Beta Experimental

      Attaches Symbol.asyncDispose methods to the MongoClient, Cursors, sessions and change streams +configureExplicitResourceManagement | mongodb

      Function configureExplicitResourceManagement

      • configureExplicitResourceManagement(): void
      • Beta Experimental

        Attaches Symbol.asyncDispose methods to the MongoClient, Cursors, sessions and change streams if Symbol.asyncDispose is defined.

        It's usually not necessary to call this method - the driver attempts to attach these methods itself when its loaded. However, sometimes the driver may be loaded before Symbol.asyncDispose @@ -8,4 +8,4 @@ 

        import { configureExplicitResourceManagement, MongoClient } from 'mongodb/lib/beta';

        Symbol.asyncDispose ??= Symbol('dispose');
        load();

        await using client = new MongoClient(...);
        -

        Returns void

      Settings

      Member Visibility
      +

      Returns void

    Settings

    Member Visibility
    diff --git a/docs/6.10/hierarchy.html b/docs/6.10/hierarchy.html index 6e34efd47e6..18ba8babe9e 100644 --- a/docs/6.10/hierarchy.html +++ b/docs/6.10/hierarchy.html @@ -1 +1 @@ -mongodb

    mongodb

    Class Hierarchy

    Settings

    Member Visibility
    +mongodb

    mongodb

    Class Hierarchy

    Settings

    Member Visibility
    diff --git a/docs/6.10/index.html b/docs/6.10/index.html index f2150cc3f7f..846e27f03d1 100644 --- a/docs/6.10/index.html +++ b/docs/6.10/index.html @@ -1,4 +1,4 @@ -mongodb

    mongodb

    MongoDB Node.js Driver

    The official MongoDB driver for Node.js.

    +mongodb

    mongodb

    MongoDB Node.js Driver

    The official MongoDB driver for Node.js.

    Upgrading to version 6? Take a look at our upgrade guide here!

    Quick Links

    @@ -279,4 +279,4 @@

    License

    Apache 2.0

    © 2012-present MongoDB Contributors
    © 2009-2012 Christian Amor Kvalheim

    -

    Settings

    Member Visibility

    On This Page

    MongoDB Node.js Driver
    +

    Settings

    Member Visibility

    On This Page

    MongoDB Node.js Driver
    diff --git a/docs/6.10/interfaces/AWSEncryptionKeyOptions.html b/docs/6.10/interfaces/AWSEncryptionKeyOptions.html index 4f7d90b67d1..646bc4c3ef7 100644 --- a/docs/6.10/interfaces/AWSEncryptionKeyOptions.html +++ b/docs/6.10/interfaces/AWSEncryptionKeyOptions.html @@ -1,8 +1,8 @@ -AWSEncryptionKeyOptions | mongodb

    Interface AWSEncryptionKeyOptions

    Configuration options for making an AWS encryption key

    +AWSEncryptionKeyOptions | mongodb

    Interface AWSEncryptionKeyOptions

    Configuration options for making an AWS encryption key

    interface AWSEncryptionKeyOptions {
        endpoint?: string;
        key: string;
        region: string;
    }

    Properties

    endpoint? key region

    Properties

    Optionalendpoint

    endpoint?: string

    An alternate host to send KMS requests to. May include port number.

    key

    key: string

    The Amazon Resource Name (ARN) to the AWS customer master key (CMK)

    region

    region: string

    The AWS region of the KMS

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/AWSKMSProviderConfiguration.html b/docs/6.10/interfaces/AWSKMSProviderConfiguration.html index 4b78ad47ce2..eafcf7ecbe4 100644 --- a/docs/6.10/interfaces/AWSKMSProviderConfiguration.html +++ b/docs/6.10/interfaces/AWSKMSProviderConfiguration.html @@ -1,8 +1,8 @@ -AWSKMSProviderConfiguration | mongodb

    Interface AWSKMSProviderConfiguration

    interface AWSKMSProviderConfiguration {
        accessKeyId: string;
        secretAccessKey: string;
        sessionToken?: string;
    }

    Properties

    accessKeyId +AWSKMSProviderConfiguration | mongodb

    Interface AWSKMSProviderConfiguration

    interface AWSKMSProviderConfiguration {
        accessKeyId: string;
        secretAccessKey: string;
        sessionToken?: string;
    }

    Properties

    accessKeyId secretAccessKey sessionToken?

    Properties

    accessKeyId

    accessKeyId: string

    The access key used for the AWS KMS provider

    secretAccessKey

    secretAccessKey: string

    The secret access key used for the AWS KMS provider

    OptionalsessionToken

    sessionToken?: string

    An optional AWS session token that will be used as the X-Amz-Security-Token header for AWS requests.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/AbstractCursorOptions.html b/docs/6.10/interfaces/AbstractCursorOptions.html index 65ba5316789..759a51ff48a 100644 --- a/docs/6.10/interfaces/AbstractCursorOptions.html +++ b/docs/6.10/interfaces/AbstractCursorOptions.html @@ -1,4 +1,4 @@ -AbstractCursorOptions | mongodb

    Interface AbstractCursorOptions

    interface AbstractCursorOptions {
        awaitData?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        comment?: unknown;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noCursorTimeout?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        session?: ClientSession;
        tailable?: boolean;
        useBigInt64?: boolean;
    }

    Hierarchy (view full)

    Properties

    awaitData? +AbstractCursorOptions | mongodb

    Interface AbstractCursorOptions

    interface AbstractCursorOptions {
        awaitData?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        comment?: unknown;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noCursorTimeout?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        session?: ClientSession;
        tailable?: boolean;
        useBigInt64?: boolean;
    }

    Hierarchy (view full)

    Properties

    awaitData? batchSize? bsonRegExp? checkKeys? @@ -67,4 +67,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/AggregateOptions.html b/docs/6.10/interfaces/AggregateOptions.html index cdbe95a0c26..3447216a4a4 100644 --- a/docs/6.10/interfaces/AggregateOptions.html +++ b/docs/6.10/interfaces/AggregateOptions.html @@ -1,4 +1,4 @@ -AggregateOptions | mongodb

    Interface AggregateOptions

    interface AggregateOptions {
        allowDiskUse?: boolean;
        authdb?: string;
        batchSize?: number;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        cursor?: Document;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        out?: string;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    allowDiskUse? +AggregateOptions | mongodb

    Interface AggregateOptions

    interface AggregateOptions {
        allowDiskUse?: boolean;
        authdb?: string;
        batchSize?: number;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        cursor?: Document;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        out?: string;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    allowDiskUse? authdb? batchSize? bsonRegExp? @@ -83,4 +83,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/AggregationCursorOptions.html b/docs/6.10/interfaces/AggregationCursorOptions.html index c7543b962ef..1ff3b243295 100644 --- a/docs/6.10/interfaces/AggregationCursorOptions.html +++ b/docs/6.10/interfaces/AggregationCursorOptions.html @@ -1,4 +1,4 @@ -AggregationCursorOptions | mongodb

    Interface AggregationCursorOptions

    interface AggregationCursorOptions {
        allowDiskUse?: boolean;
        authdb?: string;
        awaitData?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        cursor?: Document;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noCursorTimeout?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        out?: string;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        tailable?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    allowDiskUse? +AggregationCursorOptions | mongodb

    Interface AggregationCursorOptions

    interface AggregationCursorOptions {
        allowDiskUse?: boolean;
        authdb?: string;
        awaitData?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        cursor?: Document;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noCursorTimeout?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        out?: string;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        tailable?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    allowDiskUse? authdb? awaitData? batchSize? @@ -96,4 +96,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/AsyncDisposable.html b/docs/6.10/interfaces/AsyncDisposable.html index 15c9e1ddac5..d351447da5c 100644 --- a/docs/6.10/interfaces/AsyncDisposable.html +++ b/docs/6.10/interfaces/AsyncDisposable.html @@ -1,2 +1,2 @@ -AsyncDisposable | mongodb

    Interface AsyncDisposable

    interface AsyncDisposable {
        [asyncDispose](): Promise<void>;
    }

    Implemented by

    Methods

    [asyncDispose] -

    Methods

    [asyncDispose]

    Settings

    Member Visibility

    On This Page

    Methods
    +AsyncDisposable | mongodb

    Interface AsyncDisposable

    interface AsyncDisposable {
        [asyncDispose](): Promise<void>;
    }

    Implemented by

    Methods

    [asyncDispose] +

    Methods

    [asyncDispose]

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/docs/6.10/interfaces/Auth.html b/docs/6.10/interfaces/Auth.html index eb3a48bd0e3..1a8d94939d7 100644 --- a/docs/6.10/interfaces/Auth.html +++ b/docs/6.10/interfaces/Auth.html @@ -1,5 +1,5 @@ -Auth | mongodb

    Interface Auth

    interface Auth {
        password?: string;
        username?: string;
    }

    Properties

    password? +Auth | mongodb

    Interface Auth

    interface Auth {
        password?: string;
        username?: string;
    }

    Properties

    password? username?

    Properties

    Optionalpassword

    password?: string

    The password for auth

    Optionalusername

    username?: string

    The username for auth

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/AuthMechanismProperties.html b/docs/6.10/interfaces/AuthMechanismProperties.html index 394e7c3991c..57b6a00d37c 100644 --- a/docs/6.10/interfaces/AuthMechanismProperties.html +++ b/docs/6.10/interfaces/AuthMechanismProperties.html @@ -1,4 +1,4 @@ -AuthMechanismProperties | mongodb

    Interface AuthMechanismProperties

    interface AuthMechanismProperties {
        ALLOWED_HOSTS?: string[];
        AWS_SESSION_TOKEN?: string;
        CANONICALIZE_HOST_NAME?: GSSAPICanonicalizationValue;
        ENVIRONMENT?: "azure" | "gcp" | "test";
        OIDC_CALLBACK?: OIDCCallbackFunction;
        OIDC_HUMAN_CALLBACK?: OIDCCallbackFunction;
        SERVICE_HOST?: string;
        SERVICE_NAME?: string;
        SERVICE_REALM?: string;
        TOKEN_RESOURCE?: string;
    }

    Hierarchy (view full)

    Properties

    ALLOWED_HOSTS? +AuthMechanismProperties | mongodb

    Interface AuthMechanismProperties

    interface AuthMechanismProperties {
        ALLOWED_HOSTS?: string[];
        AWS_SESSION_TOKEN?: string;
        CANONICALIZE_HOST_NAME?: GSSAPICanonicalizationValue;
        ENVIRONMENT?: "azure" | "gcp" | "test";
        OIDC_CALLBACK?: OIDCCallbackFunction;
        OIDC_HUMAN_CALLBACK?: OIDCCallbackFunction;
        SERVICE_HOST?: string;
        SERVICE_NAME?: string;
        SERVICE_REALM?: string;
        TOKEN_RESOURCE?: string;
    }

    Hierarchy (view full)

    Properties

    ALLOWED_HOSTS? AWS_SESSION_TOKEN? CANONICALIZE_HOST_NAME? ENVIRONMENT? @@ -9,8 +9,8 @@ SERVICE_REALM? TOKEN_RESOURCE?

    Properties

    OptionalALLOWED_HOSTS

    ALLOWED_HOSTS?: string[]

    Allowed hosts that OIDC auth can connect to.

    -

    OptionalAWS_SESSION_TOKEN

    AWS_SESSION_TOKEN?: string

    OptionalCANONICALIZE_HOST_NAME

    CANONICALIZE_HOST_NAME?: GSSAPICanonicalizationValue

    OptionalENVIRONMENT

    ENVIRONMENT?: "azure" | "gcp" | "test"

    The OIDC environment. Note that 'test' is for internal use only.

    -

    OptionalOIDC_CALLBACK

    OIDC_CALLBACK?: OIDCCallbackFunction

    A user provided OIDC machine callback function.

    -

    OptionalOIDC_HUMAN_CALLBACK

    OIDC_HUMAN_CALLBACK?: OIDCCallbackFunction

    A user provided OIDC human interacted callback function.

    -

    OptionalSERVICE_HOST

    SERVICE_HOST?: string

    OptionalSERVICE_NAME

    SERVICE_NAME?: string

    OptionalSERVICE_REALM

    SERVICE_REALM?: string

    OptionalTOKEN_RESOURCE

    TOKEN_RESOURCE?: string

    The resource token for OIDC auth in Azure and GCP.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalAWS_SESSION_TOKEN

    AWS_SESSION_TOKEN?: string

    OptionalCANONICALIZE_HOST_NAME

    CANONICALIZE_HOST_NAME?: GSSAPICanonicalizationValue

    OptionalENVIRONMENT

    ENVIRONMENT?: "azure" | "gcp" | "test"

    The OIDC environment. Note that 'test' is for internal use only.

    +

    OptionalOIDC_CALLBACK

    OIDC_CALLBACK?: OIDCCallbackFunction

    A user provided OIDC machine callback function.

    +

    OptionalOIDC_HUMAN_CALLBACK

    OIDC_HUMAN_CALLBACK?: OIDCCallbackFunction

    A user provided OIDC human interacted callback function.

    +

    OptionalSERVICE_HOST

    SERVICE_HOST?: string

    OptionalSERVICE_NAME

    SERVICE_NAME?: string

    OptionalSERVICE_REALM

    SERVICE_REALM?: string

    OptionalTOKEN_RESOURCE

    TOKEN_RESOURCE?: string

    The resource token for OIDC auth in Azure and GCP.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/AutoEncryptionOptions.html b/docs/6.10/interfaces/AutoEncryptionOptions.html index 3306d5b8b23..9d3219581dc 100644 --- a/docs/6.10/interfaces/AutoEncryptionOptions.html +++ b/docs/6.10/interfaces/AutoEncryptionOptions.html @@ -1,4 +1,4 @@ -AutoEncryptionOptions | mongodb

    Interface AutoEncryptionOptions

    interface AutoEncryptionOptions {
        bypassAutoEncryption?: boolean;
        bypassQueryAnalysis?: boolean;
        encryptedFieldsMap?: Document;
        extraOptions?: {
            cryptSharedLibPath?: string;
            cryptSharedLibRequired?: boolean;
            mongocryptdBypassSpawn?: boolean;
            mongocryptdSpawnArgs?: string[];
            mongocryptdSpawnPath?: string;
            mongocryptdURI?: string;
        };
        keyVaultClient?: MongoClient;
        keyVaultNamespace?: string;
        kmsProviders?: KMSProviders;
        options?: {
            logger?: ((level: AutoEncryptionLoggerLevel, message: string) => void);
        };
        proxyOptions?: ProxyOptions;
        schemaMap?: Document;
        tlsOptions?: CSFLEKMSTlsOptions;
    }

    Properties

    bypassAutoEncryption? +AutoEncryptionOptions | mongodb

    Interface AutoEncryptionOptions

    interface AutoEncryptionOptions {
        bypassAutoEncryption?: boolean;
        bypassQueryAnalysis?: boolean;
        encryptedFieldsMap?: Document;
        extraOptions?: {
            cryptSharedLibPath?: string;
            cryptSharedLibRequired?: boolean;
            mongocryptdBypassSpawn?: boolean;
            mongocryptdSpawnArgs?: string[];
            mongocryptdSpawnPath?: string;
            mongocryptdURI?: string;
        };
        keyVaultClient?: MongoClient;
        keyVaultNamespace?: string;
        kmsProviders?: KMSProviders;
        options?: {
            logger?: ((level: AutoEncryptionLoggerLevel, message: string) => void);
        };
        proxyOptions?: ProxyOptions;
        schemaMap?: Document;
        tlsOptions?: CSFLEKMSTlsOptions;
    }

    Properties

    bypassAutoEncryption? bypassQueryAnalysis? encryptedFieldsMap? extraOptions? @@ -46,4 +46,4 @@ Schemas supplied in the schemaMap only apply to configuring automatic encryption for Client-Side Field Level Encryption. Other validation rules in the JSON schema will not be enforced by the driver and will result in an error.

    OptionaltlsOptions

    tlsOptions?: CSFLEKMSTlsOptions

    The TLS options to use connecting to the KMS provider

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/AzureEncryptionKeyOptions.html b/docs/6.10/interfaces/AzureEncryptionKeyOptions.html index fd45f3a70aa..58ea5bd7c8f 100644 --- a/docs/6.10/interfaces/AzureEncryptionKeyOptions.html +++ b/docs/6.10/interfaces/AzureEncryptionKeyOptions.html @@ -1,8 +1,8 @@ -AzureEncryptionKeyOptions | mongodb

    Interface AzureEncryptionKeyOptions

    Configuration options for making an Azure encryption key

    +AzureEncryptionKeyOptions | mongodb

    Interface AzureEncryptionKeyOptions

    Configuration options for making an Azure encryption key

    interface AzureEncryptionKeyOptions {
        keyName: string;
        keyVaultEndpoint: string;
        keyVersion?: string;
    }

    Properties

    keyName keyVaultEndpoint keyVersion?

    Properties

    keyName

    keyName: string

    Key name

    keyVaultEndpoint

    keyVaultEndpoint: string

    Key vault URL, typically <name>.vault.azure.net

    OptionalkeyVersion

    keyVersion?: string

    Key version

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.BSONRegExpExtended.html b/docs/6.10/interfaces/BSON.BSONRegExpExtended.html index b9790fc2f5f..b189fb62ddd 100644 --- a/docs/6.10/interfaces/BSON.BSONRegExpExtended.html +++ b/docs/6.10/interfaces/BSON.BSONRegExpExtended.html @@ -1,2 +1,2 @@ -BSONRegExpExtended | mongodb

    Interface BSONRegExpExtended

    interface BSONRegExpExtended {
        $regularExpression: {
            options: string;
            pattern: string;
        };
    }

    Properties

    $regularExpression -

    Properties

    $regularExpression

    $regularExpression: {
        options: string;
        pattern: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    +BSONRegExpExtended | mongodb

    Interface BSONRegExpExtended

    interface BSONRegExpExtended {
        $regularExpression: {
            options: string;
            pattern: string;
        };
    }

    Properties

    $regularExpression +

    Properties

    $regularExpression

    $regularExpression: {
        options: string;
        pattern: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.BSONRegExpExtendedLegacy.html b/docs/6.10/interfaces/BSON.BSONRegExpExtendedLegacy.html index d855eb69dad..920f4ea219d 100644 --- a/docs/6.10/interfaces/BSON.BSONRegExpExtendedLegacy.html +++ b/docs/6.10/interfaces/BSON.BSONRegExpExtendedLegacy.html @@ -1,3 +1,3 @@ -BSONRegExpExtendedLegacy | mongodb

    Interface BSONRegExpExtendedLegacy

    interface BSONRegExpExtendedLegacy {
        $options: string;
        $regex: string | BSONRegExp;
    }

    Properties

    $options +BSONRegExpExtendedLegacy | mongodb

    Interface BSONRegExpExtendedLegacy

    interface BSONRegExpExtendedLegacy {
        $options: string;
        $regex: string | BSONRegExp;
    }

    Properties

    $options $regex -

    Properties

    $options

    $options: string

    $regex

    $regex: string | BSONRegExp

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    $options

    $options: string

    $regex

    $regex: string | BSONRegExp

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.BSONSymbolExtended.html b/docs/6.10/interfaces/BSON.BSONSymbolExtended.html index b540fcea8e9..b7057ba9cb2 100644 --- a/docs/6.10/interfaces/BSON.BSONSymbolExtended.html +++ b/docs/6.10/interfaces/BSON.BSONSymbolExtended.html @@ -1,2 +1,2 @@ -BSONSymbolExtended | mongodb

    Interface BSONSymbolExtended

    interface BSONSymbolExtended {
        $symbol: string;
    }

    Properties

    $symbol -

    Properties

    $symbol

    $symbol: string

    Settings

    Member Visibility

    On This Page

    Properties
    +BSONSymbolExtended | mongodb

    Interface BSONSymbolExtended

    interface BSONSymbolExtended {
        $symbol: string;
    }

    Properties

    $symbol +

    Properties

    $symbol

    $symbol: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.BinaryExtended.html b/docs/6.10/interfaces/BSON.BinaryExtended.html index 1e658a547c6..21d2c983ab6 100644 --- a/docs/6.10/interfaces/BSON.BinaryExtended.html +++ b/docs/6.10/interfaces/BSON.BinaryExtended.html @@ -1,2 +1,2 @@ -BinaryExtended | mongodb

    Interface BinaryExtended

    interface BinaryExtended {
        $binary: {
            base64: string;
            subType: string;
        };
    }

    Properties

    $binary -

    Properties

    $binary

    $binary: {
        base64: string;
        subType: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    +BinaryExtended | mongodb

    Interface BinaryExtended

    interface BinaryExtended {
        $binary: {
            base64: string;
            subType: string;
        };
    }

    Properties

    $binary +

    Properties

    $binary

    $binary: {
        base64: string;
        subType: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.BinaryExtendedLegacy.html b/docs/6.10/interfaces/BSON.BinaryExtendedLegacy.html index b25f31a3266..8a3d9f338d4 100644 --- a/docs/6.10/interfaces/BSON.BinaryExtendedLegacy.html +++ b/docs/6.10/interfaces/BSON.BinaryExtendedLegacy.html @@ -1,3 +1,3 @@ -BinaryExtendedLegacy | mongodb

    Interface BinaryExtendedLegacy

    interface BinaryExtendedLegacy {
        $binary: string;
        $type: string;
    }

    Properties

    $binary +BinaryExtendedLegacy | mongodb

    Interface BinaryExtendedLegacy

    interface BinaryExtendedLegacy {
        $binary: string;
        $type: string;
    }

    Properties

    $binary $type -

    Properties

    $binary

    $binary: string

    $type

    $type: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    $binary

    $binary: string

    $type

    $type: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.CodeExtended.html b/docs/6.10/interfaces/BSON.CodeExtended.html index d4f1a9e51a2..2658356b189 100644 --- a/docs/6.10/interfaces/BSON.CodeExtended.html +++ b/docs/6.10/interfaces/BSON.CodeExtended.html @@ -1,3 +1,3 @@ -CodeExtended | mongodb

    Interface CodeExtended

    interface CodeExtended {
        $code: string;
        $scope?: Document;
    }

    Properties

    $code +CodeExtended | mongodb

    Interface CodeExtended

    interface CodeExtended {
        $code: string;
        $scope?: Document;
    }

    Properties

    $code $scope? -

    Properties

    $code

    $code: string

    Optional$scope

    $scope?: Document

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    $code

    $code: string

    Optional$scope

    $scope?: Document

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.DBRefLike.html b/docs/6.10/interfaces/BSON.DBRefLike.html index 2ccbdf0417c..903483335d0 100644 --- a/docs/6.10/interfaces/BSON.DBRefLike.html +++ b/docs/6.10/interfaces/BSON.DBRefLike.html @@ -1,4 +1,4 @@ -DBRefLike | mongodb

    Interface DBRefLike

    interface DBRefLike {
        $db?: string;
        $id: ObjectId;
        $ref: string;
    }

    Properties

    $db? +DBRefLike | mongodb

    Interface DBRefLike

    interface DBRefLike {
        $db?: string;
        $id: ObjectId;
        $ref: string;
    }

    Properties

    $db? $id $ref -

    Properties

    Optional$db

    $db?: string

    $id

    $id: ObjectId

    $ref

    $ref: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optional$db

    $db?: string

    $id

    $id: ObjectId

    $ref

    $ref: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.Decimal128Extended.html b/docs/6.10/interfaces/BSON.Decimal128Extended.html index f13a4f3567b..6d7a49ccb5f 100644 --- a/docs/6.10/interfaces/BSON.Decimal128Extended.html +++ b/docs/6.10/interfaces/BSON.Decimal128Extended.html @@ -1,2 +1,2 @@ -Decimal128Extended | mongodb

    Interface Decimal128Extended

    interface Decimal128Extended {
        $numberDecimal: string;
    }

    Properties

    $numberDecimal -

    Properties

    $numberDecimal

    $numberDecimal: string

    Settings

    Member Visibility

    On This Page

    Properties
    +Decimal128Extended | mongodb

    Interface Decimal128Extended

    interface Decimal128Extended {
        $numberDecimal: string;
    }

    Properties

    $numberDecimal +

    Properties

    $numberDecimal

    $numberDecimal: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.DeserializeOptions.html b/docs/6.10/interfaces/BSON.DeserializeOptions.html index e678fedfc76..19393ca71bb 100644 --- a/docs/6.10/interfaces/BSON.DeserializeOptions.html +++ b/docs/6.10/interfaces/BSON.DeserializeOptions.html @@ -1,4 +1,4 @@ -DeserializeOptions | mongodb

    Interface DeserializeOptions

    interface DeserializeOptions {
        allowObjectSmallerThanBufferSize?: boolean;
        bsonRegExp?: boolean;
        fieldsAsRaw?: Document;
        index?: number;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        useBigInt64?: boolean;
        validation?: {
            utf8: boolean | Record<string, true> | Record<string, false>;
        };
    }

    Properties

    allowObjectSmallerThanBufferSize? +DeserializeOptions | mongodb

    Interface DeserializeOptions

    interface DeserializeOptions {
        allowObjectSmallerThanBufferSize?: boolean;
        bsonRegExp?: boolean;
        fieldsAsRaw?: Document;
        index?: number;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        useBigInt64?: boolean;
        validation?: {
            utf8: boolean | Record<string, true> | Record<string, false>;
        };
    }

    Properties

    allowObjectSmallerThanBufferSize? bsonRegExp? fieldsAsRaw? index? @@ -29,4 +29,4 @@

    Example

    // disables validation on all keys
     validation: { utf8: false }

    // enables validation only on specified keys a, b, and c
     validation: { utf8: { a: true, b: true, c: true } }

     // disables validation only on specified keys a, b
     validation: { utf8: { a: false, b: false } }
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.Document.html b/docs/6.10/interfaces/BSON.Document.html index 2e5c26aa0fb..9b63031d8f2 100644 --- a/docs/6.10/interfaces/BSON.Document.html +++ b/docs/6.10/interfaces/BSON.Document.html @@ -1 +1 @@ -Document | mongodb

    Interface Document

    Hierarchy (view full)

    Indexable

    • [key: string]: any

    Settings

    Member Visibility
    +Document | mongodb

    Interface Document

    Hierarchy (view full)

    Indexable

    • [key: string]: any

    Settings

    Member Visibility
    diff --git a/docs/6.10/interfaces/BSON.DoubleExtended.html b/docs/6.10/interfaces/BSON.DoubleExtended.html index 68e4beb43f0..4470846faa7 100644 --- a/docs/6.10/interfaces/BSON.DoubleExtended.html +++ b/docs/6.10/interfaces/BSON.DoubleExtended.html @@ -1,2 +1,2 @@ -DoubleExtended | mongodb

    Interface DoubleExtended

    interface DoubleExtended {
        $numberDouble: string;
    }

    Properties

    $numberDouble -

    Properties

    $numberDouble

    $numberDouble: string

    Settings

    Member Visibility

    On This Page

    Properties
    +DoubleExtended | mongodb

    Interface DoubleExtended

    interface DoubleExtended {
        $numberDouble: string;
    }

    Properties

    $numberDouble +

    Properties

    $numberDouble

    $numberDouble: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.Int32Extended.html b/docs/6.10/interfaces/BSON.Int32Extended.html index d1119c10001..70da8462f6f 100644 --- a/docs/6.10/interfaces/BSON.Int32Extended.html +++ b/docs/6.10/interfaces/BSON.Int32Extended.html @@ -1,2 +1,2 @@ -Int32Extended | mongodb

    Interface Int32Extended

    interface Int32Extended {
        $numberInt: string;
    }

    Properties

    $numberInt -

    Properties

    $numberInt

    $numberInt: string

    Settings

    Member Visibility

    On This Page

    Properties
    +Int32Extended | mongodb

    Interface Int32Extended

    interface Int32Extended {
        $numberInt: string;
    }

    Properties

    $numberInt +

    Properties

    $numberInt

    $numberInt: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.LongExtended.html b/docs/6.10/interfaces/BSON.LongExtended.html index 9530ae4ba76..349cd8ddebe 100644 --- a/docs/6.10/interfaces/BSON.LongExtended.html +++ b/docs/6.10/interfaces/BSON.LongExtended.html @@ -1,2 +1,2 @@ -LongExtended | mongodb

    Interface LongExtended

    interface LongExtended {
        $numberLong: string;
    }

    Properties

    $numberLong -

    Properties

    $numberLong

    $numberLong: string

    Settings

    Member Visibility

    On This Page

    Properties
    +LongExtended | mongodb

    Interface LongExtended

    interface LongExtended {
        $numberLong: string;
    }

    Properties

    $numberLong +

    Properties

    $numberLong

    $numberLong: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.MaxKeyExtended.html b/docs/6.10/interfaces/BSON.MaxKeyExtended.html index 5cb4b8199f4..8996628fe51 100644 --- a/docs/6.10/interfaces/BSON.MaxKeyExtended.html +++ b/docs/6.10/interfaces/BSON.MaxKeyExtended.html @@ -1,2 +1,2 @@ -MaxKeyExtended | mongodb

    Interface MaxKeyExtended

    interface MaxKeyExtended {
        $maxKey: 1;
    }

    Properties

    $maxKey -

    Properties

    $maxKey

    $maxKey: 1

    Settings

    Member Visibility

    On This Page

    Properties
    +MaxKeyExtended | mongodb

    Interface MaxKeyExtended

    interface MaxKeyExtended {
        $maxKey: 1;
    }

    Properties

    $maxKey +

    Properties

    $maxKey

    $maxKey: 1

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.MinKeyExtended.html b/docs/6.10/interfaces/BSON.MinKeyExtended.html index 4e6ea8c2058..a26c718a5d4 100644 --- a/docs/6.10/interfaces/BSON.MinKeyExtended.html +++ b/docs/6.10/interfaces/BSON.MinKeyExtended.html @@ -1,2 +1,2 @@ -MinKeyExtended | mongodb

    Interface MinKeyExtended

    interface MinKeyExtended {
        $minKey: 1;
    }

    Properties

    $minKey -

    Properties

    $minKey

    $minKey: 1

    Settings

    Member Visibility

    On This Page

    Properties
    +MinKeyExtended | mongodb

    Interface MinKeyExtended

    interface MinKeyExtended {
        $minKey: 1;
    }

    Properties

    $minKey +

    Properties

    $minKey

    $minKey: 1

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.ObjectIdExtended.html b/docs/6.10/interfaces/BSON.ObjectIdExtended.html index e2233343ab3..9aef7c13785 100644 --- a/docs/6.10/interfaces/BSON.ObjectIdExtended.html +++ b/docs/6.10/interfaces/BSON.ObjectIdExtended.html @@ -1,2 +1,2 @@ -ObjectIdExtended | mongodb

    Interface ObjectIdExtended

    interface ObjectIdExtended {
        $oid: string;
    }

    Properties

    $oid -

    Properties

    $oid

    $oid: string

    Settings

    Member Visibility

    On This Page

    Properties
    +ObjectIdExtended | mongodb

    Interface ObjectIdExtended

    interface ObjectIdExtended {
        $oid: string;
    }

    Properties

    $oid +

    Properties

    $oid

    $oid: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.ObjectIdLike.html b/docs/6.10/interfaces/BSON.ObjectIdLike.html index 251f60aabbe..ea283f85c57 100644 --- a/docs/6.10/interfaces/BSON.ObjectIdLike.html +++ b/docs/6.10/interfaces/BSON.ObjectIdLike.html @@ -1,4 +1,4 @@ -ObjectIdLike | mongodb

    Interface ObjectIdLike

    interface ObjectIdLike {
        __id?: string;
        id: string | Uint8Array;
        toHexString(): string;
    }

    Properties

    __id? +ObjectIdLike | mongodb

    Interface ObjectIdLike

    interface ObjectIdLike {
        __id?: string;
        id: string | Uint8Array;
        toHexString(): string;
    }

    Properties

    __id? id

    Methods

    toHexString -

    Properties

    Optional__id

    __id?: string

    id

    id: string | Uint8Array

    Methods

    toHexString

    • toHexString(): string

    • Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Properties

    Optional__id

    __id?: string

    id

    id: string | Uint8Array

    Methods

    toHexString

    • toHexString(): string

    • Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/docs/6.10/interfaces/BSON.SerializeOptions.html b/docs/6.10/interfaces/BSON.SerializeOptions.html index aae6c905bdc..c40ed24c357 100644 --- a/docs/6.10/interfaces/BSON.SerializeOptions.html +++ b/docs/6.10/interfaces/BSON.SerializeOptions.html @@ -1,4 +1,4 @@ -SerializeOptions | mongodb

    Interface SerializeOptions

    interface SerializeOptions {
        checkKeys?: boolean;
        ignoreUndefined?: boolean;
        index?: number;
        serializeFunctions?: boolean;
    }

    Properties

    checkKeys? +SerializeOptions | mongodb

    Interface SerializeOptions

    interface SerializeOptions {
        checkKeys?: boolean;
        ignoreUndefined?: boolean;
        index?: number;
        serializeFunctions?: boolean;
    }

    Properties

    checkKeys? ignoreUndefined? index? serializeFunctions? @@ -11,4 +11,4 @@

    Default Value

    0

    OptionalserializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions

    Default Value

    false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSON.TimestampExtended.html b/docs/6.10/interfaces/BSON.TimestampExtended.html index b7da1cf5304..851650f64b5 100644 --- a/docs/6.10/interfaces/BSON.TimestampExtended.html +++ b/docs/6.10/interfaces/BSON.TimestampExtended.html @@ -1,2 +1,2 @@ -TimestampExtended | mongodb

    Interface TimestampExtended

    interface TimestampExtended {
        $timestamp: {
            i: number;
            t: number;
        };
    }

    Properties

    $timestamp -

    Properties

    $timestamp

    $timestamp: {
        i: number;
        t: number;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    +TimestampExtended | mongodb

    Interface TimestampExtended

    interface TimestampExtended {
        $timestamp: {
            i: number;
            t: number;
        };
    }

    Properties

    $timestamp +

    Properties

    $timestamp

    $timestamp: {
        i: number;
        t: number;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BSONSerializeOptions.html b/docs/6.10/interfaces/BSONSerializeOptions.html index 5ba70c2070b..b396ba9c64f 100644 --- a/docs/6.10/interfaces/BSONSerializeOptions.html +++ b/docs/6.10/interfaces/BSONSerializeOptions.html @@ -1,4 +1,4 @@ -BSONSerializeOptions | mongodb

    Interface BSONSerializeOptions

    BSON Serialization options.

    +BSONSerializeOptions | mongodb

    Interface BSONSerializeOptions

    BSON Serialization options.

    interface BSONSerializeOptions {
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        serializeFunctions?: boolean;
        useBigInt64?: boolean;
    }

    Hierarchy (view full)

    Properties

    bsonRegExp? checkKeys? enableUtf8Validation? @@ -41,4 +41,4 @@

    Remarks

    Default Value

    false

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BulkWriteOperationError.html b/docs/6.10/interfaces/BulkWriteOperationError.html index 5b6a1dc6feb..f5ee00b4936 100644 --- a/docs/6.10/interfaces/BulkWriteOperationError.html +++ b/docs/6.10/interfaces/BulkWriteOperationError.html @@ -1,6 +1,6 @@ -BulkWriteOperationError | mongodb

    Interface BulkWriteOperationError

    interface BulkWriteOperationError {
        code: number;
        errInfo: Document;
        errmsg: string;
        index: number;
        op: Document | DeleteStatement | UpdateStatement;
    }

    Properties

    code +BulkWriteOperationError | mongodb

    Interface BulkWriteOperationError

    interface BulkWriteOperationError {
        code: number;
        errInfo: Document;
        errmsg: string;
        index: number;
        op: Document | DeleteStatement | UpdateStatement;
    }

    Properties

    code errInfo errmsg index op -

    Properties

    code

    code: number

    errInfo

    errInfo: Document

    errmsg

    errmsg: string

    index

    index: number

    op

    op: Document | DeleteStatement | UpdateStatement

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    code

    code: number

    errInfo

    errInfo: Document

    errmsg

    errmsg: string

    index

    index: number

    op

    op: Document | DeleteStatement | UpdateStatement

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/BulkWriteOptions.html b/docs/6.10/interfaces/BulkWriteOptions.html index e5058b7c53d..b35b002f1ad 100644 --- a/docs/6.10/interfaces/BulkWriteOptions.html +++ b/docs/6.10/interfaces/BulkWriteOptions.html @@ -1,4 +1,4 @@ -BulkWriteOptions | mongodb

    Interface BulkWriteOptions

    interface BulkWriteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        forceServerObjectId?: boolean;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        ordered?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +BulkWriteOptions | mongodb

    Interface BulkWriteOptions

    interface BulkWriteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        forceServerObjectId?: boolean;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        ordered?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? bypassDocumentValidation? checkKeys? @@ -77,4 +77,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamCollModDocument.html b/docs/6.10/interfaces/ChangeStreamCollModDocument.html index 3c8341a88f8..9221c82a909 100644 --- a/docs/6.10/interfaces/ChangeStreamCollModDocument.html +++ b/docs/6.10/interfaces/ChangeStreamCollModDocument.html @@ -1,4 +1,4 @@ -ChangeStreamCollModDocument | mongodb

    Interface ChangeStreamCollModDocument

    Only present when the showExpandedEvents flag is enabled.

    +ChangeStreamCollModDocument | mongodb

    Interface ChangeStreamCollModDocument

    Only present when the showExpandedEvents flag is enabled.

    See

    https://www.mongodb.com/docs/manual/reference/change-events/modify/#mongodb-data-modify

    interface ChangeStreamCollModDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationType: "modify";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? @@ -29,4 +29,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamCreateDocument.html b/docs/6.10/interfaces/ChangeStreamCreateDocument.html index dd87cc68c6c..464a624d388 100644 --- a/docs/6.10/interfaces/ChangeStreamCreateDocument.html +++ b/docs/6.10/interfaces/ChangeStreamCreateDocument.html @@ -1,4 +1,4 @@ -ChangeStreamCreateDocument | mongodb

    Interface ChangeStreamCreateDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/create/#mongodb-data-create

    +ChangeStreamCreateDocument | mongodb

    Interface ChangeStreamCreateDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/create/#mongodb-data-create

    interface ChangeStreamCreateDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationType: "create";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -28,4 +28,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamCreateIndexDocument.html b/docs/6.10/interfaces/ChangeStreamCreateIndexDocument.html index 2ab3bd610dd..da76d05be24 100644 --- a/docs/6.10/interfaces/ChangeStreamCreateIndexDocument.html +++ b/docs/6.10/interfaces/ChangeStreamCreateIndexDocument.html @@ -1,4 +1,4 @@ -ChangeStreamCreateIndexDocument | mongodb

    Interface ChangeStreamCreateIndexDocument

    Only present when the showExpandedEvents flag is enabled.

    +ChangeStreamCreateIndexDocument | mongodb

    Interface ChangeStreamCreateIndexDocument

    Only present when the showExpandedEvents flag is enabled.

    See

    https://www.mongodb.com/docs/manual/reference/change-events/createIndexes/#mongodb-data-createIndexes

    interface ChangeStreamCreateIndexDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "createIndexes";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? @@ -33,4 +33,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamDeleteDocument.html b/docs/6.10/interfaces/ChangeStreamDeleteDocument.html index 89dd0055e0a..26811adf3a9 100644 --- a/docs/6.10/interfaces/ChangeStreamDeleteDocument.html +++ b/docs/6.10/interfaces/ChangeStreamDeleteDocument.html @@ -1,4 +1,4 @@ -ChangeStreamDeleteDocument | mongodb

    Interface ChangeStreamDeleteDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#delete-event

    +ChangeStreamDeleteDocument | mongodb

    Interface ChangeStreamDeleteDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#delete-event

    interface ChangeStreamDeleteDocument<TSchema> {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
        fullDocumentBeforeChange?: TSchema;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "delete";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -39,4 +39,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamDocumentCollectionUUID.html b/docs/6.10/interfaces/ChangeStreamDocumentCollectionUUID.html index 28095a83317..1b27883e858 100644 --- a/docs/6.10/interfaces/ChangeStreamDocumentCollectionUUID.html +++ b/docs/6.10/interfaces/ChangeStreamDocumentCollectionUUID.html @@ -1,7 +1,7 @@ -ChangeStreamDocumentCollectionUUID | mongodb

    Interface ChangeStreamDocumentCollectionUUID

    interface ChangeStreamDocumentCollectionUUID {
        collectionUUID: Binary;
    }

    Hierarchy (view full)

    Properties

    collectionUUID +ChangeStreamDocumentCollectionUUID | mongodb

    Interface ChangeStreamDocumentCollectionUUID

    interface ChangeStreamDocumentCollectionUUID {
        collectionUUID: Binary;
    }

    Hierarchy (view full)

    Properties

    collectionUUID

    Properties

    collectionUUID

    collectionUUID: Binary

    The UUID (Binary subtype 4) of the collection that the operation was performed on.

    Only present when the showExpandedEvents flag is enabled.

    NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.

    Since Server Version

    6.1.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamDocumentCommon.html b/docs/6.10/interfaces/ChangeStreamDocumentCommon.html index 2e4029db367..af4a869e024 100644 --- a/docs/6.10/interfaces/ChangeStreamDocumentCommon.html +++ b/docs/6.10/interfaces/ChangeStreamDocumentCommon.html @@ -1,4 +1,4 @@ -ChangeStreamDocumentCommon | mongodb

    Interface ChangeStreamDocumentCommon

    interface ChangeStreamDocumentCommon {
        _id: unknown;
        clusterTime?: Timestamp;
        lsid?: ServerSessionId;
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id +ChangeStreamDocumentCommon | mongodb

    Interface ChangeStreamDocumentCommon

    interface ChangeStreamDocumentCommon {
        _id: unknown;
        clusterTime?: Timestamp;
        lsid?: ServerSessionId;
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? lsid? splitEvent? @@ -19,4 +19,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamDocumentKey.html b/docs/6.10/interfaces/ChangeStreamDocumentKey.html index 8a786328fa7..62c82bb450b 100644 --- a/docs/6.10/interfaces/ChangeStreamDocumentKey.html +++ b/docs/6.10/interfaces/ChangeStreamDocumentKey.html @@ -1,4 +1,4 @@ -ChangeStreamDocumentKey | mongodb

    Interface ChangeStreamDocumentKey<TSchema>

    interface ChangeStreamDocumentKey<TSchema> {
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    documentKey +ChangeStreamDocumentKey | mongodb

    Interface ChangeStreamDocumentKey<TSchema>

    interface ChangeStreamDocumentKey<TSchema> {
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    documentKey

    Properties

    documentKey

    documentKey: {
        _id: InferIdType<TSchema>;
        [shardKey: string]: any;
    }

    For unsharded collections this contains a single field _id. For sharded collections, this will contain all the components of the shard key

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamDocumentOperationDescription.html b/docs/6.10/interfaces/ChangeStreamDocumentOperationDescription.html index c212e0ca95c..63e1161241b 100644 --- a/docs/6.10/interfaces/ChangeStreamDocumentOperationDescription.html +++ b/docs/6.10/interfaces/ChangeStreamDocumentOperationDescription.html @@ -1,5 +1,5 @@ -ChangeStreamDocumentOperationDescription | mongodb

    Interface ChangeStreamDocumentOperationDescription

    interface ChangeStreamDocumentOperationDescription {
        operationDescription?: Document;
    }

    Hierarchy (view full)

    Properties

    operationDescription? +ChangeStreamDocumentOperationDescription | mongodb

    Interface ChangeStreamDocumentOperationDescription

    interface ChangeStreamDocumentOperationDescription {
        operationDescription?: Document;
    }

    Hierarchy (view full)

    Properties

    operationDescription?

    Properties

    OptionaloperationDescription

    operationDescription?: Document

    An description of the operation.

    Only present when the showExpandedEvents flag is enabled.

    Since Server Version

    6.1.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamDropDatabaseDocument.html b/docs/6.10/interfaces/ChangeStreamDropDatabaseDocument.html index 4916b3d8cee..635cae504dc 100644 --- a/docs/6.10/interfaces/ChangeStreamDropDatabaseDocument.html +++ b/docs/6.10/interfaces/ChangeStreamDropDatabaseDocument.html @@ -1,4 +1,4 @@ -ChangeStreamDropDatabaseDocument | mongodb

    Interface ChangeStreamDropDatabaseDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#dropdatabase-event

    +ChangeStreamDropDatabaseDocument | mongodb

    Interface ChangeStreamDropDatabaseDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#dropdatabase-event

    interface ChangeStreamDropDatabaseDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        lsid?: ServerSessionId;
        ns: {
            db: string;
        };
        operationType: "dropDatabase";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? lsid? @@ -24,4 +24,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamDropDocument.html b/docs/6.10/interfaces/ChangeStreamDropDocument.html index b2fee65507f..8afe617ca56 100644 --- a/docs/6.10/interfaces/ChangeStreamDropDocument.html +++ b/docs/6.10/interfaces/ChangeStreamDropDocument.html @@ -1,4 +1,4 @@ -ChangeStreamDropDocument | mongodb

    Interface ChangeStreamDropDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#drop-event

    +ChangeStreamDropDocument | mongodb

    Interface ChangeStreamDropDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#drop-event

    interface ChangeStreamDropDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "drop";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -30,4 +30,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamDropIndexDocument.html b/docs/6.10/interfaces/ChangeStreamDropIndexDocument.html index 361a2b6810a..8794c05137b 100644 --- a/docs/6.10/interfaces/ChangeStreamDropIndexDocument.html +++ b/docs/6.10/interfaces/ChangeStreamDropIndexDocument.html @@ -1,4 +1,4 @@ -ChangeStreamDropIndexDocument | mongodb

    Interface ChangeStreamDropIndexDocument

    Only present when the showExpandedEvents flag is enabled.

    +ChangeStreamDropIndexDocument | mongodb

    Interface ChangeStreamDropIndexDocument

    Only present when the showExpandedEvents flag is enabled.

    See

    https://www.mongodb.com/docs/manual/reference/change-events/dropIndexes/#mongodb-data-dropIndexes

    interface ChangeStreamDropIndexDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "dropIndexes";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? @@ -33,4 +33,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamInsertDocument.html b/docs/6.10/interfaces/ChangeStreamInsertDocument.html index 5d8bb6d4004..22c799bfefc 100644 --- a/docs/6.10/interfaces/ChangeStreamInsertDocument.html +++ b/docs/6.10/interfaces/ChangeStreamInsertDocument.html @@ -1,4 +1,4 @@ -ChangeStreamInsertDocument | mongodb

    Interface ChangeStreamInsertDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#insert-event

    +ChangeStreamInsertDocument | mongodb

    Interface ChangeStreamInsertDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#insert-event

    interface ChangeStreamInsertDocument<TSchema> {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
        fullDocument: TSchema;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "insert";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -35,4 +35,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamInvalidateDocument.html b/docs/6.10/interfaces/ChangeStreamInvalidateDocument.html index ac81218fa17..0ea676e5ba5 100644 --- a/docs/6.10/interfaces/ChangeStreamInvalidateDocument.html +++ b/docs/6.10/interfaces/ChangeStreamInvalidateDocument.html @@ -1,4 +1,4 @@ -ChangeStreamInvalidateDocument | mongodb

    Interface ChangeStreamInvalidateDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#invalidate-event

    +ChangeStreamInvalidateDocument | mongodb

    Interface ChangeStreamInvalidateDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#invalidate-event

    interface ChangeStreamInvalidateDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        lsid?: ServerSessionId;
        operationType: "invalidate";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? lsid? @@ -22,4 +22,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamNameSpace.html b/docs/6.10/interfaces/ChangeStreamNameSpace.html index a8b987d920d..becc7ab1ce7 100644 --- a/docs/6.10/interfaces/ChangeStreamNameSpace.html +++ b/docs/6.10/interfaces/ChangeStreamNameSpace.html @@ -1,3 +1,3 @@ -ChangeStreamNameSpace | mongodb

    Interface ChangeStreamNameSpace

    interface ChangeStreamNameSpace {
        coll: string;
        db: string;
    }

    Properties

    coll +ChangeStreamNameSpace | mongodb

    Interface ChangeStreamNameSpace

    interface ChangeStreamNameSpace {
        coll: string;
        db: string;
    }

    Properties

    coll db -

    Properties

    coll

    coll: string

    db

    db: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    coll

    coll: string

    db

    db: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamOptions.html b/docs/6.10/interfaces/ChangeStreamOptions.html index 0b70398c5db..875a7f16d25 100644 --- a/docs/6.10/interfaces/ChangeStreamOptions.html +++ b/docs/6.10/interfaces/ChangeStreamOptions.html @@ -1,4 +1,4 @@ -ChangeStreamOptions | mongodb

    Interface ChangeStreamOptions

    Options that can be passed to a ChangeStream. Note that startAfter, resumeAfter, and startAtOperationTime are all mutually exclusive, and the server will error if more than one is specified.

    +ChangeStreamOptions | mongodb

    Interface ChangeStreamOptions

    Options that can be passed to a ChangeStream. Note that startAfter, resumeAfter, and startAtOperationTime are all mutually exclusive, and the server will error if more than one is specified.

    interface ChangeStreamOptions {
        allowDiskUse?: boolean;
        authdb?: string;
        batchSize?: number;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        cursor?: Document;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        fullDocument?: string;
        fullDocumentBeforeChange?: string;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        out?: string;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        resumeAfter?: unknown;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        showExpandedEvents?: boolean;
        startAfter?: unknown;
        startAtOperationTime?: Timestamp;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
    }

    Hierarchy

    Properties

    allowDiskUse? authdb? batchSize? @@ -121,4 +121,4 @@

    Remarks

    OptionalstartAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    -

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamRefineCollectionShardKeyDocument.html b/docs/6.10/interfaces/ChangeStreamRefineCollectionShardKeyDocument.html index f256294d505..720e06cc5be 100644 --- a/docs/6.10/interfaces/ChangeStreamRefineCollectionShardKeyDocument.html +++ b/docs/6.10/interfaces/ChangeStreamRefineCollectionShardKeyDocument.html @@ -1,4 +1,4 @@ -ChangeStreamRefineCollectionShardKeyDocument | mongodb

    Interface ChangeStreamRefineCollectionShardKeyDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/refineCollectionShardKey/#mongodb-data-refineCollectionShardKey

    +ChangeStreamRefineCollectionShardKeyDocument | mongodb

    Interface ChangeStreamRefineCollectionShardKeyDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/refineCollectionShardKey/#mongodb-data-refineCollectionShardKey

    interface ChangeStreamRefineCollectionShardKeyDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "refineCollectionShardKey";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -32,4 +32,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamRenameDocument.html b/docs/6.10/interfaces/ChangeStreamRenameDocument.html index fceafb59058..785e6d7fade 100644 --- a/docs/6.10/interfaces/ChangeStreamRenameDocument.html +++ b/docs/6.10/interfaces/ChangeStreamRenameDocument.html @@ -1,4 +1,4 @@ -ChangeStreamRenameDocument | mongodb

    Interface ChangeStreamRenameDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#rename-event

    +ChangeStreamRenameDocument | mongodb

    Interface ChangeStreamRenameDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#rename-event

    interface ChangeStreamRenameDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "rename";
        splitEvent?: ChangeStreamSplitEvent;
        to: {
            coll: string;
            db: string;
        };
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -32,4 +32,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamReplaceDocument.html b/docs/6.10/interfaces/ChangeStreamReplaceDocument.html index 330ef886b50..202f23588c9 100644 --- a/docs/6.10/interfaces/ChangeStreamReplaceDocument.html +++ b/docs/6.10/interfaces/ChangeStreamReplaceDocument.html @@ -1,4 +1,4 @@ -ChangeStreamReplaceDocument | mongodb

    Interface ChangeStreamReplaceDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#replace-event

    +ChangeStreamReplaceDocument | mongodb

    Interface ChangeStreamReplaceDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#replace-event

    interface ChangeStreamReplaceDocument<TSchema> {
        _id: unknown;
        clusterTime?: Timestamp;
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
        fullDocument: TSchema;
        fullDocumentBeforeChange?: TSchema;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "replace";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    _id clusterTime? documentKey @@ -35,4 +35,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamReshardCollectionDocument.html b/docs/6.10/interfaces/ChangeStreamReshardCollectionDocument.html index 5f7a4250da1..feb78415b1b 100644 --- a/docs/6.10/interfaces/ChangeStreamReshardCollectionDocument.html +++ b/docs/6.10/interfaces/ChangeStreamReshardCollectionDocument.html @@ -1,4 +1,4 @@ -ChangeStreamReshardCollectionDocument | mongodb

    Interface ChangeStreamReshardCollectionDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/reshardCollection/#mongodb-data-reshardCollection

    +ChangeStreamReshardCollectionDocument | mongodb

    Interface ChangeStreamReshardCollectionDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/reshardCollection/#mongodb-data-reshardCollection

    interface ChangeStreamReshardCollectionDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "reshardCollection";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -32,4 +32,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamShardCollectionDocument.html b/docs/6.10/interfaces/ChangeStreamShardCollectionDocument.html index 0aae8fd9309..3b3259b8f28 100644 --- a/docs/6.10/interfaces/ChangeStreamShardCollectionDocument.html +++ b/docs/6.10/interfaces/ChangeStreamShardCollectionDocument.html @@ -1,4 +1,4 @@ -ChangeStreamShardCollectionDocument | mongodb

    Interface ChangeStreamShardCollectionDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/shardCollection/#mongodb-data-shardCollection

    +ChangeStreamShardCollectionDocument | mongodb

    Interface ChangeStreamShardCollectionDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/shardCollection/#mongodb-data-shardCollection

    interface ChangeStreamShardCollectionDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "shardCollection";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -32,4 +32,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamSplitEvent.html b/docs/6.10/interfaces/ChangeStreamSplitEvent.html index 7baa97ddd89..d8b46592b6b 100644 --- a/docs/6.10/interfaces/ChangeStreamSplitEvent.html +++ b/docs/6.10/interfaces/ChangeStreamSplitEvent.html @@ -1,5 +1,5 @@ -ChangeStreamSplitEvent | mongodb

    Interface ChangeStreamSplitEvent

    interface ChangeStreamSplitEvent {
        fragment: number;
        of: number;
    }

    Properties

    fragment +ChangeStreamSplitEvent | mongodb

    Interface ChangeStreamSplitEvent

    interface ChangeStreamSplitEvent {
        fragment: number;
        of: number;
    }

    Properties

    fragment of

    Properties

    fragment

    fragment: number

    Which fragment of the change this is.

    of

    of: number

    The total number of fragments.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ChangeStreamUpdateDocument.html b/docs/6.10/interfaces/ChangeStreamUpdateDocument.html index d1af02e535d..707d2cf71ba 100644 --- a/docs/6.10/interfaces/ChangeStreamUpdateDocument.html +++ b/docs/6.10/interfaces/ChangeStreamUpdateDocument.html @@ -1,4 +1,4 @@ -ChangeStreamUpdateDocument | mongodb

    Interface ChangeStreamUpdateDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#update-event

    +ChangeStreamUpdateDocument | mongodb

    Interface ChangeStreamUpdateDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#update-event

    interface ChangeStreamUpdateDocument<TSchema> {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
        fullDocument?: TSchema;
        fullDocumentBeforeChange?: TSchema;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "update";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
        updateDescription: UpdateDescription<TSchema>;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -46,4 +46,4 @@ Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    updateDescription

    updateDescription: UpdateDescription<TSchema>

    Contains a description of updated and removed fields in this operation

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientBulkWriteError.html b/docs/6.10/interfaces/ClientBulkWriteError.html index e4546874fbd..2ffd0fffc52 100644 --- a/docs/6.10/interfaces/ClientBulkWriteError.html +++ b/docs/6.10/interfaces/ClientBulkWriteError.html @@ -1,3 +1,3 @@ -ClientBulkWriteError | mongodb

    Interface ClientBulkWriteError

    interface ClientBulkWriteError {
        code: number;
        message: string;
    }

    Properties

    code +ClientBulkWriteError | mongodb

    Interface ClientBulkWriteError

    interface ClientBulkWriteError {
        code: number;
        message: string;
    }

    Properties

    code message -

    Properties

    code

    code: number

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    code

    code: number

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientBulkWriteOptions.html b/docs/6.10/interfaces/ClientBulkWriteOptions.html index 451588bdd49..3d5516091f4 100644 --- a/docs/6.10/interfaces/ClientBulkWriteOptions.html +++ b/docs/6.10/interfaces/ClientBulkWriteOptions.html @@ -1,4 +1,4 @@ -ClientBulkWriteOptions | mongodb

    Interface ClientBulkWriteOptions

    interface ClientBulkWriteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        ordered?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        verboseResults?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +ClientBulkWriteOptions | mongodb

    Interface ClientBulkWriteOptions

    interface ClientBulkWriteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        ordered?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        verboseResults?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? bypassDocumentValidation? checkKeys? @@ -77,4 +77,4 @@

    Remarks

    OptionalverboseResults

    verboseResults?: boolean

    Whether detailed results for each successful operation should be included in the returned BulkWriteResult.

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientBulkWriteResult.html b/docs/6.10/interfaces/ClientBulkWriteResult.html index 69a58fcfec8..1b079d14526 100644 --- a/docs/6.10/interfaces/ClientBulkWriteResult.html +++ b/docs/6.10/interfaces/ClientBulkWriteResult.html @@ -1,4 +1,4 @@ -ClientBulkWriteResult | mongodb

    Interface ClientBulkWriteResult

    interface ClientBulkWriteResult {
        acknowledged: boolean;
        deletedCount: number;
        deleteResults?: ReadonlyMap<number, ClientDeleteResult>;
        insertedCount: number;
        insertResults?: ReadonlyMap<number, ClientInsertOneResult>;
        matchedCount: number;
        modifiedCount: number;
        updateResults?: ReadonlyMap<number, ClientUpdateResult>;
        upsertedCount: number;
    }

    Properties

    acknowledged +ClientBulkWriteResult | mongodb

    Interface ClientBulkWriteResult

    interface ClientBulkWriteResult {
        acknowledged: boolean;
        deletedCount: number;
        deleteResults?: ReadonlyMap<number, ClientDeleteResult>;
        insertedCount: number;
        insertResults?: ReadonlyMap<number, ClientInsertOneResult>;
        matchedCount: number;
        modifiedCount: number;
        updateResults?: ReadonlyMap<number, ClientUpdateResult>;
        upsertedCount: number;
    }

    Properties

    acknowledged deletedCount deleteResults? insertedCount @@ -16,4 +16,4 @@

    ReadonlymodifiedCount

    modifiedCount: number

    The total number of documents modified across all update operations.

    Optional ReadonlyupdateResults

    updateResults?: ReadonlyMap<number, ClientUpdateResult>

    The results of each individual update operation that was successfully performed.

    ReadonlyupsertedCount

    upsertedCount: number

    The total number of documents upserted across all update operations.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientDeleteManyModel.html b/docs/6.10/interfaces/ClientDeleteManyModel.html index fc164da1d35..c50f54f4cd7 100644 --- a/docs/6.10/interfaces/ClientDeleteManyModel.html +++ b/docs/6.10/interfaces/ClientDeleteManyModel.html @@ -1,4 +1,4 @@ -ClientDeleteManyModel | mongodb

    Interface ClientDeleteManyModel<TSchema>

    interface ClientDeleteManyModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "deleteMany";
        namespace: string;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    collation? +ClientDeleteManyModel | mongodb

    Interface ClientDeleteManyModel<TSchema>

    interface ClientDeleteManyModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "deleteMany";
        namespace: string;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    collation? filter hint? name @@ -11,4 +11,4 @@

    A namespace is a combination of the database name and the name of the collection: <database-name>.<collection>. All documents belong to a namespace.

    See

    https://www.mongodb.com/docs/manual/reference/limits/#std-label-faq-dev-namespace

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientDeleteOneModel.html b/docs/6.10/interfaces/ClientDeleteOneModel.html index b228651b234..54ff0b02566 100644 --- a/docs/6.10/interfaces/ClientDeleteOneModel.html +++ b/docs/6.10/interfaces/ClientDeleteOneModel.html @@ -1,4 +1,4 @@ -ClientDeleteOneModel | mongodb

    Interface ClientDeleteOneModel<TSchema>

    interface ClientDeleteOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "deleteOne";
        namespace: string;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    collation? +ClientDeleteOneModel | mongodb

    Interface ClientDeleteOneModel<TSchema>

    interface ClientDeleteOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "deleteOne";
        namespace: string;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    collation? filter hint? name @@ -11,4 +11,4 @@

    A namespace is a combination of the database name and the name of the collection: <database-name>.<collection>. All documents belong to a namespace.

    See

    https://www.mongodb.com/docs/manual/reference/limits/#std-label-faq-dev-namespace

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientDeleteResult.html b/docs/6.10/interfaces/ClientDeleteResult.html index 6fa741821bf..d0c6f50a8f6 100644 --- a/docs/6.10/interfaces/ClientDeleteResult.html +++ b/docs/6.10/interfaces/ClientDeleteResult.html @@ -1,3 +1,3 @@ -ClientDeleteResult | mongodb

    Interface ClientDeleteResult

    interface ClientDeleteResult {
        deletedCount: number;
    }

    Properties

    deletedCount +ClientDeleteResult | mongodb

    Interface ClientDeleteResult

    interface ClientDeleteResult {
        deletedCount: number;
    }

    Properties

    deletedCount

    Properties

    deletedCount

    deletedCount: number

    The number of documents that were deleted.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientEncryptionCreateDataKeyProviderOptions.html b/docs/6.10/interfaces/ClientEncryptionCreateDataKeyProviderOptions.html index a26708cc68c..5093969af19 100644 --- a/docs/6.10/interfaces/ClientEncryptionCreateDataKeyProviderOptions.html +++ b/docs/6.10/interfaces/ClientEncryptionCreateDataKeyProviderOptions.html @@ -1,8 +1,8 @@ -ClientEncryptionCreateDataKeyProviderOptions | mongodb

    Interface ClientEncryptionCreateDataKeyProviderOptions

    Options to provide when creating a new data key.

    +ClientEncryptionCreateDataKeyProviderOptions | mongodb

    Interface ClientEncryptionCreateDataKeyProviderOptions

    Options to provide when creating a new data key.

    interface ClientEncryptionCreateDataKeyProviderOptions {
        keyAltNames?: string[];
        keyMaterial?: Buffer | Binary;
        masterKey?:
            | AWSEncryptionKeyOptions
            | AzureEncryptionKeyOptions
            | GCPEncryptionKeyOptions
            | KMIPEncryptionKeyOptions;
    }

    Properties

    keyAltNames? keyMaterial? masterKey?

    Properties

    OptionalkeyAltNames

    keyAltNames?: string[]

    An optional list of string alternate names used to reference a key. If a key is created with alternate names, then encryption may refer to the key by the unique alternate name instead of by _id.

    Optional ExperimentalkeyMaterial

    keyMaterial?: Buffer | Binary

    OptionalmasterKey

    masterKey?:
        | AWSEncryptionKeyOptions
        | AzureEncryptionKeyOptions
        | GCPEncryptionKeyOptions
        | KMIPEncryptionKeyOptions

    Identifies a new KMS-specific key used to encrypt the new data key

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientEncryptionEncryptOptions.html b/docs/6.10/interfaces/ClientEncryptionEncryptOptions.html index 02d9d831b8a..ab4acb1dad7 100644 --- a/docs/6.10/interfaces/ClientEncryptionEncryptOptions.html +++ b/docs/6.10/interfaces/ClientEncryptionEncryptOptions.html @@ -1,4 +1,4 @@ -ClientEncryptionEncryptOptions | mongodb

    Interface ClientEncryptionEncryptOptions

    Options to provide when encrypting data.

    +ClientEncryptionEncryptOptions | mongodb

    Interface ClientEncryptionEncryptOptions

    Options to provide when encrypting data.

    interface ClientEncryptionEncryptOptions {
        algorithm:
            | "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"
            | "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
            | "Indexed"
            | "Unindexed"
            | "Range";
        contentionFactor?: number | bigint;
        keyAltName?: string;
        keyId?: Binary;
        queryType?: "equality" | "range";
        rangeOptions?: RangeOptions;
    }

    Properties

    algorithm contentionFactor? keyAltName? @@ -11,4 +11,4 @@

    OptionalkeyId

    keyId?: Binary

    The id of the Binary dataKey to use for encryption

    OptionalqueryType

    queryType?: "equality" | "range"

    The query type.

    OptionalrangeOptions

    rangeOptions?: RangeOptions

    The index options for a Queryable Encryption field supporting "range" queries.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientEncryptionOptions.html b/docs/6.10/interfaces/ClientEncryptionOptions.html index 99881176e1d..7429c757c40 100644 --- a/docs/6.10/interfaces/ClientEncryptionOptions.html +++ b/docs/6.10/interfaces/ClientEncryptionOptions.html @@ -1,4 +1,4 @@ -ClientEncryptionOptions | mongodb

    Interface ClientEncryptionOptions

    Additional settings to provide when creating a new ClientEncryption instance.

    +ClientEncryptionOptions | mongodb

    Interface ClientEncryptionOptions

    Additional settings to provide when creating a new ClientEncryption instance.

    interface ClientEncryptionOptions {
        keyVaultClient?: MongoClient;
        keyVaultNamespace: string;
        kmsProviders?: KMSProviders;
        proxyOptions?: ProxyOptions;
        tlsOptions?: CSFLEKMSTlsOptions;
    }

    Properties

    keyVaultClient? keyVaultNamespace kmsProviders? @@ -9,4 +9,4 @@

    OptionalkmsProviders

    kmsProviders?: KMSProviders

    Options for specific KMS providers to use

    OptionalproxyOptions

    proxyOptions?: ProxyOptions

    Options for specifying a Socks5 proxy to use for connecting to the KMS.

    OptionaltlsOptions

    tlsOptions?: CSFLEKMSTlsOptions

    TLS options for kms providers to use.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientEncryptionRewrapManyDataKeyProviderOptions.html b/docs/6.10/interfaces/ClientEncryptionRewrapManyDataKeyProviderOptions.html index 0fd7214059e..33c1fced694 100644 --- a/docs/6.10/interfaces/ClientEncryptionRewrapManyDataKeyProviderOptions.html +++ b/docs/6.10/interfaces/ClientEncryptionRewrapManyDataKeyProviderOptions.html @@ -1,3 +1,3 @@ -ClientEncryptionRewrapManyDataKeyProviderOptions | mongodb

    Interface ClientEncryptionRewrapManyDataKeyProviderOptionsExperimental

    interface ClientEncryptionRewrapManyDataKeyProviderOptions {
        masterKey?:
            | AWSEncryptionKeyOptions
            | AzureEncryptionKeyOptions
            | GCPEncryptionKeyOptions
            | KMIPEncryptionKeyOptions;
        provider: keyof KMSProviders;
    }

    Properties

    masterKey? +ClientEncryptionRewrapManyDataKeyProviderOptions | mongodb

    Interface ClientEncryptionRewrapManyDataKeyProviderOptionsExperimental

    interface ClientEncryptionRewrapManyDataKeyProviderOptions {
        masterKey?:
            | AWSEncryptionKeyOptions
            | AzureEncryptionKeyOptions
            | GCPEncryptionKeyOptions
            | KMIPEncryptionKeyOptions;
        provider: keyof KMSProviders;
    }

    Properties

    masterKey? provider -

    Properties

    Optional ExperimentalmasterKey

    masterKey?:
        | AWSEncryptionKeyOptions
        | AzureEncryptionKeyOptions
        | GCPEncryptionKeyOptions
        | KMIPEncryptionKeyOptions

    Experimentalprovider

    provider: keyof KMSProviders

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optional ExperimentalmasterKey

    masterKey?:
        | AWSEncryptionKeyOptions
        | AzureEncryptionKeyOptions
        | GCPEncryptionKeyOptions
        | KMIPEncryptionKeyOptions

    Experimentalprovider

    provider: keyof KMSProviders

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientEncryptionRewrapManyDataKeyResult.html b/docs/6.10/interfaces/ClientEncryptionRewrapManyDataKeyResult.html index 29a768697ec..46a434e1bc8 100644 --- a/docs/6.10/interfaces/ClientEncryptionRewrapManyDataKeyResult.html +++ b/docs/6.10/interfaces/ClientEncryptionRewrapManyDataKeyResult.html @@ -1,3 +1,3 @@ -ClientEncryptionRewrapManyDataKeyResult | mongodb

    Interface ClientEncryptionRewrapManyDataKeyResultExperimental

    interface ClientEncryptionRewrapManyDataKeyResult {
        bulkWriteResult?: BulkWriteResult;
    }

    Properties

    bulkWriteResult? +ClientEncryptionRewrapManyDataKeyResult | mongodb

    Interface ClientEncryptionRewrapManyDataKeyResultExperimental

    interface ClientEncryptionRewrapManyDataKeyResult {
        bulkWriteResult?: BulkWriteResult;
    }

    Properties

    bulkWriteResult?

    Properties

    Optional ExperimentalbulkWriteResult

    bulkWriteResult?: BulkWriteResult

    The result of rewrapping data keys. If unset, no keys matched the filter.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientInsertOneModel.html b/docs/6.10/interfaces/ClientInsertOneModel.html index d3b7cf06142..d340e793e08 100644 --- a/docs/6.10/interfaces/ClientInsertOneModel.html +++ b/docs/6.10/interfaces/ClientInsertOneModel.html @@ -1,4 +1,4 @@ -ClientInsertOneModel | mongodb

    Interface ClientInsertOneModel<TSchema>

    interface ClientInsertOneModel<TSchema> {
        document: OptionalId<TSchema>;
        name: "insertOne";
        namespace: string;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    document +ClientInsertOneModel | mongodb

    Interface ClientInsertOneModel<TSchema>

    interface ClientInsertOneModel<TSchema> {
        document: OptionalId<TSchema>;
        name: "insertOne";
        namespace: string;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    document name namespace

    Properties

    document

    document: OptionalId<TSchema>

    The document to insert.

    @@ -6,4 +6,4 @@

    A namespace is a combination of the database name and the name of the collection: <database-name>.<collection>. All documents belong to a namespace.

    See

    https://www.mongodb.com/docs/manual/reference/limits/#std-label-faq-dev-namespace

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientInsertOneResult.html b/docs/6.10/interfaces/ClientInsertOneResult.html index 9a99992b994..24004179fc6 100644 --- a/docs/6.10/interfaces/ClientInsertOneResult.html +++ b/docs/6.10/interfaces/ClientInsertOneResult.html @@ -1,3 +1,3 @@ -ClientInsertOneResult | mongodb

    Interface ClientInsertOneResult

    interface ClientInsertOneResult {
        insertedId: any;
    }

    Properties

    insertedId +ClientInsertOneResult | mongodb

    Interface ClientInsertOneResult

    interface ClientInsertOneResult {
        insertedId: any;
    }

    Properties

    insertedId

    Properties

    insertedId

    insertedId: any

    The _id of the inserted document.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientMetadata.html b/docs/6.10/interfaces/ClientMetadata.html index dbe9887a5b0..d7afd1d1899 100644 --- a/docs/6.10/interfaces/ClientMetadata.html +++ b/docs/6.10/interfaces/ClientMetadata.html @@ -1,8 +1,8 @@ -ClientMetadata | mongodb

    Interface ClientMetadata

    See

    https://github.com/mongodb/specifications/blob/master/source/mongodb-handshake/handshake.rst#hello-command

    +ClientMetadata | mongodb

    Interface ClientMetadata

    See

    https://github.com/mongodb/specifications/blob/master/source/mongodb-handshake/handshake.md#hello-command

    interface ClientMetadata {
        application?: {
            name: string;
        };
        driver: {
            name: string;
            version: string;
        };
        env?: {
            memory_mb?: Int32;
            name:
                | "aws.lambda"
                | "gcp.func"
                | "azure.func"
                | "vercel";
            region?: string;
            timeout_sec?: Int32;
            url?: string;
        };
        os: {
            architecture?: string;
            name?: Platform;
            type: string;
            version?: string;
        };
        platform: string;
    }

    Properties

    application? driver env? os platform

    Properties

    Optionalapplication

    application?: {
        name: string;
    }

    driver

    driver: {
        name: string;
        version: string;
    }

    Optionalenv

    env?: {
        memory_mb?: Int32;
        name:
            | "aws.lambda"
            | "gcp.func"
            | "azure.func"
            | "vercel";
        region?: string;
        timeout_sec?: Int32;
        url?: string;
    }

    FaaS environment information

    -

    os

    os: {
        architecture?: string;
        name?: Platform;
        type: string;
        version?: string;
    }

    platform

    platform: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    os

    os: {
        architecture?: string;
        name?: Platform;
        type: string;
        version?: string;
    }

    platform

    platform: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientMetadataOptions.html b/docs/6.10/interfaces/ClientMetadataOptions.html index 31c36ac60d2..858c492dcde 100644 --- a/docs/6.10/interfaces/ClientMetadataOptions.html +++ b/docs/6.10/interfaces/ClientMetadataOptions.html @@ -1,3 +1,3 @@ -ClientMetadataOptions | mongodb

    Interface ClientMetadataOptions

    interface ClientMetadataOptions {
        appName?: string;
        driverInfo?: {
            name?: string;
            platform?: string;
            version?: string;
        };
    }

    Properties

    appName? +ClientMetadataOptions | mongodb

    Interface ClientMetadataOptions

    interface ClientMetadataOptions {
        appName?: string;
        driverInfo?: {
            name?: string;
            platform?: string;
            version?: string;
        };
    }

    Properties

    appName? driverInfo? -

    Properties

    OptionalappName

    appName?: string

    OptionaldriverInfo

    driverInfo?: {
        name?: string;
        platform?: string;
        version?: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalappName

    appName?: string

    OptionaldriverInfo

    driverInfo?: {
        name?: string;
        platform?: string;
        version?: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientReplaceOneModel.html b/docs/6.10/interfaces/ClientReplaceOneModel.html index 11a891a97f5..0e18c65ec0f 100644 --- a/docs/6.10/interfaces/ClientReplaceOneModel.html +++ b/docs/6.10/interfaces/ClientReplaceOneModel.html @@ -1,4 +1,4 @@ -ClientReplaceOneModel | mongodb

    Interface ClientReplaceOneModel<TSchema>

    interface ClientReplaceOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "replaceOne";
        namespace: string;
        replacement: WithoutId<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    collation? +ClientReplaceOneModel | mongodb

    Interface ClientReplaceOneModel<TSchema>

    interface ClientReplaceOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "replaceOne";
        namespace: string;
        replacement: WithoutId<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    collation? filter hint? name @@ -15,4 +15,4 @@

    See

    https://www.mongodb.com/docs/manual/reference/limits/#std-label-faq-dev-namespace

    replacement

    replacement: WithoutId<TSchema>

    The document with which to replace the matched document.

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientSessionOptions.html b/docs/6.10/interfaces/ClientSessionOptions.html index 5af974b97dc..d4febafa530 100644 --- a/docs/6.10/interfaces/ClientSessionOptions.html +++ b/docs/6.10/interfaces/ClientSessionOptions.html @@ -1,7 +1,7 @@ -ClientSessionOptions | mongodb

    Interface ClientSessionOptions

    interface ClientSessionOptions {
        causalConsistency?: boolean;
        defaultTransactionOptions?: TransactionOptions;
        snapshot?: boolean;
    }

    Properties

    causalConsistency? +ClientSessionOptions | mongodb

    Interface ClientSessionOptions

    interface ClientSessionOptions {
        causalConsistency?: boolean;
        defaultTransactionOptions?: TransactionOptions;
        snapshot?: boolean;
    }

    Properties

    causalConsistency? defaultTransactionOptions? snapshot?

    Properties

    OptionalcausalConsistency

    causalConsistency?: boolean

    Whether causal consistency should be enabled on this session

    OptionaldefaultTransactionOptions

    defaultTransactionOptions?: TransactionOptions

    The default TransactionOptions to use for transactions started on this session.

    Optionalsnapshot

    snapshot?: boolean

    Whether all read operations should be read from the same snapshot for this session (NOTE: not compatible with causalConsistency=true)

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientUpdateManyModel.html b/docs/6.10/interfaces/ClientUpdateManyModel.html index 0aba3cd35f8..8b8db048666 100644 --- a/docs/6.10/interfaces/ClientUpdateManyModel.html +++ b/docs/6.10/interfaces/ClientUpdateManyModel.html @@ -1,4 +1,4 @@ -ClientUpdateManyModel | mongodb

    Interface ClientUpdateManyModel<TSchema>

    interface ClientUpdateManyModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "updateMany";
        namespace: string;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    arrayFilters? +ClientUpdateManyModel | mongodb

    Interface ClientUpdateManyModel<TSchema>

    interface ClientUpdateManyModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "updateMany";
        namespace: string;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    arrayFilters? collation? filter hint? @@ -19,4 +19,4 @@ UpdateFilter - A document that contains update operator expressions, Document[] - an aggregation pipeline.

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientUpdateOneModel.html b/docs/6.10/interfaces/ClientUpdateOneModel.html index 06c37067102..7e9f1bd79ab 100644 --- a/docs/6.10/interfaces/ClientUpdateOneModel.html +++ b/docs/6.10/interfaces/ClientUpdateOneModel.html @@ -1,4 +1,4 @@ -ClientUpdateOneModel | mongodb

    Interface ClientUpdateOneModel<TSchema>

    interface ClientUpdateOneModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "updateOne";
        namespace: string;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    arrayFilters? +ClientUpdateOneModel | mongodb

    Interface ClientUpdateOneModel<TSchema>

    interface ClientUpdateOneModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "updateOne";
        namespace: string;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    arrayFilters? collation? filter hint? @@ -19,4 +19,4 @@ UpdateFilter - A document that contains update operator expressions, Document[] - an aggregation pipeline.

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientUpdateResult.html b/docs/6.10/interfaces/ClientUpdateResult.html index 1277766ae74..2fc22e0b58e 100644 --- a/docs/6.10/interfaces/ClientUpdateResult.html +++ b/docs/6.10/interfaces/ClientUpdateResult.html @@ -1,4 +1,4 @@ -ClientUpdateResult | mongodb

    Interface ClientUpdateResult

    interface ClientUpdateResult {
        didUpsert: boolean;
        matchedCount: number;
        modifiedCount: number;
        upsertedId?: any;
    }

    Properties

    didUpsert +ClientUpdateResult | mongodb

    Interface ClientUpdateResult

    interface ClientUpdateResult {
        didUpsert: boolean;
        matchedCount: number;
        modifiedCount: number;
        upsertedId?: any;
    }

    Properties

    didUpsert matchedCount modifiedCount upsertedId? @@ -9,4 +9,4 @@

    It MUST be possible to discern between a BSON Null upserted ID value and this field being unset. If necessary, drivers MAY add a didUpsert boolean field to differentiate between these two cases.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClientWriteModel.html b/docs/6.10/interfaces/ClientWriteModel.html index 834ee0eab9b..42c9b6dd7cb 100644 --- a/docs/6.10/interfaces/ClientWriteModel.html +++ b/docs/6.10/interfaces/ClientWriteModel.html @@ -1,6 +1,6 @@ -ClientWriteModel | mongodb

    Interface ClientWriteModel

    interface ClientWriteModel {
        namespace: string;
    }

    Hierarchy (view full)

    Properties

    namespace +ClientWriteModel | mongodb

    Interface ClientWriteModel

    interface ClientWriteModel {
        namespace: string;
    }

    Hierarchy (view full)

    Properties

    namespace

    Properties

    namespace

    namespace: string

    The namespace for the write.

    A namespace is a combination of the database name and the name of the collection: <database-name>.<collection>. All documents belong to a namespace.

    See

    https://www.mongodb.com/docs/manual/reference/limits/#std-label-faq-dev-namespace

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/CloseOptions.html b/docs/6.10/interfaces/CloseOptions.html index 6262e50c865..8268dfc222c 100644 --- a/docs/6.10/interfaces/CloseOptions.html +++ b/docs/6.10/interfaces/CloseOptions.html @@ -1,4 +1,4 @@ -CloseOptions | mongodb

    Interface CloseOptions

    Deprecated

    This interface is deprecated and will be removed in a future release as it is not used +CloseOptions | mongodb

    Interface CloseOptions

    Deprecated

    This interface is deprecated and will be removed in a future release as it is not used in the driver

    interface CloseOptions {
        force?: boolean;
    }

    Properties

    force? -

    Properties

    Optionalforce

    force?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalforce

    force?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClusterTime.html b/docs/6.10/interfaces/ClusterTime.html index 236973a0d71..5e8dab936a8 100644 --- a/docs/6.10/interfaces/ClusterTime.html +++ b/docs/6.10/interfaces/ClusterTime.html @@ -1,7 +1,7 @@ -ClusterTime | mongodb

    Interface ClusterTime

    Gossiped in component for the cluster time tracking the state of user databases +ClusterTime | mongodb

    Interface ClusterTime

    Gossiped in component for the cluster time tracking the state of user databases across the cluster. It may optionally include a signature identifying the process that generated such a value.

    interface ClusterTime {
        clusterTime: Timestamp;
        signature?: {
            hash: Binary;
            keyId: Long;
        };
    }

    Properties

    clusterTime signature?

    Properties

    clusterTime

    clusterTime: Timestamp

    Optionalsignature

    signature?: {
        hash: Binary;
        keyId: Long;
    }

    Used to validate the identity of a request or response's ClusterTime.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ClusteredCollectionOptions.html b/docs/6.10/interfaces/ClusteredCollectionOptions.html index cc94436a78f..aac6144e2a5 100644 --- a/docs/6.10/interfaces/ClusteredCollectionOptions.html +++ b/docs/6.10/interfaces/ClusteredCollectionOptions.html @@ -1,6 +1,6 @@ -ClusteredCollectionOptions | mongodb

    Interface ClusteredCollectionOptions

    Configuration options for clustered collections

    +ClusteredCollectionOptions | mongodb

    Interface ClusteredCollectionOptions

    Configuration options for clustered collections

    See

    https://www.mongodb.com/docs/manual/core/clustered-collections/

    interface ClusteredCollectionOptions {
        key: Document;
        name?: string;
        unique: boolean;
    }

    Hierarchy (view full)

    Properties

    key name? unique -

    Properties

    key

    key: Document

    Optionalname

    name?: string

    unique

    unique: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    key

    key: Document

    Optionalname

    name?: string

    unique

    unique: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/CollationOptions.html b/docs/6.10/interfaces/CollationOptions.html index cd883dd97f0..a959ebf23e1 100644 --- a/docs/6.10/interfaces/CollationOptions.html +++ b/docs/6.10/interfaces/CollationOptions.html @@ -1,4 +1,4 @@ -CollationOptions | mongodb

    Interface CollationOptions

    interface CollationOptions {
        alternate?: string;
        backwards?: boolean;
        caseFirst?: string;
        caseLevel?: boolean;
        locale: string;
        maxVariable?: string;
        normalization?: boolean;
        numericOrdering?: boolean;
        strength?: number;
    }

    Properties

    alternate? +CollationOptions | mongodb

    Interface CollationOptions

    interface CollationOptions {
        alternate?: string;
        backwards?: boolean;
        caseFirst?: string;
        caseLevel?: boolean;
        locale: string;
        maxVariable?: string;
        normalization?: boolean;
        numericOrdering?: boolean;
        strength?: number;
    }

    Properties

    alternate? backwards? caseFirst? caseLevel? @@ -7,4 +7,4 @@ normalization? numericOrdering? strength? -

    Properties

    Optionalalternate

    alternate?: string

    Optionalbackwards

    backwards?: boolean

    OptionalcaseFirst

    caseFirst?: string

    OptionalcaseLevel

    caseLevel?: boolean

    locale

    locale: string

    OptionalmaxVariable

    maxVariable?: string

    Optionalnormalization

    normalization?: boolean

    OptionalnumericOrdering

    numericOrdering?: boolean

    Optionalstrength

    strength?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalalternate

    alternate?: string

    Optionalbackwards

    backwards?: boolean

    OptionalcaseFirst

    caseFirst?: string

    OptionalcaseLevel

    caseLevel?: boolean

    locale

    locale: string

    OptionalmaxVariable

    maxVariable?: string

    Optionalnormalization

    normalization?: boolean

    OptionalnumericOrdering

    numericOrdering?: boolean

    Optionalstrength

    strength?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/CollectionInfo.html b/docs/6.10/interfaces/CollectionInfo.html index fd5b0444669..a57389bebc3 100644 --- a/docs/6.10/interfaces/CollectionInfo.html +++ b/docs/6.10/interfaces/CollectionInfo.html @@ -1,6 +1,6 @@ -CollectionInfo | mongodb

    Interface CollectionInfo

    interface CollectionInfo {
        idIndex?: Document;
        info?: {
            readOnly?: false;
            uuid?: Binary;
        };
        name: string;
        options?: Document;
        type?: string;
    }

    Hierarchy (view full)

    Properties

    idIndex? +CollectionInfo | mongodb

    Interface CollectionInfo

    interface CollectionInfo {
        idIndex?: Document;
        info?: {
            readOnly?: false;
            uuid?: Binary;
        };
        name: string;
        options?: Document;
        type?: string;
    }

    Hierarchy (view full)

    Properties

    idIndex? info? name options? type? -

    Properties

    OptionalidIndex

    idIndex?: Document

    Optionalinfo

    info?: {
        readOnly?: false;
        uuid?: Binary;
    }

    name

    name: string

    Optionaloptions

    options?: Document

    Optionaltype

    type?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalidIndex

    idIndex?: Document

    Optionalinfo

    info?: {
        readOnly?: false;
        uuid?: Binary;
    }

    name

    name: string

    Optionaloptions

    options?: Document

    Optionaltype

    type?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/CollectionOptions.html b/docs/6.10/interfaces/CollectionOptions.html index a5559cfd9f2..58cf485a3ad 100644 --- a/docs/6.10/interfaces/CollectionOptions.html +++ b/docs/6.10/interfaces/CollectionOptions.html @@ -1,4 +1,4 @@ -CollectionOptions | mongodb

    Interface CollectionOptions

    interface CollectionOptions {
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        useBigInt64?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    bsonRegExp? +CollectionOptions | mongodb

    Interface CollectionOptions

    interface CollectionOptions {
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        useBigInt64?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    bsonRegExp? checkKeys? enableUtf8Validation? fieldsAsRaw? @@ -46,4 +46,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/CommandOperationOptions.html b/docs/6.10/interfaces/CommandOperationOptions.html index 7bbffdeb1f0..6d58c86e3e4 100644 --- a/docs/6.10/interfaces/CommandOperationOptions.html +++ b/docs/6.10/interfaces/CommandOperationOptions.html @@ -1,4 +1,4 @@ -CommandOperationOptions | mongodb

    Interface CommandOperationOptions

    interface CommandOperationOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +CommandOperationOptions | mongodb

    Interface CommandOperationOptions

    interface CommandOperationOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -65,4 +65,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ConnectOptions.html b/docs/6.10/interfaces/ConnectOptions.html index 82c2876ca62..a6c90cebd71 100644 --- a/docs/6.10/interfaces/ConnectOptions.html +++ b/docs/6.10/interfaces/ConnectOptions.html @@ -1,2 +1,2 @@ -ConnectOptions | mongodb

    Interface ConnectOptions

    interface ConnectOptions {
        readPreference?: ReadPreference;
    }

    Properties

    readPreference? -

    Properties

    OptionalreadPreference

    readPreference?: ReadPreference

    Settings

    Member Visibility

    On This Page

    Properties
    +ConnectOptions | mongodb

    Interface ConnectOptions

    interface ConnectOptions {
        readPreference?: ReadPreference;
    }

    Properties

    readPreference? +

    Properties

    OptionalreadPreference

    readPreference?: ReadPreference

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ConnectionOptions.html b/docs/6.10/interfaces/ConnectionOptions.html index f47c541929b..cf9e88ed48d 100644 --- a/docs/6.10/interfaces/ConnectionOptions.html +++ b/docs/6.10/interfaces/ConnectionOptions.html @@ -1,4 +1,4 @@ -ConnectionOptions | mongodb

    Interface ConnectionOptions

    interface ConnectionOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS?: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        generation: number;
        hints?: number;
        hostAddress: HostAddress;
        id: number | "<monitor>";
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        metadata: ClientMetadata;
        minDHSize?: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
    }

    Hierarchy (view full)

    Properties

    allowPartialTrustChain? +ConnectionOptions | mongodb

    Interface ConnectionOptions

    interface ConnectionOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS?: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        generation: number;
        hints?: number;
        hostAddress: HostAddress;
        id: number | "<monitor>";
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        metadata: ClientMetadata;
        minDHSize?: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
    }

    Hierarchy (view full)

    Properties

    allowPartialTrustChain? ALPNProtocols? autoSelectFamily? autoSelectFamilyAttemptTimeout? @@ -119,4 +119,4 @@ TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.

    OptionalserverApi

    serverApi?: ServerApi

    Optionalservername

    servername?: string

    Optionalsession

    session?: Buffer

    An optional Buffer instance containing a TLS session.

    -

    OptionalsocketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalsocketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ConnectionPoolOptions.html b/docs/6.10/interfaces/ConnectionPoolOptions.html index 54fd9dcd239..f3047eb3d30 100644 --- a/docs/6.10/interfaces/ConnectionPoolOptions.html +++ b/docs/6.10/interfaces/ConnectionPoolOptions.html @@ -1,4 +1,4 @@ -ConnectionPoolOptions | mongodb

    Interface ConnectionPoolOptions

    interface ConnectionPoolOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS?: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        hints?: number;
        hostAddress: HostAddress;
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        maxConnecting: number;
        maxIdleTimeMS: number;
        maxPoolSize: number;
        metadata: ClientMetadata;
        minDHSize?: number;
        minPoolSize: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
        waitQueueTimeoutMS: number;
    }

    Hierarchy

    Properties

    allowPartialTrustChain? +ConnectionPoolOptions | mongodb

    Interface ConnectionPoolOptions

    interface ConnectionPoolOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS?: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        hints?: number;
        hostAddress: HostAddress;
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        maxConnecting: number;
        maxIdleTimeMS: number;
        maxPoolSize: number;
        metadata: ClientMetadata;
        minDHSize?: number;
        minPoolSize: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
        waitQueueTimeoutMS: number;
    }

    Hierarchy

    Properties

    allowPartialTrustChain? ALPNProtocols? autoSelectFamily? autoSelectFamilyAttemptTimeout? @@ -128,4 +128,4 @@ interoperability. Default: none, see minVersion.

    OptionalserverApi

    serverApi?: ServerApi

    Optionalservername

    servername?: string

    Optionalsession

    session?: Buffer

    An optional Buffer instance containing a TLS session.

    OptionalsocketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    waitQueueTimeoutMS

    waitQueueTimeoutMS: number

    The maximum amount of time operation execution should wait for a connection to become available. The default is 0 which means there is no limit.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/CountDocumentsOptions.html b/docs/6.10/interfaces/CountDocumentsOptions.html index aa804dbb872..2edaddc1c53 100644 --- a/docs/6.10/interfaces/CountDocumentsOptions.html +++ b/docs/6.10/interfaces/CountDocumentsOptions.html @@ -1,4 +1,4 @@ -CountDocumentsOptions | mongodb

    Interface CountDocumentsOptions

    interface CountDocumentsOptions {
        allowDiskUse?: boolean;
        authdb?: string;
        batchSize?: number;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        cursor?: Document;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        limit?: number;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        out?: string;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        skip?: number;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    allowDiskUse? +CountDocumentsOptions | mongodb

    Interface CountDocumentsOptions

    interface CountDocumentsOptions {
        allowDiskUse?: boolean;
        authdb?: string;
        batchSize?: number;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        cursor?: Document;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        limit?: number;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        out?: string;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        skip?: number;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    allowDiskUse? authdb? batchSize? bsonRegExp? @@ -87,4 +87,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/CountOptions.html b/docs/6.10/interfaces/CountOptions.html index 620d4a59c5d..30ad1d172e8 100644 --- a/docs/6.10/interfaces/CountOptions.html +++ b/docs/6.10/interfaces/CountOptions.html @@ -1,4 +1,4 @@ -CountOptions | mongodb

    Interface CountOptions

    interface CountOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: string | Document;
        ignoreUndefined?: boolean;
        limit?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        skip?: number;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +CountOptions | mongodb

    Interface CountOptions

    interface CountOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: string | Document;
        ignoreUndefined?: boolean;
        limit?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        skip?: number;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -72,4 +72,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/CreateCollectionOptions.html b/docs/6.10/interfaces/CreateCollectionOptions.html index c8f757761b1..bfd6be6271d 100644 --- a/docs/6.10/interfaces/CreateCollectionOptions.html +++ b/docs/6.10/interfaces/CreateCollectionOptions.html @@ -1,4 +1,4 @@ -CreateCollectionOptions | mongodb

    Interface CreateCollectionOptions

    interface CreateCollectionOptions {
        authdb?: string;
        autoIndexId?: boolean;
        bsonRegExp?: boolean;
        capped?: boolean;
        changeStreamPreAndPostImages?: {
            enabled: boolean;
        };
        checkKeys?: boolean;
        clusteredIndex?: ClusteredCollectionOptions;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        encryptedFields?: Document;
        expireAfterSeconds?: number;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        flags?: number;
        ignoreUndefined?: boolean;
        indexOptionDefaults?: Document;
        max?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        pipeline?: Document[];
        pkFactory?: PkFactory;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        size?: number;
        storageEngine?: Document;
        timeseries?: TimeSeriesCollectionOptions;
        useBigInt64?: boolean;
        validationAction?: string;
        validationLevel?: string;
        validator?: Document;
        viewOn?: string;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +CreateCollectionOptions | mongodb

    Interface CreateCollectionOptions

    interface CreateCollectionOptions {
        authdb?: string;
        autoIndexId?: boolean;
        bsonRegExp?: boolean;
        capped?: boolean;
        changeStreamPreAndPostImages?: {
            enabled: boolean;
        };
        checkKeys?: boolean;
        clusteredIndex?: ClusteredCollectionOptions;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        encryptedFields?: Document;
        expireAfterSeconds?: number;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        flags?: number;
        ignoreUndefined?: boolean;
        indexOptionDefaults?: Document;
        max?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        pipeline?: Document[];
        pkFactory?: PkFactory;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        size?: number;
        storageEngine?: Document;
        timeseries?: TimeSeriesCollectionOptions;
        useBigInt64?: boolean;
        validationAction?: string;
        validationLevel?: string;
        validator?: Document;
        viewOn?: string;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? autoIndexId? bsonRegExp? capped? @@ -101,4 +101,4 @@

    Remarks

    Optionalvalidator

    validator?: Document

    Allows users to specify validation rules or expressions for the collection. For more information, see Document Validation

    OptionalviewOn

    viewOn?: string

    The name of the source collection or view from which to create the view. The name is not the full namespace of the collection or view (i.e., does not include the database name and implies the same database as the view to create)

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/CreateIndexesOptions.html b/docs/6.10/interfaces/CreateIndexesOptions.html index ca1031e1916..b608f7754c5 100644 --- a/docs/6.10/interfaces/CreateIndexesOptions.html +++ b/docs/6.10/interfaces/CreateIndexesOptions.html @@ -1,4 +1,4 @@ -CreateIndexesOptions | mongodb

    Interface CreateIndexesOptions

    interface CreateIndexesOptions {
        2dsphereIndexVersion?: number;
        authdb?: string;
        background?: boolean;
        bits?: number;
        bsonRegExp?: boolean;
        bucketSize?: number;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        commitQuorum?: string | number;
        dbName?: string;
        default_language?: string;
        enableUtf8Validation?: boolean;
        expireAfterSeconds?: number;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hidden?: boolean;
        ignoreUndefined?: boolean;
        language_override?: string;
        max?: number;
        maxTimeMS?: number;
        min?: number;
        name?: string;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        partialFilterExpression?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sparse?: boolean;
        storageEngine?: Document;
        textIndexVersion?: number;
        unique?: boolean;
        useBigInt64?: boolean;
        version?: number;
        weights?: Document;
        wildcardProjection?: Document;
        willRetryWrite?: boolean;
    }

    Hierarchy

    Properties

    2dsphereIndexVersion? +CreateIndexesOptions | mongodb

    Interface CreateIndexesOptions

    interface CreateIndexesOptions {
        2dsphereIndexVersion?: number;
        authdb?: string;
        background?: boolean;
        bits?: number;
        bsonRegExp?: boolean;
        bucketSize?: number;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        commitQuorum?: string | number;
        dbName?: string;
        default_language?: string;
        enableUtf8Validation?: boolean;
        expireAfterSeconds?: number;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hidden?: boolean;
        ignoreUndefined?: boolean;
        language_override?: string;
        max?: number;
        maxTimeMS?: number;
        min?: number;
        name?: string;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        partialFilterExpression?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sparse?: boolean;
        storageEngine?: Document;
        textIndexVersion?: number;
        unique?: boolean;
        useBigInt64?: boolean;
        version?: number;
        weights?: Document;
        wildcardProjection?: Document;
        willRetryWrite?: boolean;
    }

    Hierarchy

    Properties

    2dsphereIndexVersion? authdb? background? bits? @@ -95,4 +95,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    Optionalversion

    version?: number

    Specifies the index version number, either 0 or 1.

    -

    Optionalweights

    weights?: Document

    OptionalwildcardProjection

    wildcardProjection?: Document

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalweights

    weights?: Document

    OptionalwildcardProjection

    wildcardProjection?: Document

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/CursorStreamOptions.html b/docs/6.10/interfaces/CursorStreamOptions.html index d6706e7c19b..4e72edc7662 100644 --- a/docs/6.10/interfaces/CursorStreamOptions.html +++ b/docs/6.10/interfaces/CursorStreamOptions.html @@ -1,3 +1,3 @@ -CursorStreamOptions | mongodb

    Interface CursorStreamOptions

    interface CursorStreamOptions {
        transform?(this: void, doc: Document): Document;
    }

    Methods

    transform? +CursorStreamOptions | mongodb

    Interface CursorStreamOptions

    interface CursorStreamOptions {
        transform?(this: void, doc: Document): Document;
    }

    Methods

    transform?

    Methods

    Optionaltransform

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Parameters

    Returns Document

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/docs/6.10/interfaces/DataKey.html b/docs/6.10/interfaces/DataKey.html index adc986802a8..a6a4e531fe2 100644 --- a/docs/6.10/interfaces/DataKey.html +++ b/docs/6.10/interfaces/DataKey.html @@ -1,4 +1,4 @@ -DataKey | mongodb

    Interface DataKey

    The schema for a DataKey in the key vault collection.

    +DataKey | mongodb

    Interface DataKey

    The schema for a DataKey in the key vault collection.

    interface DataKey {
        _id: UUID;
        creationDate: Date;
        keyAltNames?: string[];
        keyMaterial: Binary;
        masterKey: Document;
        status: number;
        updateDate: Date;
        version?: number;
    }

    Properties

    _id creationDate keyAltNames? @@ -7,4 +7,4 @@ status updateDate version? -

    Properties

    _id

    _id: UUID

    creationDate

    creationDate: Date

    OptionalkeyAltNames

    keyAltNames?: string[]

    keyMaterial

    keyMaterial: Binary

    masterKey

    masterKey: Document

    status

    status: number

    updateDate

    updateDate: Date

    Optionalversion

    version?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    _id

    _id: UUID

    creationDate

    creationDate: Date

    OptionalkeyAltNames

    keyAltNames?: string[]

    keyMaterial

    keyMaterial: Binary

    masterKey

    masterKey: Document

    status

    status: number

    updateDate

    updateDate: Date

    Optionalversion

    version?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/DbOptions.html b/docs/6.10/interfaces/DbOptions.html index 1c6cc348d06..e1868bec610 100644 --- a/docs/6.10/interfaces/DbOptions.html +++ b/docs/6.10/interfaces/DbOptions.html @@ -1,4 +1,4 @@ -DbOptions | mongodb

    Interface DbOptions

    interface DbOptions {
        authSource?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        forceServerObjectId?: boolean;
        ignoreUndefined?: boolean;
        pkFactory?: PkFactory;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcern;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        useBigInt64?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authSource? +DbOptions | mongodb

    Interface DbOptions

    interface DbOptions {
        authSource?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        forceServerObjectId?: boolean;
        ignoreUndefined?: boolean;
        pkFactory?: PkFactory;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcern;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        useBigInt64?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authSource? bsonRegExp? checkKeys? enableUtf8Validation? @@ -54,4 +54,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/DbStatsOptions.html b/docs/6.10/interfaces/DbStatsOptions.html index b5cdca87bba..1fa0ff28661 100644 --- a/docs/6.10/interfaces/DbStatsOptions.html +++ b/docs/6.10/interfaces/DbStatsOptions.html @@ -1,4 +1,4 @@ -DbStatsOptions | mongodb

    Interface DbStatsOptions

    interface DbStatsOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        scale?: number;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +DbStatsOptions | mongodb

    Interface DbStatsOptions

    interface DbStatsOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        scale?: number;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -67,4 +67,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/DeleteManyModel.html b/docs/6.10/interfaces/DeleteManyModel.html index f095440f8e0..24250bfb0f5 100644 --- a/docs/6.10/interfaces/DeleteManyModel.html +++ b/docs/6.10/interfaces/DeleteManyModel.html @@ -1,7 +1,7 @@ -DeleteManyModel | mongodb

    Interface DeleteManyModel<TSchema>

    interface DeleteManyModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
    }

    Type Parameters

    Properties

    collation? +DeleteManyModel | mongodb

    Interface DeleteManyModel<TSchema>

    interface DeleteManyModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
    }

    Type Parameters

    Properties

    collation? filter hint?

    Properties

    Optionalcollation

    collation?: CollationOptions

    Specifies a collation.

    filter

    filter: Filter<TSchema>

    The filter to limit the deleted documents.

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/DeleteOneModel.html b/docs/6.10/interfaces/DeleteOneModel.html index 0b9e49f0983..f783a437f07 100644 --- a/docs/6.10/interfaces/DeleteOneModel.html +++ b/docs/6.10/interfaces/DeleteOneModel.html @@ -1,7 +1,7 @@ -DeleteOneModel | mongodb

    Interface DeleteOneModel<TSchema>

    interface DeleteOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
    }

    Type Parameters

    Properties

    collation? +DeleteOneModel | mongodb

    Interface DeleteOneModel<TSchema>

    interface DeleteOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
    }

    Type Parameters

    Properties

    collation? filter hint?

    Properties

    Optionalcollation

    collation?: CollationOptions

    Specifies a collation.

    filter

    filter: Filter<TSchema>

    The filter to limit the deleted documents.

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/DeleteOptions.html b/docs/6.10/interfaces/DeleteOptions.html index 0da7059fafb..7c9a7bd0e28 100644 --- a/docs/6.10/interfaces/DeleteOptions.html +++ b/docs/6.10/interfaces/DeleteOptions.html @@ -1,4 +1,4 @@ -DeleteOptions | mongodb

    Interface DeleteOptions

    interface DeleteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: string | Document;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        ordered?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +DeleteOptions | mongodb

    Interface DeleteOptions

    interface DeleteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: string | Document;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        ordered?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -71,4 +71,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/DeleteResult.html b/docs/6.10/interfaces/DeleteResult.html index c819d9bbc21..a83093d375e 100644 --- a/docs/6.10/interfaces/DeleteResult.html +++ b/docs/6.10/interfaces/DeleteResult.html @@ -1,5 +1,5 @@ -DeleteResult | mongodb

    Interface DeleteResult

    interface DeleteResult {
        acknowledged: boolean;
        deletedCount: number;
    }

    Properties

    acknowledged +DeleteResult | mongodb

    Interface DeleteResult

    interface DeleteResult {
        acknowledged: boolean;
        deletedCount: number;
    }

    Properties

    acknowledged deletedCount

    Properties

    acknowledged

    acknowledged: boolean

    Indicates whether this write result was acknowledged. If not, then all other members of this result will be undefined.

    deletedCount

    deletedCount: number

    The number of documents that were deleted

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/DeleteStatement.html b/docs/6.10/interfaces/DeleteStatement.html index 18da7653e5d..47376a8d727 100644 --- a/docs/6.10/interfaces/DeleteStatement.html +++ b/docs/6.10/interfaces/DeleteStatement.html @@ -1,4 +1,4 @@ -DeleteStatement | mongodb

    Interface DeleteStatement

    interface DeleteStatement {
        collation?: CollationOptions;
        hint?: Hint;
        limit: number;
        q: Document;
    }

    Properties

    collation? +DeleteStatement | mongodb

    Interface DeleteStatement

    interface DeleteStatement {
        collation?: CollationOptions;
        hint?: Hint;
        limit: number;
        q: Document;
    }

    Properties

    collation? hint? limit q @@ -6,4 +6,4 @@

    Optionalhint

    hint?: Hint

    A document or string that specifies the index to use to support the query predicate.

    limit

    limit: number

    The number of matching documents to delete.

    q

    q: Document

    The query that matches documents to delete.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/DriverInfo.html b/docs/6.10/interfaces/DriverInfo.html index d33bc401142..f9437db564c 100644 --- a/docs/6.10/interfaces/DriverInfo.html +++ b/docs/6.10/interfaces/DriverInfo.html @@ -1,4 +1,4 @@ -DriverInfo | mongodb

    Interface DriverInfo

    interface DriverInfo {
        name?: string;
        platform?: string;
        version?: string;
    }

    Properties

    name? +DriverInfo | mongodb

    Interface DriverInfo

    interface DriverInfo {
        name?: string;
        platform?: string;
        version?: string;
    }

    Properties

    name? platform? version? -

    Properties

    Optionalname

    name?: string

    Optionalplatform

    platform?: string

    Optionalversion

    version?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalname

    name?: string

    Optionalplatform

    platform?: string

    Optionalversion

    version?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/DropCollectionOptions.html b/docs/6.10/interfaces/DropCollectionOptions.html index ac305837ff8..686c862a6c1 100644 --- a/docs/6.10/interfaces/DropCollectionOptions.html +++ b/docs/6.10/interfaces/DropCollectionOptions.html @@ -1,4 +1,4 @@ -DropCollectionOptions | mongodb

    Interface DropCollectionOptions

    interface DropCollectionOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        encryptedFields?: Document;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +DropCollectionOptions | mongodb

    Interface DropCollectionOptions

    interface DropCollectionOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        encryptedFields?: Document;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -66,4 +66,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/EndSessionOptions.html b/docs/6.10/interfaces/EndSessionOptions.html index e446682ab68..bc020c69453 100644 --- a/docs/6.10/interfaces/EndSessionOptions.html +++ b/docs/6.10/interfaces/EndSessionOptions.html @@ -1,3 +1,3 @@ -EndSessionOptions | mongodb

    Interface EndSessionOptions

    interface EndSessionOptions {
        force?: boolean;
        forceClear?: boolean;
    }

    Properties

    force? +EndSessionOptions | mongodb

    Interface EndSessionOptions

    interface EndSessionOptions {
        force?: boolean;
        forceClear?: boolean;
    }

    Properties

    force? forceClear? -

    Properties

    Optionalforce

    force?: boolean

    OptionalforceClear

    forceClear?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalforce

    force?: boolean

    OptionalforceClear

    forceClear?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ErrorDescription.html b/docs/6.10/interfaces/ErrorDescription.html index 76daebfca75..fda20ea6d70 100644 --- a/docs/6.10/interfaces/ErrorDescription.html +++ b/docs/6.10/interfaces/ErrorDescription.html @@ -1,6 +1,6 @@ -ErrorDescription | mongodb

    Interface ErrorDescription

    interface ErrorDescription {
        $err?: string;
        errInfo?: Document;
        errmsg?: string;
        errorLabels?: string[];
        message?: string;
    }

    Hierarchy (view full)

    Properties

    $err? +ErrorDescription | mongodb

    Interface ErrorDescription

    interface ErrorDescription {
        $err?: string;
        errInfo?: Document;
        errmsg?: string;
        errorLabels?: string[];
        message?: string;
    }

    Hierarchy (view full)

    Properties

    $err? errInfo? errmsg? errorLabels? message? -

    Properties

    Optional$err

    $err?: string

    OptionalerrInfo

    errInfo?: Document

    Optionalerrmsg

    errmsg?: string

    OptionalerrorLabels

    errorLabels?: string[]

    Optionalmessage

    message?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optional$err

    $err?: string

    OptionalerrInfo

    errInfo?: Document

    Optionalerrmsg

    errmsg?: string

    OptionalerrorLabels

    errorLabels?: string[]

    Optionalmessage

    message?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/EstimatedDocumentCountOptions.html b/docs/6.10/interfaces/EstimatedDocumentCountOptions.html index 957399b3741..e6149357084 100644 --- a/docs/6.10/interfaces/EstimatedDocumentCountOptions.html +++ b/docs/6.10/interfaces/EstimatedDocumentCountOptions.html @@ -1,4 +1,4 @@ -EstimatedDocumentCountOptions | mongodb

    Interface EstimatedDocumentCountOptions

    interface EstimatedDocumentCountOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +EstimatedDocumentCountOptions | mongodb

    Interface EstimatedDocumentCountOptions

    interface EstimatedDocumentCountOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -67,4 +67,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ExplainCommandOptions.html b/docs/6.10/interfaces/ExplainCommandOptions.html index f63802f7d95..9cd70421f72 100644 --- a/docs/6.10/interfaces/ExplainCommandOptions.html +++ b/docs/6.10/interfaces/ExplainCommandOptions.html @@ -1,5 +1,5 @@ -ExplainCommandOptions | mongodb

    Interface ExplainCommandOptions

    interface ExplainCommandOptions {
        maxTimeMS?: number;
        verbosity: string;
    }

    Properties

    maxTimeMS? +ExplainCommandOptions | mongodb

    Interface ExplainCommandOptions

    interface ExplainCommandOptions {
        maxTimeMS?: number;
        verbosity: string;
    }

    Properties

    maxTimeMS? verbosity

    Properties

    OptionalmaxTimeMS

    maxTimeMS?: number

    The maxTimeMS setting for the command.

    verbosity

    verbosity: string

    The explain verbosity for the command.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ExplainOptions.html b/docs/6.10/interfaces/ExplainOptions.html index 9264965c9da..19b87b6e47b 100644 --- a/docs/6.10/interfaces/ExplainOptions.html +++ b/docs/6.10/interfaces/ExplainOptions.html @@ -1,4 +1,4 @@ -ExplainOptions | mongodb

    Interface ExplainOptions

    When set, this configures an explain command. Valid values are boolean (for legacy compatibility, +ExplainOptions | mongodb

    Interface ExplainOptions

    When set, this configures an explain command. Valid values are boolean (for legacy compatibility, see ExplainVerbosityLike), a string containing the explain verbosity, or an object containing the verbosity and an optional maxTimeMS.

    Examples of valid usage:

    @@ -12,4 +12,4 @@
    interface ExplainOptions {
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
    }

    Hierarchy (view full)

    Properties

    explain?

    Properties

    Optionalexplain

    explain?: ExplainVerbosityLike | ExplainCommandOptions

    Specifies the verbosity mode for the explain output.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/FilterOperators.html b/docs/6.10/interfaces/FilterOperators.html index 9edfa21084f..3a1a1df9852 100644 --- a/docs/6.10/interfaces/FilterOperators.html +++ b/docs/6.10/interfaces/FilterOperators.html @@ -1,4 +1,4 @@ -FilterOperators | mongodb

    Interface FilterOperators<TValue>

    interface FilterOperators<TValue> {
        __id?: undefined;
        $all?: readonly any[];
        $bitsAllClear?: BitwiseFilter;
        $bitsAllSet?: BitwiseFilter;
        $bitsAnyClear?: BitwiseFilter;
        $bitsAnySet?: BitwiseFilter;
        $elemMatch?: Document;
        $eq?: TValue;
        $exists?: boolean;
        $expr?: Record<string, any>;
        $geoIntersects?: {
            $geometry: Document;
        };
        $geoWithin?: Document;
        $gt?: TValue;
        $gte?: TValue;
        $in?: readonly TValue[];
        $jsonSchema?: Record<string, any>;
        $lt?: TValue;
        $lte?: TValue;
        $maxDistance?: number;
        $mod?: TValue extends number
            ? [number, number]
            : never;
        $ne?: TValue;
        $near?: Document;
        $nearSphere?: Document;
        $nin?: readonly TValue[];
        $not?: TValue extends string
            ? RegExp | FilterOperators<TValue<TValue>>
            : FilterOperators<TValue>;
        $options?: TValue extends string
            ? string
            : never;
        $rand?: Record<string, never>;
        $regex?: TValue extends string
            ? string | RegExp | BSONRegExp
            : never;
        $size?: TValue extends readonly any[]
            ? number
            : never;
        $type?:
            | "string"
            | "symbol"
            | "undefined"
            | "object"
            | "double"
            | "array"
            | "binData"
            | "objectId"
            | "bool"
            | "date"
            | "null"
            | "regex"
            | "dbPointer"
            | "javascript"
            | "javascriptWithScope"
            | "int"
            | "timestamp"
            | "long"
            | "decimal"
            | "minKey"
            | "maxKey"
            | BSON.BSONType;
        id?: undefined;
        toHexString?: any;
    }

    Type Parameters

    • TValue

    Hierarchy (view full)

    Properties

    __id? +FilterOperators | mongodb

    Interface FilterOperators<TValue>

    interface FilterOperators<TValue> {
        __id?: undefined;
        $all?: readonly any[];
        $bitsAllClear?: BitwiseFilter;
        $bitsAllSet?: BitwiseFilter;
        $bitsAnyClear?: BitwiseFilter;
        $bitsAnySet?: BitwiseFilter;
        $elemMatch?: Document;
        $eq?: TValue;
        $exists?: boolean;
        $expr?: Record<string, any>;
        $geoIntersects?: {
            $geometry: Document;
        };
        $geoWithin?: Document;
        $gt?: TValue;
        $gte?: TValue;
        $in?: readonly TValue[];
        $jsonSchema?: Record<string, any>;
        $lt?: TValue;
        $lte?: TValue;
        $maxDistance?: number;
        $mod?: TValue extends number
            ? [number, number]
            : never;
        $ne?: TValue;
        $near?: Document;
        $nearSphere?: Document;
        $nin?: readonly TValue[];
        $not?: TValue extends string
            ? RegExp | FilterOperators<TValue<TValue>>
            : FilterOperators<TValue>;
        $options?: TValue extends string
            ? string
            : never;
        $rand?: Record<string, never>;
        $regex?: TValue extends string
            ? string | RegExp | BSONRegExp
            : never;
        $size?: TValue extends readonly any[]
            ? number
            : never;
        $type?:
            | "string"
            | "symbol"
            | "undefined"
            | "object"
            | "double"
            | "array"
            | "binData"
            | "objectId"
            | "bool"
            | "date"
            | "null"
            | "regex"
            | "dbPointer"
            | "javascript"
            | "javascriptWithScope"
            | "int"
            | "timestamp"
            | "long"
            | "decimal"
            | "minKey"
            | "maxKey"
            | BSON.BSONType;
        id?: undefined;
        toHexString?: any;
    }

    Type Parameters

    • TValue

    Hierarchy (view full)

    Properties

    __id? $all? $bitsAllClear? $bitsAllSet? @@ -32,4 +32,4 @@

    Methods

    toHexString?

    Properties

    Optional__id

    __id?: undefined

    Optional$all

    $all?: readonly any[]

    Optional$bitsAllClear

    $bitsAllClear?: BitwiseFilter

    Optional$bitsAllSet

    $bitsAllSet?: BitwiseFilter

    Optional$bitsAnyClear

    $bitsAnyClear?: BitwiseFilter

    Optional$bitsAnySet

    $bitsAnySet?: BitwiseFilter

    Optional$elemMatch

    $elemMatch?: Document

    Optional$eq

    $eq?: TValue

    Optional$exists

    $exists?: boolean

    When true, $exists matches the documents that contain the field, including documents where the field value is null.

    -

    Optional$expr

    $expr?: Record<string, any>

    Optional$geoIntersects

    $geoIntersects?: {
        $geometry: Document;
    }

    Optional$geoWithin

    $geoWithin?: Document

    Optional$gt

    $gt?: TValue

    Optional$gte

    $gte?: TValue

    Optional$in

    $in?: readonly TValue[]

    Optional$jsonSchema

    $jsonSchema?: Record<string, any>

    Optional$lt

    $lt?: TValue

    Optional$lte

    $lte?: TValue

    Optional$maxDistance

    $maxDistance?: number

    Optional$mod

    $mod?: TValue extends number
        ? [number, number]
        : never

    Optional$ne

    $ne?: TValue

    Optional$near

    $near?: Document

    Optional$nearSphere

    $nearSphere?: Document

    Optional$nin

    $nin?: readonly TValue[]

    Optional$not

    $not?: TValue extends string
        ? RegExp | FilterOperators<TValue<TValue>>
        : FilterOperators<TValue>

    Optional$options

    $options?: TValue extends string
        ? string
        : never

    Optional$rand

    $rand?: Record<string, never>

    Optional$regex

    $regex?: TValue extends string
        ? string | RegExp | BSONRegExp
        : never

    Optional$size

    $size?: TValue extends readonly any[]
        ? number
        : never

    Optional$type

    $type?:
        | "string"
        | "symbol"
        | "undefined"
        | "object"
        | "double"
        | "array"
        | "binData"
        | "objectId"
        | "bool"
        | "date"
        | "null"
        | "regex"
        | "dbPointer"
        | "javascript"
        | "javascriptWithScope"
        | "int"
        | "timestamp"
        | "long"
        | "decimal"
        | "minKey"
        | "maxKey"
        | BSON.BSONType

    Optionalid

    id?: undefined

    Methods

    OptionaltoHexString

    toHexString

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Optional$expr

    $expr?: Record<string, any>

    Optional$geoIntersects

    $geoIntersects?: {
        $geometry: Document;
    }

    Optional$geoWithin

    $geoWithin?: Document

    Optional$gt

    $gt?: TValue

    Optional$gte

    $gte?: TValue

    Optional$in

    $in?: readonly TValue[]

    Optional$jsonSchema

    $jsonSchema?: Record<string, any>

    Optional$lt

    $lt?: TValue

    Optional$lte

    $lte?: TValue

    Optional$maxDistance

    $maxDistance?: number

    Optional$mod

    $mod?: TValue extends number
        ? [number, number]
        : never

    Optional$ne

    $ne?: TValue

    Optional$near

    $near?: Document

    Optional$nearSphere

    $nearSphere?: Document

    Optional$nin

    $nin?: readonly TValue[]

    Optional$not

    $not?: TValue extends string
        ? RegExp | FilterOperators<TValue<TValue>>
        : FilterOperators<TValue>

    Optional$options

    $options?: TValue extends string
        ? string
        : never

    Optional$rand

    $rand?: Record<string, never>

    Optional$regex

    $regex?: TValue extends string
        ? string | RegExp | BSONRegExp
        : never

    Optional$size

    $size?: TValue extends readonly any[]
        ? number
        : never

    Optional$type

    $type?:
        | "string"
        | "symbol"
        | "undefined"
        | "object"
        | "double"
        | "array"
        | "binData"
        | "objectId"
        | "bool"
        | "date"
        | "null"
        | "regex"
        | "dbPointer"
        | "javascript"
        | "javascriptWithScope"
        | "int"
        | "timestamp"
        | "long"
        | "decimal"
        | "minKey"
        | "maxKey"
        | BSON.BSONType

    Optionalid

    id?: undefined

    Methods

    OptionaltoHexString

    toHexString

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/docs/6.10/interfaces/FindOneAndDeleteOptions.html b/docs/6.10/interfaces/FindOneAndDeleteOptions.html index 647c8612b67..87f9fe63594 100644 --- a/docs/6.10/interfaces/FindOneAndDeleteOptions.html +++ b/docs/6.10/interfaces/FindOneAndDeleteOptions.html @@ -1,4 +1,4 @@ -FindOneAndDeleteOptions | mongodb

    Interface FindOneAndDeleteOptions

    interface FindOneAndDeleteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Document;
        ignoreUndefined?: boolean;
        includeResultMetadata?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        projection?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sort?: Sort;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +FindOneAndDeleteOptions | mongodb

    Interface FindOneAndDeleteOptions

    interface FindOneAndDeleteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Document;
        ignoreUndefined?: boolean;
        includeResultMetadata?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        projection?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sort?: Sort;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -75,4 +75,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/FindOneAndReplaceOptions.html b/docs/6.10/interfaces/FindOneAndReplaceOptions.html index 20c217e0712..a32c72dc737 100644 --- a/docs/6.10/interfaces/FindOneAndReplaceOptions.html +++ b/docs/6.10/interfaces/FindOneAndReplaceOptions.html @@ -1,4 +1,4 @@ -FindOneAndReplaceOptions | mongodb

    Interface FindOneAndReplaceOptions

    interface FindOneAndReplaceOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Document;
        ignoreUndefined?: boolean;
        includeResultMetadata?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        projection?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        returnDocument?: ReturnDocument;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sort?: Sort;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +FindOneAndReplaceOptions | mongodb

    Interface FindOneAndReplaceOptions

    interface FindOneAndReplaceOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Document;
        ignoreUndefined?: boolean;
        includeResultMetadata?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        projection?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        returnDocument?: ReturnDocument;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sort?: Sort;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? bypassDocumentValidation? checkKeys? @@ -81,4 +81,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/FindOneAndUpdateOptions.html b/docs/6.10/interfaces/FindOneAndUpdateOptions.html index 492f90dba2e..5a56f4b7c26 100644 --- a/docs/6.10/interfaces/FindOneAndUpdateOptions.html +++ b/docs/6.10/interfaces/FindOneAndUpdateOptions.html @@ -1,4 +1,4 @@ -FindOneAndUpdateOptions | mongodb

    Interface FindOneAndUpdateOptions

    interface FindOneAndUpdateOptions {
        arrayFilters?: Document[];
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Document;
        ignoreUndefined?: boolean;
        includeResultMetadata?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        projection?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        returnDocument?: ReturnDocument;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sort?: Sort;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    arrayFilters? +FindOneAndUpdateOptions | mongodb

    Interface FindOneAndUpdateOptions

    interface FindOneAndUpdateOptions {
        arrayFilters?: Document[];
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Document;
        ignoreUndefined?: boolean;
        includeResultMetadata?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        projection?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        returnDocument?: ReturnDocument;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sort?: Sort;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    arrayFilters? authdb? bsonRegExp? bypassDocumentValidation? @@ -83,4 +83,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/FindOptions.html b/docs/6.10/interfaces/FindOptions.html index db052d942ca..769530added 100644 --- a/docs/6.10/interfaces/FindOptions.html +++ b/docs/6.10/interfaces/FindOptions.html @@ -1,4 +1,4 @@ -FindOptions | mongodb

    Interface FindOptions<TSchema>

    interface FindOptions<TSchema> {
        allowDiskUse?: boolean;
        allowPartialResults?: boolean;
        authdb?: string;
        awaitData?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        limit?: number;
        max?: Document;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        min?: Document;
        noCursorTimeout?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        oplogReplay?: boolean;
        projection?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        returnKey?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        showRecordId?: boolean;
        singleBatch?: boolean;
        skip?: number;
        sort?: Sort;
        tailable?: boolean;
        timeout?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
    }

    Type Parameters

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/GCPEncryptionKeyOptions.html b/docs/6.10/interfaces/GCPEncryptionKeyOptions.html index 03cdc3687e7..8c7cd86a4a6 100644 --- a/docs/6.10/interfaces/GCPEncryptionKeyOptions.html +++ b/docs/6.10/interfaces/GCPEncryptionKeyOptions.html @@ -1,4 +1,4 @@ -GCPEncryptionKeyOptions | mongodb

    Interface GCPEncryptionKeyOptions

    Configuration options for making an AWS encryption key

    +GCPEncryptionKeyOptions | mongodb

    Interface GCPEncryptionKeyOptions

    Configuration options for making an AWS encryption key

    interface GCPEncryptionKeyOptions {
        endpoint?: string;
        keyName: string;
        keyRing: string;
        keyVersion?: string;
        location: string;
        projectId: string;
    }

    Properties

    endpoint? keyName keyRing @@ -11,4 +11,4 @@

    OptionalkeyVersion

    keyVersion?: string

    Key version

    location

    location: string

    Location name (e.g. "global")

    projectId

    projectId: string

    GCP project ID

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/GridFSBucketOptions.html b/docs/6.10/interfaces/GridFSBucketOptions.html index bd9e478d527..c318c5451ab 100644 --- a/docs/6.10/interfaces/GridFSBucketOptions.html +++ b/docs/6.10/interfaces/GridFSBucketOptions.html @@ -1,4 +1,4 @@ -GridFSBucketOptions | mongodb

    Interface GridFSBucketOptions

    interface GridFSBucketOptions {
        bucketName?: string;
        chunkSizeBytes?: number;
        readPreference?: ReadPreference;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    bucketName? +GridFSBucketOptions | mongodb

    Interface GridFSBucketOptions

    interface GridFSBucketOptions {
        bucketName?: string;
        chunkSizeBytes?: number;
        readPreference?: ReadPreference;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    bucketName? chunkSizeBytes? readPreference? writeConcern? @@ -6,4 +6,4 @@

    OptionalchunkSizeBytes

    chunkSizeBytes?: number

    Number of bytes stored in each chunk. Defaults to 255KB

    OptionalreadPreference

    readPreference?: ReadPreference

    Read preference to be passed to read operations

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/GridFSBucketReadStreamOptions.html b/docs/6.10/interfaces/GridFSBucketReadStreamOptions.html index 72d4fc2c668..6a13e879c37 100644 --- a/docs/6.10/interfaces/GridFSBucketReadStreamOptions.html +++ b/docs/6.10/interfaces/GridFSBucketReadStreamOptions.html @@ -1,8 +1,8 @@ -GridFSBucketReadStreamOptions | mongodb

    Interface GridFSBucketReadStreamOptions

    interface GridFSBucketReadStreamOptions {
        end?: number;
        skip?: number;
        sort?: Sort;
        start?: number;
    }

    Hierarchy (view full)

    Properties

    end? +GridFSBucketReadStreamOptions | mongodb

    Interface GridFSBucketReadStreamOptions

    interface GridFSBucketReadStreamOptions {
        end?: number;
        skip?: number;
        sort?: Sort;
        start?: number;
    }

    Hierarchy (view full)

    Properties

    end? skip? sort? start?

    Properties

    Optionalend

    end?: number

    0-indexed non-negative byte offset to the end of the file contents to be returned by the stream. end is non-inclusive

    Optionalskip

    skip?: number

    Optionalsort

    sort?: Sort

    Optionalstart

    start?: number

    0-indexed non-negative byte offset from the beginning of the file

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/GridFSBucketReadStreamOptionsWithRevision.html b/docs/6.10/interfaces/GridFSBucketReadStreamOptionsWithRevision.html index f4ecd18f76b..725908fc1b1 100644 --- a/docs/6.10/interfaces/GridFSBucketReadStreamOptionsWithRevision.html +++ b/docs/6.10/interfaces/GridFSBucketReadStreamOptionsWithRevision.html @@ -1,4 +1,4 @@ -GridFSBucketReadStreamOptionsWithRevision | mongodb

    Interface GridFSBucketReadStreamOptionsWithRevision

    interface GridFSBucketReadStreamOptionsWithRevision {
        end?: number;
        revision?: number;
        skip?: number;
        sort?: Sort;
        start?: number;
    }

    Hierarchy (view full)

    Properties

    end? +GridFSBucketReadStreamOptionsWithRevision | mongodb

    Interface GridFSBucketReadStreamOptionsWithRevision

    interface GridFSBucketReadStreamOptionsWithRevision {
        end?: number;
        revision?: number;
        skip?: number;
        sort?: Sort;
        start?: number;
    }

    Hierarchy (view full)

    Properties

    end? revision? skip? sort? @@ -9,4 +9,4 @@ gets you the oldest file, 1 gets you the 2nd oldest, -1 gets you the newest.

    Optionalskip

    skip?: number

    Optionalsort

    sort?: Sort

    Optionalstart

    start?: number

    0-indexed non-negative byte offset from the beginning of the file

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/GridFSBucketWriteStreamOptions.html b/docs/6.10/interfaces/GridFSBucketWriteStreamOptions.html index 735575aa03b..e1802a160a6 100644 --- a/docs/6.10/interfaces/GridFSBucketWriteStreamOptions.html +++ b/docs/6.10/interfaces/GridFSBucketWriteStreamOptions.html @@ -1,4 +1,4 @@ -GridFSBucketWriteStreamOptions | mongodb

    Interface GridFSBucketWriteStreamOptions

    interface GridFSBucketWriteStreamOptions {
        aliases?: string[];
        chunkSizeBytes?: number;
        contentType?: string;
        id?: ObjectId;
        metadata?: Document;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    aliases? +GridFSBucketWriteStreamOptions | mongodb

    Interface GridFSBucketWriteStreamOptions

    interface GridFSBucketWriteStreamOptions {
        aliases?: string[];
        chunkSizeBytes?: number;
        contentType?: string;
        id?: ObjectId;
        metadata?: Document;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    aliases? chunkSizeBytes? contentType? id? @@ -12,4 +12,4 @@

    Optionalid

    id?: ObjectId

    Custom file id for the GridFS file.

    Optionalmetadata

    metadata?: Document

    Object to store in the file document's metadata field

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/GridFSChunk.html b/docs/6.10/interfaces/GridFSChunk.html index 16c39b613db..12129f33ee7 100644 --- a/docs/6.10/interfaces/GridFSChunk.html +++ b/docs/6.10/interfaces/GridFSChunk.html @@ -1,5 +1,5 @@ -GridFSChunk | mongodb

    Interface GridFSChunk

    interface GridFSChunk {
        _id: ObjectId;
        data: Uint8Array | Buffer;
        files_id: ObjectId;
        n: number;
    }

    Properties

    _id +GridFSChunk | mongodb

    Interface GridFSChunk

    interface GridFSChunk {
        _id: ObjectId;
        data: Uint8Array | Buffer;
        files_id: ObjectId;
        n: number;
    }

    Properties

    _id data files_id n -

    Properties

    _id

    _id: ObjectId

    data

    data: Uint8Array | Buffer

    files_id

    files_id: ObjectId

    n

    n: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    _id

    _id: ObjectId

    data

    data: Uint8Array | Buffer

    files_id

    files_id: ObjectId

    n

    n: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/GridFSFile.html b/docs/6.10/interfaces/GridFSFile.html index 43c421f5603..52a3baaee06 100644 --- a/docs/6.10/interfaces/GridFSFile.html +++ b/docs/6.10/interfaces/GridFSFile.html @@ -1,4 +1,4 @@ -GridFSFile | mongodb

    Interface GridFSFile

    interface GridFSFile {
        _id: ObjectId;
        aliases?: string[];
        chunkSize: number;
        contentType?: string;
        filename: string;
        length: number;
        metadata?: Document;
        uploadDate: Date;
    }

    Properties

    _id +GridFSFile | mongodb

    Interface GridFSFile

    interface GridFSFile {
        _id: ObjectId;
        aliases?: string[];
        chunkSize: number;
        contentType?: string;
        filename: string;
        length: number;
        metadata?: Document;
        uploadDate: Date;
    }

    Properties

    _id aliases? chunkSize contentType? @@ -8,4 +8,4 @@ uploadDate

    Properties

    _id

    _id: ObjectId

    Optionalaliases

    aliases?: string[]

    Deprecated

    Will be removed in the next major version.

    chunkSize

    chunkSize: number

    OptionalcontentType

    contentType?: string

    Deprecated

    Will be removed in the next major version.

    -

    filename

    filename: string

    length

    length: number

    Optionalmetadata

    metadata?: Document

    uploadDate

    uploadDate: Date

    Settings

    Member Visibility

    On This Page

    Properties
    +

    filename

    filename: string

    length

    length: number

    Optionalmetadata

    metadata?: Document

    uploadDate

    uploadDate: Date

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/HedgeOptions.html b/docs/6.10/interfaces/HedgeOptions.html index 567f257b4d5..32f7eeff772 100644 --- a/docs/6.10/interfaces/HedgeOptions.html +++ b/docs/6.10/interfaces/HedgeOptions.html @@ -1,3 +1,3 @@ -HedgeOptions | mongodb

    Interface HedgeOptions

    interface HedgeOptions {
        enabled?: boolean;
    }

    Properties

    enabled? +HedgeOptions | mongodb

    Interface HedgeOptions

    interface HedgeOptions {
        enabled?: boolean;
    }

    Properties

    enabled?

    Properties

    Optionalenabled

    enabled?: boolean

    Explicitly enable or disable hedged reads.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/IdPInfo.html b/docs/6.10/interfaces/IdPInfo.html index 13249cd2171..ed867774954 100644 --- a/docs/6.10/interfaces/IdPInfo.html +++ b/docs/6.10/interfaces/IdPInfo.html @@ -1,4 +1,4 @@ -IdPInfo | mongodb

    Interface IdPInfo

    The information returned by the server on the IDP server.

    +IdPInfo | mongodb

    Interface IdPInfo

    The information returned by the server on the IDP server.

    interface IdPInfo {
        clientId: string;
        issuer: string;
        requestScopes?: string[];
    }

    Properties

    clientId issuer requestScopes? @@ -7,4 +7,4 @@ be the iss of provided access tokens, and be viable for RFC8414 metadata discovery and RFC9207 identification.

    OptionalrequestScopes

    requestScopes?: string[]

    A list of additional scopes to request from IdP.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/IdPServerResponse.html b/docs/6.10/interfaces/IdPServerResponse.html index 5096379f9e1..2c1110f1086 100644 --- a/docs/6.10/interfaces/IdPServerResponse.html +++ b/docs/6.10/interfaces/IdPServerResponse.html @@ -1,4 +1,4 @@ -IdPServerResponse | mongodb

    Interface IdPServerResponse

    The response from the IdP server with the access token and +IdPServerResponse | mongodb

    Interface IdPServerResponse

    The response from the IdP server with the access token and optional expiration time and refresh token.

    interface IdPServerResponse {
        accessToken: string;
        expiresInSeconds?: number;
        refreshToken?: string;
    }

    Properties

    accessToken expiresInSeconds? @@ -6,4 +6,4 @@

    Properties

    accessToken

    accessToken: string

    The OIDC access token.

    OptionalexpiresInSeconds

    expiresInSeconds?: number

    The time when the access token expires. For future use.

    OptionalrefreshToken

    refreshToken?: string

    The refresh token, if applicable, to be used by the callback to request a new token from the issuer.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/IndexDescription.html b/docs/6.10/interfaces/IndexDescription.html index 16085ce2eae..c7626cf69d4 100644 --- a/docs/6.10/interfaces/IndexDescription.html +++ b/docs/6.10/interfaces/IndexDescription.html @@ -1,4 +1,4 @@ -IndexDescription | mongodb

    Interface IndexDescription

    interface IndexDescription {
        2dsphereIndexVersion?: number;
        background?: boolean;
        bits?: number;
        bucketSize?: number;
        collation?: CollationOptions;
        default_language?: string;
        expireAfterSeconds?: number;
        hidden?: boolean;
        key: {
            [key: string]: IndexDirection;
        } | Map<string, IndexDirection>;
        language_override?: string;
        max?: number;
        min?: number;
        name?: string;
        partialFilterExpression?: Document;
        sparse?: boolean;
        storageEngine?: Document;
        textIndexVersion?: number;
        unique?: boolean;
        version?: number;
        weights?: Document;
        wildcardProjection?: Document;
    }

    Hierarchy

    • Pick<CreateIndexesOptions,
          | "background"
          | "unique"
          | "partialFilterExpression"
          | "sparse"
          | "hidden"
          | "expireAfterSeconds"
          | "storageEngine"
          | "version"
          | "weights"
          | "default_language"
          | "language_override"
          | "textIndexVersion"
          | "2dsphereIndexVersion"
          | "bits"
          | "min"
          | "max"
          | "bucketSize"
          | "wildcardProjection">
      • IndexDescription

    Properties

    2dsphereIndexVersion? +IndexDescription | mongodb

    Interface IndexDescription

    interface IndexDescription {
        2dsphereIndexVersion?: number;
        background?: boolean;
        bits?: number;
        bucketSize?: number;
        collation?: CollationOptions;
        default_language?: string;
        expireAfterSeconds?: number;
        hidden?: boolean;
        key: {
            [key: string]: IndexDirection;
        } | Map<string, IndexDirection>;
        language_override?: string;
        max?: number;
        min?: number;
        name?: string;
        partialFilterExpression?: Document;
        sparse?: boolean;
        storageEngine?: Document;
        textIndexVersion?: number;
        unique?: boolean;
        version?: number;
        weights?: Document;
        wildcardProjection?: Document;
    }

    Hierarchy

    • Pick<CreateIndexesOptions,
          | "background"
          | "unique"
          | "partialFilterExpression"
          | "sparse"
          | "hidden"
          | "expireAfterSeconds"
          | "storageEngine"
          | "version"
          | "weights"
          | "default_language"
          | "language_override"
          | "textIndexVersion"
          | "2dsphereIndexVersion"
          | "bits"
          | "min"
          | "max"
          | "bucketSize"
          | "wildcardProjection">
      • IndexDescription

    Properties

    2dsphereIndexVersion? background? bits? bucketSize? @@ -29,4 +29,4 @@

    OptionalstorageEngine

    storageEngine?: Document

    Allows users to configure the storage engine on a per-index basis when creating an index. (MongoDB 3.0 or higher)

    OptionaltextIndexVersion

    textIndexVersion?: number

    Optionalunique

    unique?: boolean

    Creates an unique index.

    Optionalversion

    version?: number

    Specifies the index version number, either 0 or 1.

    -

    Optionalweights

    weights?: Document

    OptionalwildcardProjection

    wildcardProjection?: Document

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalweights

    weights?: Document

    OptionalwildcardProjection

    wildcardProjection?: Document

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/IndexInformationOptions.html b/docs/6.10/interfaces/IndexInformationOptions.html index f4eddc38cef..ed1e518ab20 100644 --- a/docs/6.10/interfaces/IndexInformationOptions.html +++ b/docs/6.10/interfaces/IndexInformationOptions.html @@ -1,4 +1,4 @@ -IndexInformationOptions | mongodb

    Interface IndexInformationOptions

    interface IndexInformationOptions {
        awaitData?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        comment?: unknown;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        full?: boolean;
        ignoreUndefined?: boolean;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noCursorTimeout?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        session?: ClientSession;
        tailable?: boolean;
        useBigInt64?: boolean;
    }

    Hierarchy (view full)

    Properties

    awaitData? +IndexInformationOptions | mongodb

    Interface IndexInformationOptions

    interface IndexInformationOptions {
        awaitData?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        comment?: unknown;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        full?: boolean;
        ignoreUndefined?: boolean;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noCursorTimeout?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        session?: ClientSession;
        tailable?: boolean;
        useBigInt64?: boolean;
    }

    Hierarchy (view full)

    Properties

    awaitData? batchSize? bsonRegExp? checkKeys? @@ -79,4 +79,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/InsertManyResult.html b/docs/6.10/interfaces/InsertManyResult.html index 404eeed55af..8fecb7d8d0f 100644 --- a/docs/6.10/interfaces/InsertManyResult.html +++ b/docs/6.10/interfaces/InsertManyResult.html @@ -1,7 +1,7 @@ -InsertManyResult | mongodb

    Interface InsertManyResult<TSchema>

    interface InsertManyResult<TSchema> {
        acknowledged: boolean;
        insertedCount: number;
        insertedIds: {
            [key: number]: InferIdType<TSchema>;
        };
    }

    Type Parameters

    Properties

    acknowledged +InsertManyResult | mongodb

    Interface InsertManyResult<TSchema>

    interface InsertManyResult<TSchema> {
        acknowledged: boolean;
        insertedCount: number;
        insertedIds: {
            [key: number]: InferIdType<TSchema>;
        };
    }

    Type Parameters

    Properties

    acknowledged insertedCount insertedIds

    Properties

    acknowledged

    acknowledged: boolean

    Indicates whether this write result was acknowledged. If not, then all other members of this result will be undefined

    insertedCount

    insertedCount: number

    The number of inserted documents for this operations

    insertedIds

    insertedIds: {
        [key: number]: InferIdType<TSchema>;
    }

    Map of the index of the inserted document to the id of the inserted document

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/InsertOneModel.html b/docs/6.10/interfaces/InsertOneModel.html index f04b0ab7976..0eaf1777374 100644 --- a/docs/6.10/interfaces/InsertOneModel.html +++ b/docs/6.10/interfaces/InsertOneModel.html @@ -1,3 +1,3 @@ -InsertOneModel | mongodb

    Interface InsertOneModel<TSchema>

    interface InsertOneModel<TSchema> {
        document: OptionalId<TSchema>;
    }

    Type Parameters

    Properties

    document +InsertOneModel | mongodb

    Interface InsertOneModel<TSchema>

    interface InsertOneModel<TSchema> {
        document: OptionalId<TSchema>;
    }

    Type Parameters

    Properties

    document

    Properties

    document

    document: OptionalId<TSchema>

    The document to insert.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/InsertOneOptions.html b/docs/6.10/interfaces/InsertOneOptions.html index f39f41dc2ba..67ffa7e23ad 100644 --- a/docs/6.10/interfaces/InsertOneOptions.html +++ b/docs/6.10/interfaces/InsertOneOptions.html @@ -1,4 +1,4 @@ -InsertOneOptions | mongodb

    Interface InsertOneOptions

    interface InsertOneOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        forceServerObjectId?: boolean;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +InsertOneOptions | mongodb

    Interface InsertOneOptions

    interface InsertOneOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        forceServerObjectId?: boolean;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? bypassDocumentValidation? checkKeys? @@ -69,4 +69,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/InsertOneResult.html b/docs/6.10/interfaces/InsertOneResult.html index 29adc967f33..3307d0a711d 100644 --- a/docs/6.10/interfaces/InsertOneResult.html +++ b/docs/6.10/interfaces/InsertOneResult.html @@ -1,5 +1,5 @@ -InsertOneResult | mongodb

    Interface InsertOneResult<TSchema>

    interface InsertOneResult<TSchema> {
        acknowledged: boolean;
        insertedId: InferIdType<TSchema>;
    }

    Type Parameters

    Properties

    acknowledged +InsertOneResult | mongodb

    Interface InsertOneResult<TSchema>

    interface InsertOneResult<TSchema> {
        acknowledged: boolean;
        insertedId: InferIdType<TSchema>;
    }

    Type Parameters

    Properties

    acknowledged insertedId

    Properties

    acknowledged

    acknowledged: boolean

    Indicates whether this write result was acknowledged. If not, then all other members of this result will be undefined

    insertedId

    insertedId: InferIdType<TSchema>

    The identifier that was inserted. If the server generated the identifier, this value will be null as the driver does not have access to that data

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/KMIPEncryptionKeyOptions.html b/docs/6.10/interfaces/KMIPEncryptionKeyOptions.html index f09ed5f9ba0..87a76d73f49 100644 --- a/docs/6.10/interfaces/KMIPEncryptionKeyOptions.html +++ b/docs/6.10/interfaces/KMIPEncryptionKeyOptions.html @@ -1,4 +1,4 @@ -KMIPEncryptionKeyOptions | mongodb

    Interface KMIPEncryptionKeyOptions

    Configuration options for making a KMIP encryption key

    +KMIPEncryptionKeyOptions | mongodb

    Interface KMIPEncryptionKeyOptions

    Configuration options for making a KMIP encryption key

    interface KMIPEncryptionKeyOptions {
        delegated?: boolean;
        endpoint?: string;
        keyId?: string;
    }

    Properties

    delegated? endpoint? keyId? @@ -7,4 +7,4 @@

    Optionalendpoint

    endpoint?: string

    Host with optional port.

    OptionalkeyId

    keyId?: string

    keyId is the KMIP Unique Identifier to a 96 byte KMIP Secret Data managed object.

    If keyId is omitted, a random 96 byte KMIP Secret Data managed object will be created.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/KMIPKMSProviderConfiguration.html b/docs/6.10/interfaces/KMIPKMSProviderConfiguration.html index 636b3c18977..20275ed9600 100644 --- a/docs/6.10/interfaces/KMIPKMSProviderConfiguration.html +++ b/docs/6.10/interfaces/KMIPKMSProviderConfiguration.html @@ -1,5 +1,5 @@ -KMIPKMSProviderConfiguration | mongodb

    Interface KMIPKMSProviderConfiguration

    interface KMIPKMSProviderConfiguration {
        endpoint?: string;
    }

    Properties

    endpoint? +KMIPKMSProviderConfiguration | mongodb

    Interface KMIPKMSProviderConfiguration

    interface KMIPKMSProviderConfiguration {
        endpoint?: string;
    }

    Properties

    endpoint?

    Properties

    Optionalendpoint

    endpoint?: string

    The output endpoint string. The endpoint consists of a hostname and port separated by a colon. E.g. "example.com:123". A port is always present.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/KMSProviders.html b/docs/6.10/interfaces/KMSProviders.html index 70f04d25aa7..a3ead6a027e 100644 --- a/docs/6.10/interfaces/KMSProviders.html +++ b/docs/6.10/interfaces/KMSProviders.html @@ -1,4 +1,4 @@ -KMSProviders | mongodb

    Interface KMSProviders

    Configuration options that are used by specific KMS providers during key generation, encryption, and decryption.

    +KMSProviders | mongodb

    Interface KMSProviders

    Configuration options that are used by specific KMS providers during key generation, encryption, and decryption.

    Named KMS providers are not supported for automatic KMS credential fetching.

    interface KMSProviders {
        aws?: AWSKMSProviderConfiguration | Record<string, never>;
        azure?: AzureKMSProviderConfiguration | Record<string, never>;
        gcp?: GCPKMSProviderConfiguration | Record<string, never>;
        kmip?: KMIPKMSProviderConfiguration;
        local?: LocalKMSProviderConfiguration;
        [key: `aws:${string}`]: AWSKMSProviderConfiguration;
        [key: `local:${string}`]: LocalKMSProviderConfiguration;
        [key: `kmip:${string}`]: KMIPKMSProviderConfiguration;
        [key: `azure:${string}`]: AzureKMSProviderConfiguration;
        [key: `gcp:${string}`]: GCPKMSProviderConfiguration;
    }

    Indexable

    Properties

    aws? azure? @@ -10,4 +10,4 @@

    Optionalgcp

    gcp?: GCPKMSProviderConfiguration | Record<string, never>

    Configuration options for using 'gcp' as your KMS provider

    Optionalkmip

    kmip?: KMIPKMSProviderConfiguration

    Configuration options for using 'kmip' as your KMS provider

    Optionallocal

    local?: LocalKMSProviderConfiguration

    Configuration options for using 'local' as your KMS provider

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ListCollectionsOptions.html b/docs/6.10/interfaces/ListCollectionsOptions.html index 32138004f4b..c280b3210b5 100644 --- a/docs/6.10/interfaces/ListCollectionsOptions.html +++ b/docs/6.10/interfaces/ListCollectionsOptions.html @@ -1,4 +1,4 @@ -ListCollectionsOptions | mongodb

    Interface ListCollectionsOptions

    interface ListCollectionsOptions {
        authdb?: string;
        authorizedCollections?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        nameOnly?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
    }

    Hierarchy

    Properties

    authdb? +ListCollectionsOptions | mongodb

    Interface ListCollectionsOptions

    interface ListCollectionsOptions {
        authdb?: string;
        authorizedCollections?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        nameOnly?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
    }

    Hierarchy

    Properties

    authdb? authorizedCollections? batchSize? bsonRegExp? @@ -69,4 +69,4 @@

    Remarks

    Optionalsession

    session?: ClientSession

    Specify ClientSession for this command

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    -

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ListDatabasesOptions.html b/docs/6.10/interfaces/ListDatabasesOptions.html index a7fcf7f8402..e6a53ca3735 100644 --- a/docs/6.10/interfaces/ListDatabasesOptions.html +++ b/docs/6.10/interfaces/ListDatabasesOptions.html @@ -1,4 +1,4 @@ -ListDatabasesOptions | mongodb

    Interface ListDatabasesOptions

    interface ListDatabasesOptions {
        authdb?: string;
        authorizedDatabases?: boolean;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        filter?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        nameOnly?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +ListDatabasesOptions | mongodb

    Interface ListDatabasesOptions

    interface ListDatabasesOptions {
        authdb?: string;
        authorizedDatabases?: boolean;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        filter?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        nameOnly?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? authorizedDatabases? bsonRegExp? checkKeys? @@ -71,4 +71,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ListDatabasesResult.html b/docs/6.10/interfaces/ListDatabasesResult.html index efcaa5f87c2..ac68a2a799d 100644 --- a/docs/6.10/interfaces/ListDatabasesResult.html +++ b/docs/6.10/interfaces/ListDatabasesResult.html @@ -1,5 +1,5 @@ -ListDatabasesResult | mongodb

    Interface ListDatabasesResult

    interface ListDatabasesResult {
        databases: ({
            empty?: boolean;
            name: string;
            sizeOnDisk?: number;
        } & Document)[];
        ok: 0 | 1;
        totalSize?: number;
        totalSizeMb?: number;
    }

    Properties

    databases +ListDatabasesResult | mongodb

    Interface ListDatabasesResult

    interface ListDatabasesResult {
        databases: ({
            empty?: boolean;
            name: string;
            sizeOnDisk?: number;
        } & Document)[];
        ok: 0 | 1;
        totalSize?: number;
        totalSizeMb?: number;
    }

    Properties

    databases ok totalSize? totalSizeMb? -

    Properties

    databases

    databases: ({
        empty?: boolean;
        name: string;
        sizeOnDisk?: number;
    } & Document)[]

    ok

    ok: 0 | 1

    OptionaltotalSize

    totalSize?: number

    OptionaltotalSizeMb

    totalSizeMb?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    databases

    databases: ({
        empty?: boolean;
        name: string;
        sizeOnDisk?: number;
    } & Document)[]

    ok

    ok: 0 | 1

    OptionaltotalSize

    totalSize?: number

    OptionaltotalSizeMb

    totalSizeMb?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/LocalKMSProviderConfiguration.html b/docs/6.10/interfaces/LocalKMSProviderConfiguration.html index 612af4b8485..41a42779739 100644 --- a/docs/6.10/interfaces/LocalKMSProviderConfiguration.html +++ b/docs/6.10/interfaces/LocalKMSProviderConfiguration.html @@ -1,4 +1,4 @@ -LocalKMSProviderConfiguration | mongodb

    Interface LocalKMSProviderConfiguration

    interface LocalKMSProviderConfiguration {
        key: string | Uint8Array | Binary;
    }

    Properties

    key +LocalKMSProviderConfiguration | mongodb

    Interface LocalKMSProviderConfiguration

    interface LocalKMSProviderConfiguration {
        key: string | Uint8Array | Binary;
    }

    Properties

    key

    Properties

    key

    key: string | Uint8Array | Binary

    The master key used to encrypt/decrypt data keys. A 96-byte long Buffer or base64 encoded string.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ModifyResult.html b/docs/6.10/interfaces/ModifyResult.html index a6f880f3b5c..96f0ce0c78b 100644 --- a/docs/6.10/interfaces/ModifyResult.html +++ b/docs/6.10/interfaces/ModifyResult.html @@ -1,4 +1,4 @@ -ModifyResult | mongodb

    Interface ModifyResult<TSchema>

    interface ModifyResult<TSchema> {
        lastErrorObject?: Document;
        ok: 0 | 1;
        value: null | WithId<TSchema>;
    }

    Type Parameters

    Properties

    lastErrorObject? +ModifyResult | mongodb

    Interface ModifyResult<TSchema>

    interface ModifyResult<TSchema> {
        lastErrorObject?: Document;
        ok: 0 | 1;
        value: null | WithId<TSchema>;
    }

    Type Parameters

    Properties

    lastErrorObject? ok value -

    Properties

    OptionallastErrorObject

    lastErrorObject?: Document

    ok

    ok: 0 | 1

    value

    value: null | WithId<TSchema>

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionallastErrorObject

    lastErrorObject?: Document

    ok

    ok: 0 | 1

    value

    value: null | WithId<TSchema>

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/MongoClientOptions.html b/docs/6.10/interfaces/MongoClientOptions.html index 75f2bc307db..b6eed3ea3d0 100644 --- a/docs/6.10/interfaces/MongoClientOptions.html +++ b/docs/6.10/interfaces/MongoClientOptions.html @@ -1,4 +1,4 @@ -MongoClientOptions | mongodb

    Interface MongoClientOptions

    Describes all possible URI query options for the mongo client

    +MongoClientOptions | mongodb

    Interface MongoClientOptions

    Describes all possible URI query options for the mongo client

    See

    https://www.mongodb.com/docs/manual/reference/connection-string

    interface MongoClientOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        appName?: string;
        auth?: Auth;
        authMechanism?: AuthMechanism;
        authMechanismProperties?: AuthMechanismProperties;
        authSource?: string;
        autoEncryption?: AutoEncryptionOptions;
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        bsonRegExp?: boolean;
        ca?: string | Buffer | (string | Buffer)[];
        cert?: string | Buffer | (string | Buffer)[];
        checkKeys?: boolean;
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: string | (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS?: number;
        crl?: string | Buffer | (string | Buffer)[];
        directConnection?: boolean;
        driverInfo?: DriverInfo;
        ecdhCurve?: string;
        enableUtf8Validation?: boolean;
        family?: number;
        fieldsAsRaw?: Document;
        forceServerObjectId?: boolean;
        heartbeatFrequencyMS?: number;
        hints?: number;
        ignoreUndefined?: boolean;
        journal?: boolean;
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced?: boolean;
        localAddress?: string;
        localPort?: number;
        localThresholdMS?: number;
        lookup?: LookupFunction;
        maxConnecting?: number;
        maxIdleTimeMS?: number;
        maxPoolSize?: number;
        maxStalenessSeconds?: number;
        minDHSize?: number;
        minHeartbeatFrequencyMS?: number;
        minPoolSize?: number;
        monitorCommands?: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        pkFactory?: PkFactory;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readConcernLevel?: ReadConcernLevel;
        readPreference?: ReadPreference | ReadPreferenceMode;
        readPreferenceTags?: TagSet[];
        rejectUnauthorized?: boolean;
        replicaSet?: string;
        retryReads?: boolean;
        retryWrites?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serializeFunctions?: boolean;
        serverApi?: "1" | ServerApi;
        serverMonitoringMode?: ServerMonitoringMode;
        servername?: string;
        serverSelectionTimeoutMS?: number;
        session?: Buffer;
        socketTimeoutMS?: number;
        srvMaxHosts?: number;
        srvServiceName?: string;
        ssl?: boolean;
        tls?: boolean;
        tlsAllowInvalidCertificates?: boolean;
        tlsAllowInvalidHostnames?: boolean;
        tlsCAFile?: string;
        tlsCertificateKeyFile?: string;
        tlsCertificateKeyFilePassword?: string;
        tlsCRLFile?: string;
        tlsInsecure?: boolean;
        useBigInt64?: boolean;
        w?: W;
        waitQueueTimeoutMS?: number;
        writeConcern?: WriteConcern | WriteConcernSettings;
        wtimeoutMS?: number;
        zlibCompressionLevel?:
            | 0
            | 5
            | 1
            | 3
            | 9
            | 4
            | 2
            | 7
            | 6
            | 8;
    }

    Hierarchy (view full)

    Properties

    allowPartialTrustChain? ALPNProtocols? @@ -99,7 +99,7 @@

    OptionalauthSource

    authSource?: string

    Specify the database name associated with the user’s credentials.

    OptionalautoEncryption

    autoEncryption?: AutoEncryptionOptions

    Optionally enable in-use auto encryption

    Remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error -(see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    +(see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    OptionalwtimeoutMS

    wtimeoutMS?: number

    The write concern timeout

    Deprecated

    Please use the writeConcern option instead

    OptionalzlibCompressionLevel

    zlibCompressionLevel?:
        | 0
        | 5
        | 1
        | 3
        | 9
        | 4
        | 2
        | 7
        | 6
        | 8

    An integer that specifies the compression level if using zlib for network compression.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    allowPartialTrustChainALPNProtocolsappNameauthauthMechanismauthMechanismPropertiesauthSourceautoEncryptionautoSelectFamilyautoSelectFamilyAttemptTimeoutbsonRegExpcacertcheckKeyscheckServerIdentitycipherscompressorsconnectTimeoutMScrldirectConnectiondriverInfoecdhCurveenableUtf8ValidationfamilyfieldsAsRawforceServerObjectIdheartbeatFrequencyMShintsignoreUndefinedjournalkeyloadBalancedlocalAddresslocalPortlocalThresholdMSlookupmaxConnectingmaxIdleTimeMSmaxPoolSizemaxStalenessSecondsminDHSizeminHeartbeatFrequencyMSminPoolSizemonitorCommandsnoDelaypassphrasepfxpkFactorypromoteBufferspromoteLongspromoteValuesproxyHostproxyPasswordproxyPortproxyUsernamerawreadConcernreadConcernLevelreadPreferencereadPreferenceTagsrejectUnauthorizedreplicaSetretryReadsretryWritessecureContextsecureProtocolserializeFunctionsserverApiserverMonitoringModeservernameserverSelectionTimeoutMSsessionsocketTimeoutMSsrvMaxHostssrvServiceNamessltlstlsAllowInvalidCertificatestlsAllowInvalidHostnamestlsCAFiletlsCertificateKeyFiletlsCertificateKeyFilePasswordtlsCRLFiletlsInsecureuseBigInt64wwaitQueueTimeoutMSwriteConcernwtimeoutMSzlibCompressionLevel
    +

    Settings

    Member Visibility

    On This Page

    Properties
    allowPartialTrustChainALPNProtocolsappNameauthauthMechanismauthMechanismPropertiesauthSourceautoEncryptionautoSelectFamilyautoSelectFamilyAttemptTimeoutbsonRegExpcacertcheckKeyscheckServerIdentitycipherscompressorsconnectTimeoutMScrldirectConnectiondriverInfoecdhCurveenableUtf8ValidationfamilyfieldsAsRawforceServerObjectIdheartbeatFrequencyMShintsignoreUndefinedjournalkeyloadBalancedlocalAddresslocalPortlocalThresholdMSlookupmaxConnectingmaxIdleTimeMSmaxPoolSizemaxStalenessSecondsminDHSizeminHeartbeatFrequencyMSminPoolSizemonitorCommandsnoDelaypassphrasepfxpkFactorypromoteBufferspromoteLongspromoteValuesproxyHostproxyPasswordproxyPortproxyUsernamerawreadConcernreadConcernLevelreadPreferencereadPreferenceTagsrejectUnauthorizedreplicaSetretryReadsretryWritessecureContextsecureProtocolserializeFunctionsserverApiserverMonitoringModeservernameserverSelectionTimeoutMSsessionsocketTimeoutMSsrvMaxHostssrvServiceNamessltlstlsAllowInvalidCertificatestlsAllowInvalidHostnamestlsCAFiletlsCertificateKeyFiletlsCertificateKeyFilePasswordtlsCRLFiletlsInsecureuseBigInt64wwaitQueueTimeoutMSwriteConcernwtimeoutMSzlibCompressionLevel
    diff --git a/docs/6.10/interfaces/MongoCredentialsOptions.html b/docs/6.10/interfaces/MongoCredentialsOptions.html index 91f16afb5f8..5664590281c 100644 --- a/docs/6.10/interfaces/MongoCredentialsOptions.html +++ b/docs/6.10/interfaces/MongoCredentialsOptions.html @@ -1,7 +1,7 @@ -MongoCredentialsOptions | mongodb

    Interface MongoCredentialsOptions

    interface MongoCredentialsOptions {
        db?: string;
        mechanism?: AuthMechanism;
        mechanismProperties: AuthMechanismProperties;
        password: string;
        source: string;
        username?: string;
    }

    Properties

    db? +MongoCredentialsOptions | mongodb

    Interface MongoCredentialsOptions

    interface MongoCredentialsOptions {
        db?: string;
        mechanism?: AuthMechanism;
        mechanismProperties: AuthMechanismProperties;
        password: string;
        source: string;
        username?: string;
    }

    Properties

    db? mechanism? mechanismProperties password source username? -

    Properties

    Optionaldb

    db?: string

    Optionalmechanism

    mechanism?: AuthMechanism

    mechanismProperties

    mechanismProperties: AuthMechanismProperties

    password

    password: string

    source

    source: string

    Optionalusername

    username?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionaldb

    db?: string

    Optionalmechanism

    mechanism?: AuthMechanism

    mechanismProperties

    mechanismProperties: AuthMechanismProperties

    password

    password: string

    source

    source: string

    Optionalusername

    username?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/MongoNetworkErrorOptions.html b/docs/6.10/interfaces/MongoNetworkErrorOptions.html index 041966f7823..beec7593722 100644 --- a/docs/6.10/interfaces/MongoNetworkErrorOptions.html +++ b/docs/6.10/interfaces/MongoNetworkErrorOptions.html @@ -1,4 +1,4 @@ -MongoNetworkErrorOptions | mongodb

    Interface MongoNetworkErrorOptions

    interface MongoNetworkErrorOptions {
        beforeHandshake?: boolean;
        cause?: Error;
    }

    Properties

    beforeHandshake? +MongoNetworkErrorOptions | mongodb

    Interface MongoNetworkErrorOptions

    interface MongoNetworkErrorOptions {
        beforeHandshake?: boolean;
        cause?: Error;
    }

    Properties

    beforeHandshake? cause?

    Properties

    OptionalbeforeHandshake

    beforeHandshake?: boolean

    Indicates the timeout happened before a connection handshake completed

    -

    Optionalcause

    cause?: Error

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalcause

    cause?: Error

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/MongoOptions.html b/docs/6.10/interfaces/MongoOptions.html index f0d1495129c..a1c5cb84fc7 100644 --- a/docs/6.10/interfaces/MongoOptions.html +++ b/docs/6.10/interfaces/MongoOptions.html @@ -1,4 +1,4 @@ -MongoOptions | mongodb

    Interface MongoOptions

    Parsed Mongo Client Options.

    +MongoOptions | mongodb

    Interface MongoOptions

    Parsed Mongo Client Options.

    User supplied options are documented by MongoClientOptions.

    NOTE: The client's options parsing is subject to change to support new features. This type is provided to aid with inspection of options after parsing, it should not be relied upon programmatically.

    @@ -88,7 +88,7 @@ (Protocols should be ordered by their priority.)

    OptionalappName

    appName?: string

    autoEncryption

    autoEncryption: AutoEncryptionOptions

    Optionally enable in-use auto encryption

    Remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error -(see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    +(see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    OptionaltlsCAFile

    tlsCAFile?: string

    OptionaltlsCertificateKeyFile

    tlsCertificateKeyFile?: string

    OptionaltlsCRLFile

    tlsCRLFile?: string

    tlsInsecure

    tlsInsecure: boolean

    Disables various certificate validations.

    waitQueueTimeoutMS

    waitQueueTimeoutMS: number

    The maximum time in milliseconds that a thread can wait for a connection to become available.

    writeConcern

    writeConcern: WriteConcern

    zlibCompressionLevel

    zlibCompressionLevel:
        | 0
        | 1
        | 2
        | 3
        | 4
        | 5
        | 6
        | 7
        | 8
        | 9

    An integer that specifies the compression level if using zlib for network compression.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    allowPartialTrustChainALPNProtocolsappNameautoEncryptionautoSelectFamilyautoSelectFamilyAttemptTimeoutcacertcheckServerIdentitycipherscompressorsconnectTimeoutMScredentialscrldbNamedirectConnectiondriverInfoecdhCurvefamilyforceServerObjectIdheartbeatFrequencyMShintshostskeyloadBalancedlocalAddresslocalPortlocalThresholdMSlookupmaxConnectingmaxIdleTimeMSmaxPoolSizemetadataminDHSizeminHeartbeatFrequencyMSminPoolSizemonitorCommandsnoDelaypassphrasepfxpkFactoryproxyHostproxyPasswordproxyPortproxyUsernamerawreadConcernreadPreferencerejectUnauthorizedreplicaSetretryReadsretryWritessecureContextsecureProtocolserverApiserverMonitoringModeservernameserverSelectionTimeoutMSsessionsocketTimeoutMSsrvHostsrvMaxHostssrvServiceNametlstlsAllowInvalidCertificatestlsAllowInvalidHostnamestlsCAFiletlsCertificateKeyFiletlsCRLFiletlsInsecurewaitQueueTimeoutMSwriteConcernzlibCompressionLevel
    +

    Settings

    Member Visibility

    On This Page

    Properties
    allowPartialTrustChainALPNProtocolsappNameautoEncryptionautoSelectFamilyautoSelectFamilyAttemptTimeoutcacertcheckServerIdentitycipherscompressorsconnectTimeoutMScredentialscrldbNamedirectConnectiondriverInfoecdhCurvefamilyforceServerObjectIdheartbeatFrequencyMShintshostskeyloadBalancedlocalAddresslocalPortlocalThresholdMSlookupmaxConnectingmaxIdleTimeMSmaxPoolSizemetadataminDHSizeminHeartbeatFrequencyMSminPoolSizemonitorCommandsnoDelaypassphrasepfxpkFactoryproxyHostproxyPasswordproxyPortproxyUsernamerawreadConcernreadPreferencerejectUnauthorizedreplicaSetretryReadsretryWritessecureContextsecureProtocolserverApiserverMonitoringModeservernameserverSelectionTimeoutMSsessionsocketTimeoutMSsrvHostsrvMaxHostssrvServiceNametlstlsAllowInvalidCertificatestlsAllowInvalidHostnamestlsCAFiletlsCertificateKeyFiletlsCRLFiletlsInsecurewaitQueueTimeoutMSwriteConcernzlibCompressionLevel
    diff --git a/docs/6.10/interfaces/MonitorOptions.html b/docs/6.10/interfaces/MonitorOptions.html index c056cab7401..2a0f2567205 100644 --- a/docs/6.10/interfaces/MonitorOptions.html +++ b/docs/6.10/interfaces/MonitorOptions.html @@ -1,4 +1,4 @@ -MonitorOptions | mongodb

    Interface MonitorOptions

    interface MonitorOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        heartbeatFrequencyMS: number;
        hints?: number;
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        metadata: ClientMetadata;
        minDHSize?: number;
        minHeartbeatFrequencyMS: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        serverMonitoringMode: ServerMonitoringMode;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
    }

    Hierarchy

    Properties

    allowPartialTrustChain? +MonitorOptions | mongodb

    Interface MonitorOptions

    interface MonitorOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        heartbeatFrequencyMS: number;
        hints?: number;
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        metadata: ClientMetadata;
        minDHSize?: number;
        minHeartbeatFrequencyMS: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        serverMonitoringMode: ServerMonitoringMode;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
    }

    Hierarchy

    Properties

    allowPartialTrustChain? ALPNProtocols? autoSelectFamily? autoSelectFamilyAttemptTimeout? @@ -119,4 +119,4 @@ TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.

    OptionalserverApi

    serverApi?: ServerApi

    serverMonitoringMode

    serverMonitoringMode: ServerMonitoringMode

    Optionalservername

    servername?: string

    Optionalsession

    session?: Buffer

    An optional Buffer instance containing a TLS session.

    -

    OptionalsocketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalsocketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/OIDCCallbackParams.html b/docs/6.10/interfaces/OIDCCallbackParams.html index 4387cfeb024..6237e647caa 100644 --- a/docs/6.10/interfaces/OIDCCallbackParams.html +++ b/docs/6.10/interfaces/OIDCCallbackParams.html @@ -1,4 +1,4 @@ -OIDCCallbackParams | mongodb

    Interface OIDCCallbackParams

    The parameters that the driver provides to the user supplied +OIDCCallbackParams | mongodb

    Interface OIDCCallbackParams

    The parameters that the driver provides to the user supplied human or machine callback.

    The version number is used to communicate callback API changes that are not breaking but that users may want to know about and review their implementation. Users may wish to check the version @@ -13,4 +13,4 @@

    timeoutContext

    timeoutContext: AbortSignal

    The context in which to timeout the OIDC callback.

    Optionalusername

    username?: string

    Optional username.

    version

    version: 1

    The current OIDC API version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/OIDCResponse.html b/docs/6.10/interfaces/OIDCResponse.html index d5dfe593f2d..789b7250395 100644 --- a/docs/6.10/interfaces/OIDCResponse.html +++ b/docs/6.10/interfaces/OIDCResponse.html @@ -1,4 +1,4 @@ -OIDCResponse | mongodb

    Interface OIDCResponse

    The response required to be returned from the machine or +OIDCResponse | mongodb

    Interface OIDCResponse

    The response required to be returned from the machine or human callback workflows' callback.

    interface OIDCResponse {
        accessToken: string;
        expiresInSeconds?: number;
        refreshToken?: string;
    }

    Properties

    accessToken expiresInSeconds? @@ -6,4 +6,4 @@

    Properties

    accessToken

    accessToken: string

    The OIDC access token.

    OptionalexpiresInSeconds

    expiresInSeconds?: number

    The time when the access token expires. For future use.

    OptionalrefreshToken

    refreshToken?: string

    The refresh token, if applicable, to be used by the callback to request a new token from the issuer.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/OperationOptions.html b/docs/6.10/interfaces/OperationOptions.html index 676e16f9ed8..dcff8e48606 100644 --- a/docs/6.10/interfaces/OperationOptions.html +++ b/docs/6.10/interfaces/OperationOptions.html @@ -1,4 +1,4 @@ -OperationOptions | mongodb

    Interface OperationOptions

    interface OperationOptions {
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
    }

    Hierarchy (view full)

    Properties

    bsonRegExp? +OperationOptions | mongodb

    Interface OperationOptions

    interface OperationOptions {
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
    }

    Hierarchy (view full)

    Properties

    bsonRegExp? checkKeys? enableUtf8Validation? fieldsAsRaw? @@ -46,4 +46,4 @@

    Remarks

    Optionalsession

    session?: ClientSession

    Specify ClientSession for this command

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    -

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/PkFactory.html b/docs/6.10/interfaces/PkFactory.html index f609057d235..96254122d1e 100644 --- a/docs/6.10/interfaces/PkFactory.html +++ b/docs/6.10/interfaces/PkFactory.html @@ -1,2 +1,2 @@ -PkFactory | mongodb

    Interface PkFactory

    interface PkFactory {
        createPk(): any;
    }

    Methods

    createPk -

    Methods

    createPk

    Settings

    Member Visibility

    On This Page

    Methods
    +PkFactory | mongodb

    Interface PkFactory

    interface PkFactory {
        createPk(): any;
    }

    Methods

    createPk +

    Methods

    createPk

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/docs/6.10/interfaces/ProxyOptions.html b/docs/6.10/interfaces/ProxyOptions.html index 69474d4b2d3..53401f627c7 100644 --- a/docs/6.10/interfaces/ProxyOptions.html +++ b/docs/6.10/interfaces/ProxyOptions.html @@ -1,5 +1,5 @@ -ProxyOptions | mongodb

    Interface ProxyOptions

    interface ProxyOptions {
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
    }

    Hierarchy (view full)

    Properties

    proxyHost? +ProxyOptions | mongodb

    Interface ProxyOptions

    interface ProxyOptions {
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
    }

    Hierarchy (view full)

    Properties

    proxyHost? proxyPassword? proxyPort? proxyUsername? -

    Properties

    OptionalproxyHost

    proxyHost?: string

    OptionalproxyPassword

    proxyPassword?: string

    OptionalproxyPort

    proxyPort?: number

    OptionalproxyUsername

    proxyUsername?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalproxyHost

    proxyHost?: string

    OptionalproxyPassword

    proxyPassword?: string

    OptionalproxyPort

    proxyPort?: number

    OptionalproxyUsername

    proxyUsername?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/RangeOptions.html b/docs/6.10/interfaces/RangeOptions.html index 2202c17e68d..f24a0685f2d 100644 --- a/docs/6.10/interfaces/RangeOptions.html +++ b/docs/6.10/interfaces/RangeOptions.html @@ -1,4 +1,4 @@ -RangeOptions | mongodb

    Interface RangeOptions

    RangeOptions specifies index options for a Queryable Encryption field supporting "range" queries. +RangeOptions | mongodb

    Interface RangeOptions

    RangeOptions specifies index options for a Queryable Encryption field supporting "range" queries. min, max, sparsity, trimFactor and range must match the values set in the encryptedFields of the destination collection. For double and decimal128, min/max/precision must all be set, or all be unset.

    interface RangeOptions {
        max?: any;
        min?: any;
        precision?: number;
        sparsity?: bigint | Long;
        trimFactor?: number | Int32;
    }

    Properties

    max? @@ -10,4 +10,4 @@

    Optionalmin

    min?: any

    min is the minimum value for the encrypted index. Required if precision is set.

    Optionalprecision

    precision?: number

    Optionalsparsity

    sparsity?: bigint | Long

    sparsity may be used to tune performance. must be non-negative. When omitted, a default value is used.

    OptionaltrimFactor

    trimFactor?: number | Int32

    trimFactor may be used to tune performance. must be non-negative. When omitted, a default value is used.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ReadPreferenceFromOptions.html b/docs/6.10/interfaces/ReadPreferenceFromOptions.html index d8f0a909f42..505c0d90289 100644 --- a/docs/6.10/interfaces/ReadPreferenceFromOptions.html +++ b/docs/6.10/interfaces/ReadPreferenceFromOptions.html @@ -1,8 +1,8 @@ -ReadPreferenceFromOptions | mongodb

    Interface ReadPreferenceFromOptions

    interface ReadPreferenceFromOptions {
        hedge?: HedgeOptions;
        maxStalenessSeconds?: number;
        readPreference?: ReadPreferenceLike | {
            maxStalenessSeconds?: number;
            mode?: ReadPreferenceMode | undefined;
            preference?: ReadPreferenceMode | undefined;
            tags?: TagSet[];
        };
        readPreferenceTags?: TagSet[];
        session?: ClientSession;
    }

    Hierarchy (view full)

    Properties

    hedge? +ReadPreferenceFromOptions | mongodb

    Interface ReadPreferenceFromOptions

    interface ReadPreferenceFromOptions {
        hedge?: HedgeOptions;
        maxStalenessSeconds?: number;
        readPreference?: ReadPreferenceLike | {
            maxStalenessSeconds?: number;
            mode?: ReadPreferenceMode | undefined;
            preference?: ReadPreferenceMode | undefined;
            tags?: TagSet[];
        };
        readPreferenceTags?: TagSet[];
        session?: ClientSession;
    }

    Hierarchy (view full)

    Properties

    hedge? maxStalenessSeconds? readPreference? readPreferenceTags? session?

    Properties

    Optionalhedge

    hedge?: HedgeOptions

    Server mode in which the same query is dispatched in parallel to multiple replica set members.

    OptionalmaxStalenessSeconds

    maxStalenessSeconds?: number

    Max secondary read staleness in seconds, Minimum value is 90 seconds.

    -

    OptionalreadPreference

    readPreference?: ReadPreferenceLike | {
        maxStalenessSeconds?: number;
        mode?: ReadPreferenceMode | undefined;
        preference?: ReadPreferenceMode | undefined;
        tags?: TagSet[];
    }

    OptionalreadPreferenceTags

    readPreferenceTags?: TagSet[]

    Optionalsession

    session?: ClientSession

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalreadPreference

    readPreference?: ReadPreferenceLike | {
        maxStalenessSeconds?: number;
        mode?: ReadPreferenceMode | undefined;
        preference?: ReadPreferenceMode | undefined;
        tags?: TagSet[];
    }

    OptionalreadPreferenceTags

    readPreferenceTags?: TagSet[]

    Optionalsession

    session?: ClientSession

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ReadPreferenceLikeOptions.html b/docs/6.10/interfaces/ReadPreferenceLikeOptions.html index 9466c3f355d..dbe3814a094 100644 --- a/docs/6.10/interfaces/ReadPreferenceLikeOptions.html +++ b/docs/6.10/interfaces/ReadPreferenceLikeOptions.html @@ -1,6 +1,6 @@ -ReadPreferenceLikeOptions | mongodb

    Interface ReadPreferenceLikeOptions

    interface ReadPreferenceLikeOptions {
        hedge?: HedgeOptions;
        maxStalenessSeconds?: number;
        readPreference?: ReadPreferenceLike | {
            maxStalenessSeconds?: number;
            mode?: ReadPreferenceMode | undefined;
            preference?: ReadPreferenceMode | undefined;
            tags?: TagSet[];
        };
    }

    Hierarchy (view full)

    Properties

    hedge? +ReadPreferenceLikeOptions | mongodb

    Interface ReadPreferenceLikeOptions

    interface ReadPreferenceLikeOptions {
        hedge?: HedgeOptions;
        maxStalenessSeconds?: number;
        readPreference?: ReadPreferenceLike | {
            maxStalenessSeconds?: number;
            mode?: ReadPreferenceMode | undefined;
            preference?: ReadPreferenceMode | undefined;
            tags?: TagSet[];
        };
    }

    Hierarchy (view full)

    Properties

    hedge? maxStalenessSeconds? readPreference?

    Properties

    Optionalhedge

    hedge?: HedgeOptions

    Server mode in which the same query is dispatched in parallel to multiple replica set members.

    OptionalmaxStalenessSeconds

    maxStalenessSeconds?: number

    Max secondary read staleness in seconds, Minimum value is 90 seconds.

    -

    OptionalreadPreference

    readPreference?: ReadPreferenceLike | {
        maxStalenessSeconds?: number;
        mode?: ReadPreferenceMode | undefined;
        preference?: ReadPreferenceMode | undefined;
        tags?: TagSet[];
    }

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalreadPreference

    readPreference?: ReadPreferenceLike | {
        maxStalenessSeconds?: number;
        mode?: ReadPreferenceMode | undefined;
        preference?: ReadPreferenceMode | undefined;
        tags?: TagSet[];
    }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ReadPreferenceOptions.html b/docs/6.10/interfaces/ReadPreferenceOptions.html index 99a07f503ef..bbfbf4e9510 100644 --- a/docs/6.10/interfaces/ReadPreferenceOptions.html +++ b/docs/6.10/interfaces/ReadPreferenceOptions.html @@ -1,5 +1,5 @@ -ReadPreferenceOptions | mongodb

    Interface ReadPreferenceOptions

    interface ReadPreferenceOptions {
        hedge?: HedgeOptions;
        maxStalenessSeconds?: number;
    }

    Hierarchy (view full)

    Properties

    hedge? +ReadPreferenceOptions | mongodb

    Interface ReadPreferenceOptions

    interface ReadPreferenceOptions {
        hedge?: HedgeOptions;
        maxStalenessSeconds?: number;
    }

    Hierarchy (view full)

    Properties

    hedge? maxStalenessSeconds?

    Properties

    Optionalhedge

    hedge?: HedgeOptions

    Server mode in which the same query is dispatched in parallel to multiple replica set members.

    OptionalmaxStalenessSeconds

    maxStalenessSeconds?: number

    Max secondary read staleness in seconds, Minimum value is 90 seconds.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/RenameOptions.html b/docs/6.10/interfaces/RenameOptions.html index f1551de651f..5f5211dadcd 100644 --- a/docs/6.10/interfaces/RenameOptions.html +++ b/docs/6.10/interfaces/RenameOptions.html @@ -1,4 +1,4 @@ -RenameOptions | mongodb

    Interface RenameOptions

    interface RenameOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        dropTarget?: boolean;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        new_collection?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +RenameOptions | mongodb

    Interface RenameOptions

    interface RenameOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        dropTarget?: boolean;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        new_collection?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -69,4 +69,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ReplaceOneModel.html b/docs/6.10/interfaces/ReplaceOneModel.html index 4115054ad12..a82958dddc5 100644 --- a/docs/6.10/interfaces/ReplaceOneModel.html +++ b/docs/6.10/interfaces/ReplaceOneModel.html @@ -1,4 +1,4 @@ -ReplaceOneModel | mongodb

    Interface ReplaceOneModel<TSchema>

    interface ReplaceOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        replacement: WithoutId<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    collation? +ReplaceOneModel | mongodb

    Interface ReplaceOneModel<TSchema>

    interface ReplaceOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        replacement: WithoutId<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    collation? filter hint? replacement @@ -8,4 +8,4 @@

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    replacement

    replacement: WithoutId<TSchema>

    The document with which to replace the matched document.

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ReplaceOptions.html b/docs/6.10/interfaces/ReplaceOptions.html index 0df29851195..7d2ec385e48 100644 --- a/docs/6.10/interfaces/ReplaceOptions.html +++ b/docs/6.10/interfaces/ReplaceOptions.html @@ -1,4 +1,4 @@ -ReplaceOptions | mongodb

    Interface ReplaceOptions

    interface ReplaceOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: string | Document;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +ReplaceOptions | mongodb

    Interface ReplaceOptions

    interface ReplaceOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: string | Document;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? bypassDocumentValidation? checkKeys? @@ -73,4 +73,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ResumeOptions.html b/docs/6.10/interfaces/ResumeOptions.html index b934997f3a6..adca092c682 100644 --- a/docs/6.10/interfaces/ResumeOptions.html +++ b/docs/6.10/interfaces/ResumeOptions.html @@ -1,4 +1,4 @@ -ResumeOptions | mongodb

    Interface ResumeOptions

    Deprecated

    Please use the ChangeStreamCursorOptions type instead.

    +ResumeOptions | mongodb

    Interface ResumeOptions

    Deprecated

    Please use the ChangeStreamCursorOptions type instead.

    interface ResumeOptions {
        batchSize?: number;
        collation?: CollationOptions;
        fullDocument?: string;
        maxAwaitTimeMS?: number;
        readPreference?: ReadPreference;
        resumeAfter?: unknown;
        startAfter?: unknown;
        startAtOperationTime?: Timestamp;
    }

    Properties

    batchSize? collation? fullDocument? @@ -7,4 +7,4 @@ resumeAfter? startAfter? startAtOperationTime? -

    Properties

    OptionalbatchSize

    batchSize?: number

    Optionalcollation

    collation?: CollationOptions

    OptionalfullDocument

    fullDocument?: string

    OptionalmaxAwaitTimeMS

    maxAwaitTimeMS?: number

    OptionalreadPreference

    readPreference?: ReadPreference

    OptionalresumeAfter

    resumeAfter?: unknown

    OptionalstartAfter

    startAfter?: unknown

    OptionalstartAtOperationTime

    startAtOperationTime?: Timestamp

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalbatchSize

    batchSize?: number

    Optionalcollation

    collation?: CollationOptions

    OptionalfullDocument

    fullDocument?: string

    OptionalmaxAwaitTimeMS

    maxAwaitTimeMS?: number

    OptionalreadPreference

    readPreference?: ReadPreference

    OptionalresumeAfter

    resumeAfter?: unknown

    OptionalstartAfter

    startAfter?: unknown

    OptionalstartAtOperationTime

    startAtOperationTime?: Timestamp

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/RootFilterOperators.html b/docs/6.10/interfaces/RootFilterOperators.html index 6d4e39a3be5..ef429122df9 100644 --- a/docs/6.10/interfaces/RootFilterOperators.html +++ b/docs/6.10/interfaces/RootFilterOperators.html @@ -1,7 +1,7 @@ -RootFilterOperators | mongodb

    Interface RootFilterOperators<TSchema>

    interface RootFilterOperators<TSchema> {
        $and?: Filter<TSchema>[];
        $comment?: string | Document;
        $nor?: Filter<TSchema>[];
        $or?: Filter<TSchema>[];
        $text?: {
            $caseSensitive?: boolean;
            $diacriticSensitive?: boolean;
            $language?: string;
            $search: string;
        };
        $where?: string | ((this: TSchema) => boolean);
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    $and? +RootFilterOperators | mongodb

    Interface RootFilterOperators<TSchema>

    interface RootFilterOperators<TSchema> {
        $and?: Filter<TSchema>[];
        $comment?: string | Document;
        $nor?: Filter<TSchema>[];
        $or?: Filter<TSchema>[];
        $text?: {
            $caseSensitive?: boolean;
            $diacriticSensitive?: boolean;
            $language?: string;
            $search: string;
        };
        $where?: string | ((this: TSchema) => boolean);
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    $and? $comment? $nor? $or? $text? $where? -

    Properties

    Optional$and

    $and?: Filter<TSchema>[]

    Optional$comment

    $comment?: string | Document

    Optional$nor

    $nor?: Filter<TSchema>[]

    Optional$or

    $or?: Filter<TSchema>[]

    Optional$text

    $text?: {
        $caseSensitive?: boolean;
        $diacriticSensitive?: boolean;
        $language?: string;
        $search: string;
    }

    Optional$where

    $where?: string | ((this: TSchema) => boolean)

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optional$and

    $and?: Filter<TSchema>[]

    Optional$comment

    $comment?: string | Document

    Optional$nor

    $nor?: Filter<TSchema>[]

    Optional$or

    $or?: Filter<TSchema>[]

    Optional$text

    $text?: {
        $caseSensitive?: boolean;
        $diacriticSensitive?: boolean;
        $language?: string;
        $search: string;
    }

    Optional$where

    $where?: string | ((this: TSchema) => boolean)

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/SearchIndexDescription.html b/docs/6.10/interfaces/SearchIndexDescription.html index 814a0e114c5..cc63d546c20 100644 --- a/docs/6.10/interfaces/SearchIndexDescription.html +++ b/docs/6.10/interfaces/SearchIndexDescription.html @@ -1,7 +1,7 @@ -SearchIndexDescription | mongodb

    Interface SearchIndexDescription

    interface SearchIndexDescription {
        definition: Document;
        name?: string;
        type?: string;
    }

    Hierarchy (view full)

    Properties

    definition +SearchIndexDescription | mongodb

    Interface SearchIndexDescription

    interface SearchIndexDescription {
        definition: Document;
        name?: string;
        type?: string;
    }

    Hierarchy (view full)

    Properties

    definition name? type?

    Properties

    definition

    definition: Document

    The index definition.

    Optionalname

    name?: string

    The name of the index.

    Optionaltype

    type?: string

    The type of the index. Currently search or vectorSearch are supported.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/SelectServerOptions.html b/docs/6.10/interfaces/SelectServerOptions.html index c1f2337c8f9..8ed3f618142 100644 --- a/docs/6.10/interfaces/SelectServerOptions.html +++ b/docs/6.10/interfaces/SelectServerOptions.html @@ -1,7 +1,7 @@ -SelectServerOptions | mongodb

    Interface SelectServerOptions

    interface SelectServerOptions {
        operationName: string;
        previousServer?: ServerDescription;
        readPreference?: ReadPreferenceLike;
        serverSelectionTimeoutMS?: number;
        session?: ClientSession;
    }

    Properties

    operationName +SelectServerOptions | mongodb

    Interface SelectServerOptions

    interface SelectServerOptions {
        operationName: string;
        previousServer?: ServerDescription;
        readPreference?: ReadPreferenceLike;
        serverSelectionTimeoutMS?: number;
        session?: ClientSession;
    }

    Properties

    operationName previousServer? readPreference? serverSelectionTimeoutMS? session?

    Properties

    operationName

    operationName: string

    OptionalpreviousServer

    previousServer?: ServerDescription

    OptionalreadPreference

    readPreference?: ReadPreferenceLike

    OptionalserverSelectionTimeoutMS

    serverSelectionTimeoutMS?: number

    How long to block for server selection before throwing an error

    -

    Optionalsession

    session?: ClientSession

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalsession

    session?: ClientSession

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ServerApi.html b/docs/6.10/interfaces/ServerApi.html index 299fa771fb1..550f0881983 100644 --- a/docs/6.10/interfaces/ServerApi.html +++ b/docs/6.10/interfaces/ServerApi.html @@ -1,4 +1,4 @@ -ServerApi | mongodb

    Interface ServerApi

    interface ServerApi {
        deprecationErrors?: boolean;
        strict?: boolean;
        version: "1";
    }

    Properties

    deprecationErrors? +ServerApi | mongodb

    Interface ServerApi

    interface ServerApi {
        deprecationErrors?: boolean;
        strict?: boolean;
        version: "1";
    }

    Properties

    deprecationErrors? strict? version -

    Properties

    OptionaldeprecationErrors

    deprecationErrors?: boolean

    Optionalstrict

    strict?: boolean

    version

    version: "1"

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionaldeprecationErrors

    deprecationErrors?: boolean

    Optionalstrict

    strict?: boolean

    version

    version: "1"

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/StreamDescriptionOptions.html b/docs/6.10/interfaces/StreamDescriptionOptions.html index 033292e9ea2..cf2d3c31388 100644 --- a/docs/6.10/interfaces/StreamDescriptionOptions.html +++ b/docs/6.10/interfaces/StreamDescriptionOptions.html @@ -1,4 +1,4 @@ -StreamDescriptionOptions | mongodb

    Interface StreamDescriptionOptions

    interface StreamDescriptionOptions {
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        loadBalanced: boolean;
        logicalSessionTimeoutMinutes?: number;
    }

    Hierarchy (view full)

    Properties

    compressors? +StreamDescriptionOptions | mongodb

    Interface StreamDescriptionOptions

    interface StreamDescriptionOptions {
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        loadBalanced: boolean;
        logicalSessionTimeoutMinutes?: number;
    }

    Hierarchy (view full)

    Properties

    compressors? loadBalanced logicalSessionTimeoutMinutes? -

    Properties

    Optionalcompressors

    compressors?: (
        | "none"
        | "snappy"
        | "zlib"
        | "zstd")[]

    loadBalanced

    loadBalanced: boolean

    OptionallogicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalcompressors

    compressors?: (
        | "none"
        | "snappy"
        | "zlib"
        | "zstd")[]

    loadBalanced

    loadBalanced: boolean

    OptionallogicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/TimeSeriesCollectionOptions.html b/docs/6.10/interfaces/TimeSeriesCollectionOptions.html index ec8b555b33c..9dc15624310 100644 --- a/docs/6.10/interfaces/TimeSeriesCollectionOptions.html +++ b/docs/6.10/interfaces/TimeSeriesCollectionOptions.html @@ -1,8 +1,8 @@ -TimeSeriesCollectionOptions | mongodb

    Interface TimeSeriesCollectionOptions

    Configuration options for timeseries collections

    +TimeSeriesCollectionOptions | mongodb

    Interface TimeSeriesCollectionOptions

    Configuration options for timeseries collections

    See

    https://www.mongodb.com/docs/manual/core/timeseries-collections/

    interface TimeSeriesCollectionOptions {
        bucketMaxSpanSeconds?: number;
        bucketRoundingSeconds?: number;
        granularity?: string;
        metaField?: string;
        timeField: string;
    }

    Hierarchy (view full)

    Properties

    bucketMaxSpanSeconds? bucketRoundingSeconds? granularity? metaField? timeField -

    Properties

    OptionalbucketMaxSpanSeconds

    bucketMaxSpanSeconds?: number

    OptionalbucketRoundingSeconds

    bucketRoundingSeconds?: number

    Optionalgranularity

    granularity?: string

    OptionalmetaField

    metaField?: string

    timeField

    timeField: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalbucketMaxSpanSeconds

    bucketMaxSpanSeconds?: number

    OptionalbucketRoundingSeconds

    bucketRoundingSeconds?: number

    Optionalgranularity

    granularity?: string

    OptionalmetaField

    metaField?: string

    timeField

    timeField: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/TopologyDescriptionOptions.html b/docs/6.10/interfaces/TopologyDescriptionOptions.html index 941c8000785..e27a99d8462 100644 --- a/docs/6.10/interfaces/TopologyDescriptionOptions.html +++ b/docs/6.10/interfaces/TopologyDescriptionOptions.html @@ -1,3 +1,3 @@ -TopologyDescriptionOptions | mongodb

    Interface TopologyDescriptionOptions

    interface TopologyDescriptionOptions {
        heartbeatFrequencyMS?: number;
        localThresholdMS?: number;
    }

    Properties

    heartbeatFrequencyMS? +TopologyDescriptionOptions | mongodb

    Interface TopologyDescriptionOptions

    interface TopologyDescriptionOptions {
        heartbeatFrequencyMS?: number;
        localThresholdMS?: number;
    }

    Properties

    heartbeatFrequencyMS? localThresholdMS? -

    Properties

    OptionalheartbeatFrequencyMS

    heartbeatFrequencyMS?: number

    OptionallocalThresholdMS

    localThresholdMS?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalheartbeatFrequencyMS

    heartbeatFrequencyMS?: number

    OptionallocalThresholdMS

    localThresholdMS?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/TopologyVersion.html b/docs/6.10/interfaces/TopologyVersion.html index c3ad0ff5f0f..f1e5c8dd880 100644 --- a/docs/6.10/interfaces/TopologyVersion.html +++ b/docs/6.10/interfaces/TopologyVersion.html @@ -1,3 +1,3 @@ -TopologyVersion | mongodb

    Interface TopologyVersion

    interface TopologyVersion {
        counter: Long;
        processId: ObjectId;
    }

    Properties

    counter +TopologyVersion | mongodb

    Interface TopologyVersion

    interface TopologyVersion {
        counter: Long;
        processId: ObjectId;
    }

    Properties

    counter processId -

    Properties

    counter

    counter: Long

    processId

    processId: ObjectId

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    counter

    counter: Long

    processId

    processId: ObjectId

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/TransactionOptions.html b/docs/6.10/interfaces/TransactionOptions.html index a5b56263313..e1d67ef34e2 100644 --- a/docs/6.10/interfaces/TransactionOptions.html +++ b/docs/6.10/interfaces/TransactionOptions.html @@ -1,4 +1,4 @@ -TransactionOptions | mongodb

    Interface TransactionOptions

    Configuration options for a transaction.

    +TransactionOptions | mongodb

    Interface TransactionOptions

    Configuration options for a transaction.

    interface TransactionOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxCommitTimeMS?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? @@ -68,4 +68,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern

    A default writeConcern for commands in this transaction

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/UpdateDescription.html b/docs/6.10/interfaces/UpdateDescription.html index 00eda6411cd..62e2a9331ad 100644 --- a/docs/6.10/interfaces/UpdateDescription.html +++ b/docs/6.10/interfaces/UpdateDescription.html @@ -1,4 +1,4 @@ -UpdateDescription | mongodb

    Interface UpdateDescription<TSchema>

    interface UpdateDescription<TSchema> {
        disambiguatedPaths?: Document;
        removedFields?: string[];
        truncatedArrays?: {
            field: string;
            newSize: number;
        }[];
        updatedFields?: Partial<TSchema>;
    }

    Type Parameters

    Properties

    disambiguatedPaths? +UpdateDescription | mongodb

    Interface UpdateDescription<TSchema>

    interface UpdateDescription<TSchema> {
        disambiguatedPaths?: Document;
        removedFields?: string[];
        truncatedArrays?: {
            field: string;
            newSize: number;
        }[];
        updatedFields?: Partial<TSchema>;
    }

    Type Parameters

    Properties

    disambiguatedPaths? removedFields? truncatedArrays? updatedFields? @@ -24,4 +24,4 @@
  • newSize: number

    The number of elements in the truncated array.

    • OptionalupdatedFields

    updatedFields?: Partial<TSchema>

    A document containing key:value pairs of names of the fields that were changed, and the new value for those fields.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/UpdateManyModel.html b/docs/6.10/interfaces/UpdateManyModel.html index 0d2fd634270..10be7369d53 100644 --- a/docs/6.10/interfaces/UpdateManyModel.html +++ b/docs/6.10/interfaces/UpdateManyModel.html @@ -1,4 +1,4 @@ -UpdateManyModel | mongodb

    Interface UpdateManyModel<TSchema>

    interface UpdateManyModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    arrayFilters? +UpdateManyModel | mongodb

    Interface UpdateManyModel<TSchema>

    interface UpdateManyModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    arrayFilters? collation? filter hint? @@ -12,4 +12,4 @@ UpdateFilter - A document that contains update operator expressions, Document[] - an aggregation pipeline.

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/UpdateOneModel.html b/docs/6.10/interfaces/UpdateOneModel.html index dade7fa15ae..b126bc79c82 100644 --- a/docs/6.10/interfaces/UpdateOneModel.html +++ b/docs/6.10/interfaces/UpdateOneModel.html @@ -1,4 +1,4 @@ -UpdateOneModel | mongodb

    Interface UpdateOneModel<TSchema>

    interface UpdateOneModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    arrayFilters? +UpdateOneModel | mongodb

    Interface UpdateOneModel<TSchema>

    interface UpdateOneModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    arrayFilters? collation? filter hint? @@ -12,4 +12,4 @@ UpdateFilter - A document that contains update operator expressions, Document[] - an aggregation pipeline.

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/UpdateOptions.html b/docs/6.10/interfaces/UpdateOptions.html index d2eb71d6b1d..9d233381119 100644 --- a/docs/6.10/interfaces/UpdateOptions.html +++ b/docs/6.10/interfaces/UpdateOptions.html @@ -1,4 +1,4 @@ -UpdateOptions | mongodb

    Interface UpdateOptions

    interface UpdateOptions {
        arrayFilters?: Document[];
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    arrayFilters? +UpdateOptions | mongodb

    Interface UpdateOptions

    interface UpdateOptions {
        arrayFilters?: Document[];
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    arrayFilters? authdb? bsonRegExp? bypassDocumentValidation? @@ -75,4 +75,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/UpdateResult.html b/docs/6.10/interfaces/UpdateResult.html index 083166864d9..5e48c5d3682 100644 --- a/docs/6.10/interfaces/UpdateResult.html +++ b/docs/6.10/interfaces/UpdateResult.html @@ -1,4 +1,4 @@ -UpdateResult | mongodb

    Interface UpdateResult<TSchema>

    TSchema is the schema of the collection

    +UpdateResult | mongodb

    Interface UpdateResult<TSchema>

    TSchema is the schema of the collection

    interface UpdateResult<TSchema> {
        acknowledged: boolean;
        matchedCount: number;
        modifiedCount: number;
        upsertedCount: number;
        upsertedId: null | InferIdType<TSchema>;
    }

    Type Parameters

    Properties

    acknowledged matchedCount modifiedCount @@ -9,4 +9,4 @@

    modifiedCount

    modifiedCount: number

    The number of documents that were modified

    upsertedCount

    upsertedCount: number

    The number of documents that were upserted

    upsertedId

    upsertedId: null | InferIdType<TSchema>

    The identifier of the inserted document if an upsert took place

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/UpdateStatement.html b/docs/6.10/interfaces/UpdateStatement.html index 0ced063f76a..6fc27a0fb7e 100644 --- a/docs/6.10/interfaces/UpdateStatement.html +++ b/docs/6.10/interfaces/UpdateStatement.html @@ -1,4 +1,4 @@ -UpdateStatement | mongodb

    Interface UpdateStatement

    interface UpdateStatement {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        hint?: Hint;
        multi?: boolean;
        q: Document;
        u: Document | Document[];
        upsert?: boolean;
    }

    Properties

    arrayFilters? +UpdateStatement | mongodb

    Interface UpdateStatement

    interface UpdateStatement {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        hint?: Hint;
        multi?: boolean;
        q: Document;
        u: Document | Document[];
        upsert?: boolean;
    }

    Properties

    arrayFilters? collation? hint? multi? @@ -12,4 +12,4 @@

    q

    q: Document

    The query that matches documents to update.

    u

    u: Document | Document[]

    The modifications to apply.

    Optionalupsert

    upsert?: boolean

    If true, perform an insert if no documents match the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/ValidateCollectionOptions.html b/docs/6.10/interfaces/ValidateCollectionOptions.html index 30c6d7507d7..c0c935fdc41 100644 --- a/docs/6.10/interfaces/ValidateCollectionOptions.html +++ b/docs/6.10/interfaces/ValidateCollectionOptions.html @@ -1,4 +1,4 @@ -ValidateCollectionOptions | mongodb

    Interface ValidateCollectionOptions

    interface ValidateCollectionOptions {
        authdb?: string;
        background?: boolean;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +ValidateCollectionOptions | mongodb

    Interface ValidateCollectionOptions

    interface ValidateCollectionOptions {
        authdb?: string;
        background?: boolean;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? background? bsonRegExp? checkKeys? @@ -67,4 +67,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/WriteConcernErrorData.html b/docs/6.10/interfaces/WriteConcernErrorData.html index 888dc81a48a..165df8595a2 100644 --- a/docs/6.10/interfaces/WriteConcernErrorData.html +++ b/docs/6.10/interfaces/WriteConcernErrorData.html @@ -1,4 +1,4 @@ -WriteConcernErrorData | mongodb

    Interface WriteConcernErrorData

    interface WriteConcernErrorData {
        code: number;
        errInfo?: Document;
        errmsg: string;
    }

    Properties

    code +WriteConcernErrorData | mongodb

    Interface WriteConcernErrorData

    interface WriteConcernErrorData {
        code: number;
        errInfo?: Document;
        errmsg: string;
    }

    Properties

    code errInfo? errmsg -

    Properties

    code

    code: number

    OptionalerrInfo

    errInfo?: Document

    errmsg

    errmsg: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    code

    code: number

    OptionalerrInfo

    errInfo?: Document

    errmsg

    errmsg: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/WriteConcernErrorResult.html b/docs/6.10/interfaces/WriteConcernErrorResult.html index bbe2315999b..79d86b62a61 100644 --- a/docs/6.10/interfaces/WriteConcernErrorResult.html +++ b/docs/6.10/interfaces/WriteConcernErrorResult.html @@ -1,6 +1,6 @@ -WriteConcernErrorResult | mongodb

    Interface WriteConcernErrorResult

    The type of the result property of MongoWriteConcernError

    +WriteConcernErrorResult | mongodb

    Interface WriteConcernErrorResult

    The type of the result property of MongoWriteConcernError

    interface WriteConcernErrorResult {
        code?: number;
        errorLabels?: string[];
        ok: number;
        writeConcernError: {
            code: number;
            codeName?: string;
            errInfo?: Document;
            errmsg: string;
        };
        [x: string | number]: unknown;
    }

    Indexable

    • [x: string | number]: unknown

    Properties

    code? errorLabels? ok writeConcernError -

    Properties

    Optionalcode

    code?: number

    OptionalerrorLabels

    errorLabels?: string[]

    ok

    ok: number

    writeConcernError

    writeConcernError: {
        code: number;
        codeName?: string;
        errInfo?: Document;
        errmsg: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalcode

    code?: number

    OptionalerrorLabels

    errorLabels?: string[]

    ok

    ok: number

    writeConcernError

    writeConcernError: {
        code: number;
        codeName?: string;
        errInfo?: Document;
        errmsg: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/WriteConcernOptions.html b/docs/6.10/interfaces/WriteConcernOptions.html index facd16b52d2..948767529a5 100644 --- a/docs/6.10/interfaces/WriteConcernOptions.html +++ b/docs/6.10/interfaces/WriteConcernOptions.html @@ -1,3 +1,3 @@ -WriteConcernOptions | mongodb

    Interface WriteConcernOptions

    interface WriteConcernOptions {
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    writeConcern? +WriteConcernOptions | mongodb

    Interface WriteConcernOptions

    interface WriteConcernOptions {
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    writeConcern?

    Properties

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/interfaces/WriteConcernSettings.html b/docs/6.10/interfaces/WriteConcernSettings.html index 68665a7f507..76f461d6bae 100644 --- a/docs/6.10/interfaces/WriteConcernSettings.html +++ b/docs/6.10/interfaces/WriteConcernSettings.html @@ -1,4 +1,4 @@ -WriteConcernSettings | mongodb

    Interface WriteConcernSettings

    interface WriteConcernSettings {
        fsync?: boolean | 1;
        j?: boolean;
        journal?: boolean;
        w?: W;
        wtimeout?: number;
        wtimeoutMS?: number;
    }

    Properties

    fsync? +WriteConcernSettings | mongodb

    Interface WriteConcernSettings

    interface WriteConcernSettings {
        fsync?: boolean | 1;
        j?: boolean;
        journal?: boolean;
        w?: W;
        wtimeout?: number;
        wtimeoutMS?: number;
    }

    Properties

    fsync? j? journal? w? @@ -13,4 +13,4 @@

    Optionalwtimeout

    wtimeout?: number

    The write concern timeout.

    Deprecated

    Will be removed in the next major version. Please use the wtimeoutMS option.

    OptionalwtimeoutMS

    wtimeoutMS?: number

    The write concern timeout

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/6.10/modules.html b/docs/6.10/modules.html index 6a9772e9ed0..d470fba79fe 100644 --- a/docs/6.10/modules.html +++ b/docs/6.10/modules.html @@ -1,4 +1,4 @@ -mongodb

    mongodb

    Error

    MongoAPIError +mongodb

    mongodb

    Error

    MongoAPIError MongoAWSError MongoAzureError MongoBatchReExecutionError @@ -416,4 +416,4 @@ ServerType TopologyType configureExplicitResourceManagement -

    Other

    Binary

    Re-exports Binary

    BSONRegExp

    Re-exports BSONRegExp

    BSONSymbol

    Re-exports BSONSymbol

    BSONType

    Re-exports BSONType

    Code

    Re-exports Code

    DBRef

    Re-exports DBRef

    Decimal128

    Re-exports Decimal128

    deserialize

    Re-exports deserialize

    Document

    Re-exports Document

    Double

    Re-exports Double

    Int32

    Re-exports Int32

    Long

    Re-exports Long

    MaxKey

    Re-exports MaxKey

    MinKey

    Re-exports MinKey

    ObjectId

    Re-exports ObjectId

    serialize

    Re-exports serialize

    Timestamp

    Re-exports Timestamp

    UUID

    Re-exports UUID

    Settings

    Member Visibility

    On This Page

    Other
    +

    Other

    Binary

    Re-exports Binary

    BSONRegExp

    Re-exports BSONRegExp

    BSONSymbol

    Re-exports BSONSymbol

    BSONType

    Re-exports BSONType

    Code

    Re-exports Code

    DBRef

    Re-exports DBRef

    Decimal128

    Re-exports Decimal128

    deserialize

    Re-exports deserialize

    Document

    Re-exports Document

    Double

    Re-exports Double

    Int32

    Re-exports Int32

    Long

    Re-exports Long

    MaxKey

    Re-exports MaxKey

    MinKey

    Re-exports MinKey

    ObjectId

    Re-exports ObjectId

    serialize

    Re-exports serialize

    Timestamp

    Re-exports Timestamp

    UUID

    Re-exports UUID

    Settings

    Member Visibility

    On This Page

    Other
    diff --git a/docs/6.10/modules/BSON.html b/docs/6.10/modules/BSON.html index 6d4b57ab13f..860c6ece56b 100644 --- a/docs/6.10/modules/BSON.html +++ b/docs/6.10/modules/BSON.html @@ -1,4 +1,4 @@ -BSON | mongodb

    Namespace BSON

    Index

    BSONType

    Binary +BSON | mongodb

    Namespace BSON

    Index

    BSONType

    Binary BSONRegExp BSONSymbol Code @@ -66,4 +66,4 @@ serialize serializeWithBufferAndIndex setInternalBufferSize -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/AbstractCursorEvents.html b/docs/6.10/types/AbstractCursorEvents.html index df5b07141fb..e4a6f169e95 100644 --- a/docs/6.10/types/AbstractCursorEvents.html +++ b/docs/6.10/types/AbstractCursorEvents.html @@ -1 +1 @@ -AbstractCursorEvents | mongodb

    Type Alias AbstractCursorEvents

    AbstractCursorEvents: {
        close(): void;
    }

    Settings

    Member Visibility
    +AbstractCursorEvents | mongodb

    Type Alias AbstractCursorEvents

    AbstractCursorEvents: {
        close(): void;
    }

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/AcceptedFields.html b/docs/6.10/types/AcceptedFields.html index 94253ddfef3..d324dd26350 100644 --- a/docs/6.10/types/AcceptedFields.html +++ b/docs/6.10/types/AcceptedFields.html @@ -1 +1 @@ -AcceptedFields | mongodb

    Type Alias AcceptedFields<TSchema, FieldType, AssignableType>

    AcceptedFields<TSchema, FieldType, AssignableType>: {
        readonly [key in KeysOfAType<TSchema, FieldType>]?: AssignableType
    }

    Type Parameters

    • TSchema
    • FieldType
    • AssignableType

    Settings

    Member Visibility
    +AcceptedFields | mongodb

    Type Alias AcceptedFields<TSchema, FieldType, AssignableType>

    AcceptedFields<TSchema, FieldType, AssignableType>: {
        readonly [key in KeysOfAType<TSchema, FieldType>]?: AssignableType
    }

    Type Parameters

    • TSchema
    • FieldType
    • AssignableType

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/AddToSetOperators.html b/docs/6.10/types/AddToSetOperators.html index c7562abf783..5be1629225d 100644 --- a/docs/6.10/types/AddToSetOperators.html +++ b/docs/6.10/types/AddToSetOperators.html @@ -1 +1 @@ -AddToSetOperators | mongodb

    Type Alias AddToSetOperators<Type>

    AddToSetOperators<Type>: {
        $each?: Flatten<Type>[];
    }

    Type Parameters

    • Type

    Settings

    Member Visibility
    +AddToSetOperators | mongodb

    Type Alias AddToSetOperators<Type>

    AddToSetOperators<Type>: {
        $each?: Flatten<Type>[];
    }

    Type Parameters

    • Type

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/AlternativeType.html b/docs/6.10/types/AlternativeType.html index 6db62b3fba3..7695a6d15ac 100644 --- a/docs/6.10/types/AlternativeType.html +++ b/docs/6.10/types/AlternativeType.html @@ -1,4 +1,4 @@ -AlternativeType | mongodb

    Type Alias AlternativeType<T>

    AlternativeType<T>: T extends ReadonlyArray<infer U>
        ? T | RegExpOrString<U>
        : RegExpOrString<T>

    It is possible to search using alternative types in mongodb e.g. +AlternativeType | mongodb

    Type Alias AlternativeType<T>

    AlternativeType<T>: T extends ReadonlyArray<infer U>
        ? T | RegExpOrString<U>
        : RegExpOrString<T>

    It is possible to search using alternative types in mongodb e.g. string types can be searched using a regex in mongo array types can be searched using their element type

    -

    Type Parameters

    • T

    Settings

    Member Visibility
    +

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/AnyBulkWriteOperation.html b/docs/6.10/types/AnyBulkWriteOperation.html index 265bbf3caea..9905e4e50cb 100644 --- a/docs/6.10/types/AnyBulkWriteOperation.html +++ b/docs/6.10/types/AnyBulkWriteOperation.html @@ -1 +1 @@ -AnyBulkWriteOperation | mongodb

    Type Alias AnyBulkWriteOperation<TSchema>

    AnyBulkWriteOperation<TSchema>:
        | {
            insertOne: InsertOneModel<TSchema>;
        }
        | {
            replaceOne: ReplaceOneModel<TSchema>;
        }
        | {
            updateOne: UpdateOneModel<TSchema>;
        }
        | {
            updateMany: UpdateManyModel<TSchema>;
        }
        | {
            deleteOne: DeleteOneModel<TSchema>;
        }
        | {
            deleteMany: DeleteManyModel<TSchema>;
        }

    Type Parameters

    Settings

    Member Visibility
    +AnyBulkWriteOperation | mongodb

    Type Alias AnyBulkWriteOperation<TSchema>

    AnyBulkWriteOperation<TSchema>:
        | {
            insertOne: InsertOneModel<TSchema>;
        }
        | {
            replaceOne: ReplaceOneModel<TSchema>;
        }
        | {
            updateOne: UpdateOneModel<TSchema>;
        }
        | {
            updateMany: UpdateManyModel<TSchema>;
        }
        | {
            deleteOne: DeleteOneModel<TSchema>;
        }
        | {
            deleteMany: DeleteManyModel<TSchema>;
        }

    Type Parameters

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/AnyClientBulkWriteModel.html b/docs/6.10/types/AnyClientBulkWriteModel.html index e98aed97cf8..ecdaf8f7dbc 100644 --- a/docs/6.10/types/AnyClientBulkWriteModel.html +++ b/docs/6.10/types/AnyClientBulkWriteModel.html @@ -1,3 +1,3 @@ -AnyClientBulkWriteModel | mongodb

    Type Alias AnyClientBulkWriteModel<TSchema>

    AnyClientBulkWriteModel<TSchema>:
        | ClientInsertOneModel<TSchema>
        | ClientReplaceOneModel<TSchema>
        | ClientUpdateOneModel<TSchema>
        | ClientUpdateManyModel<TSchema>
        | ClientDeleteOneModel<TSchema>
        | ClientDeleteManyModel<TSchema>

    Used to represent any of the client bulk write models that can be passed as an array +AnyClientBulkWriteModel | mongodb

    Type Alias AnyClientBulkWriteModel<TSchema>

    AnyClientBulkWriteModel<TSchema>:
        | ClientInsertOneModel<TSchema>
        | ClientReplaceOneModel<TSchema>
        | ClientUpdateOneModel<TSchema>
        | ClientUpdateManyModel<TSchema>
        | ClientDeleteOneModel<TSchema>
        | ClientDeleteManyModel<TSchema>

    Used to represent any of the client bulk write models that can be passed as an array to MongoClient#bulkWrite.

    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/AnyError.html b/docs/6.10/types/AnyError.html index 4db424c7315..acbba5ff1de 100644 --- a/docs/6.10/types/AnyError.html +++ b/docs/6.10/types/AnyError.html @@ -1 +1 @@ -AnyError | mongodb

    Type Alias AnyError

    AnyError: MongoError | Error

    Settings

    Member Visibility
    +AnyError | mongodb

    Type Alias AnyError

    AnyError: MongoError | Error

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ArrayElement.html b/docs/6.10/types/ArrayElement.html index c15fea44d6a..e5fa0b93a45 100644 --- a/docs/6.10/types/ArrayElement.html +++ b/docs/6.10/types/ArrayElement.html @@ -1 +1 @@ -ArrayElement | mongodb

    Type Alias ArrayElement<Type>

    ArrayElement<Type>: Type extends ReadonlyArray<infer Item>
        ? Item
        : never

    Type Parameters

    • Type

    Settings

    Member Visibility
    +ArrayElement | mongodb

    Type Alias ArrayElement<Type>

    ArrayElement<Type>: Type extends ReadonlyArray<infer Item>
        ? Item
        : never

    Type Parameters

    • Type

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ArrayOperator.html b/docs/6.10/types/ArrayOperator.html index c0284951805..be3a9a97829 100644 --- a/docs/6.10/types/ArrayOperator.html +++ b/docs/6.10/types/ArrayOperator.html @@ -1 +1 @@ -ArrayOperator | mongodb

    Type Alias ArrayOperator<Type>

    ArrayOperator<Type>: {
        $each?: Flatten<Type>[];
        $position?: number;
        $slice?: number;
        $sort?: Sort;
    }

    Type Parameters

    • Type

    Settings

    Member Visibility
    +ArrayOperator | mongodb

    Type Alias ArrayOperator<Type>

    ArrayOperator<Type>: {
        $each?: Flatten<Type>[];
        $position?: number;
        $slice?: number;
        $sort?: Sort;
    }

    Type Parameters

    • Type

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/AuthMechanism.html b/docs/6.10/types/AuthMechanism.html index afe1d40c9fd..07a7c9bde98 100644 --- a/docs/6.10/types/AuthMechanism.html +++ b/docs/6.10/types/AuthMechanism.html @@ -1 +1 @@ -AuthMechanism | mongodb

    Type Alias AuthMechanism

    AuthMechanism: typeof AuthMechanism[keyof typeof AuthMechanism]

    Settings

    Member Visibility
    +AuthMechanism | mongodb

    Type Alias AuthMechanism

    AuthMechanism: typeof AuthMechanism[keyof typeof AuthMechanism]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/AutoEncryptionExtraOptions.html b/docs/6.10/types/AutoEncryptionExtraOptions.html index 3fc2a907886..33653c6c36f 100644 --- a/docs/6.10/types/AutoEncryptionExtraOptions.html +++ b/docs/6.10/types/AutoEncryptionExtraOptions.html @@ -1,3 +1,3 @@ -AutoEncryptionExtraOptions | mongodb

    Type Alias AutoEncryptionExtraOptions

    AutoEncryptionExtraOptions: NonNullable<AutoEncryptionOptions["extraOptions"]>

    Extra options related to the mongocryptd process +AutoEncryptionExtraOptions | mongodb

    Type Alias AutoEncryptionExtraOptions

    AutoEncryptionExtraOptions: NonNullable<AutoEncryptionOptions["extraOptions"]>

    Extra options related to the mongocryptd process * Available in MongoDB 6.0 or higher.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/AutoEncryptionLoggerLevel.html b/docs/6.10/types/AutoEncryptionLoggerLevel.html index 8af7888c7ef..02f6334bef4 100644 --- a/docs/6.10/types/AutoEncryptionLoggerLevel.html +++ b/docs/6.10/types/AutoEncryptionLoggerLevel.html @@ -1,4 +1,4 @@ -AutoEncryptionLoggerLevel | mongodb

    Type Alias AutoEncryptionLoggerLevel

    AutoEncryptionLoggerLevel: typeof AutoEncryptionLoggerLevel[keyof typeof AutoEncryptionLoggerLevel]

    The level of severity of the log message

    +AutoEncryptionLoggerLevel | mongodb

    Type Alias AutoEncryptionLoggerLevel

    AutoEncryptionLoggerLevel: typeof AutoEncryptionLoggerLevel[keyof typeof AutoEncryptionLoggerLevel]

    The level of severity of the log message

    @@ -29,4 +29,4 @@
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/AzureKMSProviderConfiguration.html b/docs/6.10/types/AzureKMSProviderConfiguration.html index 6a60d5db598..567db9fa54f 100644 --- a/docs/6.10/types/AzureKMSProviderConfiguration.html +++ b/docs/6.10/types/AzureKMSProviderConfiguration.html @@ -1,4 +1,4 @@ -AzureKMSProviderConfiguration | mongodb

    Type Alias AzureKMSProviderConfiguration

    AzureKMSProviderConfiguration: {
        clientId: string;
        clientSecret: string;
        identityPlatformEndpoint?: string;
        tenantId: string;
    } | {
        accessToken: string;
    }

    Type declaration

    • clientId: string

      The client ID to authenticate a registered application

      +AzureKMSProviderConfiguration | mongodb

      Type Alias AzureKMSProviderConfiguration

      AzureKMSProviderConfiguration: {
          clientId: string;
          clientSecret: string;
          identityPlatformEndpoint?: string;
          tenantId: string;
      } | {
          accessToken: string;
      }

      Type declaration

      • clientId: string

        The client ID to authenticate a registered application

      • clientSecret: string

        The client secret to authenticate a registered application

      • OptionalidentityPlatformEndpoint?: string

        If present, a host with optional port. E.g. "example.com" or "example.com:443". This is optional, and only needed if customer is using a non-commercial Azure instance @@ -6,4 +6,4 @@ Defaults to "login.microsoftonline.com"

      • tenantId: string

        The tenant ID identifies the organization for the account

      Type declaration

      • accessToken: string

        If present, an access token to authenticate with Azure.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/BSON.BSONType.html b/docs/6.10/types/BSON.BSONType.html index 8b468cf3ded..0cf7a7b376d 100644 --- a/docs/6.10/types/BSON.BSONType.html +++ b/docs/6.10/types/BSON.BSONType.html @@ -1 +1 @@ -BSONType | mongodb

    Type Alias BSONType

    BSONType: typeof BSON.BSONType[keyof typeof BSON.BSONType]

    Settings

    Member Visibility
    +BSONType | mongodb

    Type Alias BSONType

    BSONType: typeof BSON.BSONType[keyof typeof BSON.BSONType]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/BSON.BinarySequence.html b/docs/6.10/types/BSON.BinarySequence.html index 3b2a6cd714b..c1333eeedba 100644 --- a/docs/6.10/types/BSON.BinarySequence.html +++ b/docs/6.10/types/BSON.BinarySequence.html @@ -1 +1 @@ -BinarySequence | mongodb

    Type Alias BinarySequence

    BinarySequence: Uint8Array | number[]

    Settings

    Member Visibility
    +BinarySequence | mongodb

    Type Alias BinarySequence

    BinarySequence: Uint8Array | number[]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/BSON.CalculateObjectSizeOptions.html b/docs/6.10/types/BSON.CalculateObjectSizeOptions.html index 15735bb1387..058d89c1744 100644 --- a/docs/6.10/types/BSON.CalculateObjectSizeOptions.html +++ b/docs/6.10/types/BSON.CalculateObjectSizeOptions.html @@ -1 +1 @@ -CalculateObjectSizeOptions | mongodb

    Type Alias CalculateObjectSizeOptions

    CalculateObjectSizeOptions: Pick<SerializeOptions, "serializeFunctions" | "ignoreUndefined">

    Settings

    Member Visibility
    +CalculateObjectSizeOptions | mongodb

    Type Alias CalculateObjectSizeOptions

    CalculateObjectSizeOptions: Pick<SerializeOptions, "serializeFunctions" | "ignoreUndefined">

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/BSON.EJSONOptions.html b/docs/6.10/types/BSON.EJSONOptions.html index aa67456725f..2a850f0540f 100644 --- a/docs/6.10/types/BSON.EJSONOptions.html +++ b/docs/6.10/types/BSON.EJSONOptions.html @@ -1,7 +1,7 @@ -EJSONOptions | mongodb

    Type Alias EJSONOptions

    EJSONOptions: {
        legacy?: boolean;
        relaxed?: boolean;
        useBigInt64?: boolean;
    }

    Type declaration

    • Optionallegacy?: boolean

      Output using the Extended JSON v1 spec

      +EJSONOptions | mongodb

      Type Alias EJSONOptions

      EJSONOptions: {
          legacy?: boolean;
          relaxed?: boolean;
          useBigInt64?: boolean;
      }

      Type declaration

      • Optionallegacy?: boolean

        Output using the Extended JSON v1 spec

        Default Value

        false

      • Optionalrelaxed?: boolean

        Enable Extended JSON's relaxed mode, which attempts to return native JS types where possible, rather than BSON types

        Default Value

        false

      • OptionaluseBigInt64?: boolean

        Enable native bigint support

        Default Value

        false

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/BSON.LongWithoutOverrides.html b/docs/6.10/types/BSON.LongWithoutOverrides.html index eb076279f4c..53b7ebcf784 100644 --- a/docs/6.10/types/BSON.LongWithoutOverrides.html +++ b/docs/6.10/types/BSON.LongWithoutOverrides.html @@ -1 +1 @@ -LongWithoutOverrides | mongodb

    Type Alias LongWithoutOverrides

    LongWithoutOverrides: (new (low: unknown, high?: number | boolean, unsigned?: boolean) => {
        [P in Exclude<keyof Long, TimestampOverrides>]: Long[P]
    })

    Settings

    Member Visibility
    +LongWithoutOverrides | mongodb

    Type Alias LongWithoutOverrides

    LongWithoutOverrides: (new (low: unknown, high?: number | boolean, unsigned?: boolean) => {
        [P in Exclude<keyof Long, TimestampOverrides>]: Long[P]
    })

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/BSON.OnDemand.html b/docs/6.10/types/BSON.OnDemand.html index 179eda11a73..976625d4738 100644 --- a/docs/6.10/types/BSON.OnDemand.html +++ b/docs/6.10/types/BSON.OnDemand.html @@ -1,2 +1,2 @@ -OnDemand | mongodb

    Type Alias OnDemandExperimental

    OnDemand: {
        BSONElement: BSONElement;
        ByteUtils: ByteUtils;
        NumberUtils: NumberUtils;
        parseToElements: ((this: void, bytes: Uint8Array, startOffset?: number) => Iterable<BSONElement>);
    }

    A new set of BSON APIs that are currently experimental and not intended for production use.

    -

    Settings

    Member Visibility
    +OnDemand | mongodb

    Type Alias OnDemandExperimental

    OnDemand: {
        BSONElement: BSONElement;
        ByteUtils: ByteUtils;
        NumberUtils: NumberUtils;
        parseToElements: ((this: void, bytes: Uint8Array, startOffset?: number) => Iterable<BSONElement>);
    }

    A new set of BSON APIs that are currently experimental and not intended for production use.

    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/BSON.TimestampOverrides.html b/docs/6.10/types/BSON.TimestampOverrides.html index d39917c40d8..80bd681ed57 100644 --- a/docs/6.10/types/BSON.TimestampOverrides.html +++ b/docs/6.10/types/BSON.TimestampOverrides.html @@ -1 +1 @@ -TimestampOverrides | mongodb

    Type Alias TimestampOverrides

    TimestampOverrides:
        | "_bsontype"
        | "toExtendedJSON"
        | "fromExtendedJSON"
        | "inspect"

    Settings

    Member Visibility
    +TimestampOverrides | mongodb

    Type Alias TimestampOverrides

    TimestampOverrides:
        | "_bsontype"
        | "toExtendedJSON"
        | "fromExtendedJSON"
        | "inspect"

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/BSON.UUIDExtended.html b/docs/6.10/types/BSON.UUIDExtended.html index 951206f18fd..d3586ce02f0 100644 --- a/docs/6.10/types/BSON.UUIDExtended.html +++ b/docs/6.10/types/BSON.UUIDExtended.html @@ -1 +1 @@ -UUIDExtended | mongodb

    Type Alias UUIDExtended

    UUIDExtended: {
        $uuid: string;
    }

    Settings

    Member Visibility
    +UUIDExtended | mongodb

    Type Alias UUIDExtended

    UUIDExtended: {
        $uuid: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/BSONTypeAlias.html b/docs/6.10/types/BSONTypeAlias.html index 2fa538dfde8..bd15107c78e 100644 --- a/docs/6.10/types/BSONTypeAlias.html +++ b/docs/6.10/types/BSONTypeAlias.html @@ -1 +1 @@ -BSONTypeAlias | mongodb

    Type Alias BSONTypeAlias

    BSONTypeAlias: keyof typeof BSON.BSONType

    Settings

    Member Visibility
    +BSONTypeAlias | mongodb

    Type Alias BSONTypeAlias

    BSONTypeAlias: keyof typeof BSON.BSONType

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/BatchType.html b/docs/6.10/types/BatchType.html index b888d4f2e90..81d061f8428 100644 --- a/docs/6.10/types/BatchType.html +++ b/docs/6.10/types/BatchType.html @@ -1 +1 @@ -BatchType | mongodb

    Type Alias BatchType

    BatchType: typeof BatchType[keyof typeof BatchType]

    Settings

    Member Visibility
    +BatchType | mongodb

    Type Alias BatchType

    BatchType: typeof BatchType[keyof typeof BatchType]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/BitwiseFilter.html b/docs/6.10/types/BitwiseFilter.html index 7caf86e4611..9978b476623 100644 --- a/docs/6.10/types/BitwiseFilter.html +++ b/docs/6.10/types/BitwiseFilter.html @@ -1 +1 @@ -BitwiseFilter | mongodb

    Type Alias BitwiseFilter

    BitwiseFilter: number | Binary | ReadonlyArray<number>

    Settings

    Member Visibility
    +BitwiseFilter | mongodb

    Type Alias BitwiseFilter

    BitwiseFilter: number | Binary | ReadonlyArray<number>

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/CSFLEKMSTlsOptions.html b/docs/6.10/types/CSFLEKMSTlsOptions.html index 27db5544227..ecf2e148f79 100644 --- a/docs/6.10/types/CSFLEKMSTlsOptions.html +++ b/docs/6.10/types/CSFLEKMSTlsOptions.html @@ -1 +1 @@ -CSFLEKMSTlsOptions | mongodb

    Type Alias CSFLEKMSTlsOptions

    CSFLEKMSTlsOptions: {
        aws?: ClientEncryptionTlsOptions;
        azure?: ClientEncryptionTlsOptions;
        gcp?: ClientEncryptionTlsOptions;
        kmip?: ClientEncryptionTlsOptions;
        local?: ClientEncryptionTlsOptions;
        [key: string]: ClientEncryptionTlsOptions | undefined;
    }

    Settings

    Member Visibility
    +CSFLEKMSTlsOptions | mongodb

    Type Alias CSFLEKMSTlsOptions

    CSFLEKMSTlsOptions: {
        aws?: ClientEncryptionTlsOptions;
        azure?: ClientEncryptionTlsOptions;
        gcp?: ClientEncryptionTlsOptions;
        kmip?: ClientEncryptionTlsOptions;
        local?: ClientEncryptionTlsOptions;
        [key: string]: ClientEncryptionTlsOptions | undefined;
    }

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/Callback.html b/docs/6.10/types/Callback.html index dd37a560439..1acd2504229 100644 --- a/docs/6.10/types/Callback.html +++ b/docs/6.10/types/Callback.html @@ -1,2 +1,2 @@ -Callback | mongodb

    Type Alias Callback<T>

    Callback<T>: ((error?: AnyError, result?: T) => void)

    MongoDB Driver style callback

    -

    Type Parameters

    • T = any

    Settings

    Member Visibility
    +Callback | mongodb

    Type Alias Callback<T>

    Callback<T>: ((error?: AnyError, result?: T) => void)

    MongoDB Driver style callback

    +

    Type Parameters

    • T = any

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ChangeStreamDocument.html b/docs/6.10/types/ChangeStreamDocument.html index 3007520115f..ff1413a6e68 100644 --- a/docs/6.10/types/ChangeStreamDocument.html +++ b/docs/6.10/types/ChangeStreamDocument.html @@ -1 +1 @@ -ChangeStreamDocument | mongodb

    Type Alias ChangeStreamDocument<TSchema>

    ChangeStreamDocument<TSchema>:
        | ChangeStreamInsertDocument<TSchema>
        | ChangeStreamUpdateDocument<TSchema>
        | ChangeStreamReplaceDocument<TSchema>
        | ChangeStreamDeleteDocument<TSchema>
        | ChangeStreamDropDocument
        | ChangeStreamRenameDocument
        | ChangeStreamDropDatabaseDocument
        | ChangeStreamInvalidateDocument
        | ChangeStreamCreateIndexDocument
        | ChangeStreamCreateDocument
        | ChangeStreamCollModDocument
        | ChangeStreamDropIndexDocument
        | ChangeStreamShardCollectionDocument
        | ChangeStreamReshardCollectionDocument
        | ChangeStreamRefineCollectionShardKeyDocument

    Type Parameters

    Settings

    Member Visibility
    +ChangeStreamDocument | mongodb

    Type Alias ChangeStreamDocument<TSchema>

    ChangeStreamDocument<TSchema>:
        | ChangeStreamInsertDocument<TSchema>
        | ChangeStreamUpdateDocument<TSchema>
        | ChangeStreamReplaceDocument<TSchema>
        | ChangeStreamDeleteDocument<TSchema>
        | ChangeStreamDropDocument
        | ChangeStreamRenameDocument
        | ChangeStreamDropDatabaseDocument
        | ChangeStreamInvalidateDocument
        | ChangeStreamCreateIndexDocument
        | ChangeStreamCreateDocument
        | ChangeStreamCollModDocument
        | ChangeStreamDropIndexDocument
        | ChangeStreamShardCollectionDocument
        | ChangeStreamReshardCollectionDocument
        | ChangeStreamRefineCollectionShardKeyDocument

    Type Parameters

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ChangeStreamEvents.html b/docs/6.10/types/ChangeStreamEvents.html index abc46346fc7..cb385606965 100644 --- a/docs/6.10/types/ChangeStreamEvents.html +++ b/docs/6.10/types/ChangeStreamEvents.html @@ -1 +1 @@ -ChangeStreamEvents | mongodb

    Type Alias ChangeStreamEvents<TSchema, TChange>

    ChangeStreamEvents<TSchema, TChange>: {
        change(change: TChange): void;
        end(): void;
        error(error: Error): void;
        init(response: any): void;
        more(response?: any): void;
        response(): void;
        resumeTokenChanged(token: unknown): void;
    } & AbstractCursorEvents

    Type Parameters

    Settings

    Member Visibility
    +ChangeStreamEvents | mongodb

    Type Alias ChangeStreamEvents<TSchema, TChange>

    ChangeStreamEvents<TSchema, TChange>: {
        change(change: TChange): void;
        end(): void;
        error(error: Error): void;
        init(response: any): void;
        more(response?: any): void;
        response(): void;
        resumeTokenChanged(token: unknown): void;
    } & AbstractCursorEvents

    Type Parameters

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ClientBulkWriteModel.html b/docs/6.10/types/ClientBulkWriteModel.html index d0503f1a194..52770858c1c 100644 --- a/docs/6.10/types/ClientBulkWriteModel.html +++ b/docs/6.10/types/ClientBulkWriteModel.html @@ -1,6 +1,6 @@ -ClientBulkWriteModel | mongodb

    Type Alias ClientBulkWriteModel<SchemaMap>

    ClientBulkWriteModel<SchemaMap>: {
        [Namespace in keyof SchemaMap]: AnyClientBulkWriteModel<SchemaMap[Namespace]> & {
            namespace: Namespace;
        }
    }[keyof SchemaMap]

    A mapping of namespace strings to collections schemas.

    +ClientBulkWriteModel | mongodb

    Type Alias ClientBulkWriteModel<SchemaMap>

    ClientBulkWriteModel<SchemaMap>: {
        [Namespace in keyof SchemaMap]: AnyClientBulkWriteModel<SchemaMap[Namespace]> & {
            namespace: Namespace;
        }
    }[keyof SchemaMap]

    A mapping of namespace strings to collections schemas.

    Type Parameters

    Example

    type MongoDBSchemas = {
      'db.books': Book;
      'db.authors': Author;
    }

    const model: ClientBulkWriteModel<MongoDBSchemas> = {
      namespace: 'db.books'
      name: 'insertOne',
      document: { title: 'Practical MongoDB Aggregations', authorName: 3 } // error `authorName` cannot be number
    };

    The type of the namespace field narrows other parts of the BulkWriteModel to use the correct schema for type assertions.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ClientEncryptionDataKeyProvider.html b/docs/6.10/types/ClientEncryptionDataKeyProvider.html index 301f85f0bc5..0fc1ca6f3d9 100644 --- a/docs/6.10/types/ClientEncryptionDataKeyProvider.html +++ b/docs/6.10/types/ClientEncryptionDataKeyProvider.html @@ -1,8 +1,8 @@ -ClientEncryptionDataKeyProvider | mongodb

    Type Alias ClientEncryptionDataKeyProvider

    ClientEncryptionDataKeyProvider: keyof KMSProviders

    A data key provider. Allowed values:

    +ClientEncryptionDataKeyProvider | mongodb

    Type Alias ClientEncryptionDataKeyProvider

    ClientEncryptionDataKeyProvider: keyof KMSProviders

    A data key provider. Allowed values:

    • aws, gcp, local, kmip or azure
    • (mongodb-client-encryption>=6.0.1 only) a named key, in the form of: aws:<name>, gcp:<name>, local:<name>, kmip:<name>, azure:<name> where name is an alphanumeric string, underscores allowed.
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ClientEncryptionSocketOptions.html b/docs/6.10/types/ClientEncryptionSocketOptions.html index d18bf7e06f2..f5d1a2da2fc 100644 --- a/docs/6.10/types/ClientEncryptionSocketOptions.html +++ b/docs/6.10/types/ClientEncryptionSocketOptions.html @@ -1,2 +1,2 @@ -ClientEncryptionSocketOptions | mongodb

    Type Alias ClientEncryptionSocketOptions

    ClientEncryptionSocketOptions: Pick<MongoClientOptions, "autoSelectFamily" | "autoSelectFamilyAttemptTimeout">

    Socket options to use for KMS requests.

    -

    Settings

    Member Visibility
    +ClientEncryptionSocketOptions | mongodb

    Type Alias ClientEncryptionSocketOptions

    ClientEncryptionSocketOptions: Pick<MongoClientOptions, "autoSelectFamily" | "autoSelectFamilyAttemptTimeout">

    Socket options to use for KMS requests.

    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ClientEncryptionTlsOptions.html b/docs/6.10/types/ClientEncryptionTlsOptions.html index 550cf6ecaca..64870b83276 100644 --- a/docs/6.10/types/ClientEncryptionTlsOptions.html +++ b/docs/6.10/types/ClientEncryptionTlsOptions.html @@ -1,4 +1,4 @@ -ClientEncryptionTlsOptions | mongodb

    Type Alias ClientEncryptionTlsOptions

    ClientEncryptionTlsOptions: Pick<MongoClientOptions, "tlsCAFile" | "tlsCertificateKeyFile" | "tlsCertificateKeyFilePassword">

    TLS options to use when connecting. The spec specifically calls out which insecure +ClientEncryptionTlsOptions | mongodb

    Type Alias ClientEncryptionTlsOptions

    ClientEncryptionTlsOptions: Pick<MongoClientOptions, "tlsCAFile" | "tlsCertificateKeyFile" | "tlsCertificateKeyFilePassword">

    TLS options to use when connecting. The spec specifically calls out which insecure tls options are not allowed:

    • tlsAllowInvalidCertificates
      • @@ -6,4 +6,4 @@
    • tlsInsecure

    These options are not included in the type, and are ignored if provided.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ClientSessionEvents.html b/docs/6.10/types/ClientSessionEvents.html index 887ae11d4a0..0fc6948552c 100644 --- a/docs/6.10/types/ClientSessionEvents.html +++ b/docs/6.10/types/ClientSessionEvents.html @@ -1 +1 @@ -ClientSessionEvents | mongodb

    Type Alias ClientSessionEvents

    ClientSessionEvents: {
        ended(session: ClientSession): void;
    }

    Settings

    Member Visibility
    +ClientSessionEvents | mongodb

    Type Alias ClientSessionEvents

    ClientSessionEvents: {
        ended(session: ClientSession): void;
    }

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/CommonEvents.html b/docs/6.10/types/CommonEvents.html index 0eae9cda6b5..a7ea71ac160 100644 --- a/docs/6.10/types/CommonEvents.html +++ b/docs/6.10/types/CommonEvents.html @@ -1 +1 @@ -CommonEvents | mongodb

    Type Alias CommonEvents

    CommonEvents: "newListener" | "removeListener"

    Settings

    Member Visibility
    +CommonEvents | mongodb

    Type Alias CommonEvents

    CommonEvents: "newListener" | "removeListener"

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/Compressor.html b/docs/6.10/types/Compressor.html index 61f81ce5be7..9218d259bd5 100644 --- a/docs/6.10/types/Compressor.html +++ b/docs/6.10/types/Compressor.html @@ -1 +1 @@ -Compressor | mongodb

    Type Alias Compressor

    Compressor: typeof Compressor[CompressorName]

    Settings

    Member Visibility
    +Compressor | mongodb

    Type Alias Compressor

    Compressor: typeof Compressor[CompressorName]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/CompressorName.html b/docs/6.10/types/CompressorName.html index e5c3af26436..5fdd116e3c6 100644 --- a/docs/6.10/types/CompressorName.html +++ b/docs/6.10/types/CompressorName.html @@ -1 +1 @@ -CompressorName | mongodb

    Type Alias CompressorName

    CompressorName: keyof typeof Compressor

    Settings

    Member Visibility
    +CompressorName | mongodb

    Type Alias CompressorName

    CompressorName: keyof typeof Compressor

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/Condition.html b/docs/6.10/types/Condition.html index 73b68b04e61..65acaaebd78 100644 --- a/docs/6.10/types/Condition.html +++ b/docs/6.10/types/Condition.html @@ -1 +1 @@ -Condition | mongodb

    Type Alias Condition<T>

    Condition<T>: AlternativeType<T> | FilterOperators<AlternativeType<T>>

    Type Parameters

    • T

    Settings

    Member Visibility
    +Condition | mongodb

    Type Alias Condition<T>

    Condition<T>: AlternativeType<T> | FilterOperators<AlternativeType<T>>

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ConnectionEvents.html b/docs/6.10/types/ConnectionEvents.html index 6a9d4db89df..b022cb33bcc 100644 --- a/docs/6.10/types/ConnectionEvents.html +++ b/docs/6.10/types/ConnectionEvents.html @@ -1 +1 @@ -ConnectionEvents | mongodb

    Type Alias ConnectionEvents

    ConnectionEvents: {
        close(): void;
        clusterTimeReceived(clusterTime: Document): void;
        commandFailed(event: CommandFailedEvent): void;
        commandStarted(event: CommandStartedEvent): void;
        commandSucceeded(event: CommandSucceededEvent): void;
        pinned(pinType: string): void;
        unpinned(pinType: string): void;
    }

    Settings

    Member Visibility
    +ConnectionEvents | mongodb

    Type Alias ConnectionEvents

    ConnectionEvents: {
        close(): void;
        clusterTimeReceived(clusterTime: Document): void;
        commandFailed(event: CommandFailedEvent): void;
        commandStarted(event: CommandStartedEvent): void;
        commandSucceeded(event: CommandSucceededEvent): void;
        pinned(pinType: string): void;
        unpinned(pinType: string): void;
    }

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ConnectionPoolEvents.html b/docs/6.10/types/ConnectionPoolEvents.html index 9daf1b9aea0..9cc9ee228f2 100644 --- a/docs/6.10/types/ConnectionPoolEvents.html +++ b/docs/6.10/types/ConnectionPoolEvents.html @@ -1 +1 @@ -ConnectionPoolEvents | mongodb

    Type Alias ConnectionPoolEvents

    ConnectionPoolEvents: {
        connectionCheckedIn(event: ConnectionCheckedInEvent): void;
        connectionCheckedOut(event: ConnectionCheckedOutEvent): void;
        connectionCheckOutFailed(event: ConnectionCheckOutFailedEvent): void;
        connectionCheckOutStarted(event: ConnectionCheckOutStartedEvent): void;
        connectionClosed(event: ConnectionClosedEvent): void;
        connectionCreated(event: ConnectionCreatedEvent): void;
        connectionPoolCleared(event: ConnectionPoolClearedEvent): void;
        connectionPoolClosed(event: ConnectionPoolClosedEvent): void;
        connectionPoolCreated(event: ConnectionPoolCreatedEvent): void;
        connectionPoolReady(event: ConnectionPoolReadyEvent): void;
        connectionReady(event: ConnectionReadyEvent): void;
    } & Omit<ConnectionEvents, "close" | "message">

    Settings

    Member Visibility
    +ConnectionPoolEvents | mongodb

    Type Alias ConnectionPoolEvents

    ConnectionPoolEvents: {
        connectionCheckedIn(event: ConnectionCheckedInEvent): void;
        connectionCheckedOut(event: ConnectionCheckedOutEvent): void;
        connectionCheckOutFailed(event: ConnectionCheckOutFailedEvent): void;
        connectionCheckOutStarted(event: ConnectionCheckOutStartedEvent): void;
        connectionClosed(event: ConnectionClosedEvent): void;
        connectionCreated(event: ConnectionCreatedEvent): void;
        connectionPoolCleared(event: ConnectionPoolClearedEvent): void;
        connectionPoolClosed(event: ConnectionPoolClosedEvent): void;
        connectionPoolCreated(event: ConnectionPoolCreatedEvent): void;
        connectionPoolReady(event: ConnectionPoolReadyEvent): void;
        connectionReady(event: ConnectionReadyEvent): void;
    } & Omit<ConnectionEvents, "close" | "message">

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/CursorFlag.html b/docs/6.10/types/CursorFlag.html index b240aff0764..5635e835cf1 100644 --- a/docs/6.10/types/CursorFlag.html +++ b/docs/6.10/types/CursorFlag.html @@ -1 +1 @@ -CursorFlag | mongodb

    Type Alias CursorFlag

    CursorFlag: typeof CURSOR_FLAGS[number]

    Settings

    Member Visibility
    +CursorFlag | mongodb

    Type Alias CursorFlag

    CursorFlag: typeof CURSOR_FLAGS[number]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/DistinctOptions.html b/docs/6.10/types/DistinctOptions.html index 1128b5db06a..03ddd99c9fb 100644 --- a/docs/6.10/types/DistinctOptions.html +++ b/docs/6.10/types/DistinctOptions.html @@ -1 +1 @@ -DistinctOptions | mongodb

    Type Alias DistinctOptions

    DistinctOptions: CommandOperationOptions

    Settings

    Member Visibility
    +DistinctOptions | mongodb

    Type Alias DistinctOptions

    DistinctOptions: CommandOperationOptions

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/DropDatabaseOptions.html b/docs/6.10/types/DropDatabaseOptions.html index 9eb7406eb2b..350f38d5802 100644 --- a/docs/6.10/types/DropDatabaseOptions.html +++ b/docs/6.10/types/DropDatabaseOptions.html @@ -1 +1 @@ -DropDatabaseOptions | mongodb

    Type Alias DropDatabaseOptions

    DropDatabaseOptions: CommandOperationOptions

    Settings

    Member Visibility
    +DropDatabaseOptions | mongodb

    Type Alias DropDatabaseOptions

    DropDatabaseOptions: CommandOperationOptions

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/DropIndexesOptions.html b/docs/6.10/types/DropIndexesOptions.html index dc33540b868..0d1839ed282 100644 --- a/docs/6.10/types/DropIndexesOptions.html +++ b/docs/6.10/types/DropIndexesOptions.html @@ -1 +1 @@ -DropIndexesOptions | mongodb

    Type Alias DropIndexesOptions

    DropIndexesOptions: CommandOperationOptions

    Settings

    Member Visibility
    +DropIndexesOptions | mongodb

    Type Alias DropIndexesOptions

    DropIndexesOptions: CommandOperationOptions

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/EnhancedOmit.html b/docs/6.10/types/EnhancedOmit.html index 9fda60108a5..03a1ec741d4 100644 --- a/docs/6.10/types/EnhancedOmit.html +++ b/docs/6.10/types/EnhancedOmit.html @@ -1,2 +1,2 @@ -EnhancedOmit | mongodb

    Type Alias EnhancedOmit<TRecordOrUnion, KeyUnion>

    EnhancedOmit<TRecordOrUnion, KeyUnion>: string extends keyof TRecordOrUnion
        ? TRecordOrUnion
        : TRecordOrUnion extends any
            ? Pick<TRecordOrUnion, Exclude<keyof TRecordOrUnion, KeyUnion>>
            : never

    TypeScript Omit (Exclude to be specific) does not work for objects with an "any" indexed type, and breaks discriminated unions

    -

    Type Parameters

    • TRecordOrUnion
    • KeyUnion

    Settings

    Member Visibility
    +EnhancedOmit | mongodb

    Type Alias EnhancedOmit<TRecordOrUnion, KeyUnion>

    EnhancedOmit<TRecordOrUnion, KeyUnion>: string extends keyof TRecordOrUnion
        ? TRecordOrUnion
        : TRecordOrUnion extends any
            ? Pick<TRecordOrUnion, Exclude<keyof TRecordOrUnion, KeyUnion>>
            : never

    TypeScript Omit (Exclude to be specific) does not work for objects with an "any" indexed type, and breaks discriminated unions

    +

    Type Parameters

    • TRecordOrUnion
    • KeyUnion

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/EventEmitterWithState.html b/docs/6.10/types/EventEmitterWithState.html index c11f52d2001..8e372338663 100644 --- a/docs/6.10/types/EventEmitterWithState.html +++ b/docs/6.10/types/EventEmitterWithState.html @@ -1 +1 @@ -EventEmitterWithState | mongodb

    Type Alias EventEmitterWithState

    EventEmitterWithState: {}

    Settings

    Member Visibility
    +EventEmitterWithState | mongodb

    Type Alias EventEmitterWithState

    EventEmitterWithState: {}

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/EventsDescription.html b/docs/6.10/types/EventsDescription.html index 96dd63807c1..e5f9789baf4 100644 --- a/docs/6.10/types/EventsDescription.html +++ b/docs/6.10/types/EventsDescription.html @@ -1,2 +1,2 @@ -EventsDescription | mongodb

    Type Alias EventsDescription

    EventsDescription: Record<string, GenericListener>

    Event description type

    -

    Settings

    Member Visibility
    +EventsDescription | mongodb

    Type Alias EventsDescription

    EventsDescription: Record<string, GenericListener>

    Event description type

    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ExplainVerbosity.html b/docs/6.10/types/ExplainVerbosity.html index 68caf0aeafc..d88de274b38 100644 --- a/docs/6.10/types/ExplainVerbosity.html +++ b/docs/6.10/types/ExplainVerbosity.html @@ -1 +1 @@ -ExplainVerbosity | mongodb

    Type Alias ExplainVerbosity

    ExplainVerbosity: string

    Settings

    Member Visibility
    +ExplainVerbosity | mongodb

    Type Alias ExplainVerbosity

    ExplainVerbosity: string

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ExplainVerbosityLike.html b/docs/6.10/types/ExplainVerbosityLike.html index 988311d1b2c..5c66508a44e 100644 --- a/docs/6.10/types/ExplainVerbosityLike.html +++ b/docs/6.10/types/ExplainVerbosityLike.html @@ -1,3 +1,3 @@ -ExplainVerbosityLike | mongodb

    Type Alias ExplainVerbosityLike

    ExplainVerbosityLike: ExplainVerbosity | boolean

    For backwards compatibility, true is interpreted as "allPlansExecution" +ExplainVerbosityLike | mongodb

    Type Alias ExplainVerbosityLike

    ExplainVerbosityLike: ExplainVerbosity | boolean

    For backwards compatibility, true is interpreted as "allPlansExecution" and false as "queryPlanner".

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/Filter.html b/docs/6.10/types/Filter.html index 4e33c61dab8..8aa35c7031c 100644 --- a/docs/6.10/types/Filter.html +++ b/docs/6.10/types/Filter.html @@ -1,2 +1,2 @@ -Filter | mongodb

    Type Alias Filter<TSchema>

    Filter<TSchema>: {
        [P in keyof WithId<TSchema>]?: Condition<WithId<TSchema>[P]>
    } & RootFilterOperators<WithId<TSchema>>

    A MongoDB filter can be some portion of the schema or a set of operators

    -

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +Filter | mongodb

    Type Alias Filter<TSchema>

    Filter<TSchema>: {
        [P in keyof WithId<TSchema>]?: Condition<WithId<TSchema>[P]>
    } & RootFilterOperators<WithId<TSchema>>

    A MongoDB filter can be some portion of the schema or a set of operators

    +

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/FilterOperations.html b/docs/6.10/types/FilterOperations.html index b1f19e35b18..82f6dd5ff93 100644 --- a/docs/6.10/types/FilterOperations.html +++ b/docs/6.10/types/FilterOperations.html @@ -1 +1 @@ -FilterOperations | mongodb

    Type Alias FilterOperations<T>

    FilterOperations<T>: T extends Record<string, any>
        ? {
            [key in keyof T]?: FilterOperators<T[key]>
        }
        : FilterOperators<T>

    Type Parameters

    • T

    Settings

    Member Visibility
    +FilterOperations | mongodb

    Type Alias FilterOperations<T>

    FilterOperations<T>: T extends Record<string, any>
        ? {
            [key in keyof T]?: FilterOperators<T[key]>
        }
        : FilterOperators<T>

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/Flatten.html b/docs/6.10/types/Flatten.html index af8ba955e8b..50964ce5e70 100644 --- a/docs/6.10/types/Flatten.html +++ b/docs/6.10/types/Flatten.html @@ -1 +1 @@ -Flatten | mongodb

    Type Alias Flatten<Type>

    Flatten<Type>: Type extends ReadonlyArray<infer Item>
        ? Item
        : Type

    Type Parameters

    • Type

    Settings

    Member Visibility
    +Flatten | mongodb

    Type Alias Flatten<Type>

    Flatten<Type>: Type extends ReadonlyArray<infer Item>
        ? Item
        : Type

    Type Parameters

    • Type

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/GCPKMSProviderConfiguration.html b/docs/6.10/types/GCPKMSProviderConfiguration.html index 72010fa39e2..ffb718abc2d 100644 --- a/docs/6.10/types/GCPKMSProviderConfiguration.html +++ b/docs/6.10/types/GCPKMSProviderConfiguration.html @@ -1,6 +1,6 @@ -GCPKMSProviderConfiguration | mongodb

    Type Alias GCPKMSProviderConfiguration

    GCPKMSProviderConfiguration: {
        email: string;
        endpoint?: string;
        privateKey: string | Buffer;
    } | {
        accessToken: string;
    }

    Type declaration

    • email: string

      The service account email to authenticate

      +GCPKMSProviderConfiguration | mongodb

      Type Alias GCPKMSProviderConfiguration

      GCPKMSProviderConfiguration: {
          email: string;
          endpoint?: string;
          privateKey: string | Buffer;
      } | {
          accessToken: string;
      }

      Type declaration

      • email: string

        The service account email to authenticate

      • Optionalendpoint?: string

        If present, a host with optional port. E.g. "example.com" or "example.com:443". Defaults to "oauth2.googleapis.com"

      • privateKey: string | Buffer

        A PKCS#8 encrypted key. This can either be a base64 string or a binary representation

      Type declaration

      • accessToken: string

        If present, an access token to authenticate with GCP.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/GSSAPICanonicalizationValue.html b/docs/6.10/types/GSSAPICanonicalizationValue.html index 7a6acb22406..159f59858a7 100644 --- a/docs/6.10/types/GSSAPICanonicalizationValue.html +++ b/docs/6.10/types/GSSAPICanonicalizationValue.html @@ -1 +1 @@ -GSSAPICanonicalizationValue | mongodb

    Type Alias GSSAPICanonicalizationValue

    GSSAPICanonicalizationValue: typeof GSSAPICanonicalizationValue[keyof typeof GSSAPICanonicalizationValue]

    Settings

    Member Visibility
    +GSSAPICanonicalizationValue | mongodb

    Type Alias GSSAPICanonicalizationValue

    GSSAPICanonicalizationValue: typeof GSSAPICanonicalizationValue[keyof typeof GSSAPICanonicalizationValue]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/GenericListener.html b/docs/6.10/types/GenericListener.html index 68d9b56ef04..eaef0a3aad7 100644 --- a/docs/6.10/types/GenericListener.html +++ b/docs/6.10/types/GenericListener.html @@ -1 +1 @@ -GenericListener | mongodb

    Type Alias GenericListener

    GenericListener: ((...args: any[]) => void)

    Settings

    Member Visibility
    +GenericListener | mongodb

    Type Alias GenericListener

    GenericListener: ((...args: any[]) => void)

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/GridFSBucketEvents.html b/docs/6.10/types/GridFSBucketEvents.html index 32d05762236..b8dc7e78049 100644 --- a/docs/6.10/types/GridFSBucketEvents.html +++ b/docs/6.10/types/GridFSBucketEvents.html @@ -1 +1 @@ -GridFSBucketEvents | mongodb

    Type Alias GridFSBucketEvents

    GridFSBucketEvents: {
        index(): void;
    }

    Settings

    Member Visibility
    +GridFSBucketEvents | mongodb

    Type Alias GridFSBucketEvents

    GridFSBucketEvents: {
        index(): void;
    }

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/Hint.html b/docs/6.10/types/Hint.html index 1e8a6abbe07..b57008ab410 100644 --- a/docs/6.10/types/Hint.html +++ b/docs/6.10/types/Hint.html @@ -1 +1 @@ -Hint | mongodb

    Type Alias Hint

    Hint: string | Document

    Settings

    Member Visibility
    +Hint | mongodb

    Type Alias Hint

    Hint: string | Document

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/IndexDescriptionCompact.html b/docs/6.10/types/IndexDescriptionCompact.html index eaf5edb6827..2e60c3fe85d 100644 --- a/docs/6.10/types/IndexDescriptionCompact.html +++ b/docs/6.10/types/IndexDescriptionCompact.html @@ -1 +1 @@ -IndexDescriptionCompact | mongodb

    Type Alias IndexDescriptionCompact

    IndexDescriptionCompact: Record<string, [name: string, direction: IndexDirection][]>

    Settings

    Member Visibility
    +IndexDescriptionCompact | mongodb

    Type Alias IndexDescriptionCompact

    IndexDescriptionCompact: Record<string, [name: string, direction: IndexDirection][]>

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/IndexDescriptionInfo.html b/docs/6.10/types/IndexDescriptionInfo.html index ced7a33a730..79d15e0ae3c 100644 --- a/docs/6.10/types/IndexDescriptionInfo.html +++ b/docs/6.10/types/IndexDescriptionInfo.html @@ -1,2 +1,2 @@ -IndexDescriptionInfo | mongodb

    Type Alias IndexDescriptionInfo

    IndexDescriptionInfo: Omit<IndexDescription, "key" | "version"> & {
        key: {
            [key: string]: IndexDirection;
        };
        v?: IndexDescription["version"];
    } & Document

    The index information returned by the listIndexes command. https://www.mongodb.com/docs/manual/reference/command/listIndexes/#mongodb-dbcommand-dbcmd.listIndexes

    -

    Settings

    Member Visibility
    +IndexDescriptionInfo | mongodb

    Type Alias IndexDescriptionInfo

    IndexDescriptionInfo: Omit<IndexDescription, "key" | "version"> & {
        key: {
            [key: string]: IndexDirection;
        };
        v?: IndexDescription["version"];
    } & Document

    The index information returned by the listIndexes command. https://www.mongodb.com/docs/manual/reference/command/listIndexes/#mongodb-dbcommand-dbcmd.listIndexes

    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/IndexDirection.html b/docs/6.10/types/IndexDirection.html index 5f498b574e7..b47a70d094f 100644 --- a/docs/6.10/types/IndexDirection.html +++ b/docs/6.10/types/IndexDirection.html @@ -1 +1 @@ -IndexDirection | mongodb

    Type Alias IndexDirection

    IndexDirection:
        | -1
        | 1
        | "2d"
        | "2dsphere"
        | "text"
        | "geoHaystack"
        | "hashed"
        | number

    Settings

    Member Visibility
    +IndexDirection | mongodb

    Type Alias IndexDirection

    IndexDirection:
        | -1
        | 1
        | "2d"
        | "2dsphere"
        | "text"
        | "geoHaystack"
        | "hashed"
        | number

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/IndexSpecification.html b/docs/6.10/types/IndexSpecification.html index e7c9306990f..b52793314d2 100644 --- a/docs/6.10/types/IndexSpecification.html +++ b/docs/6.10/types/IndexSpecification.html @@ -1 +1 @@ -IndexSpecification | mongodb

    Type Alias IndexSpecification

    IndexSpecification: OneOrMore<
        | string
        | [string, IndexDirection]
        | {
            [key: string]: IndexDirection;
        }
        | Map<string, IndexDirection>>

    Settings

    Member Visibility
    +IndexSpecification | mongodb

    Type Alias IndexSpecification

    IndexSpecification: OneOrMore<
        | string
        | [string, IndexDirection]
        | {
            [key: string]: IndexDirection;
        }
        | Map<string, IndexDirection>>

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/InferIdType.html b/docs/6.10/types/InferIdType.html index 97fec0281de..6e0525e6398 100644 --- a/docs/6.10/types/InferIdType.html +++ b/docs/6.10/types/InferIdType.html @@ -1,2 +1,2 @@ -InferIdType | mongodb

    Type Alias InferIdType<TSchema>

    InferIdType<TSchema>: TSchema extends {
            _id: infer IdType;
        }
        ? Record<any, never> extends IdType
            ? never
            : IdType
        : TSchema extends {
                _id?: infer IdType;
            }
            ? unknown extends IdType
                ? ObjectId
                : IdType
            : ObjectId

    Given an object shaped type, return the type of the _id field or default to ObjectId

    -

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +InferIdType | mongodb

    Type Alias InferIdType<TSchema>

    InferIdType<TSchema>: TSchema extends {
            _id: infer IdType;
        }
        ? Record<any, never> extends IdType
            ? never
            : IdType
        : TSchema extends {
                _id?: infer IdType;
            }
            ? unknown extends IdType
                ? ObjectId
                : IdType
            : ObjectId

    Given an object shaped type, return the type of the _id field or default to ObjectId

    +

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/IntegerType.html b/docs/6.10/types/IntegerType.html index 1fe31c5a327..0c9538ef812 100644 --- a/docs/6.10/types/IntegerType.html +++ b/docs/6.10/types/IntegerType.html @@ -1 +1 @@ -IntegerType | mongodb

    Type Alias IntegerType

    IntegerType:
        | number
        | Int32
        | Long
        | bigint

    Settings

    Member Visibility
    +IntegerType | mongodb

    Type Alias IntegerType

    IntegerType:
        | number
        | Int32
        | Long
        | bigint

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/IsAny.html b/docs/6.10/types/IsAny.html index e5c58479089..0fa26d42601 100644 --- a/docs/6.10/types/IsAny.html +++ b/docs/6.10/types/IsAny.html @@ -1 +1 @@ -IsAny | mongodb

    Type Alias IsAny<Type, ResultIfAny, ResultIfNotAny>

    IsAny<Type, ResultIfAny, ResultIfNotAny>: true extends false & Type
        ? ResultIfAny
        : ResultIfNotAny

    Type Parameters

    • Type
    • ResultIfAny
    • ResultIfNotAny

    Settings

    Member Visibility
    +IsAny | mongodb

    Type Alias IsAny<Type, ResultIfAny, ResultIfNotAny>

    IsAny<Type, ResultIfAny, ResultIfNotAny>: true extends false & Type
        ? ResultIfAny
        : ResultIfNotAny

    Type Parameters

    • Type
    • ResultIfAny
    • ResultIfNotAny

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/Join.html b/docs/6.10/types/Join.html index bf67a6cb2ff..0cabae23d6c 100644 --- a/docs/6.10/types/Join.html +++ b/docs/6.10/types/Join.html @@ -1 +1 @@ -Join | mongodb

    Type Alias Join<T, D>

    Join<T, D>: T extends []
        ? ""
        : T extends [string | number]
            ? `${T[0]}`
            : T extends [string | number, ...(infer R)]
                ? `${T[0]}${D}${Join<R, D>}`
                : string

    Type Parameters

    • T extends unknown[]
    • D extends string

    Settings

    Member Visibility
    +Join | mongodb

    Type Alias Join<T, D>

    Join<T, D>: T extends []
        ? ""
        : T extends [string | number]
            ? `${T[0]}`
            : T extends [string | number, ...(infer R)]
                ? `${T[0]}${D}${Join<R, D>}`
                : string

    Type Parameters

    • T extends unknown[]
    • D extends string

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/KeysOfAType.html b/docs/6.10/types/KeysOfAType.html index eb6a546a7b6..8666bbc7533 100644 --- a/docs/6.10/types/KeysOfAType.html +++ b/docs/6.10/types/KeysOfAType.html @@ -1 +1 @@ -KeysOfAType | mongodb

    Type Alias KeysOfAType<TSchema, Type>

    KeysOfAType<TSchema, Type>: {
        [key in keyof TSchema]: NonNullable<TSchema[key]> extends Type
            ? key
            : never
    }[keyof TSchema]

    Type Parameters

    • TSchema
    • Type

    Settings

    Member Visibility
    +KeysOfAType | mongodb

    Type Alias KeysOfAType<TSchema, Type>

    KeysOfAType<TSchema, Type>: {
        [key in keyof TSchema]: NonNullable<TSchema[key]> extends Type
            ? key
            : never
    }[keyof TSchema]

    Type Parameters

    • TSchema
    • Type

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/KeysOfOtherType.html b/docs/6.10/types/KeysOfOtherType.html index db158f5a0f5..b0d05b895d7 100644 --- a/docs/6.10/types/KeysOfOtherType.html +++ b/docs/6.10/types/KeysOfOtherType.html @@ -1 +1 @@ -KeysOfOtherType | mongodb

    Type Alias KeysOfOtherType<TSchema, Type>

    KeysOfOtherType<TSchema, Type>: {
        [key in keyof TSchema]: NonNullable<TSchema[key]> extends Type
            ? never
            : key
    }[keyof TSchema]

    Type Parameters

    • TSchema
    • Type

    Settings

    Member Visibility
    +KeysOfOtherType | mongodb

    Type Alias KeysOfOtherType<TSchema, Type>

    KeysOfOtherType<TSchema, Type>: {
        [key in keyof TSchema]: NonNullable<TSchema[key]> extends Type
            ? never
            : key
    }[keyof TSchema]

    Type Parameters

    • TSchema
    • Type

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ListIndexesOptions.html b/docs/6.10/types/ListIndexesOptions.html index 7d39d0168fe..d41cf9650df 100644 --- a/docs/6.10/types/ListIndexesOptions.html +++ b/docs/6.10/types/ListIndexesOptions.html @@ -1 +1 @@ -ListIndexesOptions | mongodb

    Type Alias ListIndexesOptions

    ListIndexesOptions: AbstractCursorOptions

    Settings

    Member Visibility
    +ListIndexesOptions | mongodb

    Type Alias ListIndexesOptions

    ListIndexesOptions: AbstractCursorOptions

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ListSearchIndexesOptions.html b/docs/6.10/types/ListSearchIndexesOptions.html index ff8811a7c5d..42faeea0833 100644 --- a/docs/6.10/types/ListSearchIndexesOptions.html +++ b/docs/6.10/types/ListSearchIndexesOptions.html @@ -1 +1 @@ -ListSearchIndexesOptions | mongodb

    Type Alias ListSearchIndexesOptions

    ListSearchIndexesOptions: Omit<AggregateOptions, "readConcern" | "writeConcern">

    Settings

    Member Visibility
    +ListSearchIndexesOptions | mongodb

    Type Alias ListSearchIndexesOptions

    ListSearchIndexesOptions: Omit<AggregateOptions, "readConcern" | "writeConcern">

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/MatchKeysAndValues.html b/docs/6.10/types/MatchKeysAndValues.html index a75ea2c4035..5a6b8b1a92a 100644 --- a/docs/6.10/types/MatchKeysAndValues.html +++ b/docs/6.10/types/MatchKeysAndValues.html @@ -1 +1 @@ -MatchKeysAndValues | mongodb

    Type Alias MatchKeysAndValues<TSchema>

    MatchKeysAndValues<TSchema>: Readonly<Partial<TSchema>> & Record<string, any>

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +MatchKeysAndValues | mongodb

    Type Alias MatchKeysAndValues<TSchema>

    MatchKeysAndValues<TSchema>: Readonly<Partial<TSchema>> & Record<string, any>

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/MongoClientEvents.html b/docs/6.10/types/MongoClientEvents.html index 6258507a9df..46a04f03559 100644 --- a/docs/6.10/types/MongoClientEvents.html +++ b/docs/6.10/types/MongoClientEvents.html @@ -1 +1 @@ -MongoClientEvents | mongodb

    Type Alias MongoClientEvents

    MongoClientEvents: Pick<TopologyEvents, typeof MONGO_CLIENT_EVENTS[number]> & {
        open(mongoClient: MongoClient): void;
    }

    Settings

    Member Visibility
    +MongoClientEvents | mongodb

    Type Alias MongoClientEvents

    MongoClientEvents: Pick<TopologyEvents, typeof MONGO_CLIENT_EVENTS[number]> & {
        open(mongoClient: MongoClient): void;
    }

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/MongoErrorLabel.html b/docs/6.10/types/MongoErrorLabel.html index 9960e97c69a..a3e22ebe623 100644 --- a/docs/6.10/types/MongoErrorLabel.html +++ b/docs/6.10/types/MongoErrorLabel.html @@ -1 +1 @@ -MongoErrorLabel | mongodb

    Type Alias MongoErrorLabel

    MongoErrorLabel: typeof MongoErrorLabel[keyof typeof MongoErrorLabel]

    Settings

    Member Visibility
    +MongoErrorLabel | mongodb

    Type Alias MongoErrorLabel

    MongoErrorLabel: typeof MongoErrorLabel[keyof typeof MongoErrorLabel]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/MonitorEvents.html b/docs/6.10/types/MonitorEvents.html index 1951f28bcf9..74c15d10a44 100644 --- a/docs/6.10/types/MonitorEvents.html +++ b/docs/6.10/types/MonitorEvents.html @@ -1 +1 @@ -MonitorEvents | mongodb

    Type Alias MonitorEvents

    MonitorEvents: {
        close(): void;
        resetConnectionPool(): void;
        resetServer(error?: MongoError): void;
        serverHeartbeatFailed(event: ServerHeartbeatFailedEvent): void;
        serverHeartbeatStarted(event: ServerHeartbeatStartedEvent): void;
        serverHeartbeatSucceeded(event: ServerHeartbeatSucceededEvent): void;
    } & EventEmitterWithState

    Settings

    Member Visibility
    +MonitorEvents | mongodb

    Type Alias MonitorEvents

    MonitorEvents: {
        close(): void;
        resetConnectionPool(): void;
        resetServer(error?: MongoError): void;
        serverHeartbeatFailed(event: ServerHeartbeatFailedEvent): void;
        serverHeartbeatStarted(event: ServerHeartbeatStartedEvent): void;
        serverHeartbeatSucceeded(event: ServerHeartbeatSucceededEvent): void;
    } & EventEmitterWithState

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/NestedPaths.html b/docs/6.10/types/NestedPaths.html index fefff9af4a3..fa025fb54b7 100644 --- a/docs/6.10/types/NestedPaths.html +++ b/docs/6.10/types/NestedPaths.html @@ -1,8 +1,8 @@ -NestedPaths | mongodb

    Type Alias NestedPaths<Type, Depth>

    NestedPaths<Type, Depth>: Depth["length"] extends 8
        ? []
        : Type extends
                | string
                | number
                | bigint
                | boolean
                | Date
                | RegExp
                | Buffer
                | Uint8Array
                | ((...args: any[]) => any)
                | {
                    _bsontype: string;
                }
            ? []
            : Type extends ReadonlyArray<infer ArrayType>
                ? [] | [number, ...NestedPaths<ArrayType, [...Depth, 1]>]
                : Type extends Map<string, any>
                    ? [string]
                    : Type extends object
                        ? {
                            [Key in Extract<keyof Type, string>]: Type[Key] extends Type
                                ? [Key]
                                : Type extends Type[Key]
                                    ? [Key]
                                    : (...)[(...)] extends ReadonlyArray<(...)>
                                        ? (...) extends (...)
                                            ? (...)
                                            : (...)
                                        : (...) | (...)
                        }[Extract<keyof Type, string>]
                        : []

    returns tuple of strings (keys to be joined on '.') that represent every path into a schema +NestedPaths | mongodb

    Type Alias NestedPaths<Type, Depth>

    NestedPaths<Type, Depth>: Depth["length"] extends 8
        ? []
        : Type extends
                | string
                | number
                | bigint
                | boolean
                | Date
                | RegExp
                | Buffer
                | Uint8Array
                | ((...args: any[]) => any)
                | {
                    _bsontype: string;
                }
            ? []
            : Type extends ReadonlyArray<infer ArrayType>
                ? [] | [number, ...NestedPaths<ArrayType, [...Depth, 1]>]
                : Type extends Map<string, any>
                    ? [string]
                    : Type extends object
                        ? {
                            [Key in Extract<keyof Type, string>]: Type[Key] extends Type
                                ? [Key]
                                : Type extends Type[Key]
                                    ? [Key]
                                    : (...)[(...)] extends ReadonlyArray<(...)>
                                        ? (...) extends (...)
                                            ? (...)
                                            : (...)
                                        : (...) | (...)
                        }[Extract<keyof Type, string>]
                        : []

    returns tuple of strings (keys to be joined on '.') that represent every path into a schema https://www.mongodb.com/docs/manual/tutorial/query-embedded-documents/

    Type Parameters

    • Type
    • Depth extends number[]

    Remarks

    Through testing we determined that a depth of 8 is safe for the typescript compiler and provides reasonable compilation times. This number is otherwise not special and should be changed if issues are found with this level of checking. Beyond this depth any helpers that make use of NestedPaths should devolve to not asserting any type safety on the input.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/NestedPathsOfType.html b/docs/6.10/types/NestedPathsOfType.html index f7aafa46364..3820a2ab3ff 100644 --- a/docs/6.10/types/NestedPathsOfType.html +++ b/docs/6.10/types/NestedPathsOfType.html @@ -1,3 +1,3 @@ -NestedPathsOfType | mongodb

    Type Alias NestedPathsOfType<TSchema, Type>

    NestedPathsOfType<TSchema, Type>: KeysOfAType<{
        [Property in Join<NestedPaths<TSchema, []>, ".">]: PropertyType<TSchema, Property>
    }, Type>

    returns keys (strings) for every path into a schema with a value of type +NestedPathsOfType | mongodb

    Type Alias NestedPathsOfType<TSchema, Type>

    NestedPathsOfType<TSchema, Type>: KeysOfAType<{
        [Property in Join<NestedPaths<TSchema, []>, ".">]: PropertyType<TSchema, Property>
    }, Type>

    returns keys (strings) for every path into a schema with a value of type https://www.mongodb.com/docs/manual/tutorial/query-embedded-documents/

    -

    Type Parameters

    • TSchema
    • Type

    Settings

    Member Visibility
    +

    Type Parameters

    • TSchema
    • Type

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/NonObjectIdLikeDocument.html b/docs/6.10/types/NonObjectIdLikeDocument.html index aa61eebc6ec..14df00636ed 100644 --- a/docs/6.10/types/NonObjectIdLikeDocument.html +++ b/docs/6.10/types/NonObjectIdLikeDocument.html @@ -1,2 +1,2 @@ -NonObjectIdLikeDocument | mongodb

    Type Alias NonObjectIdLikeDocument

    NonObjectIdLikeDocument: {
        [key in keyof ObjectIdLike]?: never
    } & Document

    A type that extends Document but forbids anything that "looks like" an object id.

    -

    Settings

    Member Visibility
    +NonObjectIdLikeDocument | mongodb

    Type Alias NonObjectIdLikeDocument

    NonObjectIdLikeDocument: {
        [key in keyof ObjectIdLike]?: never
    } & Document

    A type that extends Document but forbids anything that "looks like" an object id.

    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/NotAcceptedFields.html b/docs/6.10/types/NotAcceptedFields.html index 25d1c05f657..1c2cdb90a33 100644 --- a/docs/6.10/types/NotAcceptedFields.html +++ b/docs/6.10/types/NotAcceptedFields.html @@ -1,2 +1,2 @@ -NotAcceptedFields | mongodb

    Type Alias NotAcceptedFields<TSchema, FieldType>

    NotAcceptedFields<TSchema, FieldType>: {
        readonly [key in KeysOfOtherType<TSchema, FieldType>]?: never
    }

    It avoids using fields with not acceptable types

    -

    Type Parameters

    • TSchema
    • FieldType

    Settings

    Member Visibility
    +NotAcceptedFields | mongodb

    Type Alias NotAcceptedFields<TSchema, FieldType>

    NotAcceptedFields<TSchema, FieldType>: {
        readonly [key in KeysOfOtherType<TSchema, FieldType>]?: never
    }

    It avoids using fields with not acceptable types

    +

    Type Parameters

    • TSchema
    • FieldType

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/NumericType.html b/docs/6.10/types/NumericType.html index bab7a352c2d..e6020c69a8f 100644 --- a/docs/6.10/types/NumericType.html +++ b/docs/6.10/types/NumericType.html @@ -1 +1 @@ -NumericType | mongodb

    Type Alias NumericType

    NumericType: IntegerType | Decimal128 | Double

    Settings

    Member Visibility
    +NumericType | mongodb

    Type Alias NumericType

    NumericType: IntegerType | Decimal128 | Double

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/OIDCCallbackFunction.html b/docs/6.10/types/OIDCCallbackFunction.html index 261372599ea..c131cd6d2be 100644 --- a/docs/6.10/types/OIDCCallbackFunction.html +++ b/docs/6.10/types/OIDCCallbackFunction.html @@ -1,2 +1,2 @@ -OIDCCallbackFunction | mongodb

    Type Alias OIDCCallbackFunction

    OIDCCallbackFunction: ((params: OIDCCallbackParams) => Promise<OIDCResponse>)

    The signature of the human or machine callback functions.

    -

    Settings

    Member Visibility
    +OIDCCallbackFunction | mongodb

    Type Alias OIDCCallbackFunction

    OIDCCallbackFunction: ((params: OIDCCallbackParams) => Promise<OIDCResponse>)

    The signature of the human or machine callback functions.

    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/OneOrMore.html b/docs/6.10/types/OneOrMore.html index 79c0acb0649..3e02a63c18f 100644 --- a/docs/6.10/types/OneOrMore.html +++ b/docs/6.10/types/OneOrMore.html @@ -1 +1 @@ -OneOrMore | mongodb

    Type Alias OneOrMore<T>

    OneOrMore<T>: T | ReadonlyArray<T>

    Type Parameters

    • T

    Settings

    Member Visibility
    +OneOrMore | mongodb

    Type Alias OneOrMore<T>

    OneOrMore<T>: T | ReadonlyArray<T>

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/OnlyFieldsOfType.html b/docs/6.10/types/OnlyFieldsOfType.html index f849e7cca64..93a4073b03e 100644 --- a/docs/6.10/types/OnlyFieldsOfType.html +++ b/docs/6.10/types/OnlyFieldsOfType.html @@ -1 +1 @@ -OnlyFieldsOfType | mongodb

    Type Alias OnlyFieldsOfType<TSchema, FieldType, AssignableType>

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], AssignableType extends FieldType
        ? Record<string, FieldType>
        : Record<string, AssignableType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type Parameters

    • TSchema
    • FieldType = any
    • AssignableType = FieldType

    Settings

    Member Visibility
    +OnlyFieldsOfType | mongodb

    Type Alias OnlyFieldsOfType<TSchema, FieldType, AssignableType>

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], AssignableType extends FieldType
        ? Record<string, FieldType>
        : Record<string, AssignableType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type Parameters

    • TSchema
    • FieldType = any
    • AssignableType = FieldType

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/OperationTime.html b/docs/6.10/types/OperationTime.html index 783b8839b42..3f1f73e6713 100644 --- a/docs/6.10/types/OperationTime.html +++ b/docs/6.10/types/OperationTime.html @@ -1,3 +1,3 @@ -OperationTime | mongodb

    Type Alias OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    +OperationTime | mongodb

    Type Alias OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    See

    https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/OptionalId.html b/docs/6.10/types/OptionalId.html index 9d63afb51ed..b1d55260120 100644 --- a/docs/6.10/types/OptionalId.html +++ b/docs/6.10/types/OptionalId.html @@ -1,2 +1,2 @@ -OptionalId | mongodb

    Type Alias OptionalId<TSchema>

    OptionalId<TSchema>: EnhancedOmit<TSchema, "_id"> & {
        _id?: InferIdType<TSchema>;
    }

    Add an optional _id field to an object shaped type

    -

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +OptionalId | mongodb

    Type Alias OptionalId<TSchema>

    OptionalId<TSchema>: EnhancedOmit<TSchema, "_id"> & {
        _id?: InferIdType<TSchema>;
    }

    Add an optional _id field to an object shaped type

    +

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/OptionalUnlessRequiredId.html b/docs/6.10/types/OptionalUnlessRequiredId.html index 8e07dce1414..e40b3007938 100644 --- a/docs/6.10/types/OptionalUnlessRequiredId.html +++ b/docs/6.10/types/OptionalUnlessRequiredId.html @@ -1,3 +1,3 @@ -OptionalUnlessRequiredId | mongodb

    Type Alias OptionalUnlessRequiredId<TSchema>

    OptionalUnlessRequiredId<TSchema>: TSchema extends {
            _id: any;
        }
        ? TSchema
        : OptionalId<TSchema>

    Adds an optional _id field to an object shaped type, unless the _id field is required on that type. +OptionalUnlessRequiredId | mongodb

    Type Alias OptionalUnlessRequiredId<TSchema>

    OptionalUnlessRequiredId<TSchema>: TSchema extends {
            _id: any;
        }
        ? TSchema
        : OptionalId<TSchema>

    Adds an optional _id field to an object shaped type, unless the _id field is required on that type. In the case _id is required, this method continues to require_id.

    -

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ProfilingLevel.html b/docs/6.10/types/ProfilingLevel.html index 1069f5185a7..baf4995a416 100644 --- a/docs/6.10/types/ProfilingLevel.html +++ b/docs/6.10/types/ProfilingLevel.html @@ -1 +1 @@ -ProfilingLevel | mongodb

    Type Alias ProfilingLevel

    ProfilingLevel: typeof ProfilingLevel[keyof typeof ProfilingLevel]

    Settings

    Member Visibility
    +ProfilingLevel | mongodb

    Type Alias ProfilingLevel

    ProfilingLevel: typeof ProfilingLevel[keyof typeof ProfilingLevel]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ProfilingLevelOptions.html b/docs/6.10/types/ProfilingLevelOptions.html index 87eb1168236..1de370066f8 100644 --- a/docs/6.10/types/ProfilingLevelOptions.html +++ b/docs/6.10/types/ProfilingLevelOptions.html @@ -1 +1 @@ -ProfilingLevelOptions | mongodb

    Type Alias ProfilingLevelOptions

    ProfilingLevelOptions: CommandOperationOptions

    Settings

    Member Visibility
    +ProfilingLevelOptions | mongodb

    Type Alias ProfilingLevelOptions

    ProfilingLevelOptions: CommandOperationOptions

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/PropertyType.html b/docs/6.10/types/PropertyType.html index 608feddcf55..a9b417d2c39 100644 --- a/docs/6.10/types/PropertyType.html +++ b/docs/6.10/types/PropertyType.html @@ -1 +1 @@ -PropertyType | mongodb

    Type Alias PropertyType<Type, Property>

    PropertyType<Type, Property>: string extends Property
        ? unknown
        : Property extends keyof Type
            ? Type[Property]
            : Property extends `${number}`
                ? Type extends ReadonlyArray<infer ArrayType>
                    ? ArrayType
                    : unknown
                : Property extends `${infer Key}.${infer Rest}`
                    ? Key extends `${number}`
                        ? Type extends ReadonlyArray<infer ArrayType>
                            ? PropertyType<ArrayType, Rest>
                            : unknown
                        : Key extends keyof Type
                            ? Type[Key] extends Map<string, infer MapType>
                                ? MapType
                                : PropertyType<Type[Key], Rest>
                            : unknown
                    : unknown

    Type Parameters

    • Type
    • Property extends string

    Settings

    Member Visibility
    +PropertyType | mongodb

    Type Alias PropertyType<Type, Property>

    PropertyType<Type, Property>: string extends Property
        ? unknown
        : Property extends keyof Type
            ? Type[Property]
            : Property extends `${number}`
                ? Type extends ReadonlyArray<infer ArrayType>
                    ? ArrayType
                    : unknown
                : Property extends `${infer Key}.${infer Rest}`
                    ? Key extends `${number}`
                        ? Type extends ReadonlyArray<infer ArrayType>
                            ? PropertyType<ArrayType, Rest>
                            : unknown
                        : Key extends keyof Type
                            ? Type[Key] extends Map<string, infer MapType>
                                ? MapType
                                : PropertyType<Type[Key], Rest>
                            : unknown
                    : unknown

    Type Parameters

    • Type
    • Property extends string

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/PullAllOperator.html b/docs/6.10/types/PullAllOperator.html index 170d1ba8e71..d03915c0cbc 100644 --- a/docs/6.10/types/PullAllOperator.html +++ b/docs/6.10/types/PullAllOperator.html @@ -1 +1 @@ -PullAllOperator | mongodb

    Type Alias PullAllOperator<TSchema>

    PullAllOperator<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: TSchema[key]
    } & NotAcceptedFields<TSchema, ReadonlyArray<any>> & {
        [key: string]: ReadonlyArray<any>;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +PullAllOperator | mongodb

    Type Alias PullAllOperator<TSchema>

    PullAllOperator<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: TSchema[key]
    } & NotAcceptedFields<TSchema, ReadonlyArray<any>> & {
        [key: string]: ReadonlyArray<any>;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/PullOperator.html b/docs/6.10/types/PullOperator.html index 8c190bfb049..a5a52907490 100644 --- a/docs/6.10/types/PullOperator.html +++ b/docs/6.10/types/PullOperator.html @@ -1 +1 @@ -PullOperator | mongodb

    Type Alias PullOperator<TSchema>

    PullOperator<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: Partial<Flatten<TSchema[key]>> | FilterOperations<Flatten<TSchema[key]>>
    } & NotAcceptedFields<TSchema, ReadonlyArray<any>> & {
        [key: string]: FilterOperators<any> | any;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +PullOperator | mongodb

    Type Alias PullOperator<TSchema>

    PullOperator<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: Partial<Flatten<TSchema[key]>> | FilterOperations<Flatten<TSchema[key]>>
    } & NotAcceptedFields<TSchema, ReadonlyArray<any>> & {
        [key: string]: FilterOperators<any> | any;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/PushOperator.html b/docs/6.10/types/PushOperator.html index c374d407919..6c33fbc3b1e 100644 --- a/docs/6.10/types/PushOperator.html +++ b/docs/6.10/types/PushOperator.html @@ -1 +1 @@ -PushOperator | mongodb

    Type Alias PushOperator<TSchema>

    PushOperator<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: Flatten<TSchema[key]> | ArrayOperator<Flatten<TSchema[key]>[]>
    } & NotAcceptedFields<TSchema, ReadonlyArray<any>> & {
        [key: string]: ArrayOperator<any> | any;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +PushOperator | mongodb

    Type Alias PushOperator<TSchema>

    PushOperator<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: Flatten<TSchema[key]> | ArrayOperator<Flatten<TSchema[key]>[]>
    } & NotAcceptedFields<TSchema, ReadonlyArray<any>> & {
        [key: string]: ArrayOperator<any> | any;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ReadConcernLevel.html b/docs/6.10/types/ReadConcernLevel.html index f154b1edd62..fbf82022ac4 100644 --- a/docs/6.10/types/ReadConcernLevel.html +++ b/docs/6.10/types/ReadConcernLevel.html @@ -1 +1 @@ -ReadConcernLevel | mongodb

    Type Alias ReadConcernLevel

    ReadConcernLevel: typeof ReadConcernLevel[keyof typeof ReadConcernLevel]

    Settings

    Member Visibility
    +ReadConcernLevel | mongodb

    Type Alias ReadConcernLevel

    ReadConcernLevel: typeof ReadConcernLevel[keyof typeof ReadConcernLevel]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ReadConcernLike.html b/docs/6.10/types/ReadConcernLike.html index 9b16189389a..4c0204a4507 100644 --- a/docs/6.10/types/ReadConcernLike.html +++ b/docs/6.10/types/ReadConcernLike.html @@ -1 +1 @@ -ReadConcernLike | mongodb

    Type Alias ReadConcernLike

    ReadConcernLike: ReadConcern | {
        level: ReadConcernLevel;
    } | ReadConcernLevel

    Settings

    Member Visibility
    +ReadConcernLike | mongodb

    Type Alias ReadConcernLike

    ReadConcernLike: ReadConcern | {
        level: ReadConcernLevel;
    } | ReadConcernLevel

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ReadPreferenceLike.html b/docs/6.10/types/ReadPreferenceLike.html index 2f2f9364f21..5d5f025c1d0 100644 --- a/docs/6.10/types/ReadPreferenceLike.html +++ b/docs/6.10/types/ReadPreferenceLike.html @@ -1 +1 @@ -ReadPreferenceLike | mongodb

    Type Alias ReadPreferenceLike

    ReadPreferenceLike: ReadPreference | ReadPreferenceMode

    Settings

    Member Visibility
    +ReadPreferenceLike | mongodb

    Type Alias ReadPreferenceLike

    ReadPreferenceLike: ReadPreference | ReadPreferenceMode

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ReadPreferenceMode.html b/docs/6.10/types/ReadPreferenceMode.html index d978d07b50d..eab404981f8 100644 --- a/docs/6.10/types/ReadPreferenceMode.html +++ b/docs/6.10/types/ReadPreferenceMode.html @@ -1 +1 @@ -ReadPreferenceMode | mongodb

    Type Alias ReadPreferenceMode

    ReadPreferenceMode: typeof ReadPreferenceMode[keyof typeof ReadPreferenceMode]

    Settings

    Member Visibility
    +ReadPreferenceMode | mongodb

    Type Alias ReadPreferenceMode

    ReadPreferenceMode: typeof ReadPreferenceMode[keyof typeof ReadPreferenceMode]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/RegExpOrString.html b/docs/6.10/types/RegExpOrString.html index da54d2fcc10..1b249653cfd 100644 --- a/docs/6.10/types/RegExpOrString.html +++ b/docs/6.10/types/RegExpOrString.html @@ -1 +1 @@ -RegExpOrString | mongodb

    Type Alias RegExpOrString<T>

    RegExpOrString<T>: T extends string
        ? BSONRegExp | RegExp | T
        : T

    Type Parameters

    • T

    Settings

    Member Visibility
    +RegExpOrString | mongodb

    Type Alias RegExpOrString<T>

    RegExpOrString<T>: T extends string
        ? BSONRegExp | RegExp | T
        : T

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/RemoveUserOptions.html b/docs/6.10/types/RemoveUserOptions.html index 5d5911b9575..30d7b892c9d 100644 --- a/docs/6.10/types/RemoveUserOptions.html +++ b/docs/6.10/types/RemoveUserOptions.html @@ -1 +1 @@ -RemoveUserOptions | mongodb

    Type Alias RemoveUserOptions

    RemoveUserOptions: CommandOperationOptions

    Settings

    Member Visibility
    +RemoveUserOptions | mongodb

    Type Alias RemoveUserOptions

    RemoveUserOptions: CommandOperationOptions

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ResumeToken.html b/docs/6.10/types/ResumeToken.html index 37e37d2932d..2f79b178be9 100644 --- a/docs/6.10/types/ResumeToken.html +++ b/docs/6.10/types/ResumeToken.html @@ -1,3 +1,3 @@ -ResumeToken | mongodb

    Type Alias ResumeToken

    ResumeToken: unknown

    Represents the logical starting point for a new ChangeStream or resuming a ChangeStream on the server.

    +ResumeToken | mongodb

    Type Alias ResumeToken

    ResumeToken: unknown

    Represents the logical starting point for a new ChangeStream or resuming a ChangeStream on the server.

    See

    https://www.mongodb.com/docs/manual/changeStreams/#std-label-change-stream-resume

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ReturnDocument.html b/docs/6.10/types/ReturnDocument.html index bd4aba802ee..86a668fd784 100644 --- a/docs/6.10/types/ReturnDocument.html +++ b/docs/6.10/types/ReturnDocument.html @@ -1 +1 @@ -ReturnDocument | mongodb

    Type Alias ReturnDocument

    ReturnDocument: typeof ReturnDocument[keyof typeof ReturnDocument]

    Settings

    Member Visibility
    +ReturnDocument | mongodb

    Type Alias ReturnDocument

    ReturnDocument: typeof ReturnDocument[keyof typeof ReturnDocument]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/RunCommandOptions.html b/docs/6.10/types/RunCommandOptions.html index 234177be701..f66d155c839 100644 --- a/docs/6.10/types/RunCommandOptions.html +++ b/docs/6.10/types/RunCommandOptions.html @@ -1,3 +1,3 @@ -RunCommandOptions | mongodb

    Type Alias RunCommandOptions

    RunCommandOptions: {
        readPreference?: ReadPreferenceLike;
        session?: ClientSession;
    } & BSONSerializeOptions

    Type declaration

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/RunCursorCommandOptions.html b/docs/6.10/types/RunCursorCommandOptions.html index f4ee1fcf555..aa8ed2ed0b2 100644 --- a/docs/6.10/types/RunCursorCommandOptions.html +++ b/docs/6.10/types/RunCursorCommandOptions.html @@ -1 +1 @@ -RunCursorCommandOptions | mongodb

    Type Alias RunCursorCommandOptions

    RunCursorCommandOptions: {
        readPreference?: ReadPreferenceLike;
        session?: ClientSession;
    } & BSONSerializeOptions

    Settings

    Member Visibility
    +RunCursorCommandOptions | mongodb

    Type Alias RunCursorCommandOptions

    RunCursorCommandOptions: {
        readPreference?: ReadPreferenceLike;
        session?: ClientSession;
    } & BSONSerializeOptions

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/SchemaMember.html b/docs/6.10/types/SchemaMember.html index 5ece92553a4..55286ad5fdd 100644 --- a/docs/6.10/types/SchemaMember.html +++ b/docs/6.10/types/SchemaMember.html @@ -1 +1 @@ -SchemaMember | mongodb

    Type Alias SchemaMember<T, V>

    SchemaMember<T, V>: {
        [P in keyof T]?: V
    } | {
        [key: string]: V;
    }

    Type Parameters

    • T
    • V

    Settings

    Member Visibility
    +SchemaMember | mongodb

    Type Alias SchemaMember<T, V>

    SchemaMember<T, V>: {
        [P in keyof T]?: V
    } | {
        [key: string]: V;
    }

    Type Parameters

    • T
    • V

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ServerApiVersion.html b/docs/6.10/types/ServerApiVersion.html index aed852d1721..bf3972cb057 100644 --- a/docs/6.10/types/ServerApiVersion.html +++ b/docs/6.10/types/ServerApiVersion.html @@ -1 +1 @@ -ServerApiVersion | mongodb

    Type Alias ServerApiVersion

    ServerApiVersion: typeof ServerApiVersion[keyof typeof ServerApiVersion]

    Settings

    Member Visibility
    +ServerApiVersion | mongodb

    Type Alias ServerApiVersion

    ServerApiVersion: typeof ServerApiVersion[keyof typeof ServerApiVersion]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ServerEvents.html b/docs/6.10/types/ServerEvents.html index cd562cef688..3fbac721eaf 100644 --- a/docs/6.10/types/ServerEvents.html +++ b/docs/6.10/types/ServerEvents.html @@ -1 +1 @@ -ServerEvents | mongodb

    Type Alias ServerEvents

    ServerEvents: {
        closed(): void;
        descriptionReceived(description: ServerDescription): void;
        ended(): void;
        serverHeartbeatFailed(event: ServerHeartbeatFailedEvent): void;
        serverHeartbeatStarted(event: ServerHeartbeatStartedEvent): void;
        serverHeartbeatSucceeded(event: ServerHeartbeatSucceededEvent): void;
    } & ConnectionPoolEvents & EventEmitterWithState

    Settings

    Member Visibility
    +ServerEvents | mongodb

    Type Alias ServerEvents

    ServerEvents: {
        closed(): void;
        descriptionReceived(description: ServerDescription): void;
        ended(): void;
        serverHeartbeatFailed(event: ServerHeartbeatFailedEvent): void;
        serverHeartbeatStarted(event: ServerHeartbeatStartedEvent): void;
        serverHeartbeatSucceeded(event: ServerHeartbeatSucceededEvent): void;
    } & ConnectionPoolEvents & EventEmitterWithState

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ServerMonitoringMode.html b/docs/6.10/types/ServerMonitoringMode.html index 80ab250be23..8c798443683 100644 --- a/docs/6.10/types/ServerMonitoringMode.html +++ b/docs/6.10/types/ServerMonitoringMode.html @@ -1 +1 @@ -ServerMonitoringMode | mongodb

    Type Alias ServerMonitoringMode

    ServerMonitoringMode: typeof ServerMonitoringMode[keyof typeof ServerMonitoringMode]

    Settings

    Member Visibility
    +ServerMonitoringMode | mongodb

    Type Alias ServerMonitoringMode

    ServerMonitoringMode: typeof ServerMonitoringMode[keyof typeof ServerMonitoringMode]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ServerSessionId.html b/docs/6.10/types/ServerSessionId.html index f80d06c4d7c..29187808471 100644 --- a/docs/6.10/types/ServerSessionId.html +++ b/docs/6.10/types/ServerSessionId.html @@ -1 +1 @@ -ServerSessionId | mongodb

    Type Alias ServerSessionId

    ServerSessionId: {
        id: Binary;
    }

    Settings

    Member Visibility
    +ServerSessionId | mongodb

    Type Alias ServerSessionId

    ServerSessionId: {
        id: Binary;
    }

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/ServerType.html b/docs/6.10/types/ServerType.html index c0536d29449..7f36ee127ec 100644 --- a/docs/6.10/types/ServerType.html +++ b/docs/6.10/types/ServerType.html @@ -1 +1 @@ -ServerType | mongodb

    Type Alias ServerType

    ServerType: typeof ServerType[keyof typeof ServerType]

    Settings

    Member Visibility
    +ServerType | mongodb

    Type Alias ServerType

    ServerType: typeof ServerType[keyof typeof ServerType]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/SetFields.html b/docs/6.10/types/SetFields.html index 23608d56ef6..3c53ff942ca 100644 --- a/docs/6.10/types/SetFields.html +++ b/docs/6.10/types/SetFields.html @@ -1 +1 @@ -SetFields | mongodb

    Type Alias SetFields<TSchema>

    SetFields<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any> | undefined>]?: OptionalId<Flatten<TSchema[key]>> | AddToSetOperators<OptionalId<Flatten<TSchema[key]>>[]>
    } & IsAny<TSchema[keyof TSchema], object, NotAcceptedFields<TSchema, ReadonlyArray<any> | undefined>> & {
        [key: string]: AddToSetOperators<any> | any;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +SetFields | mongodb

    Type Alias SetFields<TSchema>

    SetFields<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any> | undefined>]?: OptionalId<Flatten<TSchema[key]>> | AddToSetOperators<OptionalId<Flatten<TSchema[key]>>[]>
    } & IsAny<TSchema[keyof TSchema], object, NotAcceptedFields<TSchema, ReadonlyArray<any> | undefined>> & {
        [key: string]: AddToSetOperators<any> | any;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/SetProfilingLevelOptions.html b/docs/6.10/types/SetProfilingLevelOptions.html index 95bc2f1e379..4a7ad1dd3e2 100644 --- a/docs/6.10/types/SetProfilingLevelOptions.html +++ b/docs/6.10/types/SetProfilingLevelOptions.html @@ -1 +1 @@ -SetProfilingLevelOptions | mongodb

    Type Alias SetProfilingLevelOptions

    SetProfilingLevelOptions: CommandOperationOptions

    Settings

    Member Visibility
    +SetProfilingLevelOptions | mongodb

    Type Alias SetProfilingLevelOptions

    SetProfilingLevelOptions: CommandOperationOptions

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/Sort.html b/docs/6.10/types/Sort.html index 2151bef70da..86b8399d7b0 100644 --- a/docs/6.10/types/Sort.html +++ b/docs/6.10/types/Sort.html @@ -1 +1 @@ -Sort | mongodb

    Type Alias Sort

    Sort:
        | string
        | Exclude<SortDirection, {
            $meta: string;
        }>
        | string[]
        | {
            [key: string]: SortDirection;
        }
        | Map<string, SortDirection>
        | [string, SortDirection][]
        | [string, SortDirection]

    Settings

    Member Visibility
    +Sort | mongodb

    Type Alias Sort

    Sort:
        | string
        | Exclude<SortDirection, {
            $meta: string;
        }>
        | string[]
        | {
            [key: string]: SortDirection;
        }
        | Map<string, SortDirection>
        | [string, SortDirection][]
        | [string, SortDirection]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/SortDirection.html b/docs/6.10/types/SortDirection.html index e58138f9d64..508271c0413 100644 --- a/docs/6.10/types/SortDirection.html +++ b/docs/6.10/types/SortDirection.html @@ -1 +1 @@ -SortDirection | mongodb

    Type Alias SortDirection

    SortDirection:
        | 1
        | -1
        | "asc"
        | "desc"
        | "ascending"
        | "descending"
        | {
            $meta: string;
        }

    Settings

    Member Visibility
    +SortDirection | mongodb

    Type Alias SortDirection

    SortDirection:
        | 1
        | -1
        | "asc"
        | "desc"
        | "ascending"
        | "descending"
        | {
            $meta: string;
        }

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/Stream.html b/docs/6.10/types/Stream.html index 3e53ef12fd4..7e4190e7817 100644 --- a/docs/6.10/types/Stream.html +++ b/docs/6.10/types/Stream.html @@ -1 +1 @@ -Stream | mongodb

    Type Alias Stream

    Stream: Socket | TLSSocket

    Settings

    Member Visibility
    +Stream | mongodb

    Type Alias Stream

    Stream: Socket | TLSSocket

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/StrictFilter.html b/docs/6.10/types/StrictFilter.html index b2e2f7e962f..ca9eda57a8c 100644 --- a/docs/6.10/types/StrictFilter.html +++ b/docs/6.10/types/StrictFilter.html @@ -1 +1 @@ -StrictFilter | mongodb

    Type Alias StrictFilter<TSchema>Experimental

    StrictFilter<TSchema>: Partial<TSchema> | {
        [Property in Join<NestedPaths<WithId<TSchema>, []>, ".">]?: Condition<PropertyType<WithId<TSchema>, Property>>
    } & RootFilterOperators<WithId<TSchema>>

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +StrictFilter | mongodb

    Type Alias StrictFilter<TSchema>Experimental

    StrictFilter<TSchema>: Partial<TSchema> | {
        [Property in Join<NestedPaths<WithId<TSchema>, []>, ".">]?: Condition<PropertyType<WithId<TSchema>, Property>>
    } & RootFilterOperators<WithId<TSchema>>

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/StrictMatchKeysAndValues.html b/docs/6.10/types/StrictMatchKeysAndValues.html index 35930f3782c..393ead3a463 100644 --- a/docs/6.10/types/StrictMatchKeysAndValues.html +++ b/docs/6.10/types/StrictMatchKeysAndValues.html @@ -1 +1 @@ -StrictMatchKeysAndValues | mongodb

    Type Alias StrictMatchKeysAndValues<TSchema>Experimental

    StrictMatchKeysAndValues<TSchema>: Readonly<{
        [Property in Join<NestedPaths<TSchema, []>, ".">]?: PropertyType<TSchema, Property>
    } & {
        [Property in `${NestedPathsOfType<TSchema, any[]>}.$${`[${string}]` | ""}`]?: ArrayElement<PropertyType<TSchema, Property extends `${infer Key}.$${string}`
            ? Key
            : never>>
    } & {
        [Property in `${NestedPathsOfType<TSchema, Record<string, any>[]>}.$${`[${string}]` | ""}.${string}`]?: any
    } & Document>

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +StrictMatchKeysAndValues | mongodb

    Type Alias StrictMatchKeysAndValues<TSchema>Experimental

    StrictMatchKeysAndValues<TSchema>: Readonly<{
        [Property in Join<NestedPaths<TSchema, []>, ".">]?: PropertyType<TSchema, Property>
    } & {
        [Property in `${NestedPathsOfType<TSchema, any[]>}.$${`[${string}]` | ""}`]?: ArrayElement<PropertyType<TSchema, Property extends `${infer Key}.$${string}`
            ? Key
            : never>>
    } & {
        [Property in `${NestedPathsOfType<TSchema, Record<string, any>[]>}.$${`[${string}]` | ""}.${string}`]?: any
    } & Document>

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/StrictUpdateFilter.html b/docs/6.10/types/StrictUpdateFilter.html index 3beb2698d96..4f9bf1a50c2 100644 --- a/docs/6.10/types/StrictUpdateFilter.html +++ b/docs/6.10/types/StrictUpdateFilter.html @@ -1 +1 @@ -StrictUpdateFilter | mongodb

    Type Alias StrictUpdateFilter<TSchema>Experimental

    StrictUpdateFilter<TSchema>: {
        $addToSet?: SetFields<TSchema>;
        $bit?: OnlyFieldsOfType<TSchema, NumericType | undefined, {
            and: IntegerType;
        } | {
            or: IntegerType;
        } | {
            xor: IntegerType;
        }>;
        $currentDate?: OnlyFieldsOfType<TSchema, Date | Timestamp, true | {
            $type: "date" | "timestamp";
        }>;
        $inc?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $max?: StrictMatchKeysAndValues<TSchema>;
        $min?: StrictMatchKeysAndValues<TSchema>;
        $mul?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $pop?: OnlyFieldsOfType<TSchema, ReadonlyArray<any>, 1 | -1>;
        $pull?: PullOperator<TSchema>;
        $pullAll?: PullAllOperator<TSchema>;
        $push?: PushOperator<TSchema>;
        $rename?: Record<string, string>;
        $set?: StrictMatchKeysAndValues<TSchema>;
        $setOnInsert?: StrictMatchKeysAndValues<TSchema>;
        $unset?: OnlyFieldsOfType<TSchema, any, "" | true | 1>;
    } & Document

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +StrictUpdateFilter | mongodb

    Type Alias StrictUpdateFilter<TSchema>Experimental

    StrictUpdateFilter<TSchema>: {
        $addToSet?: SetFields<TSchema>;
        $bit?: OnlyFieldsOfType<TSchema, NumericType | undefined, {
            and: IntegerType;
        } | {
            or: IntegerType;
        } | {
            xor: IntegerType;
        }>;
        $currentDate?: OnlyFieldsOfType<TSchema, Date | Timestamp, true | {
            $type: "date" | "timestamp";
        }>;
        $inc?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $max?: StrictMatchKeysAndValues<TSchema>;
        $min?: StrictMatchKeysAndValues<TSchema>;
        $mul?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $pop?: OnlyFieldsOfType<TSchema, ReadonlyArray<any>, 1 | -1>;
        $pull?: PullOperator<TSchema>;
        $pullAll?: PullAllOperator<TSchema>;
        $push?: PushOperator<TSchema>;
        $rename?: Record<string, string>;
        $set?: StrictMatchKeysAndValues<TSchema>;
        $setOnInsert?: StrictMatchKeysAndValues<TSchema>;
        $unset?: OnlyFieldsOfType<TSchema, any, "" | true | 1>;
    } & Document

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/SupportedNodeConnectionOptions.html b/docs/6.10/types/SupportedNodeConnectionOptions.html index bf3eac3be1e..90a49ad0d57 100644 --- a/docs/6.10/types/SupportedNodeConnectionOptions.html +++ b/docs/6.10/types/SupportedNodeConnectionOptions.html @@ -1 +1 @@ -SupportedNodeConnectionOptions | mongodb

    Type Alias SupportedNodeConnectionOptions

    SupportedNodeConnectionOptions: SupportedTLSConnectionOptions & SupportedTLSSocketOptions & SupportedSocketOptions

    Settings

    Member Visibility
    +SupportedNodeConnectionOptions | mongodb

    Type Alias SupportedNodeConnectionOptions

    SupportedNodeConnectionOptions: SupportedTLSConnectionOptions & SupportedTLSSocketOptions & SupportedSocketOptions

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/SupportedSocketOptions.html b/docs/6.10/types/SupportedSocketOptions.html index e9baeeff4fc..cd189004b50 100644 --- a/docs/6.10/types/SupportedSocketOptions.html +++ b/docs/6.10/types/SupportedSocketOptions.html @@ -1 +1 @@ -SupportedSocketOptions | mongodb

    Type Alias SupportedSocketOptions

    SupportedSocketOptions: Pick<TcpNetConnectOpts & {
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
    }, typeof LEGAL_TCP_SOCKET_OPTIONS[number]>

    Settings

    Member Visibility
    +SupportedSocketOptions | mongodb

    Type Alias SupportedSocketOptions

    SupportedSocketOptions: Pick<TcpNetConnectOpts & {
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
    }, typeof LEGAL_TCP_SOCKET_OPTIONS[number]>

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/SupportedTLSConnectionOptions.html b/docs/6.10/types/SupportedTLSConnectionOptions.html index 85c41616c77..6c95f2bd9a3 100644 --- a/docs/6.10/types/SupportedTLSConnectionOptions.html +++ b/docs/6.10/types/SupportedTLSConnectionOptions.html @@ -1 +1 @@ -SupportedTLSConnectionOptions | mongodb

    Type Alias SupportedTLSConnectionOptions

    SupportedTLSConnectionOptions: Pick<TLSConnectionOptions & {
        allowPartialTrustChain?: boolean;
    }, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>

    Settings

    Member Visibility
    +SupportedTLSConnectionOptions | mongodb

    Type Alias SupportedTLSConnectionOptions

    SupportedTLSConnectionOptions: Pick<TLSConnectionOptions & {
        allowPartialTrustChain?: boolean;
    }, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/SupportedTLSSocketOptions.html b/docs/6.10/types/SupportedTLSSocketOptions.html index 3d7e74c938a..172c0c2ba1a 100644 --- a/docs/6.10/types/SupportedTLSSocketOptions.html +++ b/docs/6.10/types/SupportedTLSSocketOptions.html @@ -1 +1 @@ -SupportedTLSSocketOptions | mongodb

    Type Alias SupportedTLSSocketOptions

    SupportedTLSSocketOptions: Pick<TLSSocketOptions, Extract<keyof TLSSocketOptions, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>>

    Settings

    Member Visibility
    +SupportedTLSSocketOptions | mongodb

    Type Alias SupportedTLSSocketOptions

    SupportedTLSSocketOptions: Pick<TLSSocketOptions, Extract<keyof TLSSocketOptions, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>>

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/TagSet.html b/docs/6.10/types/TagSet.html index 6bcf55230d1..ca8bfd36a8f 100644 --- a/docs/6.10/types/TagSet.html +++ b/docs/6.10/types/TagSet.html @@ -1 +1 @@ -TagSet | mongodb

    Type Alias TagSet

    TagSet: {
        [key: string]: string;
    }

    Settings

    Member Visibility
    +TagSet | mongodb

    Type Alias TagSet

    TagSet: {
        [key: string]: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/TopologyEvents.html b/docs/6.10/types/TopologyEvents.html index c6110d58c3a..170d8d9e1ba 100644 --- a/docs/6.10/types/TopologyEvents.html +++ b/docs/6.10/types/TopologyEvents.html @@ -1 +1 @@ -TopologyEvents | mongodb

    Type Alias TopologyEvents

    TopologyEvents: {
        close(): void;
        error(error: Error): void;
        serverClosed(event: ServerClosedEvent): void;
        serverDescriptionChanged(event: ServerDescriptionChangedEvent): void;
        serverOpening(event: ServerOpeningEvent): void;
        timeout(): void;
        topologyClosed(event: TopologyClosedEvent): void;
        topologyDescriptionChanged(event: TopologyDescriptionChangedEvent): void;
        topologyOpening(event: TopologyOpeningEvent): void;
    } & Omit<ServerEvents, "connect"> & ConnectionPoolEvents & ConnectionEvents & EventEmitterWithState

    Settings

    Member Visibility
    +TopologyEvents | mongodb

    Type Alias TopologyEvents

    TopologyEvents: {
        close(): void;
        error(error: Error): void;
        serverClosed(event: ServerClosedEvent): void;
        serverDescriptionChanged(event: ServerDescriptionChangedEvent): void;
        serverOpening(event: ServerOpeningEvent): void;
        timeout(): void;
        topologyClosed(event: TopologyClosedEvent): void;
        topologyDescriptionChanged(event: TopologyDescriptionChangedEvent): void;
        topologyOpening(event: TopologyOpeningEvent): void;
    } & Omit<ServerEvents, "connect"> & ConnectionPoolEvents & ConnectionEvents & EventEmitterWithState

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/TopologyType.html b/docs/6.10/types/TopologyType.html index 3684835e0b5..ca2a288ccf5 100644 --- a/docs/6.10/types/TopologyType.html +++ b/docs/6.10/types/TopologyType.html @@ -1 +1 @@ -TopologyType | mongodb

    Type Alias TopologyType

    TopologyType: typeof TopologyType[keyof typeof TopologyType]

    Settings

    Member Visibility
    +TopologyType | mongodb

    Type Alias TopologyType

    TopologyType: typeof TopologyType[keyof typeof TopologyType]

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/UpdateFilter.html b/docs/6.10/types/UpdateFilter.html index 9019b251601..537bce216e8 100644 --- a/docs/6.10/types/UpdateFilter.html +++ b/docs/6.10/types/UpdateFilter.html @@ -1 +1 @@ -UpdateFilter | mongodb

    Type Alias UpdateFilter<TSchema>

    UpdateFilter<TSchema>: {
        $addToSet?: SetFields<TSchema>;
        $bit?: OnlyFieldsOfType<TSchema, NumericType | undefined, {
            and: IntegerType;
        } | {
            or: IntegerType;
        } | {
            xor: IntegerType;
        }>;
        $currentDate?: OnlyFieldsOfType<TSchema, Date | Timestamp, true | {
            $type: "date" | "timestamp";
        }>;
        $inc?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $max?: MatchKeysAndValues<TSchema>;
        $min?: MatchKeysAndValues<TSchema>;
        $mul?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $pop?: OnlyFieldsOfType<TSchema, ReadonlyArray<any>, 1 | -1>;
        $pull?: PullOperator<TSchema>;
        $pullAll?: PullAllOperator<TSchema>;
        $push?: PushOperator<TSchema>;
        $rename?: Record<string, string>;
        $set?: MatchKeysAndValues<TSchema>;
        $setOnInsert?: MatchKeysAndValues<TSchema>;
        $unset?: OnlyFieldsOfType<TSchema, any, "" | true | 1>;
    } & Document

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +UpdateFilter | mongodb

    Type Alias UpdateFilter<TSchema>

    UpdateFilter<TSchema>: {
        $addToSet?: SetFields<TSchema>;
        $bit?: OnlyFieldsOfType<TSchema, NumericType | undefined, {
            and: IntegerType;
        } | {
            or: IntegerType;
        } | {
            xor: IntegerType;
        }>;
        $currentDate?: OnlyFieldsOfType<TSchema, Date | Timestamp, true | {
            $type: "date" | "timestamp";
        }>;
        $inc?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $max?: MatchKeysAndValues<TSchema>;
        $min?: MatchKeysAndValues<TSchema>;
        $mul?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $pop?: OnlyFieldsOfType<TSchema, ReadonlyArray<any>, 1 | -1>;
        $pull?: PullOperator<TSchema>;
        $pullAll?: PullAllOperator<TSchema>;
        $push?: PushOperator<TSchema>;
        $rename?: Record<string, string>;
        $set?: MatchKeysAndValues<TSchema>;
        $setOnInsert?: MatchKeysAndValues<TSchema>;
        $unset?: OnlyFieldsOfType<TSchema, any, "" | true | 1>;
    } & Document

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/W.html b/docs/6.10/types/W.html index 06d5e46b744..5d6aa277b33 100644 --- a/docs/6.10/types/W.html +++ b/docs/6.10/types/W.html @@ -1 +1 @@ -W | mongodb

    Type Alias W

    W: number | "majority"

    Settings

    Member Visibility
    +W | mongodb

    Type Alias W

    W: number | "majority"

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/WithId.html b/docs/6.10/types/WithId.html index 9226d9c57d3..4e92e209125 100644 --- a/docs/6.10/types/WithId.html +++ b/docs/6.10/types/WithId.html @@ -1,2 +1,2 @@ -WithId | mongodb

    Type Alias WithId<TSchema>

    WithId<TSchema>: EnhancedOmit<TSchema, "_id"> & {
        _id: InferIdType<TSchema>;
    }

    Add an _id field to an object shaped type

    -

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +WithId | mongodb

    Type Alias WithId<TSchema>

    WithId<TSchema>: EnhancedOmit<TSchema, "_id"> & {
        _id: InferIdType<TSchema>;
    }

    Add an _id field to an object shaped type

    +

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/WithSessionCallback.html b/docs/6.10/types/WithSessionCallback.html index 1812c3a2f7a..2cd4cf57df6 100644 --- a/docs/6.10/types/WithSessionCallback.html +++ b/docs/6.10/types/WithSessionCallback.html @@ -1 +1 @@ -WithSessionCallback | mongodb

    Type Alias WithSessionCallback<T>

    WithSessionCallback<T>: ((session: ClientSession) => Promise<T>)

    Type Parameters

    • T = unknown

    Settings

    Member Visibility
    +WithSessionCallback | mongodb

    Type Alias WithSessionCallback<T>

    WithSessionCallback<T>: ((session: ClientSession) => Promise<T>)

    Type Parameters

    • T = unknown

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/WithTransactionCallback.html b/docs/6.10/types/WithTransactionCallback.html index b46d16f9325..092c687e5d7 100644 --- a/docs/6.10/types/WithTransactionCallback.html +++ b/docs/6.10/types/WithTransactionCallback.html @@ -1 +1 @@ -WithTransactionCallback | mongodb

    Type Alias WithTransactionCallback<T>

    WithTransactionCallback<T>: ((session: ClientSession) => Promise<T>)

    Type Parameters

    • T = any

    Settings

    Member Visibility
    +WithTransactionCallback | mongodb

    Type Alias WithTransactionCallback<T>

    WithTransactionCallback<T>: ((session: ClientSession) => Promise<T>)

    Type Parameters

    • T = any

    Settings

    Member Visibility
    diff --git a/docs/6.10/types/WithoutId.html b/docs/6.10/types/WithoutId.html index 8a3f0075066..fe4d19b1f2e 100644 --- a/docs/6.10/types/WithoutId.html +++ b/docs/6.10/types/WithoutId.html @@ -1,2 +1,2 @@ -WithoutId | mongodb

    Type Alias WithoutId<TSchema>

    WithoutId<TSchema>: Omit<TSchema, "_id">

    Remove the _id field from an object shaped type

    -

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +WithoutId | mongodb

    Type Alias WithoutId<TSchema>

    WithoutId<TSchema>: Omit<TSchema, "_id">

    Remove the _id field from an object shaped type

    +

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/AuthMechanism-1.html b/docs/6.10/variables/AuthMechanism-1.html index 3dc65784f54..bce7e3e8936 100644 --- a/docs/6.10/variables/AuthMechanism-1.html +++ b/docs/6.10/variables/AuthMechanism-1.html @@ -1 +1 @@ -AuthMechanism | mongodb

    Variable AuthMechanismConst

    AuthMechanism: Readonly<{
        MONGODB_AWS: "MONGODB-AWS";
        MONGODB_CR: "MONGODB-CR";
        MONGODB_DEFAULT: "DEFAULT";
        MONGODB_GSSAPI: "GSSAPI";
        MONGODB_OIDC: "MONGODB-OIDC";
        MONGODB_PLAIN: "PLAIN";
        MONGODB_SCRAM_SHA1: "SCRAM-SHA-1";
        MONGODB_SCRAM_SHA256: "SCRAM-SHA-256";
        MONGODB_X509: "MONGODB-X509";
    }> = ...

    Settings

    Member Visibility
    +AuthMechanism | mongodb

    Variable AuthMechanismConst

    AuthMechanism: Readonly<{
        MONGODB_AWS: "MONGODB-AWS";
        MONGODB_CR: "MONGODB-CR";
        MONGODB_DEFAULT: "DEFAULT";
        MONGODB_GSSAPI: "GSSAPI";
        MONGODB_OIDC: "MONGODB-OIDC";
        MONGODB_PLAIN: "PLAIN";
        MONGODB_SCRAM_SHA1: "SCRAM-SHA-1";
        MONGODB_SCRAM_SHA256: "SCRAM-SHA-256";
        MONGODB_X509: "MONGODB-X509";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/AutoEncryptionLoggerLevel-1.html b/docs/6.10/variables/AutoEncryptionLoggerLevel-1.html index f2648c2fa9a..fa1e4b9331d 100644 --- a/docs/6.10/variables/AutoEncryptionLoggerLevel-1.html +++ b/docs/6.10/variables/AutoEncryptionLoggerLevel-1.html @@ -1 +1 @@ -AutoEncryptionLoggerLevel | mongodb

    Variable AutoEncryptionLoggerLevelConst

    AutoEncryptionLoggerLevel: Readonly<{
        Error: 1;
        FatalError: 0;
        Info: 3;
        Trace: 4;
        Warning: 2;
    }> = ...

    Settings

    Member Visibility
    +AutoEncryptionLoggerLevel | mongodb

    Variable AutoEncryptionLoggerLevelConst

    AutoEncryptionLoggerLevel: Readonly<{
        Error: 1;
        FatalError: 0;
        Info: 3;
        Trace: 4;
        Warning: 2;
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/BSON.BSONType-1.html b/docs/6.10/variables/BSON.BSONType-1.html index 0207270c159..782485e99c0 100644 --- a/docs/6.10/variables/BSON.BSONType-1.html +++ b/docs/6.10/variables/BSON.BSONType-1.html @@ -1 +1 @@ -BSONType | mongodb

    Variable BSONTypeConst

    BSONType: Readonly<{
        array: 4;
        binData: 5;
        bool: 8;
        date: 9;
        dbPointer: 12;
        decimal: 19;
        double: 1;
        int: 16;
        javascript: 13;
        javascriptWithScope: 15;
        long: 18;
        maxKey: 127;
        minKey: -1;
        null: 10;
        object: 3;
        objectId: 7;
        regex: 11;
        string: 2;
        symbol: 14;
        timestamp: 17;
        undefined: 6;
    }>

    Settings

    Member Visibility
    +BSONType | mongodb

    Variable BSONTypeConst

    BSONType: Readonly<{
        array: 4;
        binData: 5;
        bool: 8;
        date: 9;
        dbPointer: 12;
        decimal: 19;
        double: 1;
        int: 16;
        javascript: 13;
        javascriptWithScope: 15;
        long: 18;
        maxKey: 127;
        minKey: -1;
        null: 10;
        object: 3;
        objectId: 7;
        regex: 11;
        string: 2;
        symbol: 14;
        timestamp: 17;
        undefined: 6;
    }>

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/BSON.EJSON.html b/docs/6.10/variables/BSON.EJSON.html index 2c5d7979fce..8d02df6652d 100644 --- a/docs/6.10/variables/BSON.EJSON.html +++ b/docs/6.10/variables/BSON.EJSON.html @@ -1 +1 @@ -EJSON | mongodb

    Variable EJSONConst

    EJSON: {
        deserialize: typeof EJSONdeserialize;
        parse: typeof parse;
        serialize: typeof EJSONserialize;
        stringify: typeof stringify;
    }

    Settings

    Member Visibility
    +EJSON | mongodb

    Variable EJSONConst

    EJSON: {
        deserialize: typeof EJSONdeserialize;
        parse: typeof parse;
        serialize: typeof EJSONserialize;
        stringify: typeof stringify;
    }

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/BSON.LongWithoutOverridesClass.html b/docs/6.10/variables/BSON.LongWithoutOverridesClass.html index f405d249383..41c25b68c39 100644 --- a/docs/6.10/variables/BSON.LongWithoutOverridesClass.html +++ b/docs/6.10/variables/BSON.LongWithoutOverridesClass.html @@ -1 +1 @@ -LongWithoutOverridesClass | mongodb

    Variable LongWithoutOverridesClassConst

    LongWithoutOverridesClass: LongWithoutOverrides

    Settings

    Member Visibility
    +LongWithoutOverridesClass | mongodb

    Variable LongWithoutOverridesClassConst

    LongWithoutOverridesClass: LongWithoutOverrides

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/BSON.onDemand-1.html b/docs/6.10/variables/BSON.onDemand-1.html index 5ef89229b6d..4d9bad1571b 100644 --- a/docs/6.10/variables/BSON.onDemand-1.html +++ b/docs/6.10/variables/BSON.onDemand-1.html @@ -1 +1 @@ -onDemand | mongodb

    Variable onDemandConst Experimental

    onDemand: OnDemand

    Settings

    Member Visibility
    +onDemand | mongodb

    Variable onDemandConst Experimental

    onDemand: OnDemand

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/BatchType-1.html b/docs/6.10/variables/BatchType-1.html index 8c1cc16d076..5b678cb17e1 100644 --- a/docs/6.10/variables/BatchType-1.html +++ b/docs/6.10/variables/BatchType-1.html @@ -1 +1 @@ -BatchType | mongodb

    Variable BatchTypeConst

    BatchType: Readonly<{
        DELETE: 3;
        INSERT: 1;
        UPDATE: 2;
    }> = ...

    Settings

    Member Visibility
    +BatchType | mongodb

    Variable BatchTypeConst

    BatchType: Readonly<{
        DELETE: 3;
        INSERT: 1;
        UPDATE: 2;
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/CURSOR_FLAGS.html b/docs/6.10/variables/CURSOR_FLAGS.html index e53e7a5937a..79f39a83421 100644 --- a/docs/6.10/variables/CURSOR_FLAGS.html +++ b/docs/6.10/variables/CURSOR_FLAGS.html @@ -1 +1 @@ -CURSOR_FLAGS | mongodb

    Variable CURSOR_FLAGSConst

    CURSOR_FLAGS: readonly ["tailable", "oplogReplay", "noCursorTimeout", "awaitData", "exhaust", "partial"] = ...

    Settings

    Member Visibility
    +CURSOR_FLAGS | mongodb

    Variable CURSOR_FLAGSConst

    CURSOR_FLAGS: readonly ["tailable", "oplogReplay", "noCursorTimeout", "awaitData", "exhaust", "partial"] = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/Compressor-1.html b/docs/6.10/variables/Compressor-1.html index b82ca9d83dc..bad38c65ba7 100644 --- a/docs/6.10/variables/Compressor-1.html +++ b/docs/6.10/variables/Compressor-1.html @@ -1 +1 @@ -Compressor | mongodb

    Variable CompressorConst

    Compressor: Readonly<{
        none: 0;
        snappy: 1;
        zlib: 2;
        zstd: 3;
    }> = ...

    Settings

    Member Visibility
    +Compressor | mongodb

    Variable CompressorConst

    Compressor: Readonly<{
        none: 0;
        snappy: 1;
        zlib: 2;
        zstd: 3;
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/ExplainVerbosity-1.html b/docs/6.10/variables/ExplainVerbosity-1.html index 2841453b893..fdbe0376e6e 100644 --- a/docs/6.10/variables/ExplainVerbosity-1.html +++ b/docs/6.10/variables/ExplainVerbosity-1.html @@ -1 +1 @@ -ExplainVerbosity | mongodb

    Variable ExplainVerbosityConst

    ExplainVerbosity: Readonly<{
        allPlansExecution: "allPlansExecution";
        executionStats: "executionStats";
        queryPlanner: "queryPlanner";
        queryPlannerExtended: "queryPlannerExtended";
    }> = ...

    Settings

    Member Visibility
    +ExplainVerbosity | mongodb

    Variable ExplainVerbosityConst

    ExplainVerbosity: Readonly<{
        allPlansExecution: "allPlansExecution";
        executionStats: "executionStats";
        queryPlanner: "queryPlanner";
        queryPlannerExtended: "queryPlannerExtended";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/GSSAPICanonicalizationValue-1.html b/docs/6.10/variables/GSSAPICanonicalizationValue-1.html index a9bfaebcc83..4ac91102c66 100644 --- a/docs/6.10/variables/GSSAPICanonicalizationValue-1.html +++ b/docs/6.10/variables/GSSAPICanonicalizationValue-1.html @@ -1 +1 @@ -GSSAPICanonicalizationValue | mongodb

    Variable GSSAPICanonicalizationValueConst

    GSSAPICanonicalizationValue: Readonly<{
        forward: "forward";
        forwardAndReverse: "forwardAndReverse";
        none: "none";
        off: false;
        on: true;
    }> = ...

    Settings

    Member Visibility
    +GSSAPICanonicalizationValue | mongodb

    Variable GSSAPICanonicalizationValueConst

    GSSAPICanonicalizationValue: Readonly<{
        forward: "forward";
        forwardAndReverse: "forwardAndReverse";
        none: "none";
        off: false;
        on: true;
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/LEGAL_TCP_SOCKET_OPTIONS.html b/docs/6.10/variables/LEGAL_TCP_SOCKET_OPTIONS.html index 754d83a5b7e..49a45e5acf6 100644 --- a/docs/6.10/variables/LEGAL_TCP_SOCKET_OPTIONS.html +++ b/docs/6.10/variables/LEGAL_TCP_SOCKET_OPTIONS.html @@ -1 +1 @@ -LEGAL_TCP_SOCKET_OPTIONS | mongodb

    Variable LEGAL_TCP_SOCKET_OPTIONSConst

    LEGAL_TCP_SOCKET_OPTIONS: readonly ["autoSelectFamily", "autoSelectFamilyAttemptTimeout", "family", "hints", "localAddress", "localPort", "lookup"] = ...

    Settings

    Member Visibility
    +LEGAL_TCP_SOCKET_OPTIONS | mongodb

    Variable LEGAL_TCP_SOCKET_OPTIONSConst

    LEGAL_TCP_SOCKET_OPTIONS: readonly ["autoSelectFamily", "autoSelectFamilyAttemptTimeout", "family", "hints", "localAddress", "localPort", "lookup"] = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/LEGAL_TLS_SOCKET_OPTIONS.html b/docs/6.10/variables/LEGAL_TLS_SOCKET_OPTIONS.html index 089ecf737ca..27b8348fe6c 100644 --- a/docs/6.10/variables/LEGAL_TLS_SOCKET_OPTIONS.html +++ b/docs/6.10/variables/LEGAL_TLS_SOCKET_OPTIONS.html @@ -1 +1 @@ -LEGAL_TLS_SOCKET_OPTIONS | mongodb

    Variable LEGAL_TLS_SOCKET_OPTIONSConst

    LEGAL_TLS_SOCKET_OPTIONS: readonly ["allowPartialTrustChain", "ALPNProtocols", "ca", "cert", "checkServerIdentity", "ciphers", "crl", "ecdhCurve", "key", "minDHSize", "passphrase", "pfx", "rejectUnauthorized", "secureContext", "secureProtocol", "servername", "session"] = ...

    Settings

    Member Visibility
    +LEGAL_TLS_SOCKET_OPTIONS | mongodb

    Variable LEGAL_TLS_SOCKET_OPTIONSConst

    LEGAL_TLS_SOCKET_OPTIONS: readonly ["allowPartialTrustChain", "ALPNProtocols", "ca", "cert", "checkServerIdentity", "ciphers", "crl", "ecdhCurve", "key", "minDHSize", "passphrase", "pfx", "rejectUnauthorized", "secureContext", "secureProtocol", "servername", "session"] = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/MONGO_CLIENT_EVENTS.html b/docs/6.10/variables/MONGO_CLIENT_EVENTS.html index 1130b6172b6..2bee94cfe3d 100644 --- a/docs/6.10/variables/MONGO_CLIENT_EVENTS.html +++ b/docs/6.10/variables/MONGO_CLIENT_EVENTS.html @@ -1 +1 @@ -MONGO_CLIENT_EVENTS | mongodb

    Variable MONGO_CLIENT_EVENTSConst

    MONGO_CLIENT_EVENTS: readonly ["connectionPoolCreated", "connectionPoolReady", "connectionPoolCleared", "connectionPoolClosed", "connectionCreated", "connectionReady", "connectionClosed", "connectionCheckOutStarted", "connectionCheckOutFailed", "connectionCheckedOut", "connectionCheckedIn", "commandStarted", "commandSucceeded", "commandFailed", "serverOpening", "serverClosed", "serverDescriptionChanged", "topologyOpening", "topologyClosed", "topologyDescriptionChanged", "error", "timeout", "close", "serverHeartbeatStarted", "serverHeartbeatSucceeded", "serverHeartbeatFailed"] = ...

    Settings

    Member Visibility
    +MONGO_CLIENT_EVENTS | mongodb

    Variable MONGO_CLIENT_EVENTSConst

    MONGO_CLIENT_EVENTS: readonly ["connectionPoolCreated", "connectionPoolReady", "connectionPoolCleared", "connectionPoolClosed", "connectionCreated", "connectionReady", "connectionClosed", "connectionCheckOutStarted", "connectionCheckOutFailed", "connectionCheckedOut", "connectionCheckedIn", "commandStarted", "commandSucceeded", "commandFailed", "serverOpening", "serverClosed", "serverDescriptionChanged", "topologyOpening", "topologyClosed", "topologyDescriptionChanged", "error", "timeout", "close", "serverHeartbeatStarted", "serverHeartbeatSucceeded", "serverHeartbeatFailed"] = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/MongoErrorLabel-1.html b/docs/6.10/variables/MongoErrorLabel-1.html index f90ad43f5ad..4845127d376 100644 --- a/docs/6.10/variables/MongoErrorLabel-1.html +++ b/docs/6.10/variables/MongoErrorLabel-1.html @@ -1 +1 @@ -MongoErrorLabel | mongodb

    Variable MongoErrorLabelConst

    MongoErrorLabel: Readonly<{
        HandshakeError: "HandshakeError";
        InterruptInUseConnections: "InterruptInUseConnections";
        NoWritesPerformed: "NoWritesPerformed";
        PoolRequstedRetry: "PoolRequstedRetry";
        ResetPool: "ResetPool";
        ResumableChangeStreamError: "ResumableChangeStreamError";
        RetryableWriteError: "RetryableWriteError";
        TransientTransactionError: "TransientTransactionError";
        UnknownTransactionCommitResult: "UnknownTransactionCommitResult";
    }> = ...

    Settings

    Member Visibility
    +MongoErrorLabel | mongodb

    Variable MongoErrorLabelConst

    MongoErrorLabel: Readonly<{
        HandshakeError: "HandshakeError";
        InterruptInUseConnections: "InterruptInUseConnections";
        NoWritesPerformed: "NoWritesPerformed";
        PoolRequstedRetry: "PoolRequstedRetry";
        ResetPool: "ResetPool";
        ResumableChangeStreamError: "ResumableChangeStreamError";
        RetryableWriteError: "RetryableWriteError";
        TransientTransactionError: "TransientTransactionError";
        UnknownTransactionCommitResult: "UnknownTransactionCommitResult";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/ProfilingLevel-1.html b/docs/6.10/variables/ProfilingLevel-1.html index 6e354785bee..a2876deffa7 100644 --- a/docs/6.10/variables/ProfilingLevel-1.html +++ b/docs/6.10/variables/ProfilingLevel-1.html @@ -1 +1 @@ -ProfilingLevel | mongodb

    Variable ProfilingLevelConst

    ProfilingLevel: Readonly<{
        all: "all";
        off: "off";
        slowOnly: "slow_only";
    }> = ...

    Settings

    Member Visibility
    +ProfilingLevel | mongodb

    Variable ProfilingLevelConst

    ProfilingLevel: Readonly<{
        all: "all";
        off: "off";
        slowOnly: "slow_only";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/ReadConcernLevel-1.html b/docs/6.10/variables/ReadConcernLevel-1.html index 1b0e978fc42..4cb86578bed 100644 --- a/docs/6.10/variables/ReadConcernLevel-1.html +++ b/docs/6.10/variables/ReadConcernLevel-1.html @@ -1 +1 @@ -ReadConcernLevel | mongodb

    Variable ReadConcernLevelConst

    ReadConcernLevel: Readonly<{
        available: "available";
        linearizable: "linearizable";
        local: "local";
        majority: "majority";
        snapshot: "snapshot";
    }> = ...

    Settings

    Member Visibility
    +ReadConcernLevel | mongodb

    Variable ReadConcernLevelConst

    ReadConcernLevel: Readonly<{
        available: "available";
        linearizable: "linearizable";
        local: "local";
        majority: "majority";
        snapshot: "snapshot";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/ReadPreferenceMode-1.html b/docs/6.10/variables/ReadPreferenceMode-1.html index 5ca30e77eb1..3c0bc4a2335 100644 --- a/docs/6.10/variables/ReadPreferenceMode-1.html +++ b/docs/6.10/variables/ReadPreferenceMode-1.html @@ -1 +1 @@ -ReadPreferenceMode | mongodb

    Variable ReadPreferenceModeConst

    ReadPreferenceMode: Readonly<{
        nearest: "nearest";
        primary: "primary";
        primaryPreferred: "primaryPreferred";
        secondary: "secondary";
        secondaryPreferred: "secondaryPreferred";
    }> = ...

    Settings

    Member Visibility
    +ReadPreferenceMode | mongodb

    Variable ReadPreferenceModeConst

    ReadPreferenceMode: Readonly<{
        nearest: "nearest";
        primary: "primary";
        primaryPreferred: "primaryPreferred";
        secondary: "secondary";
        secondaryPreferred: "secondaryPreferred";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/ReturnDocument-1.html b/docs/6.10/variables/ReturnDocument-1.html index 36a782bfb45..557439ded41 100644 --- a/docs/6.10/variables/ReturnDocument-1.html +++ b/docs/6.10/variables/ReturnDocument-1.html @@ -1 +1 @@ -ReturnDocument | mongodb

    Variable ReturnDocumentConst

    ReturnDocument: Readonly<{
        AFTER: "after";
        BEFORE: "before";
    }> = ...

    Settings

    Member Visibility
    +ReturnDocument | mongodb

    Variable ReturnDocumentConst

    ReturnDocument: Readonly<{
        AFTER: "after";
        BEFORE: "before";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/ServerApiVersion-1.html b/docs/6.10/variables/ServerApiVersion-1.html index 2a87658df4b..425d44a9d16 100644 --- a/docs/6.10/variables/ServerApiVersion-1.html +++ b/docs/6.10/variables/ServerApiVersion-1.html @@ -1 +1 @@ -ServerApiVersion | mongodb

    Variable ServerApiVersionConst

    ServerApiVersion: Readonly<{
        v1: "1";
    }> = ...

    Settings

    Member Visibility
    +ServerApiVersion | mongodb

    Variable ServerApiVersionConst

    ServerApiVersion: Readonly<{
        v1: "1";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/ServerMonitoringMode-1.html b/docs/6.10/variables/ServerMonitoringMode-1.html index 5d91544525d..29732f3adab 100644 --- a/docs/6.10/variables/ServerMonitoringMode-1.html +++ b/docs/6.10/variables/ServerMonitoringMode-1.html @@ -1 +1 @@ -ServerMonitoringMode | mongodb

    Variable ServerMonitoringModeConst

    ServerMonitoringMode: Readonly<{
        auto: "auto";
        poll: "poll";
        stream: "stream";
    }> = ...

    Settings

    Member Visibility
    +ServerMonitoringMode | mongodb

    Variable ServerMonitoringModeConst

    ServerMonitoringMode: Readonly<{
        auto: "auto";
        poll: "poll";
        stream: "stream";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/ServerType-1.html b/docs/6.10/variables/ServerType-1.html index dc8c009560c..9dda2c1275d 100644 --- a/docs/6.10/variables/ServerType-1.html +++ b/docs/6.10/variables/ServerType-1.html @@ -1,2 +1,2 @@ -ServerType | mongodb

    Variable ServerTypeConst

    ServerType: Readonly<{
        LoadBalancer: "LoadBalancer";
        Mongos: "Mongos";
        PossiblePrimary: "PossiblePrimary";
        RSArbiter: "RSArbiter";
        RSGhost: "RSGhost";
        RSOther: "RSOther";
        RSPrimary: "RSPrimary";
        RSSecondary: "RSSecondary";
        Standalone: "Standalone";
        Unknown: "Unknown";
    }> = ...

    An enumeration of server types we know about

    -

    Settings

    Member Visibility
    +ServerType | mongodb

    Variable ServerTypeConst

    ServerType: Readonly<{
        LoadBalancer: "LoadBalancer";
        Mongos: "Mongos";
        PossiblePrimary: "PossiblePrimary";
        RSArbiter: "RSArbiter";
        RSGhost: "RSGhost";
        RSOther: "RSOther";
        RSPrimary: "RSPrimary";
        RSSecondary: "RSSecondary";
        Standalone: "Standalone";
        Unknown: "Unknown";
    }> = ...

    An enumeration of server types we know about

    +

    Settings

    Member Visibility
    diff --git a/docs/6.10/variables/TopologyType-1.html b/docs/6.10/variables/TopologyType-1.html index 4cefd4d3c32..4e6a5281a43 100644 --- a/docs/6.10/variables/TopologyType-1.html +++ b/docs/6.10/variables/TopologyType-1.html @@ -1,2 +1,2 @@ -TopologyType | mongodb

    Variable TopologyTypeConst

    TopologyType: Readonly<{
        LoadBalanced: "LoadBalanced";
        ReplicaSetNoPrimary: "ReplicaSetNoPrimary";
        ReplicaSetWithPrimary: "ReplicaSetWithPrimary";
        Sharded: "Sharded";
        Single: "Single";
        Unknown: "Unknown";
    }> = ...

    An enumeration of topology types we know about

    -

    Settings

    Member Visibility
    +TopologyType | mongodb

    Variable TopologyTypeConst

    TopologyType: Readonly<{
        LoadBalanced: "LoadBalanced";
        ReplicaSetNoPrimary: "ReplicaSetNoPrimary";
        ReplicaSetWithPrimary: "ReplicaSetWithPrimary";
        Sharded: "Sharded";
        Single: "Single";
        Unknown: "Unknown";
    }> = ...

    An enumeration of topology types we know about

    +

    Settings

    Member Visibility
    diff --git a/docs/Next/classes/AbstractCursor.html b/docs/Next/classes/AbstractCursor.html index b9d22edfdef..21cd5fca751 100644 --- a/docs/Next/classes/AbstractCursor.html +++ b/docs/Next/classes/AbstractCursor.html @@ -1,4 +1,4 @@ -AbstractCursor | mongodb

    Class AbstractCursor<TSchema, CursorEvents>Abstract

    Type Parameters

    Hierarchy (view full)

    Implements

    Properties

    [asyncDispose] +AbstractCursor | mongodb

    Class AbstractCursor<TSchema, CursorEvents>Abstract

    Type Parameters

    Hierarchy (view full)

    Implements

    Properties

    [asyncDispose] captureRejections captureRejectionSymbol CLOSE @@ -503,4 +503,4 @@

    Deprecat

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/Admin.html b/docs/Next/classes/Admin.html index 37f76e8b750..e5aea571b01 100644 --- a/docs/Next/classes/Admin.html +++ b/docs/Next/classes/Admin.html @@ -1,4 +1,4 @@ -Admin | mongodb

    Class Admin

    The Admin class is an internal class that allows convenient access to +Admin | mongodb

    Class Admin

    The Admin class is an internal class that allows convenient access to the admin functionality and commands for MongoDB.

    ADMIN Cannot directly be instantiated

    Example

    import { MongoClient } from 'mongodb';

    const client = new MongoClient('mongodb://localhost:27017');
    const admin = client.db().admin();
    const dbInfo = await admin.listDatabases();
    for (const db of dbInfo.databases) {
      console.log(db.name);
    }
@@ -52,4 +52,4 @@

    Returns Promise<Document>

    validateCollection

    • validateCollection(collectionName, options?): Promise<Document>

    • Validate an existing collection

      Parameters

      • collectionName: string

        The name of the collection to validate.

      • options: ValidateCollectionOptions = {}

        Optional settings for the command

        -

      Returns Promise<Document>

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Returns Promise<Document>

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/docs/Next/classes/AggregationCursor.html b/docs/Next/classes/AggregationCursor.html index cc8661e3df9..746a1e071ab 100644 --- a/docs/Next/classes/AggregationCursor.html +++ b/docs/Next/classes/AggregationCursor.html @@ -1,4 +1,4 @@ -AggregationCursor | mongodb

    Class AggregationCursor<TSchema>

    The AggregationCursor class is an internal class that embodies an aggregation cursor on MongoDB +AggregationCursor | mongodb

    Class AggregationCursor<TSchema>

    The AggregationCursor class is an internal class that embodies an aggregation cursor on MongoDB allowing for iteration over the results returned from the underlying query. It supports one by one document iteration, conversion to an array or can be iterated as a Node 4.X or higher stream

    @@ -550,4 +550,4 @@

    Deprecat

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.BSONError.html b/docs/Next/classes/BSON.BSONError.html index 688178d6c57..a7fd8ce93f6 100644 --- a/docs/Next/classes/BSON.BSONError.html +++ b/docs/Next/classes/BSON.BSONError.html @@ -1,4 +1,4 @@ -BSONError | mongodb

    Class BSONError

    Hierarchy (view full)

    Constructors

    constructor +BSONError | mongodb

    Class BSONError

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? message stack? @@ -14,4 +14,4 @@ This method can assist with determining if an error originates from the BSON library even if it does not pass an instanceof check against this class' constructor.

    Parameters

    • value: unknown

      any javascript value that needs type checking

      -

    Returns value is BSONError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns value is BSONError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.BSONOffsetError.html b/docs/Next/classes/BSON.BSONOffsetError.html index cebd304592e..a8cb2660874 100644 --- a/docs/Next/classes/BSON.BSONOffsetError.html +++ b/docs/Next/classes/BSON.BSONOffsetError.html @@ -1,4 +1,4 @@ -BSONOffsetError | mongodb

    Class BSONOffsetErrorExperimental

    Hierarchy (view full)

    Constructors

    constructor +BSONOffsetError | mongodb

    Class BSONOffsetErrorExperimental

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? message offset @@ -15,4 +15,4 @@ This method can assist with determining if an error originates from the BSON library even if it does not pass an instanceof check against this class' constructor.

    Parameters

    • value: unknown

      any javascript value that needs type checking

      -

    Returns value is BSONError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns value is BSONError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.BSONRegExp.html b/docs/Next/classes/BSON.BSONRegExp.html index a68c47bbd5d..36861009f48 100644 --- a/docs/Next/classes/BSON.BSONRegExp.html +++ b/docs/Next/classes/BSON.BSONRegExp.html @@ -1,4 +1,4 @@ -BSONRegExp | mongodb

    Class BSONRegExp

    A class representation of the BSON RegExp type.

    +BSONRegExp | mongodb

    Class BSONRegExp

    A class representation of the BSON RegExp type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    options pattern @@ -9,4 +9,4 @@
  • Optionaloptions: string

    The regular expression options

    • Returns BSONRegExp

    Properties

    options

    options: string

    pattern

    pattern: string

    Accessors

    _bsontype

    • get _bsontype(): "BSONRegExp"

    • Returns "BSONRegExp"

    Methods

    inspect

    • inspect(depth?, options?, inspect?): string

    • Prints a human-readable string of BSON value information If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

      -

      Parameters

      • Optionaldepth: number
      • Optionaloptions: unknown
      • Optionalinspect: InspectFn

      Returns string

    StaticparseOptions

    • parseOptions(options?): string

    • Parameters

      • Optionaloptions: string

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • Optionaldepth: number
    • Optionaloptions: unknown
    • Optionalinspect: InspectFn

    Returns string

    StaticparseOptions

    • parseOptions(options?): string

    • Parameters

      • Optionaloptions: string

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.BSONRuntimeError.html b/docs/Next/classes/BSON.BSONRuntimeError.html index b96646419e2..e0bedf90160 100644 --- a/docs/Next/classes/BSON.BSONRuntimeError.html +++ b/docs/Next/classes/BSON.BSONRuntimeError.html @@ -1,4 +1,4 @@ -BSONRuntimeError | mongodb

    Class BSONRuntimeError

    Hierarchy (view full)

    Constructors

    constructor +BSONRuntimeError | mongodb

    Class BSONRuntimeError

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? message stack? @@ -14,4 +14,4 @@ This method can assist with determining if an error originates from the BSON library even if it does not pass an instanceof check against this class' constructor.

    Parameters

    • value: unknown

      any javascript value that needs type checking

      -

    Returns value is BSONError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns value is BSONError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.BSONSymbol.html b/docs/Next/classes/BSON.BSONSymbol.html index 4bed71005f6..c5e6d3cfad3 100644 --- a/docs/Next/classes/BSON.BSONSymbol.html +++ b/docs/Next/classes/BSON.BSONSymbol.html @@ -1,4 +1,4 @@ -BSONSymbol | mongodb

    Class BSONSymbol

    A class representation of the BSON Symbol type.

    +BSONSymbol | mongodb

    Class BSONSymbol

    A class representation of the BSON Symbol type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    value

    Accessors

    _bsontype @@ -11,4 +11,4 @@ If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

    Parameters

    • Optionaldepth: number
    • Optionaloptions: unknown
    • Optionalinspect: InspectFn

    Returns string

    toJSON

    • toJSON(): string

    • Returns string

    toString

    • toString(): string

    • Returns a string representation of an object.

      Returns string

    valueOf

    • valueOf(): string

    • Access the wrapped string value.

      -

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.BSONValue.html b/docs/Next/classes/BSON.BSONValue.html index e64e520768e..f2603d09699 100644 --- a/docs/Next/classes/BSON.BSONValue.html +++ b/docs/Next/classes/BSON.BSONValue.html @@ -1,6 +1,6 @@ -BSONValue | mongodb

    Class BSONValueAbstract

    Hierarchy (view full)

    Constructors

    constructor +BSONValue | mongodb

    Class BSONValueAbstract

    Hierarchy (view full)

    Constructors

    constructor

    Accessors

    _bsontype

    Methods

    inspect

    Constructors

    constructor

    Accessors

    Abstract_bsontype

    • get _bsontype(): string

    • Returns string

    Methods

    Abstractinspect

    • inspect(depth?, options?, inspect?): string

    • Prints a human-readable string of BSON value information If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

      -

      Parameters

      • Optionaldepth: number
      • Optionaloptions: unknown
      • Optionalinspect: InspectFn

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Parameters

    • Optionaldepth: number
    • Optionaloptions: unknown
    • Optionalinspect: InspectFn

    Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.BSONVersionError.html b/docs/Next/classes/BSON.BSONVersionError.html index a007a383e2b..59a47ded6c1 100644 --- a/docs/Next/classes/BSON.BSONVersionError.html +++ b/docs/Next/classes/BSON.BSONVersionError.html @@ -1,4 +1,4 @@ -BSONVersionError | mongodb

    Class BSONVersionError

    Hierarchy (view full)

    Constructors

    constructor +BSONVersionError | mongodb

    Class BSONVersionError

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? message stack? @@ -14,4 +14,4 @@ This method can assist with determining if an error originates from the BSON library even if it does not pass an instanceof check against this class' constructor.

    Parameters

    • value: unknown

      any javascript value that needs type checking

      -

    Returns value is BSONError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns value is BSONError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.Binary.html b/docs/Next/classes/BSON.Binary.html index de76b46cceb..e07a1843d63 100644 --- a/docs/Next/classes/BSON.Binary.html +++ b/docs/Next/classes/BSON.Binary.html @@ -1,4 +1,4 @@ -Binary | mongodb

    Class Binary

    A class representation of the BSON Binary type.

    +Binary | mongodb

    Class Binary

    A class representation of the BSON Binary type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    buffer position @@ -56,4 +56,4 @@
  • offset: number

    specify the binary of where to write the content.

    • Returns void

    StaticcreateFromBase64

    • createFromBase64(base64, subType?): Binary

    • Creates an Binary instance from a base64 string

      Parameters

      • base64: string
      • OptionalsubType: number

      Returns Binary

    StaticcreateFromHexString

    • createFromHexString(hex, subType?): Binary

    • Creates an Binary instance from a hex digit string

      -

      Parameters

      • hex: string
      • OptionalsubType: number

      Returns Binary

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • hex: string
    • OptionalsubType: number

    Returns Binary

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.Code.html b/docs/Next/classes/BSON.Code.html index 222b496053a..6eda7ce6838 100644 --- a/docs/Next/classes/BSON.Code.html +++ b/docs/Next/classes/BSON.Code.html @@ -1,4 +1,4 @@ -Code | mongodb

    Class Code

    A class representation of the BSON Code type.

    +Code | mongodb

    Class Code

    A class representation of the BSON Code type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    code scope @@ -9,4 +9,4 @@
  • Optionalscope: null | Document

    an optional scope for the function.

    • Returns Code

    Properties

    code

    code: string

    scope

    scope: null | Document

    Accessors

    _bsontype

    • get _bsontype(): "Code"

    • Returns "Code"

    Methods

    inspect

    • inspect(depth?, options?, inspect?): string

    • Prints a human-readable string of BSON value information If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

      -

      Parameters

      • Optionaldepth: number
      • Optionaloptions: unknown
      • Optionalinspect: InspectFn

      Returns string

    toJSON

    • toJSON(): {
          code: string;
          scope?: Document;
      }

    • Returns {
          code: string;
          scope?: Document;
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • Optionaldepth: number
    • Optionaloptions: unknown
    • Optionalinspect: InspectFn

    Returns string

    toJSON

    • toJSON(): {
          code: string;
          scope?: Document;
      }

    • Returns {
          code: string;
          scope?: Document;
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.DBRef.html b/docs/Next/classes/BSON.DBRef.html index 7fae8ee83e9..fc5a372d058 100644 --- a/docs/Next/classes/BSON.DBRef.html +++ b/docs/Next/classes/BSON.DBRef.html @@ -1,4 +1,4 @@ -DBRef | mongodb

    Class DBRef

    A class representation of the BSON DBRef type.

    +DBRef | mongodb

    Class DBRef

    A class representation of the BSON DBRef type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    collection db? @@ -12,4 +12,4 @@
  • Optionaldb: string

    optional db name, if omitted the reference is local to the current db.

  • Optionalfields: Document

    • Returns DBRef

    Properties

    collection

    collection: string

    Optionaldb

    db?: string

    fields

    fields: Document

    oid

    oid: ObjectId

    Accessors

    _bsontype

    • get _bsontype(): "DBRef"

    • Returns "DBRef"

    Methods

    inspect

    • inspect(depth?, options?, inspect?): string

    • Prints a human-readable string of BSON value information If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

      -

      Parameters

      • Optionaldepth: number
      • Optionaloptions: unknown
      • Optionalinspect: InspectFn

      Returns string

    toJSON

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • Optionaldepth: number
    • Optionaloptions: unknown
    • Optionalinspect: InspectFn

    Returns string

    toJSON

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.Decimal128.html b/docs/Next/classes/BSON.Decimal128.html index 628ce7de919..3b843950960 100644 --- a/docs/Next/classes/BSON.Decimal128.html +++ b/docs/Next/classes/BSON.Decimal128.html @@ -1,4 +1,4 @@ -Decimal128 | mongodb

    Class Decimal128

    A class representation of the BSON Decimal128 type.

    +Decimal128 | mongodb

    Class Decimal128

    A class representation of the BSON Decimal128 type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    bytes

    Accessors

    _bsontype @@ -20,4 +20,4 @@

    Returns Decimal128

    Example: Example of a number that will be rounded

    > let d = Decimal128.fromString('37.499999999999999196428571428571375')
    Uncaught:
    BSONError: "37.499999999999999196428571428571375" is not a valid Decimal128 string - inexact rounding
    at invalidErr (/home/wajames/js-bson/lib/bson.cjs:1402:11)
    at Decimal128.fromStringInternal (/home/wajames/js-bson/lib/bson.cjs:1633:25)
    at Decimal128.fromString (/home/wajames/js-bson/lib/bson.cjs:1424:27)

    > d = Decimal128.fromStringWithRounding('37.499999999999999196428571428571375')
    new Decimal128("37.49999999999999919642857142857138")
    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.Double.html b/docs/Next/classes/BSON.Double.html index 0ac044b313b..c1178df3afd 100644 --- a/docs/Next/classes/BSON.Double.html +++ b/docs/Next/classes/BSON.Double.html @@ -1,4 +1,4 @@ -Double | mongodb

    Class Double

    A class representation of the BSON Double type.

    +Double | mongodb

    Class Double

    A class representation of the BSON Double type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    value

    Accessors

    _bsontype @@ -24,4 +24,4 @@

    Strings with leading zeros, however, are also allowed

    Parameters

    • value: string

      the string we want to represent as a double.

      -

    Returns Double

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns Double

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.Int32.html b/docs/Next/classes/BSON.Int32.html index c04828cf1a1..ae843a50fb1 100644 --- a/docs/Next/classes/BSON.Int32.html +++ b/docs/Next/classes/BSON.Int32.html @@ -1,4 +1,4 @@ -Int32 | mongodb

    Class Int32

    A class representation of a BSON Int32 type.

    +Int32 | mongodb

    Class Int32

    A class representation of a BSON Int32 type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    value

    Accessors

    _bsontype @@ -24,4 +24,4 @@

    Strings with leading zeros, however, are allowed.

    Parameters

    • value: string

      the string we want to represent as an int32.

      -

    Returns Int32

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns Int32

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.Long.html b/docs/Next/classes/BSON.Long.html index 0b51f0437e3..8191c0909ab 100644 --- a/docs/Next/classes/BSON.Long.html +++ b/docs/Next/classes/BSON.Long.html @@ -1,4 +1,4 @@ -Long | mongodb

    Class Long

    A class representing a 64-bit integer

    +Long | mongodb

    Class Long

    A class representing a 64-bit integer

    Remarks

    The internal representation of a long is the two given signed, 32-bit values. We use 32-bit pieces because these are the size of integers on which Javascript performs bit-operations. For operations like addition and @@ -334,4 +334,4 @@

    StaticfromValue

    • fromValue(val, unsigned?): Long

    • Converts the specified value to a Long.

      Parameters

      • val: string | number | {
            high: number;
            low: number;
            unsigned?: boolean;
        }
      • Optionalunsigned: boolean

        Whether unsigned or not, defaults to signed

      Returns Long

    StaticisLong

    • isLong(value): value is Long

    • Tests if the specified object is a Long.

      -

      Parameters

      • value: unknown

      Returns value is Long

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • value: unknown

    Returns value is Long

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.MaxKey.html b/docs/Next/classes/BSON.MaxKey.html index 1b884ed71a4..c24465a32ca 100644 --- a/docs/Next/classes/BSON.MaxKey.html +++ b/docs/Next/classes/BSON.MaxKey.html @@ -1,7 +1,7 @@ -MaxKey | mongodb

    Class MaxKey

    A class representation of the BSON MaxKey type.

    +MaxKey | mongodb

    Class MaxKey

    A class representation of the BSON MaxKey type.

    Hierarchy (view full)

    Constructors

    constructor

    Accessors

    _bsontype

    Methods

    inspect

    Constructors

    constructor

    Accessors

    _bsontype

    • get _bsontype(): "MaxKey"

    • Returns "MaxKey"

    Methods

    inspect

    • inspect(): string

    • Prints a human-readable string of BSON value information If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

      -

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.MinKey.html b/docs/Next/classes/BSON.MinKey.html index e89e8f2381e..096a882a930 100644 --- a/docs/Next/classes/BSON.MinKey.html +++ b/docs/Next/classes/BSON.MinKey.html @@ -1,7 +1,7 @@ -MinKey | mongodb

    Class MinKey

    A class representation of the BSON MinKey type.

    +MinKey | mongodb

    Class MinKey

    A class representation of the BSON MinKey type.

    Hierarchy (view full)

    Constructors

    constructor

    Accessors

    _bsontype

    Methods

    inspect

    Constructors

    constructor

    Accessors

    _bsontype

    • get _bsontype(): "MinKey"

    • Returns "MinKey"

    Methods

    inspect

    • inspect(): string

    • Prints a human-readable string of BSON value information If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

      -

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.ObjectId.html b/docs/Next/classes/BSON.ObjectId.html index 3d7330ad8ed..9d3687c5e65 100644 --- a/docs/Next/classes/BSON.ObjectId.html +++ b/docs/Next/classes/BSON.ObjectId.html @@ -1,4 +1,4 @@ -ObjectId | mongodb

    Class ObjectId

    A class representation of the BSON ObjectId type.

    +ObjectId | mongodb

    Class ObjectId

    A class representation of the BSON ObjectId type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cacheHexString

    Accessors

    _bsontype @@ -47,4 +47,4 @@

    Parameters

    • Optionaltime: number

      pass in a second based timestamp.

    Returns Uint8Array

    StaticisValid

    • isValid(id): boolean

    • Checks if a value can be used to create a valid bson ObjectId

      Parameters

      • id:
            | string
            | number
            | Uint8Array
            | ObjectId
            | ObjectIdLike

        any JS value

        -

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.Timestamp.html b/docs/Next/classes/BSON.Timestamp.html index 16f87accce4..e58a5c56a89 100644 --- a/docs/Next/classes/BSON.Timestamp.html +++ b/docs/Next/classes/BSON.Timestamp.html @@ -1,4 +1,4 @@ -Timestamp | mongodb

    Class Timestamp

    Hierarchy (view full)

    Constructors

    constructor +Timestamp | mongodb

    Class Timestamp

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    __isLong__ add and @@ -162,4 +162,4 @@

    Parameters

    • value: number

    Returns Timestamp

    StaticfromString

    • fromString(str, optRadix): Timestamp

    • Returns a Timestamp from the given string, optionally using the given radix.

      Parameters

      • str: string

        the textual representation of the Timestamp.

      • optRadix: number

        the radix in which the text is written.

        -

      Returns Timestamp

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns Timestamp

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BSON.UUID.html b/docs/Next/classes/BSON.UUID.html index c5dd31e764a..00443a96fee 100644 --- a/docs/Next/classes/BSON.UUID.html +++ b/docs/Next/classes/BSON.UUID.html @@ -1,4 +1,4 @@ -UUID | mongodb

    Class UUID

    A class representation of the BSON UUID type.

    +UUID | mongodb

    Class UUID

    A class representation of the BSON UUID type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    buffer position @@ -74,4 +74,4 @@

    Returns UUID

    Staticgenerate

    • generate(): Uint8Array

    • Generates a populated buffer containing a v4 uuid

      Returns Uint8Array

    StaticisValid

    • isValid(input): boolean

    • Checks if a value is a valid bson UUID

      Parameters

      • input:
            | string
            | Uint8Array
            | Binary
            | UUID

        UUID, string or Buffer to validate.

        -

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/Batch.html b/docs/Next/classes/Batch.html index c93c9811c11..b839c28b797 100644 --- a/docs/Next/classes/Batch.html +++ b/docs/Next/classes/Batch.html @@ -1,4 +1,4 @@ -Batch | mongodb

    Class Batch<T>

    Keeps the state of a unordered batch so we can rewrite the results +Batch | mongodb

    Class Batch<T>

    Keeps the state of a unordered batch so we can rewrite the results correctly after command execution

    Type Parameters

    Constructors

    constructor

    Properties

    batchType @@ -8,4 +8,4 @@ originalZeroIndex size sizeBytes -

    Constructors

    constructor

    Properties

    batchType

    batchType: BatchType

    currentIndex

    currentIndex: number

    operations

    operations: T[]

    originalIndexes

    originalIndexes: number[]

    originalZeroIndex

    originalZeroIndex: number

    size

    size: number

    sizeBytes

    sizeBytes: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    batchType

    batchType: BatchType

    currentIndex

    currentIndex: number

    operations

    operations: T[]

    originalIndexes

    originalIndexes: number[]

    originalZeroIndex

    originalZeroIndex: number

    size

    size: number

    sizeBytes

    sizeBytes: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/docs/Next/classes/BulkOperationBase.html b/docs/Next/classes/BulkOperationBase.html index b4169994295..175d0672d2c 100644 --- a/docs/Next/classes/BulkOperationBase.html +++ b/docs/Next/classes/BulkOperationBase.html @@ -1,4 +1,4 @@ -BulkOperationBase | mongodb

    Class BulkOperationBaseAbstract

    Hierarchy (view full)

    Properties

    isOrdered +BulkOperationBase | mongodb

    Class BulkOperationBaseAbstract

    Hierarchy (view full)

    Properties

    isOrdered operationId?

    Accessors

    batches bsonOptions @@ -19,4 +19,4 @@

    raw

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/BulkWriteResult.html b/docs/Next/classes/BulkWriteResult.html index d3034d0197b..cb664d3487d 100644 --- a/docs/Next/classes/BulkWriteResult.html +++ b/docs/Next/classes/BulkWriteResult.html @@ -1,4 +1,4 @@ -BulkWriteResult | mongodb

    Class BulkWriteResult

    The result of a bulk write.

    +BulkWriteResult | mongodb

    Class BulkWriteResult

    The result of a bulk write.

    Properties

    deletedCount insertedCount insertedIds @@ -31,4 +31,4 @@

    Parameters

    • index: number

    Returns undefined | WriteError

    getWriteErrorCount

    • getWriteErrorCount(): number

    • Returns the number of write errors off the bulk operation

      Returns number

    getWriteErrors

    hasWriteErrors

    • hasWriteErrors(): boolean

    • Returns true if the bulk operation contains a write error

      -

      Returns boolean

    isOk

    toString

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Returns boolean

    isOk

    toString

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/CancellationToken.html b/docs/Next/classes/CancellationToken.html index ecb9072be78..6830ea96cd6 100644 --- a/docs/Next/classes/CancellationToken.html +++ b/docs/Next/classes/CancellationToken.html @@ -1,4 +1,4 @@ -CancellationToken | mongodb

    Class CancellationToken

    Hierarchy (view full)

    Constructors

    constructor +CancellationToken | mongodb

    Class CancellationToken

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    captureRejections captureRejectionSymbol defaultMaxListeners @@ -419,4 +419,4 @@

    Deprecated

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/Next/classes/ChangeStream.html b/docs/Next/classes/ChangeStream.html index e110024a65d..82e23330c98 100644 --- a/docs/Next/classes/ChangeStream.html +++ b/docs/Next/classes/ChangeStream.html @@ -1,4 +1,4 @@ -ChangeStream | mongodb

    Class ChangeStream<TSchema, TChange>

    Creates a new Change Stream instance. Normally created using Collection.watch().

    +ChangeStream | mongodb

    Class ChangeStream<TSchema, TChange>

    Creates a new Change Stream instance. Normally created using Collection.watch().

    Type Parameters

    Hierarchy (view full)

    Implements

    Properties

    [asyncDispose] namespace options @@ -462,4 +462,4 @@

    Deprecated

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/ClientEncryption.html b/docs/Next/classes/ClientEncryption.html index 403c92da9bf..20f81d47207 100644 --- a/docs/Next/classes/ClientEncryption.html +++ b/docs/Next/classes/ClientEncryption.html @@ -1,4 +1,4 @@ -ClientEncryption | mongodb

    Class ClientEncryption

    The public interface for explicit in-use encryption

    +ClientEncryption | mongodb

    Class ClientEncryption

    The public interface for explicit in-use encryption

    Constructors

    constructor

    Accessors

    libmongocryptVersion

    Methods

    addKeyAltName @@ -116,4 +116,4 @@

    ExampleExample

    // attempting to rewrap all data keys with no matches
    const filter = { _id: new Binary() } // assume _id matches no documents in the database
    const result = await clientEncryption.rewrapManyDataKey(filter);

    if (result.bulkWriteResult == null) {
     // no keys matched, `bulkWriteResult` does not exist on the result object
    }
    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/Next/classes/ClientSession.html b/docs/Next/classes/ClientSession.html index e9a10eedeef..b20c1d6ceb2 100644 --- a/docs/Next/classes/ClientSession.html +++ b/docs/Next/classes/ClientSession.html @@ -1,4 +1,4 @@ -ClientSession | mongodb

    Class ClientSession

    A class representing a client session on the server

    +ClientSession | mongodb

    Class ClientSession

    A class representing a client session on the server

    NOTE: not meant to be instantiated directly.

    Hierarchy (view full)

    Implements

    Properties

    [asyncDispose] clientOptions? @@ -496,4 +496,4 @@

    Deprecated

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/Collection.html b/docs/Next/classes/Collection.html index 7577625e900..4cb208c4af9 100644 --- a/docs/Next/classes/Collection.html +++ b/docs/Next/classes/Collection.html @@ -1,4 +1,4 @@ -Collection | mongodb

    Class Collection<TSchema>

    The Collection class is an internal class that embodies a MongoDB collection +Collection | mongodb

    Class Collection<TSchema>

    The Collection class is an internal class that embodies a MongoDB collection allowing for insert/find/update/delete and other command operation on that MongoDB collection.

    COLLECTION Cannot directly be instantiated

    Example

    import { MongoClient } from 'mongodb';

    interface Pet {
      name: string;
      kind: 'dog' | 'cat' | 'fish';
    }

    const client = new MongoClient('mongodb://localhost:27017');
    const pets = client.db().collection<Pet>('pets');

    const petCursor = pets.find();

    for await (const pet of petCursor) {
      console.log(`${pet.name} is a ${pet.kind}!`);
    }
@@ -273,4 +273,4 @@ 
    Examplecollection
      .watch<Schema, ChangeStreamInsertDocument<Schema> & { comment: string }>([
        { $addFields: { comment: 'big changes' } },
        { $match: { operationType: 'insert' } }
      ])
      .on('change', change => {
        change.comment.startsWith('big');
        change.operationType === 'insert';
        // No need to narrow in code because the generics did that for us!
        expectType<Schema>(change.fullDocument);
      });
    -

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods
    diff --git a/docs/Next/classes/CommandFailedEvent.html b/docs/Next/classes/CommandFailedEvent.html index 08c431d22e3..401c340a114 100644 --- a/docs/Next/classes/CommandFailedEvent.html +++ b/docs/Next/classes/CommandFailedEvent.html @@ -1,4 +1,4 @@ -CommandFailedEvent | mongodb

    Class CommandFailedEvent

    An event indicating the failure of a given command

    +CommandFailedEvent | mongodb

    Class CommandFailedEvent

    An event indicating the failure of a given command

    Properties

    address commandName connectionId? @@ -11,4 +11,4 @@

    Properties

    address

    address: string

    commandName

    commandName: string

    OptionalconnectionId

    connectionId?: string | number

    Driver generated connection id

    duration

    duration: number

    failure

    failure: Error

    requestId

    requestId: number

    serverConnectionId

    serverConnectionId: null | bigint

    Server generated connection id Distinct from the connection id and is returned by the hello or legacy hello response as "connectionId" from the server on 4.2+.

    -

    OptionalserviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    +

    OptionalserviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    diff --git a/docs/Next/classes/CommandStartedEvent.html b/docs/Next/classes/CommandStartedEvent.html index 7ff4936f0bb..a3349b2c63d 100644 --- a/docs/Next/classes/CommandStartedEvent.html +++ b/docs/Next/classes/CommandStartedEvent.html @@ -1,4 +1,4 @@ -CommandStartedEvent | mongodb

    Class CommandStartedEvent

    An event indicating the start of a given command

    +CommandStartedEvent | mongodb

    Class CommandStartedEvent

    An event indicating the start of a given command

    Properties

    address command commandName @@ -13,4 +13,4 @@

    databaseName

    databaseName: string

    requestId

    requestId: number

    serverConnectionId

    serverConnectionId: null | bigint

    Server generated connection id Distinct from the connection id and is returned by the hello or legacy hello response as "connectionId" from the server on 4.2+.

    -

    OptionalserviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    +

    OptionalserviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    diff --git a/docs/Next/classes/CommandSucceededEvent.html b/docs/Next/classes/CommandSucceededEvent.html index a875128c56b..1f9e524b56b 100644 --- a/docs/Next/classes/CommandSucceededEvent.html +++ b/docs/Next/classes/CommandSucceededEvent.html @@ -1,4 +1,4 @@ -CommandSucceededEvent | mongodb

    Class CommandSucceededEvent

    An event indicating the success of a given command

    +CommandSucceededEvent | mongodb

    Class CommandSucceededEvent

    An event indicating the success of a given command

    Properties

    address commandName connectionId? @@ -11,4 +11,4 @@

    Properties

    address

    address: string

    commandName

    commandName: string

    OptionalconnectionId

    connectionId?: string | number

    Driver generated connection id

    duration

    duration: number

    reply

    reply: unknown

    requestId

    requestId: number

    serverConnectionId

    serverConnectionId: null | bigint

    Server generated connection id Distinct from the connection id and is returned by the hello or legacy hello response as "connectionId" from the server on 4.2+.

    -

    OptionalserviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    +

    OptionalserviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    diff --git a/docs/Next/classes/ConnectionCheckOutFailedEvent.html b/docs/Next/classes/ConnectionCheckOutFailedEvent.html index 6809ef13f1a..bbff4d7e69f 100644 --- a/docs/Next/classes/ConnectionCheckOutFailedEvent.html +++ b/docs/Next/classes/ConnectionCheckOutFailedEvent.html @@ -1,4 +1,4 @@ -ConnectionCheckOutFailedEvent | mongodb

    Class ConnectionCheckOutFailedEvent

    An event published when a request to check a connection out fails

    +ConnectionCheckOutFailedEvent | mongodb

    Class ConnectionCheckOutFailedEvent

    An event published when a request to check a connection out fails

    Hierarchy (view full)

    Properties

    address durationMS reason @@ -10,4 +10,4 @@ and emitting this event as part of the same check out.

    reason

    reason: string

    The reason the attempt to check out failed

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ConnectionCheckOutStartedEvent.html b/docs/Next/classes/ConnectionCheckOutStartedEvent.html index bd4ad7b4950..fed6005d5a6 100644 --- a/docs/Next/classes/ConnectionCheckOutStartedEvent.html +++ b/docs/Next/classes/ConnectionCheckOutStartedEvent.html @@ -1,6 +1,6 @@ -ConnectionCheckOutStartedEvent | mongodb

    Class ConnectionCheckOutStartedEvent

    An event published when a request to check a connection out begins

    +ConnectionCheckOutStartedEvent | mongodb

    Class ConnectionCheckOutStartedEvent

    An event published when a request to check a connection out begins

    Hierarchy (view full)

    Properties

    address time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ConnectionCheckedInEvent.html b/docs/Next/classes/ConnectionCheckedInEvent.html index f1c86217745..6777ccf9755 100644 --- a/docs/Next/classes/ConnectionCheckedInEvent.html +++ b/docs/Next/classes/ConnectionCheckedInEvent.html @@ -1,8 +1,8 @@ -ConnectionCheckedInEvent | mongodb

    Class ConnectionCheckedInEvent

    An event published when a connection is checked into the connection pool

    +ConnectionCheckedInEvent | mongodb

    Class ConnectionCheckedInEvent

    An event published when a connection is checked into the connection pool

    Hierarchy (view full)

    Properties

    address connectionId time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    connectionId

    connectionId: number | "<monitor>"

    The id of the connection

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ConnectionCheckedOutEvent.html b/docs/Next/classes/ConnectionCheckedOutEvent.html index d9a45a7f1d0..cbcf0b2fb3e 100644 --- a/docs/Next/classes/ConnectionCheckedOutEvent.html +++ b/docs/Next/classes/ConnectionCheckedOutEvent.html @@ -1,4 +1,4 @@ -ConnectionCheckedOutEvent | mongodb

    Class ConnectionCheckedOutEvent

    An event published when a connection is checked out of the connection pool

    +ConnectionCheckedOutEvent | mongodb

    Class ConnectionCheckedOutEvent

    An event published when a connection is checked out of the connection pool

    Hierarchy (view full)

    Properties

    address connectionId durationMS @@ -10,4 +10,4 @@ emitting a ConnectionCheckOutStartedEvent and emitting this event as part of the same checking out.

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ConnectionClosedEvent.html b/docs/Next/classes/ConnectionClosedEvent.html index 5f339e280b4..3221bb64c9a 100644 --- a/docs/Next/classes/ConnectionClosedEvent.html +++ b/docs/Next/classes/ConnectionClosedEvent.html @@ -1,4 +1,4 @@ -ConnectionClosedEvent | mongodb

    Class ConnectionClosedEvent

    An event published when a connection is closed

    +ConnectionClosedEvent | mongodb

    Class ConnectionClosedEvent

    An event published when a connection is closed

    Hierarchy (view full)

    Properties

    address connectionId reason @@ -8,4 +8,4 @@

    connectionId

    connectionId: number | "<monitor>"

    The id of the connection

    reason

    reason: string

    The reason the connection was closed

    OptionalserviceId

    serviceId?: ObjectId

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ConnectionCreatedEvent.html b/docs/Next/classes/ConnectionCreatedEvent.html index ec5365b5cb9..0e2936cd7f2 100644 --- a/docs/Next/classes/ConnectionCreatedEvent.html +++ b/docs/Next/classes/ConnectionCreatedEvent.html @@ -1,8 +1,8 @@ -ConnectionCreatedEvent | mongodb

    Class ConnectionCreatedEvent

    An event published when a connection pool creates a new connection

    +ConnectionCreatedEvent | mongodb

    Class ConnectionCreatedEvent

    An event published when a connection pool creates a new connection

    Hierarchy (view full)

    Properties

    address connectionId time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    connectionId

    connectionId: number | "<monitor>"

    A monotonically increasing, per-pool id for the newly created connection

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ConnectionPoolClearedEvent.html b/docs/Next/classes/ConnectionPoolClearedEvent.html index 44b2bc8d4c4..d5c4e9b9c1b 100644 --- a/docs/Next/classes/ConnectionPoolClearedEvent.html +++ b/docs/Next/classes/ConnectionPoolClearedEvent.html @@ -1,7 +1,7 @@ -ConnectionPoolClearedEvent | mongodb

    Class ConnectionPoolClearedEvent

    An event published when a connection pool is cleared

    +ConnectionPoolClearedEvent | mongodb

    Class ConnectionPoolClearedEvent

    An event published when a connection pool is cleared

    Hierarchy (view full)

    Properties

    address interruptInUseConnections? time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    OptionalinterruptInUseConnections

    interruptInUseConnections?: boolean

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ConnectionPoolClosedEvent.html b/docs/Next/classes/ConnectionPoolClosedEvent.html index fd2b61cf547..1ed7db397bc 100644 --- a/docs/Next/classes/ConnectionPoolClosedEvent.html +++ b/docs/Next/classes/ConnectionPoolClosedEvent.html @@ -1,6 +1,6 @@ -ConnectionPoolClosedEvent | mongodb

    Class ConnectionPoolClosedEvent

    An event published when a connection pool is closed

    +ConnectionPoolClosedEvent | mongodb

    Class ConnectionPoolClosedEvent

    An event published when a connection pool is closed

    Hierarchy (view full)

    Properties

    address time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ConnectionPoolCreatedEvent.html b/docs/Next/classes/ConnectionPoolCreatedEvent.html index 93eaea2c731..16a49ace926 100644 --- a/docs/Next/classes/ConnectionPoolCreatedEvent.html +++ b/docs/Next/classes/ConnectionPoolCreatedEvent.html @@ -1,8 +1,8 @@ -ConnectionPoolCreatedEvent | mongodb

    Class ConnectionPoolCreatedEvent

    An event published when a connection pool is created

    +ConnectionPoolCreatedEvent | mongodb

    Class ConnectionPoolCreatedEvent

    An event published when a connection pool is created

    Hierarchy (view full)

    Properties

    address options time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    options

    options: Pick<ConnectionPoolOptions,
        | "maxConnecting"
        | "maxIdleTimeMS"
        | "maxPoolSize"
        | "minPoolSize"
        | "waitQueueTimeoutMS">

    The options used to create this connection pool

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ConnectionPoolMonitoringEvent.html b/docs/Next/classes/ConnectionPoolMonitoringEvent.html index 80e2bd1d96f..78adef5b6ac 100644 --- a/docs/Next/classes/ConnectionPoolMonitoringEvent.html +++ b/docs/Next/classes/ConnectionPoolMonitoringEvent.html @@ -1,6 +1,6 @@ -ConnectionPoolMonitoringEvent | mongodb

    Class ConnectionPoolMonitoringEventAbstract

    The base export class for all monitoring events published from the connection pool

    +ConnectionPoolMonitoringEvent | mongodb

    Class ConnectionPoolMonitoringEventAbstract

    The base export class for all monitoring events published from the connection pool

    Hierarchy (view full)

    Properties

    address time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ConnectionPoolReadyEvent.html b/docs/Next/classes/ConnectionPoolReadyEvent.html index 936e090cc09..b720796b49f 100644 --- a/docs/Next/classes/ConnectionPoolReadyEvent.html +++ b/docs/Next/classes/ConnectionPoolReadyEvent.html @@ -1,6 +1,6 @@ -ConnectionPoolReadyEvent | mongodb

    Class ConnectionPoolReadyEvent

    An event published when a connection pool is ready

    +ConnectionPoolReadyEvent | mongodb

    Class ConnectionPoolReadyEvent

    An event published when a connection pool is ready

    Hierarchy (view full)

    Properties

    address time

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ConnectionReadyEvent.html b/docs/Next/classes/ConnectionReadyEvent.html index 497af45aeff..f9d4449c656 100644 --- a/docs/Next/classes/ConnectionReadyEvent.html +++ b/docs/Next/classes/ConnectionReadyEvent.html @@ -1,4 +1,4 @@ -ConnectionReadyEvent | mongodb

    Class ConnectionReadyEvent

    An event published when a connection is ready for use

    +ConnectionReadyEvent | mongodb

    Class ConnectionReadyEvent

    An event published when a connection is ready for use

    Hierarchy (view full)

    Properties

    address connectionId durationMS @@ -14,4 +14,4 @@ this duration is not greater than ConnectionCheckedOutEvent.duration.

    time

    time: Date

    A timestamp when the event was created

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/Db.html b/docs/Next/classes/Db.html index 48a58bcc465..00c312b9944 100644 --- a/docs/Next/classes/Db.html +++ b/docs/Next/classes/Db.html @@ -1,4 +1,4 @@ -Db | mongodb

    Class Db

    The Db class is a class that represents a MongoDB Database.

    +Db | mongodb

    Class Db

    The Db class is a class that represents a MongoDB Database.

    Example

    import { MongoClient } from 'mongodb';

    interface Pet {
      name: string;
      kind: 'dog' | 'cat' | 'fish';
    }

    const client = new MongoClient('mongodb://localhost:27017');
    const db = client.db();

    // Create a collection that validates our union
    await db.createCollection<Pet>('pets', {
      validator: { $expr: { $in: ['$kind', ['dog', 'cat', 'fish']] } }
    })
    @@ -130,4 +130,4 @@
  • The first is to provide the schema that may be defined for all the collections within this database
  • The second is to override the shape of the change stream document entirely, if it is not provided the type will default to ChangeStreamDocument of the first argument
    • -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/FindCursor.html b/docs/Next/classes/FindCursor.html index 0543ab17f09..2660e23d52e 100644 --- a/docs/Next/classes/FindCursor.html +++ b/docs/Next/classes/FindCursor.html @@ -1,4 +1,4 @@ -FindCursor | mongodb

    Class FindCursor<TSchema>

    Type Parameters

    • TSchema = any

    Hierarchy (view full)

    Properties

    [asyncDispose] +FindCursor | mongodb

    Class FindCursor<TSchema>

    Type Parameters

    • TSchema = any

    Hierarchy (view full)

    Properties

    [asyncDispose] captureRejections captureRejectionSymbol CLOSE @@ -566,4 +566,4 @@

    Deprecat

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/FindOperators.html b/docs/Next/classes/FindOperators.html index c74886e9edf..06e8fb13954 100644 --- a/docs/Next/classes/FindOperators.html +++ b/docs/Next/classes/FindOperators.html @@ -1,4 +1,4 @@ -FindOperators | mongodb

    Class FindOperators

    A builder object that is returned from BulkOperationBase#find. +FindOperators | mongodb

    Class FindOperators

    A builder object that is returned from BulkOperationBase#find. Is used to build a write operation that involves a query filter.

    Properties

    bulkOperation

    Methods

    arrayFilters @@ -19,4 +19,4 @@

    Parameters

    Returns BulkOperationBase

    update

    updateOne

    upsert

    • upsert(): this

    • Upsert modifier for update bulk operation, noting that this operation is an upsert.

      -

      Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/docs/Next/classes/GridFSBucket.html b/docs/Next/classes/GridFSBucket.html index 444f4d3c2d9..4a8c1bf561c 100644 --- a/docs/Next/classes/GridFSBucket.html +++ b/docs/Next/classes/GridFSBucket.html @@ -1,4 +1,4 @@ -GridFSBucket | mongodb

    Class GridFSBucket

    Constructor for a streaming GridFS interface

    +GridFSBucket | mongodb

    Class GridFSBucket

    Constructor for a streaming GridFS interface

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    captureRejections captureRejectionSymbol @@ -455,4 +455,4 @@

    Deprecated

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/Next/classes/GridFSBucketReadStream.html b/docs/Next/classes/GridFSBucketReadStream.html index 6cc6472e0e4..8a2ae7004fb 100644 --- a/docs/Next/classes/GridFSBucketReadStream.html +++ b/docs/Next/classes/GridFSBucketReadStream.html @@ -1,4 +1,4 @@ -GridFSBucketReadStream | mongodb

    Class GridFSBucketReadStream

    A readable stream that enables you to read buffers from GridFS.

    +GridFSBucketReadStream | mongodb

    Class GridFSBucketReadStream

    A readable stream that enables you to read buffers from GridFS.

    Do not instantiate this class directly. Use openDownloadStream() instead.

    Hierarchy

    • Readable
      • GridFSBucketReadStream

    Properties

    closed destroyed @@ -1169,4 +1169,4 @@

    Deprecated

  • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    • Returns void

    Since

    v15.4.0

    StatictoWeb

    • toWeb(streamReadable): ReadableStream<any>
    • Experimental

      A utility method for creating a web ReadableStream from a Readable.

      Parameters

      • streamReadable: Readable

      Returns ReadableStream<any>

      Since

      v17.0.0

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/docs/Next/classes/GridFSBucketWriteStream.html b/docs/Next/classes/GridFSBucketWriteStream.html index a8c183fae84..2d22bc8847b 100644 --- a/docs/Next/classes/GridFSBucketWriteStream.html +++ b/docs/Next/classes/GridFSBucketWriteStream.html @@ -1,4 +1,4 @@ -GridFSBucketWriteStream | mongodb

    Class GridFSBucketWriteStream

    A writable stream that enables you to write buffers to GridFS.

    +GridFSBucketWriteStream | mongodb

    Class GridFSBucketWriteStream

    A writable stream that enables you to write buffers to GridFS.

    Do not instantiate this class directly. Use openUploadStream() instead.

    Hierarchy

    • Writable
      • GridFSBucketWriteStream

    Properties

    bucket bufToStore @@ -948,4 +948,4 @@

    Deprecated

  • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    • Returns void

    Since

    v15.4.0

    StatictoWeb

    • toWeb(streamWritable): WritableStream<any>
    • Experimental

      A utility method for creating a web WritableStream from a Writable.

      Parameters

      • streamWritable: Writable

      Returns WritableStream<any>

      Since

      v17.0.0

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/docs/Next/classes/HostAddress.html b/docs/Next/classes/HostAddress.html index 8a8ca74a1ea..fe1fb965dff 100644 --- a/docs/Next/classes/HostAddress.html +++ b/docs/Next/classes/HostAddress.html @@ -1,4 +1,4 @@ -HostAddress | mongodb

    Class HostAddress

    Constructors

    constructor +HostAddress | mongodb

    Class HostAddress

    Constructors

    constructor

    Properties

    host isIPv6 port @@ -9,4 +9,4 @@ fromHostPort fromSrvRecord fromString -

    Constructors

    constructor

    Properties

    host

    host: undefined | string = undefined

    isIPv6

    isIPv6: boolean = false

    port

    port: undefined | number = undefined

    socketPath

    socketPath: undefined | string = undefined

    Methods

    inspect

    toHostPort

    • toHostPort(): {
          host: string;
          port: number;
      }

    • Returns {
          host: string;
          port: number;
      }

      • host: string
      • port: number

    toString

    StaticfromHostPort

    StaticfromSrvRecord

    StaticfromString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    host

    host: undefined | string = undefined

    isIPv6

    isIPv6: boolean = false

    port

    port: undefined | number = undefined

    socketPath

    socketPath: undefined | string = undefined

    Methods

    inspect

    toHostPort

    • toHostPort(): {
          host: string;
          port: number;
      }

    • Returns {
          host: string;
          port: number;
      }

      • host: string
      • port: number

    toString

    StaticfromHostPort

    StaticfromSrvRecord

    StaticfromString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/Next/classes/ListCollectionsCursor.html b/docs/Next/classes/ListCollectionsCursor.html index 15200e8294d..972f2990621 100644 --- a/docs/Next/classes/ListCollectionsCursor.html +++ b/docs/Next/classes/ListCollectionsCursor.html @@ -1,4 +1,4 @@ -ListCollectionsCursor | mongodb

    Class ListCollectionsCursor<T>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +ListCollectionsCursor | mongodb

    Class ListCollectionsCursor<T>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    [asyncDispose] filter options? @@ -507,4 +507,4 @@

    Deprecat

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/ListIndexesCursor.html b/docs/Next/classes/ListIndexesCursor.html index a1b2a190ae9..ecd4a561109 100644 --- a/docs/Next/classes/ListIndexesCursor.html +++ b/docs/Next/classes/ListIndexesCursor.html @@ -1,4 +1,4 @@ -ListIndexesCursor | mongodb

    Class ListIndexesCursor

    Hierarchy (view full)

    Constructors

    constructor +ListIndexesCursor | mongodb

    Class ListIndexesCursor

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    [asyncDispose] options? parent @@ -506,4 +506,4 @@

    Deprecat

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/ListSearchIndexesCursor.html b/docs/Next/classes/ListSearchIndexesCursor.html index 9162577a543..944686853db 100644 --- a/docs/Next/classes/ListSearchIndexesCursor.html +++ b/docs/Next/classes/ListSearchIndexesCursor.html @@ -1,4 +1,4 @@ -ListSearchIndexesCursor | mongodb

    Class ListSearchIndexesCursor

    Hierarchy (view full)

    Properties

    [asyncDispose] +ListSearchIndexesCursor | mongodb

    Class ListSearchIndexesCursor

    Hierarchy (view full)

    Properties

    [asyncDispose] pipeline captureRejections captureRejectionSymbol @@ -546,4 +546,4 @@

    Deprecat

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoAPIError.html b/docs/Next/classes/MongoAPIError.html index fc07030a366..8a2b2a9d3bb 100644 --- a/docs/Next/classes/MongoAPIError.html +++ b/docs/Next/classes/MongoAPIError.html @@ -1,4 +1,4 @@ -MongoAPIError | mongodb

    Class MongoAPIError

    An error generated when the driver API is used incorrectly

    +MongoAPIError | mongodb

    Class MongoAPIError

    An error generated when the driver API is used incorrectly

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoAWSError.html b/docs/Next/classes/MongoAWSError.html index 02e8960b22c..3516e9a97ac 100644 --- a/docs/Next/classes/MongoAWSError.html +++ b/docs/Next/classes/MongoAWSError.html @@ -1,4 +1,4 @@ -MongoAWSError | mongodb

    Class MongoAWSError

    A error generated when the user attempts to authenticate +MongoAWSError | mongodb

    Class MongoAWSError

    A error generated when the user attempts to authenticate via AWS, but fails

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoAzureError.html b/docs/Next/classes/MongoAzureError.html index 6664be99bdc..ebc958ab904 100644 --- a/docs/Next/classes/MongoAzureError.html +++ b/docs/Next/classes/MongoAzureError.html @@ -1,4 +1,4 @@ -MongoAzureError | mongodb

    Class MongoAzureError

    A error generated when the user attempts to authenticate +MongoAzureError | mongodb

    Class MongoAzureError

    A error generated when the user attempts to authenticate via Azure, but fails.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoBatchReExecutionError.html b/docs/Next/classes/MongoBatchReExecutionError.html index 946b041b5ed..1e1d1cb7025 100644 --- a/docs/Next/classes/MongoBatchReExecutionError.html +++ b/docs/Next/classes/MongoBatchReExecutionError.html @@ -1,4 +1,4 @@ -MongoBatchReExecutionError | mongodb

    Class MongoBatchReExecutionError

    An error generated when a batch command is re-executed after one of the commands in the batch +MongoBatchReExecutionError | mongodb

    Class MongoBatchReExecutionError

    An error generated when a batch command is re-executed after one of the commands in the batch has failed

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoBulkWriteError.html b/docs/Next/classes/MongoBulkWriteError.html index 96c768a12fe..49d0c21951e 100644 --- a/docs/Next/classes/MongoBulkWriteError.html +++ b/docs/Next/classes/MongoBulkWriteError.html @@ -1,4 +1,4 @@ -MongoBulkWriteError | mongodb

    Class MongoBulkWriteError

    An error indicating an unsuccessful Bulk Write

    +MongoBulkWriteError | mongodb

    Class MongoBulkWriteError

    An error indicating an unsuccessful Bulk Write

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -49,4 +49,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoChangeStreamError.html b/docs/Next/classes/MongoChangeStreamError.html index ebe7f30b286..1e478750c52 100644 --- a/docs/Next/classes/MongoChangeStreamError.html +++ b/docs/Next/classes/MongoChangeStreamError.html @@ -1,4 +1,4 @@ -MongoChangeStreamError | mongodb

    Class MongoChangeStreamError

    An error generated when a ChangeStream operation fails to execute.

    +MongoChangeStreamError | mongodb

    Class MongoChangeStreamError

    An error generated when a ChangeStream operation fails to execute.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoClient.html b/docs/Next/classes/MongoClient.html index 8085fdd414b..8dc4750e877 100644 --- a/docs/Next/classes/MongoClient.html +++ b/docs/Next/classes/MongoClient.html @@ -1,4 +1,4 @@ -MongoClient | mongodb

    Class MongoClient

    The MongoClient class is a class that allows for making Connections to MongoDB.

    +MongoClient | mongodb

    Class MongoClient

    The MongoClient class is a class that allows for making Connections to MongoDB.

    Remarks

    The programmatically provided options take precedence over the URI options.

    Example

    import { MongoClient } from 'mongodb';

    // Enable command monitoring for debugging
    const client = new MongoClient('mongodb://localhost:27017', { monitorCommands: true });

    client.on('commandStarted', started => console.log(started));
    client.db().collection('pets');
    await client.insertOne({ name: 'spot', kind: 'dog' });
    @@ -483,4 +483,4 @@

    Deprecated

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoClientBulkWriteCursorError.html b/docs/Next/classes/MongoClientBulkWriteCursorError.html index 69185a923d7..964bb36031c 100644 --- a/docs/Next/classes/MongoClientBulkWriteCursorError.html +++ b/docs/Next/classes/MongoClientBulkWriteCursorError.html @@ -1,4 +1,4 @@ -MongoClientBulkWriteCursorError | mongodb

    Class MongoClientBulkWriteCursorError

    An error indicating that an error occurred when processing bulk write results.

    +MongoClientBulkWriteCursorError | mongodb

    Class MongoClientBulkWriteCursorError

    An error indicating that an error occurred when processing bulk write results.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoClientBulkWriteError.html b/docs/Next/classes/MongoClientBulkWriteError.html index c3d6b8224dd..f3b79b65b7b 100644 --- a/docs/Next/classes/MongoClientBulkWriteError.html +++ b/docs/Next/classes/MongoClientBulkWriteError.html @@ -1,4 +1,4 @@ -MongoClientBulkWriteError | mongodb

    Class MongoClientBulkWriteError

    An error indicating that an error occurred when executing the bulk write.

    +MongoClientBulkWriteError | mongodb

    Class MongoClientBulkWriteError

    An error indicating that an error occurred when executing the bulk write.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -39,4 +39,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoClientBulkWriteExecutionError.html b/docs/Next/classes/MongoClientBulkWriteExecutionError.html index d9435ab8bc4..28b9d6e1551 100644 --- a/docs/Next/classes/MongoClientBulkWriteExecutionError.html +++ b/docs/Next/classes/MongoClientBulkWriteExecutionError.html @@ -1,4 +1,4 @@ -MongoClientBulkWriteExecutionError | mongodb

    Class MongoClientBulkWriteExecutionError

    An error indicating that an error occurred on the client when executing a client bulk write.

    +MongoClientBulkWriteExecutionError | mongodb

    Class MongoClientBulkWriteExecutionError

    An error indicating that an error occurred on the client when executing a client bulk write.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoCompatibilityError.html b/docs/Next/classes/MongoCompatibilityError.html index ede2065e451..48e3dc3e957 100644 --- a/docs/Next/classes/MongoCompatibilityError.html +++ b/docs/Next/classes/MongoCompatibilityError.html @@ -1,4 +1,4 @@ -MongoCompatibilityError | mongodb

    Class MongoCompatibilityError

    An error generated when a feature that is not enabled or allowed for the current server +MongoCompatibilityError | mongodb

    Class MongoCompatibilityError

    An error generated when a feature that is not enabled or allowed for the current server configuration is used

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoCredentials.html b/docs/Next/classes/MongoCredentials.html index 76561986044..d4bc119f57f 100644 --- a/docs/Next/classes/MongoCredentials.html +++ b/docs/Next/classes/MongoCredentials.html @@ -1,5 +1,5 @@ -MongoCredentials | mongodb

    Class MongoCredentials

    A representation of the credentials used by MongoDB

    -

    Constructors

    constructor +MongoCredentials | mongodb

    Class MongoCredentials

    A representation of the credentials used by MongoDB

    +

    Constructors

    constructor

    Properties

    mechanism mechanismProperties password @@ -9,13 +9,13 @@ resolveAuthMechanism validate merge -

    Constructors

    constructor

    Properties

    Readonlymechanism

    mechanism: AuthMechanism

    The method used to authenticate

    -

    ReadonlymechanismProperties

    mechanismProperties: AuthMechanismProperties

    Special properties used by some types of auth mechanisms

    -

    Readonlypassword

    password: string

    The password used for authentication

    -

    Readonlysource

    source: string

    The database that the user should authenticate against

    -

    Readonlyusername

    username: string

    The username used for authentication

    -

    Methods

    equals

    resolveAuthMechanism

    • resolveAuthMechanism(hello): MongoCredentials

    • If the authentication mechanism is set to "default", resolves the authMechanism +

    Constructors

    constructor

    Properties

    Readonlymechanism

    mechanism: AuthMechanism

    The method used to authenticate

    +

    ReadonlymechanismProperties

    mechanismProperties: AuthMechanismProperties

    Special properties used by some types of auth mechanisms

    +

    Readonlypassword

    password: string

    The password used for authentication

    +

    Readonlysource

    source: string

    The database that the user should authenticate against

    +

    Readonlyusername

    username: string

    The username used for authentication

    +

    Methods

    equals

    resolveAuthMechanism

    validate

    Staticmerge

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns MongoCredentials

    validate

    Staticmerge

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/Next/classes/MongoCryptAzureKMSRequestError.html b/docs/Next/classes/MongoCryptAzureKMSRequestError.html index 7a2739454cd..2b4df1c2be1 100644 --- a/docs/Next/classes/MongoCryptAzureKMSRequestError.html +++ b/docs/Next/classes/MongoCryptAzureKMSRequestError.html @@ -1,4 +1,4 @@ -MongoCryptAzureKMSRequestError | mongodb

    Class MongoCryptAzureKMSRequestError

    An error indicating that mongodb-client-encryption failed to auto-refresh Azure KMS credentials.

    +MongoCryptAzureKMSRequestError | mongodb

    Class MongoCryptAzureKMSRequestError

    An error indicating that mongodb-client-encryption failed to auto-refresh Azure KMS credentials.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    body? cause? @@ -28,4 +28,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoCryptCreateDataKeyError.html b/docs/Next/classes/MongoCryptCreateDataKeyError.html index 054c1bda6c5..3697533dfd5 100644 --- a/docs/Next/classes/MongoCryptCreateDataKeyError.html +++ b/docs/Next/classes/MongoCryptCreateDataKeyError.html @@ -1,4 +1,4 @@ -MongoCryptCreateDataKeyError | mongodb

    Class MongoCryptCreateDataKeyError

    An error indicating that ClientEncryption.createEncryptedCollection() failed to create data keys

    +MongoCryptCreateDataKeyError | mongodb

    Class MongoCryptCreateDataKeyError

    An error indicating that ClientEncryption.createEncryptedCollection() failed to create data keys

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoCryptCreateEncryptedCollectionError.html b/docs/Next/classes/MongoCryptCreateEncryptedCollectionError.html index 5fe9071b971..dc8aefe6847 100644 --- a/docs/Next/classes/MongoCryptCreateEncryptedCollectionError.html +++ b/docs/Next/classes/MongoCryptCreateEncryptedCollectionError.html @@ -1,4 +1,4 @@ -MongoCryptCreateEncryptedCollectionError | mongodb

    Class MongoCryptCreateEncryptedCollectionError

    An error indicating that ClientEncryption.createEncryptedCollection() failed to create a collection

    +MongoCryptCreateEncryptedCollectionError | mongodb

    Class MongoCryptCreateEncryptedCollectionError

    An error indicating that ClientEncryption.createEncryptedCollection() failed to create a collection

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoCryptError.html b/docs/Next/classes/MongoCryptError.html index d0a01413838..803bbf32825 100644 --- a/docs/Next/classes/MongoCryptError.html +++ b/docs/Next/classes/MongoCryptError.html @@ -1,4 +1,4 @@ -MongoCryptError | mongodb

    Class MongoCryptError

    An error indicating that something went wrong specifically with MongoDB Client Encryption

    +MongoCryptError | mongodb

    Class MongoCryptError

    An error indicating that something went wrong specifically with MongoDB Client Encryption

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoCryptInvalidArgumentError.html b/docs/Next/classes/MongoCryptInvalidArgumentError.html index eb31b53cf22..c7c44a557c9 100644 --- a/docs/Next/classes/MongoCryptInvalidArgumentError.html +++ b/docs/Next/classes/MongoCryptInvalidArgumentError.html @@ -1,4 +1,4 @@ -MongoCryptInvalidArgumentError | mongodb

    Class MongoCryptInvalidArgumentError

    An error indicating an invalid argument was provided to an encryption API.

    +MongoCryptInvalidArgumentError | mongodb

    Class MongoCryptInvalidArgumentError

    An error indicating an invalid argument was provided to an encryption API.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoCryptKMSRequestNetworkTimeoutError.html b/docs/Next/classes/MongoCryptKMSRequestNetworkTimeoutError.html index 22ef109e3ef..dd63394eb8f 100644 --- a/docs/Next/classes/MongoCryptKMSRequestNetworkTimeoutError.html +++ b/docs/Next/classes/MongoCryptKMSRequestNetworkTimeoutError.html @@ -1,4 +1,4 @@ -MongoCryptKMSRequestNetworkTimeoutError | mongodb

    Class MongoCryptKMSRequestNetworkTimeoutError

    Hierarchy (view full)

    Constructors

    constructor +MongoCryptKMSRequestNetworkTimeoutError | mongodb

    Class MongoCryptKMSRequestNetworkTimeoutError

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? connectionGeneration? @@ -25,4 +25,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoCursorExhaustedError.html b/docs/Next/classes/MongoCursorExhaustedError.html index d339ece6819..34fa4140c6a 100644 --- a/docs/Next/classes/MongoCursorExhaustedError.html +++ b/docs/Next/classes/MongoCursorExhaustedError.html @@ -1,4 +1,4 @@ -MongoCursorExhaustedError | mongodb

    Class MongoCursorExhaustedError

    An error thrown when an attempt is made to read from a cursor that has been exhausted

    +MongoCursorExhaustedError | mongodb

    Class MongoCursorExhaustedError

    An error thrown when an attempt is made to read from a cursor that has been exhausted

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoCursorInUseError.html b/docs/Next/classes/MongoCursorInUseError.html index d37b8d52af8..c42fcb2c693 100644 --- a/docs/Next/classes/MongoCursorInUseError.html +++ b/docs/Next/classes/MongoCursorInUseError.html @@ -1,4 +1,4 @@ -MongoCursorInUseError | mongodb

    Class MongoCursorInUseError

    An error thrown when the user attempts to add options to a cursor that has already been +MongoCursorInUseError | mongodb

    Class MongoCursorInUseError

    An error thrown when the user attempts to add options to a cursor that has already been initialized

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoDBCollectionNamespace.html b/docs/Next/classes/MongoDBCollectionNamespace.html index 63d0e3d9af7..3e04a20da9f 100644 --- a/docs/Next/classes/MongoDBCollectionNamespace.html +++ b/docs/Next/classes/MongoDBCollectionNamespace.html @@ -1,4 +1,4 @@ -MongoDBCollectionNamespace | mongodb

    Class MongoDBCollectionNamespace

    A class representing a collection's namespace. This class enforces (through Typescript) that +MongoDBCollectionNamespace | mongodb

    Class MongoDBCollectionNamespace

    A class representing a collection's namespace. This class enforces (through Typescript) that the collection portion of the namespace is defined and should only be used in scenarios where this can be guaranteed.

    Hierarchy (view full)

    Constructors

    constructor @@ -9,4 +9,4 @@ fromString

    Constructors

    constructor

    Properties

    collection

    collection: string

    collection name

    db

    db: string

    database name

    -

    Methods

    toString

    withCollection

    StaticfromString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Methods

    toString

    withCollection

    StaticfromString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/Next/classes/MongoDBNamespace.html b/docs/Next/classes/MongoDBNamespace.html index 91a83d887d4..9da28b16879 100644 --- a/docs/Next/classes/MongoDBNamespace.html +++ b/docs/Next/classes/MongoDBNamespace.html @@ -1,4 +1,4 @@ -MongoDBNamespace | mongodb

    Class MongoDBNamespace

    Hierarchy (view full)

    Constructors

    constructor +MongoDBNamespace | mongodb

    Class MongoDBNamespace

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    collection? db

    Methods

    toString @@ -9,4 +9,4 @@
  • Optionalcollection: string

    collection name

    • Returns MongoDBNamespace

    Properties

    Optionalcollection

    collection?: string

    collection name

    db

    db: string

    database name

    -

    Methods

    toString

    withCollection

    StaticfromString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Methods

    toString

    withCollection

    StaticfromString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/Next/classes/MongoDecompressionError.html b/docs/Next/classes/MongoDecompressionError.html index 8cca7f449aa..961c1f6b06d 100644 --- a/docs/Next/classes/MongoDecompressionError.html +++ b/docs/Next/classes/MongoDecompressionError.html @@ -1,4 +1,4 @@ -MongoDecompressionError | mongodb

    Class MongoDecompressionError

    An error generated when the driver fails to decompress +MongoDecompressionError | mongodb

    Class MongoDecompressionError

    An error generated when the driver fails to decompress data received from the server.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoDriverError.html b/docs/Next/classes/MongoDriverError.html index 7e385272d39..94ca1d35b1a 100644 --- a/docs/Next/classes/MongoDriverError.html +++ b/docs/Next/classes/MongoDriverError.html @@ -1,4 +1,4 @@ -MongoDriverError | mongodb

    Class MongoDriverError

    An error generated by the driver

    +MongoDriverError | mongodb

    Class MongoDriverError

    An error generated by the driver

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoError.html b/docs/Next/classes/MongoError.html index fdd681833d2..fea731d4562 100644 --- a/docs/Next/classes/MongoError.html +++ b/docs/Next/classes/MongoError.html @@ -1,4 +1,4 @@ -MongoError | mongodb

    Class MongoError

    Hierarchy (view full)

    Constructors

    constructor +MongoError | mongodb

    Class MongoError

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? connectionGeneration? @@ -25,4 +25,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoExpiredSessionError.html b/docs/Next/classes/MongoExpiredSessionError.html index 24dca803bf1..5c2c1afe9d9 100644 --- a/docs/Next/classes/MongoExpiredSessionError.html +++ b/docs/Next/classes/MongoExpiredSessionError.html @@ -1,4 +1,4 @@ -MongoExpiredSessionError | mongodb

    Class MongoExpiredSessionError

    An error generated when the user attempts to operate +MongoExpiredSessionError | mongodb

    Class MongoExpiredSessionError

    An error generated when the user attempts to operate on a session that has expired or has been closed.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoGCPError.html b/docs/Next/classes/MongoGCPError.html index 18ed8c41a66..05dec576f1f 100644 --- a/docs/Next/classes/MongoGCPError.html +++ b/docs/Next/classes/MongoGCPError.html @@ -1,4 +1,4 @@ -MongoGCPError | mongodb

    Class MongoGCPError

    A error generated when the user attempts to authenticate +MongoGCPError | mongodb

    Class MongoGCPError

    A error generated when the user attempts to authenticate via GCP, but fails.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoGridFSChunkError.html b/docs/Next/classes/MongoGridFSChunkError.html index dcef6ab4095..aa5dddb080e 100644 --- a/docs/Next/classes/MongoGridFSChunkError.html +++ b/docs/Next/classes/MongoGridFSChunkError.html @@ -1,4 +1,4 @@ -MongoGridFSChunkError | mongodb

    Class MongoGridFSChunkError

    An error generated when a malformed or invalid chunk is +MongoGridFSChunkError | mongodb

    Class MongoGridFSChunkError

    An error generated when a malformed or invalid chunk is encountered when reading from a GridFSStream.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoGridFSStreamError.html b/docs/Next/classes/MongoGridFSStreamError.html index 59c6f45c38d..ff926618744 100644 --- a/docs/Next/classes/MongoGridFSStreamError.html +++ b/docs/Next/classes/MongoGridFSStreamError.html @@ -1,4 +1,4 @@ -MongoGridFSStreamError | mongodb

    Class MongoGridFSStreamError

    An error generated when a GridFSStream operation fails to execute.

    +MongoGridFSStreamError | mongodb

    Class MongoGridFSStreamError

    An error generated when a GridFSStream operation fails to execute.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoInvalidArgumentError.html b/docs/Next/classes/MongoInvalidArgumentError.html index be226cfe424..cc5851334b3 100644 --- a/docs/Next/classes/MongoInvalidArgumentError.html +++ b/docs/Next/classes/MongoInvalidArgumentError.html @@ -1,4 +1,4 @@ -MongoInvalidArgumentError | mongodb

    Class MongoInvalidArgumentError

    An error generated when the user supplies malformed or unexpected arguments +MongoInvalidArgumentError | mongodb

    Class MongoInvalidArgumentError

    An error generated when the user supplies malformed or unexpected arguments or when a required argument or field is not provided.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoKerberosError.html b/docs/Next/classes/MongoKerberosError.html index 2a7ddc019ab..fb246865c11 100644 --- a/docs/Next/classes/MongoKerberosError.html +++ b/docs/Next/classes/MongoKerberosError.html @@ -1,4 +1,4 @@ -MongoKerberosError | mongodb

    Class MongoKerberosError

    A error generated when the user attempts to authenticate +MongoKerberosError | mongodb

    Class MongoKerberosError

    A error generated when the user attempts to authenticate via Kerberos, but fails to connect to the Kerberos client.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoMissingCredentialsError.html b/docs/Next/classes/MongoMissingCredentialsError.html index 3faebd234bb..346c3b48ca4 100644 --- a/docs/Next/classes/MongoMissingCredentialsError.html +++ b/docs/Next/classes/MongoMissingCredentialsError.html @@ -1,4 +1,4 @@ -MongoMissingCredentialsError | mongodb

    Class MongoMissingCredentialsError

    An error generated when the user fails to provide authentication credentials before attempting +MongoMissingCredentialsError | mongodb

    Class MongoMissingCredentialsError

    An error generated when the user fails to provide authentication credentials before attempting to connect to a mongo server instance.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoMissingDependencyError.html b/docs/Next/classes/MongoMissingDependencyError.html index c485ad6f531..227337e45c3 100644 --- a/docs/Next/classes/MongoMissingDependencyError.html +++ b/docs/Next/classes/MongoMissingDependencyError.html @@ -1,4 +1,4 @@ -MongoMissingDependencyError | mongodb

    Class MongoMissingDependencyError

    An error generated when a required module or dependency is not present in the local environment

    +MongoMissingDependencyError | mongodb

    Class MongoMissingDependencyError

    An error generated when a required module or dependency is not present in the local environment

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause code? @@ -28,4 +28,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoNetworkError.html b/docs/Next/classes/MongoNetworkError.html index a138391ebd6..fd90fdc5e84 100644 --- a/docs/Next/classes/MongoNetworkError.html +++ b/docs/Next/classes/MongoNetworkError.html @@ -1,4 +1,4 @@ -MongoNetworkError | mongodb

    Class MongoNetworkError

    An error indicating an issue with the network, including TCP errors and timeouts.

    +MongoNetworkError | mongodb

    Class MongoNetworkError

    An error indicating an issue with the network, including TCP errors and timeouts.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoNetworkTimeoutError.html b/docs/Next/classes/MongoNetworkTimeoutError.html index 6998a8a6299..84dc66fbab0 100644 --- a/docs/Next/classes/MongoNetworkTimeoutError.html +++ b/docs/Next/classes/MongoNetworkTimeoutError.html @@ -1,4 +1,4 @@ -MongoNetworkTimeoutError | mongodb

    Class MongoNetworkTimeoutError

    An error indicating a network timeout occurred

    +MongoNetworkTimeoutError | mongodb

    Class MongoNetworkTimeoutError

    An error indicating a network timeout occurred

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoNotConnectedError.html b/docs/Next/classes/MongoNotConnectedError.html index a77e04c06cd..49308980931 100644 --- a/docs/Next/classes/MongoNotConnectedError.html +++ b/docs/Next/classes/MongoNotConnectedError.html @@ -1,4 +1,4 @@ -MongoNotConnectedError | mongodb

    Class MongoNotConnectedError

    An error thrown when the user attempts to operate on a database or collection through a MongoClient +MongoNotConnectedError | mongodb

    Class MongoNotConnectedError

    An error thrown when the user attempts to operate on a database or collection through a MongoClient that has not yet successfully called the "connect" method

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoOIDCError.html b/docs/Next/classes/MongoOIDCError.html index 136b39e402c..8f80b01e5c0 100644 --- a/docs/Next/classes/MongoOIDCError.html +++ b/docs/Next/classes/MongoOIDCError.html @@ -1,4 +1,4 @@ -MongoOIDCError | mongodb

    Class MongoOIDCError

    A error generated when the user attempts to authenticate +MongoOIDCError | mongodb

    Class MongoOIDCError

    A error generated when the user attempts to authenticate via OIDC callbacks, but fails.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoParseError.html b/docs/Next/classes/MongoParseError.html index 74813fabfba..47b7fa72136 100644 --- a/docs/Next/classes/MongoParseError.html +++ b/docs/Next/classes/MongoParseError.html @@ -1,4 +1,4 @@ -MongoParseError | mongodb

    Class MongoParseError

    An error used when attempting to parse a value (like a connection string)

    +MongoParseError | mongodb

    Class MongoParseError

    An error used when attempting to parse a value (like a connection string)

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoRuntimeError.html b/docs/Next/classes/MongoRuntimeError.html index 24788249289..7b888e450e1 100644 --- a/docs/Next/classes/MongoRuntimeError.html +++ b/docs/Next/classes/MongoRuntimeError.html @@ -1,4 +1,4 @@ -MongoRuntimeError | mongodb

    Class MongoRuntimeError

    An error generated when the driver encounters unexpected input +MongoRuntimeError | mongodb

    Class MongoRuntimeError

    An error generated when the driver encounters unexpected input or reaches an unexpected/invalid internal state

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoServerClosedError.html b/docs/Next/classes/MongoServerClosedError.html index f0fc1ad1ba9..d2e92e40a31 100644 --- a/docs/Next/classes/MongoServerClosedError.html +++ b/docs/Next/classes/MongoServerClosedError.html @@ -1,4 +1,4 @@ -MongoServerClosedError | mongodb

    Class MongoServerClosedError

    An error generated when an attempt is made to operate +MongoServerClosedError | mongodb

    Class MongoServerClosedError

    An error generated when an attempt is made to operate on a closed/closing server.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoServerError.html b/docs/Next/classes/MongoServerError.html index ee73d71d4d7..869344fb052 100644 --- a/docs/Next/classes/MongoServerError.html +++ b/docs/Next/classes/MongoServerError.html @@ -1,4 +1,4 @@ -MongoServerError | mongodb

    Class MongoServerError

    An error coming from the mongo server

    +MongoServerError | mongodb

    Class MongoServerError

    An error coming from the mongo server

    Hierarchy (view full)

    Indexable

    • [key: string]: any

    Constructors

    constructor

    Properties

    cause? code? @@ -32,4 +32,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoServerSelectionError.html b/docs/Next/classes/MongoServerSelectionError.html index 6e7f6994e70..80c929facf9 100644 --- a/docs/Next/classes/MongoServerSelectionError.html +++ b/docs/Next/classes/MongoServerSelectionError.html @@ -1,4 +1,4 @@ -MongoServerSelectionError | mongodb

    Class MongoServerSelectionError

    An error signifying a client-side server selection error

    +MongoServerSelectionError | mongodb

    Class MongoServerSelectionError

    An error signifying a client-side server selection error

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -28,4 +28,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoSystemError.html b/docs/Next/classes/MongoSystemError.html index d2d7c52034d..bd303a0ddfd 100644 --- a/docs/Next/classes/MongoSystemError.html +++ b/docs/Next/classes/MongoSystemError.html @@ -1,4 +1,4 @@ -MongoSystemError | mongodb

    Class MongoSystemError

    An error signifying a general system issue

    +MongoSystemError | mongodb

    Class MongoSystemError

    An error signifying a general system issue

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -28,4 +28,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoTailableCursorError.html b/docs/Next/classes/MongoTailableCursorError.html index 57328a27467..0fad95883d3 100644 --- a/docs/Next/classes/MongoTailableCursorError.html +++ b/docs/Next/classes/MongoTailableCursorError.html @@ -1,4 +1,4 @@ -MongoTailableCursorError | mongodb

    Class MongoTailableCursorError

    An error thrown when the user calls a function or method not supported on a tailable cursor

    +MongoTailableCursorError | mongodb

    Class MongoTailableCursorError

    An error thrown when the user calls a function or method not supported on a tailable cursor

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -26,4 +26,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoTopologyClosedError.html b/docs/Next/classes/MongoTopologyClosedError.html index 311d5bc4ebe..cf3fe80c4ef 100644 --- a/docs/Next/classes/MongoTopologyClosedError.html +++ b/docs/Next/classes/MongoTopologyClosedError.html @@ -1,4 +1,4 @@ -MongoTopologyClosedError | mongodb

    Class MongoTopologyClosedError

    An error generated when an attempt is made to operate on a +MongoTopologyClosedError | mongodb

    Class MongoTopologyClosedError

    An error generated when an attempt is made to operate on a dropped, or otherwise unavailable, database.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoTransactionError.html b/docs/Next/classes/MongoTransactionError.html index 7a17e006b51..a342d9c684c 100644 --- a/docs/Next/classes/MongoTransactionError.html +++ b/docs/Next/classes/MongoTransactionError.html @@ -1,4 +1,4 @@ -MongoTransactionError | mongodb

    Class MongoTransactionError

    An error generated when the user makes a mistake in the usage of transactions. +MongoTransactionError | mongodb

    Class MongoTransactionError

    An error generated when the user makes a mistake in the usage of transactions. (e.g. attempting to commit a transaction with a readPreference other than primary)

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? @@ -27,4 +27,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoUnexpectedServerResponseError.html b/docs/Next/classes/MongoUnexpectedServerResponseError.html index e0ce8e8b132..5566211cf83 100644 --- a/docs/Next/classes/MongoUnexpectedServerResponseError.html +++ b/docs/Next/classes/MongoUnexpectedServerResponseError.html @@ -1,4 +1,4 @@ -MongoUnexpectedServerResponseError | mongodb

    Class MongoUnexpectedServerResponseError

    An error generated when a parsable unexpected response comes from the server. +MongoUnexpectedServerResponseError | mongodb

    Class MongoUnexpectedServerResponseError

    An error generated when a parsable unexpected response comes from the server. This is generally an error where the driver in a state expecting a certain behavior to occur in the next message from MongoDB but it receives something else. This error does not represent an issue with wire message formatting.

    @@ -34,4 +34,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Example
    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Example
    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/MongoWriteConcernError.html b/docs/Next/classes/MongoWriteConcernError.html index 64a2b7656da..fed650b1f7c 100644 --- a/docs/Next/classes/MongoWriteConcernError.html +++ b/docs/Next/classes/MongoWriteConcernError.html @@ -1,4 +1,4 @@ -MongoWriteConcernError | mongodb

    Class MongoWriteConcernError

    An error thrown when the server reports a writeConcernError

    +MongoWriteConcernError | mongodb

    Class MongoWriteConcernError

    An error thrown when the server reports a writeConcernError

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    cause? code? @@ -34,4 +34,4 @@

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/OrderedBulkOperation.html b/docs/Next/classes/OrderedBulkOperation.html index 44d70867b4d..313e3c6b3e8 100644 --- a/docs/Next/classes/OrderedBulkOperation.html +++ b/docs/Next/classes/OrderedBulkOperation.html @@ -1,4 +1,4 @@ -OrderedBulkOperation | mongodb

    Class OrderedBulkOperation

    Hierarchy (view full)

    Properties

    isOrdered +OrderedBulkOperation | mongodb

    Class OrderedBulkOperation

    Hierarchy (view full)

    Properties

    isOrdered operationId?

    Accessors

    batches bsonOptions @@ -19,4 +19,4 @@

    raw

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/ReadConcern.html b/docs/Next/classes/ReadConcern.html index 08ddbdc4c85..527dd370a93 100644 --- a/docs/Next/classes/ReadConcern.html +++ b/docs/Next/classes/ReadConcern.html @@ -1,4 +1,4 @@ -ReadConcern | mongodb

    Class ReadConcern

    The MongoDB ReadConcern, which allows for control of the consistency and isolation properties +ReadConcern | mongodb

    Class ReadConcern

    The MongoDB ReadConcern, which allows for control of the consistency and isolation properties of the data read from replica sets and replica set shards.

    See

    https://www.mongodb.com/docs/manual/reference/read-concern/index.html

    Constructors

    constructor @@ -12,4 +12,4 @@

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    StaticAVAILABLE

    StaticLINEARIZABLE

    StaticMAJORITY

    StaticSNAPSHOT

    Methods

    toJSON

    StaticfromOptions

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns undefined | ReadConcern

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/ReadPreference.html b/docs/Next/classes/ReadPreference.html index 8b47fc3091c..bfa91933866 100644 --- a/docs/Next/classes/ReadPreference.html +++ b/docs/Next/classes/ReadPreference.html @@ -1,4 +1,4 @@ -ReadPreference | mongodb

    Class ReadPreference

    The ReadPreference class is a class that represents a MongoDB ReadPreference and is +ReadPreference | mongodb

    Class ReadPreference

    The ReadPreference class is a class that represents a MongoDB ReadPreference and is used to construct connections.

    See

    https://www.mongodb.com/docs/manual/core/read-preference/

    Constructors

    constructor @@ -41,4 +41,4 @@

    Returns undefined | ReadPreference

    StaticfromString

    StaticisValid

    • isValid(mode): boolean

    • Validate if a mode is legal

      Parameters

      • mode: string

        The string representing the read preference mode.

      Returns boolean

    Statictranslate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns ReadPreferenceLikeOptions

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/RunCommandCursor.html b/docs/Next/classes/RunCommandCursor.html index 0c66f43fb00..89ba86ff581 100644 --- a/docs/Next/classes/RunCommandCursor.html +++ b/docs/Next/classes/RunCommandCursor.html @@ -1,4 +1,4 @@ -RunCommandCursor | mongodb

    Class RunCommandCursor

    Hierarchy (view full)

    Properties

    [asyncDispose] +RunCommandCursor | mongodb

    Class RunCommandCursor

    Hierarchy (view full)

    Properties

    [asyncDispose] command getMoreOptions captureRejections @@ -509,4 +509,4 @@

    Deprecat

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/ServerCapabilities.html b/docs/Next/classes/ServerCapabilities.html index d1e00cbb8e3..c3846630b7d 100644 --- a/docs/Next/classes/ServerCapabilities.html +++ b/docs/Next/classes/ServerCapabilities.html @@ -1,4 +1,4 @@ -ServerCapabilities | mongodb

    Class ServerCapabilities

    Constructors

    constructor +ServerCapabilities | mongodb

    Class ServerCapabilities

    Constructors

    constructor

    Properties

    maxWireVersion minWireVersion

    Accessors

    commandsTakeCollation @@ -10,4 +10,4 @@ hasTextSearch hasWriteCommands supportsSnapshotReads -

    Constructors

    constructor

    Properties

    maxWireVersion

    maxWireVersion: number

    minWireVersion

    minWireVersion: number

    Accessors

    commandsTakeCollation

    commandsTakeWriteConcern

    hasAggregationCursor

    hasAuthCommands

    hasListCollectionsCommand

    hasListIndexesCommand

    hasTextSearch

    hasWriteCommands

    supportsSnapshotReads

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    +

    Constructors

    constructor

    Properties

    maxWireVersion

    maxWireVersion: number

    minWireVersion

    minWireVersion: number

    Accessors

    commandsTakeCollation

    commandsTakeWriteConcern

    hasAggregationCursor

    hasAuthCommands

    hasListCollectionsCommand

    hasListIndexesCommand

    hasTextSearch

    hasWriteCommands

    supportsSnapshotReads

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    diff --git a/docs/Next/classes/ServerClosedEvent.html b/docs/Next/classes/ServerClosedEvent.html index dec16f48208..541bf77aa2a 100644 --- a/docs/Next/classes/ServerClosedEvent.html +++ b/docs/Next/classes/ServerClosedEvent.html @@ -1,6 +1,6 @@ -ServerClosedEvent | mongodb

    Class ServerClosedEvent

    Emitted when server is closed.

    +ServerClosedEvent | mongodb

    Class ServerClosedEvent

    Emitted when server is closed.

    Properties

    address topologyId

    Properties

    address

    address: string

    The address (host/port pair) of the server

    topologyId

    topologyId: number

    A unique identifier for the topology

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ServerDescription.html b/docs/Next/classes/ServerDescription.html index 1724c97a280..78b074b55b9 100644 --- a/docs/Next/classes/ServerDescription.html +++ b/docs/Next/classes/ServerDescription.html @@ -1,4 +1,4 @@ -ServerDescription | mongodb

    Class ServerDescription

    The client's view of a single server, based on the most recent hello outcome.

    +ServerDescription | mongodb

    Class ServerDescription

    The client's view of a single server, based on the most recent hello outcome.

    Internal type, not meant to be directly instantiated

    Properties

    $clusterTime? address @@ -39,6 +39,6 @@

    minWireVersion

    minWireVersion: number

    passives

    passives: string[]

    primary

    primary: null | string

    roundTripTime

    roundTripTime: number

    setName

    setName: null | string

    setVersion

    setVersion: null | number

    tags

    tags: TagSet

    topologyVersion

    topologyVersion: null | TopologyVersion

    type

    type: ServerType

    Accessors

    allHosts

    host

    hostAddress

    isDataBearing

    isReadable

    isWritable

    port

    Methods

    equals

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Returns boolean

    port

    Methods

    equals

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/ServerDescriptionChangedEvent.html b/docs/Next/classes/ServerDescriptionChangedEvent.html index c572c7618cd..0cdcf2e54de 100644 --- a/docs/Next/classes/ServerDescriptionChangedEvent.html +++ b/docs/Next/classes/ServerDescriptionChangedEvent.html @@ -1,4 +1,4 @@ -ServerDescriptionChangedEvent | mongodb

    Class ServerDescriptionChangedEvent

    Emitted when server description changes, but does NOT include changes to the RTT.

    +ServerDescriptionChangedEvent | mongodb

    Class ServerDescriptionChangedEvent

    Emitted when server description changes, but does NOT include changes to the RTT.

    Properties

    address name newDescription @@ -8,4 +8,4 @@

    name

    name: "serverDescriptionChanged" = SERVER_DESCRIPTION_CHANGED

    newDescription

    newDescription: ServerDescription

    The new server description

    previousDescription

    previousDescription: ServerDescription

    The previous server description

    topologyId

    topologyId: number

    A unique identifier for the topology

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ServerHeartbeatFailedEvent.html b/docs/Next/classes/ServerHeartbeatFailedEvent.html index 048c71a18c3..033292afba6 100644 --- a/docs/Next/classes/ServerHeartbeatFailedEvent.html +++ b/docs/Next/classes/ServerHeartbeatFailedEvent.html @@ -1,4 +1,4 @@ -ServerHeartbeatFailedEvent | mongodb

    Class ServerHeartbeatFailedEvent

    Emitted when the server monitor’s hello fails, either with an “ok: 0” or a socket exception.

    +ServerHeartbeatFailedEvent | mongodb

    Class ServerHeartbeatFailedEvent

    Emitted when the server monitor’s hello fails, either with an “ok: 0” or a socket exception.

    Properties

    awaited connectionId duration @@ -7,4 +7,4 @@

    connectionId

    connectionId: string

    The connection id for the command

    duration

    duration: number

    The execution time of the event in ms

    failure

    failure: Error

    The command failure

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ServerHeartbeatStartedEvent.html b/docs/Next/classes/ServerHeartbeatStartedEvent.html index a57aab02976..df854895f6f 100644 --- a/docs/Next/classes/ServerHeartbeatStartedEvent.html +++ b/docs/Next/classes/ServerHeartbeatStartedEvent.html @@ -1,7 +1,7 @@ -ServerHeartbeatStartedEvent | mongodb

    Class ServerHeartbeatStartedEvent

    Emitted when the server monitor’s hello command is started - immediately before +ServerHeartbeatStartedEvent | mongodb

    Class ServerHeartbeatStartedEvent

    Emitted when the server monitor’s hello command is started - immediately before the hello command is serialized into raw BSON and written to the socket.

    Properties

    awaited connectionId

    Properties

    awaited

    awaited: boolean

    Is true when using the streaming protocol

    connectionId

    connectionId: string

    The connection id for the command

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ServerHeartbeatSucceededEvent.html b/docs/Next/classes/ServerHeartbeatSucceededEvent.html index be5dfa65e0a..3711aedb1db 100644 --- a/docs/Next/classes/ServerHeartbeatSucceededEvent.html +++ b/docs/Next/classes/ServerHeartbeatSucceededEvent.html @@ -1,4 +1,4 @@ -ServerHeartbeatSucceededEvent | mongodb

    Class ServerHeartbeatSucceededEvent

    Emitted when the server monitor’s hello succeeds.

    +ServerHeartbeatSucceededEvent | mongodb

    Class ServerHeartbeatSucceededEvent

    Emitted when the server monitor’s hello succeeds.

    Properties

    awaited connectionId duration @@ -7,4 +7,4 @@

    connectionId

    connectionId: string

    The connection id for the command

    duration

    duration: number

    The execution time of the event in ms

    reply

    reply: Document

    The command reply

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ServerOpeningEvent.html b/docs/Next/classes/ServerOpeningEvent.html index 795beb94786..0190a69fb76 100644 --- a/docs/Next/classes/ServerOpeningEvent.html +++ b/docs/Next/classes/ServerOpeningEvent.html @@ -1,6 +1,6 @@ -ServerOpeningEvent | mongodb

    Class ServerOpeningEvent

    Emitted when server is initialized.

    +ServerOpeningEvent | mongodb

    Class ServerOpeningEvent

    Emitted when server is initialized.

    Properties

    address topologyId

    Properties

    address

    address: string

    The address (host/port pair) of the server

    topologyId

    topologyId: number

    A unique identifier for the topology

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/ServerSession.html b/docs/Next/classes/ServerSession.html index ce41f4ea19d..a41cd5d958a 100644 --- a/docs/Next/classes/ServerSession.html +++ b/docs/Next/classes/ServerSession.html @@ -1,4 +1,4 @@ -ServerSession | mongodb

    Class ServerSession

    Reflects the existence of a session on the server. Can be reused by the session pool. +ServerSession | mongodb

    Class ServerSession

    Reflects the existence of a session on the server. Can be reused by the session pool. WARNING: not meant to be instantiated directly. For internal use only.

    Properties

    id isDirty @@ -7,4 +7,4 @@

    Methods

    hasTimedOut

    Properties

    id

    id: ServerSessionId

    isDirty

    isDirty: boolean

    lastUse

    lastUse: number

    txnNumber

    txnNumber: number

    Methods

    hasTimedOut

    • hasTimedOut(sessionTimeoutMinutes): boolean

    • Determines if the server session has timed out.

      Parameters

      • sessionTimeoutMinutes: number

        The server's "logicalSessionTimeoutMinutes"

        -

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/docs/Next/classes/StreamDescription.html b/docs/Next/classes/StreamDescription.html index 54c4cc19093..baff81121b5 100644 --- a/docs/Next/classes/StreamDescription.html +++ b/docs/Next/classes/StreamDescription.html @@ -1,4 +1,4 @@ -StreamDescription | mongodb

    Class StreamDescription

    Constructors

    constructor +StreamDescription | mongodb

    Class StreamDescription

    Constructors

    constructor

    Properties

    __nodejs_mock_server__? address compressor? @@ -16,4 +16,4 @@ zlibCompressionLevel?

    Methods

    parseServerConnectionID receiveResponse -

    Constructors

    constructor

    Properties

    Optional__nodejs_mock_server__

    __nodejs_mock_server__?: boolean

    address

    address: string

    Optionalcompressor

    compressor?:
        | "none"
        | "snappy"
        | "zlib"
        | "zstd"

    compressors

    compressors: (
        | "none"
        | "snappy"
        | "zlib"
        | "zstd")[]

    hello

    hello: null | Document = null

    loadBalanced

    loadBalanced: boolean

    OptionallogicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    maxBsonObjectSize

    maxBsonObjectSize: number

    maxMessageSizeBytes

    maxMessageSizeBytes: number

    OptionalmaxWireVersion

    maxWireVersion?: number

    maxWriteBatchSize

    maxWriteBatchSize: number

    OptionalminWireVersion

    minWireVersion?: number

    serverConnectionId

    serverConnectionId: null | bigint

    type

    type: ServerType

    OptionalzlibCompressionLevel

    zlibCompressionLevel?: number

    Methods

    parseServerConnectionID

    receiveResponse

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    Optional__nodejs_mock_server__

    __nodejs_mock_server__?: boolean

    address

    address: string

    Optionalcompressor

    compressor?:
        | "none"
        | "snappy"
        | "zlib"
        | "zstd"

    compressors

    compressors: (
        | "none"
        | "snappy"
        | "zlib"
        | "zstd")[]

    hello

    hello: null | Document = null

    loadBalanced

    loadBalanced: boolean

    OptionallogicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    maxBsonObjectSize

    maxBsonObjectSize: number

    maxMessageSizeBytes

    maxMessageSizeBytes: number

    OptionalmaxWireVersion

    maxWireVersion?: number

    maxWriteBatchSize

    maxWriteBatchSize: number

    OptionalminWireVersion

    minWireVersion?: number

    serverConnectionId

    serverConnectionId: null | bigint

    type

    type: ServerType

    OptionalzlibCompressionLevel

    zlibCompressionLevel?: number

    Methods

    parseServerConnectionID

    receiveResponse

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/Next/classes/TopologyClosedEvent.html b/docs/Next/classes/TopologyClosedEvent.html index dd84e1373aa..e44435a5a3b 100644 --- a/docs/Next/classes/TopologyClosedEvent.html +++ b/docs/Next/classes/TopologyClosedEvent.html @@ -1,4 +1,4 @@ -TopologyClosedEvent | mongodb

    Class TopologyClosedEvent

    Emitted when topology is closed.

    +TopologyClosedEvent | mongodb

    Class TopologyClosedEvent

    Emitted when topology is closed.

    Properties

    topologyId

    Properties

    topologyId

    topologyId: number

    A unique identifier for the topology

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/TopologyDescription.html b/docs/Next/classes/TopologyDescription.html index 27429131cc0..105e8cd794b 100644 --- a/docs/Next/classes/TopologyDescription.html +++ b/docs/Next/classes/TopologyDescription.html @@ -1,4 +1,4 @@ -TopologyDescription | mongodb

    Class TopologyDescription

    Representation of a deployment of servers

    +TopologyDescription | mongodb

    Class TopologyDescription

    Representation of a deployment of servers

    Constructors

    constructor

    Properties

    commonWireVersion compatibilityError? @@ -22,4 +22,4 @@

    Returns boolean

    Methods

    toJSON

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns Document

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/TopologyDescriptionChangedEvent.html b/docs/Next/classes/TopologyDescriptionChangedEvent.html index 8bb1424ca5f..25af8baf9f4 100644 --- a/docs/Next/classes/TopologyDescriptionChangedEvent.html +++ b/docs/Next/classes/TopologyDescriptionChangedEvent.html @@ -1,8 +1,8 @@ -TopologyDescriptionChangedEvent | mongodb

    Class TopologyDescriptionChangedEvent

    Emitted when topology description changes.

    +TopologyDescriptionChangedEvent | mongodb

    Class TopologyDescriptionChangedEvent

    Emitted when topology description changes.

    Properties

    newDescription previousDescription topologyId

    Properties

    newDescription

    newDescription: TopologyDescription

    The new topology description

    previousDescription

    previousDescription: TopologyDescription

    The old topology description

    topologyId

    topologyId: number

    A unique identifier for the topology

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/TopologyOpeningEvent.html b/docs/Next/classes/TopologyOpeningEvent.html index 8c79b8e563c..142016842f6 100644 --- a/docs/Next/classes/TopologyOpeningEvent.html +++ b/docs/Next/classes/TopologyOpeningEvent.html @@ -1,4 +1,4 @@ -TopologyOpeningEvent | mongodb

    Class TopologyOpeningEvent

    Emitted when topology is initialized.

    +TopologyOpeningEvent | mongodb

    Class TopologyOpeningEvent

    Emitted when topology is initialized.

    Properties

    topologyId

    Properties

    topologyId

    topologyId: number

    A unique identifier for the topology

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/classes/Transaction.html b/docs/Next/classes/Transaction.html index d9796a006df..744b2867f67 100644 --- a/docs/Next/classes/Transaction.html +++ b/docs/Next/classes/Transaction.html @@ -1,4 +1,4 @@ -Transaction | mongodb

    Class Transaction

    A class maintaining state related to a server transaction. Internal Only

    +Transaction | mongodb

    Class Transaction

    A class maintaining state related to a server transaction. Internal Only

    Properties

    options

    Accessors

    isActive isCommitted @@ -7,4 +7,4 @@ recoveryToken

    Properties

    options

    options: TransactionOptions

    Accessors

    isActive

    • get isActive(): boolean

    • Returns boolean

      Whether this session is presently in a transaction

    isCommitted

    isPinned

    isStarting

    recoveryToken

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    +

    recoveryToken

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    diff --git a/docs/Next/classes/TypedEventEmitter.html b/docs/Next/classes/TypedEventEmitter.html index ef164296bcd..0ba8754a30c 100644 --- a/docs/Next/classes/TypedEventEmitter.html +++ b/docs/Next/classes/TypedEventEmitter.html @@ -1,4 +1,4 @@ -TypedEventEmitter | mongodb

    Class TypedEventEmitter<Events>

    Typescript type safe event emitter

    +TypedEventEmitter | mongodb

    Class TypedEventEmitter<Events>

    Typescript type safe event emitter

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    captureRejections captureRejectionSymbol @@ -420,4 +420,4 @@

    Deprecated

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/Next/classes/UnorderedBulkOperation.html b/docs/Next/classes/UnorderedBulkOperation.html index e09396e894b..a35c5c69e8e 100644 --- a/docs/Next/classes/UnorderedBulkOperation.html +++ b/docs/Next/classes/UnorderedBulkOperation.html @@ -1,4 +1,4 @@ -UnorderedBulkOperation | mongodb

    Class UnorderedBulkOperation

    Hierarchy (view full)

    Properties

    isOrdered +UnorderedBulkOperation | mongodb

    Class UnorderedBulkOperation

    Hierarchy (view full)

    Properties

    isOrdered operationId?

    Accessors

    batches bsonOptions @@ -19,4 +19,4 @@

    raw

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Parameters

    Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/docs/Next/classes/WriteConcern.html b/docs/Next/classes/WriteConcern.html index a2b73a210fe..6d3c64292c5 100644 --- a/docs/Next/classes/WriteConcern.html +++ b/docs/Next/classes/WriteConcern.html @@ -1,4 +1,4 @@ -WriteConcern | mongodb

    Class WriteConcern

    A MongoDB WriteConcern, which describes the level of acknowledgement +WriteConcern | mongodb

    Class WriteConcern

    A MongoDB WriteConcern, which describes the level of acknowledgement requested from MongoDB for write operations.

    See

    https://www.mongodb.com/docs/manual/reference/write-concern/

    Constructors

    constructor @@ -27,4 +27,4 @@

    Optional ReadonlywtimeoutMS

    wtimeoutMS?: number

    Specify a time limit to prevent write operations from blocking indefinitely

    Methods

    Staticapply

    StaticfromOptions

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns undefined | WriteConcern

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/Next/classes/WriteConcernError.html b/docs/Next/classes/WriteConcernError.html index ad54da42a2f..f9054492b75 100644 --- a/docs/Next/classes/WriteConcernError.html +++ b/docs/Next/classes/WriteConcernError.html @@ -1,4 +1,4 @@ -WriteConcernError | mongodb

    Class WriteConcernError

    An error representing a failure by the server to apply the requested write concern to the bulk operation.

    +WriteConcernError | mongodb

    Class WriteConcernError

    An error representing a failure by the server to apply the requested write concern to the bulk operation.

    Constructors

    constructor

    Accessors

    code errInfo @@ -8,4 +8,4 @@

    Constructors

    constructor

    Accessors

    code

    • get code(): undefined | number

    • Write concern error code.

      Returns undefined | number

    errInfo

    errmsg

    • get errmsg(): undefined | string

    • Write concern error message.

      -

      Returns undefined | string

    Methods

    toJSON

    toString

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Returns undefined | string

    Methods

    toJSON

    toString

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/Next/classes/WriteError.html b/docs/Next/classes/WriteError.html index a8fd9fbfb5b..8f3e45cb663 100644 --- a/docs/Next/classes/WriteError.html +++ b/docs/Next/classes/WriteError.html @@ -1,4 +1,4 @@ -WriteError | mongodb

    Class WriteError

    An error that occurred during a BulkWrite on the server.

    +WriteError | mongodb

    Class WriteError

    An error that occurred during a BulkWrite on the server.

    Constructors

    constructor

    Properties

    err

    Accessors

    code @@ -13,4 +13,4 @@

    Returns undefined | Document

    errmsg

    • get errmsg(): undefined | string

    • WriteError message.

      Returns undefined | string

    index

    Methods

    getOperation

    toJSON

    • toJSON(): {
          code: number;
          errmsg?: string;
          index: number;
          op: Document;
      }

    • Returns {
          code: number;
          errmsg?: string;
          index: number;
          op: Document;
      }

      • code: number
      • Optionalerrmsg?: string
      • index: number
      • op: Document

    toString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns Document

    toJSON

    • toJSON(): {
          code: number;
          errmsg?: string;
          index: number;
          op: Document;
      }

    • Returns {
          code: number;
          errmsg?: string;
          index: number;
          op: Document;
      }

      • code: number
      • Optionalerrmsg?: string
      • index: number
      • op: Document

    toString

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/Next/functions/BSON.calculateObjectSize.html b/docs/Next/functions/BSON.calculateObjectSize.html index baacc1645a8..54fda2522f9 100644 --- a/docs/Next/functions/BSON.calculateObjectSize.html +++ b/docs/Next/functions/BSON.calculateObjectSize.html @@ -1,4 +1,4 @@ -calculateObjectSize | mongodb

    Function calculateObjectSize

    • calculateObjectSize(object, options?): number

    • Calculate the bson size for a passed in Javascript object.

      +calculateObjectSize | mongodb

      Function calculateObjectSize

      • calculateObjectSize(object, options?): number

      • Calculate the bson size for a passed in Javascript object.

        Parameters

        Returns number

        size of BSON object in bytes

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/Next/functions/BSON.deserialize.html b/docs/Next/functions/BSON.deserialize.html index 83ef7a4a7bb..dfb5689ae73 100644 --- a/docs/Next/functions/BSON.deserialize.html +++ b/docs/Next/functions/BSON.deserialize.html @@ -1,4 +1,4 @@ -deserialize | mongodb

    Function deserialize

    • deserialize(buffer, options?): Document

    • Deserialize data as BSON.

      +deserialize | mongodb

      Function deserialize

      • deserialize(buffer, options?): Document

      • Deserialize data as BSON.

        Parameters

        • buffer: Uint8Array

          the buffer containing the serialized set of BSON documents.

        • Optionaloptions: DeserializeOptions

        Returns Document

        returns the deserialized Javascript Object.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/Next/functions/BSON.deserializeStream.html b/docs/Next/functions/BSON.deserializeStream.html index ee0b8cf1547..7032367f814 100644 --- a/docs/Next/functions/BSON.deserializeStream.html +++ b/docs/Next/functions/BSON.deserializeStream.html @@ -1,4 +1,4 @@ -deserializeStream | mongodb

    Function deserializeStream

    • deserializeStream(data, startIndex, numberOfDocuments, documents, docStartIndex, options): number

    • Deserialize stream data as BSON documents.

      +deserializeStream | mongodb

      Function deserializeStream

      • deserializeStream(data, startIndex, numberOfDocuments, documents, docStartIndex, options): number

      • Deserialize stream data as BSON documents.

        Parameters

        • data: Uint8Array | ArrayBuffer

          the buffer containing the serialized set of BSON documents.

        • startIndex: number

          the start index in the data Buffer where the deserialization is to start.

        • numberOfDocuments: number

          number of documents to deserialize.

          @@ -6,4 +6,4 @@
        • docStartIndex: number

          the index in the documents array from where to start inserting documents.

        • options: DeserializeOptions

          additional options used for the deserialization.

        Returns number

        next index in the buffer after deserialization x numbers of documents.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/Next/functions/BSON.serialize.html b/docs/Next/functions/BSON.serialize.html index 1a045d57e90..2719561be05 100644 --- a/docs/Next/functions/BSON.serialize.html +++ b/docs/Next/functions/BSON.serialize.html @@ -1,4 +1,4 @@ -serialize | mongodb

    Function serialize

    • serialize(object, options?): Uint8Array

    • Serialize a Javascript object.

      +serialize | mongodb

      Function serialize

      • serialize(object, options?): Uint8Array

      • Serialize a Javascript object.

        Parameters

        Returns Uint8Array

        Buffer object containing the serialized object.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/Next/functions/BSON.serializeWithBufferAndIndex.html b/docs/Next/functions/BSON.serializeWithBufferAndIndex.html index d7a386f5611..e299dc0e0da 100644 --- a/docs/Next/functions/BSON.serializeWithBufferAndIndex.html +++ b/docs/Next/functions/BSON.serializeWithBufferAndIndex.html @@ -1,6 +1,6 @@ -serializeWithBufferAndIndex | mongodb

    Function serializeWithBufferAndIndex

    • serializeWithBufferAndIndex(object, finalBuffer, options?): number

    • Serialize a Javascript object using a predefined Buffer and index into the buffer, +serializeWithBufferAndIndex | mongodb

      Function serializeWithBufferAndIndex

      • serializeWithBufferAndIndex(object, finalBuffer, options?): number

      • Serialize a Javascript object using a predefined Buffer and index into the buffer, useful when pre-allocating the space for serialization.

        Parameters

        • object: Document

          the Javascript object to serialize.

        • finalBuffer: Uint8Array

          the Buffer you pre-allocated to store the serialized BSON object.

        • Optionaloptions: SerializeOptions

        Returns number

        the index pointing to the last written byte in the buffer.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/Next/functions/BSON.setInternalBufferSize.html b/docs/Next/functions/BSON.setInternalBufferSize.html index d67e865fd78..a4867231fe0 100644 --- a/docs/Next/functions/BSON.setInternalBufferSize.html +++ b/docs/Next/functions/BSON.setInternalBufferSize.html @@ -1,3 +1,3 @@ -setInternalBufferSize | mongodb

    Function setInternalBufferSize

    • setInternalBufferSize(size): void

    • Sets the size of the internal serialization buffer.

      +setInternalBufferSize | mongodb

      Function setInternalBufferSize

      • setInternalBufferSize(size): void

      • Sets the size of the internal serialization buffer.

        Parameters

        • size: number

          The desired size for the internal serialization buffer in bytes

          -

        Returns void

      Settings

      Member Visibility
      +

    Returns void

    Settings

    Member Visibility
    diff --git a/docs/Next/functions/configureExplicitResourceManagement.html b/docs/Next/functions/configureExplicitResourceManagement.html index 814826b7867..556f6eaef8c 100644 --- a/docs/Next/functions/configureExplicitResourceManagement.html +++ b/docs/Next/functions/configureExplicitResourceManagement.html @@ -1,4 +1,4 @@ -configureExplicitResourceManagement | mongodb

    Function configureExplicitResourceManagement

    • configureExplicitResourceManagement(): void
    • Beta Experimental

      Attaches Symbol.asyncDispose methods to the MongoClient, Cursors, sessions and change streams +configureExplicitResourceManagement | mongodb

      Function configureExplicitResourceManagement

      • configureExplicitResourceManagement(): void
      • Beta Experimental

        Attaches Symbol.asyncDispose methods to the MongoClient, Cursors, sessions and change streams if Symbol.asyncDispose is defined.

        It's usually not necessary to call this method - the driver attempts to attach these methods itself when its loaded. However, sometimes the driver may be loaded before Symbol.asyncDispose @@ -8,4 +8,4 @@ 

        import { configureExplicitResourceManagement, MongoClient } from 'mongodb/lib/beta';

        Symbol.asyncDispose ??= Symbol('dispose');
        load();

        await using client = new MongoClient(...);
        -

        Returns void

      Settings

      Member Visibility
      +

      Returns void

    Settings

    Member Visibility
    diff --git a/docs/Next/hierarchy.html b/docs/Next/hierarchy.html index 6e34efd47e6..18ba8babe9e 100644 --- a/docs/Next/hierarchy.html +++ b/docs/Next/hierarchy.html @@ -1 +1 @@ -mongodb

    mongodb

    Class Hierarchy

    Settings

    Member Visibility
    +mongodb

    mongodb

    Class Hierarchy

    Settings

    Member Visibility
    diff --git a/docs/Next/index.html b/docs/Next/index.html index f2150cc3f7f..846e27f03d1 100644 --- a/docs/Next/index.html +++ b/docs/Next/index.html @@ -1,4 +1,4 @@ -mongodb

    mongodb

    MongoDB Node.js Driver

    The official MongoDB driver for Node.js.

    +mongodb

    mongodb

    MongoDB Node.js Driver

    The official MongoDB driver for Node.js.

    Upgrading to version 6? Take a look at our upgrade guide here!

    Quick Links

    @@ -279,4 +279,4 @@

    License

    Apache 2.0

    © 2012-present MongoDB Contributors
    © 2009-2012 Christian Amor Kvalheim

    -

    Settings

    Member Visibility

    On This Page

    MongoDB Node.js Driver
    +

    Settings

    Member Visibility

    On This Page

    MongoDB Node.js Driver
    diff --git a/docs/Next/interfaces/AWSEncryptionKeyOptions.html b/docs/Next/interfaces/AWSEncryptionKeyOptions.html index a54bb06c303..76d2265ce68 100644 --- a/docs/Next/interfaces/AWSEncryptionKeyOptions.html +++ b/docs/Next/interfaces/AWSEncryptionKeyOptions.html @@ -1,8 +1,8 @@ -AWSEncryptionKeyOptions | mongodb

    Interface AWSEncryptionKeyOptions

    Configuration options for making an AWS encryption key

    +AWSEncryptionKeyOptions | mongodb

    Interface AWSEncryptionKeyOptions

    Configuration options for making an AWS encryption key

    interface AWSEncryptionKeyOptions {
        endpoint?: string;
        key: string;
        region: string;
    }

    Properties

    endpoint? key region

    Properties

    Optionalendpoint

    endpoint?: string

    An alternate host to send KMS requests to. May include port number.

    key

    key: string

    The Amazon Resource Name (ARN) to the AWS customer master key (CMK)

    region

    region: string

    The AWS region of the KMS

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/AWSKMSProviderConfiguration.html b/docs/Next/interfaces/AWSKMSProviderConfiguration.html index f72112e9546..d9ab7125d9c 100644 --- a/docs/Next/interfaces/AWSKMSProviderConfiguration.html +++ b/docs/Next/interfaces/AWSKMSProviderConfiguration.html @@ -1,8 +1,8 @@ -AWSKMSProviderConfiguration | mongodb

    Interface AWSKMSProviderConfiguration

    interface AWSKMSProviderConfiguration {
        accessKeyId: string;
        secretAccessKey: string;
        sessionToken?: string;
    }

    Properties

    accessKeyId +AWSKMSProviderConfiguration | mongodb

    Interface AWSKMSProviderConfiguration

    interface AWSKMSProviderConfiguration {
        accessKeyId: string;
        secretAccessKey: string;
        sessionToken?: string;
    }

    Properties

    accessKeyId secretAccessKey sessionToken?

    Properties

    accessKeyId

    accessKeyId: string

    The access key used for the AWS KMS provider

    secretAccessKey

    secretAccessKey: string

    The secret access key used for the AWS KMS provider

    OptionalsessionToken

    sessionToken?: string

    An optional AWS session token that will be used as the X-Amz-Security-Token header for AWS requests.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/AbstractCursorOptions.html b/docs/Next/interfaces/AbstractCursorOptions.html index fbe7f5cfa2f..43bc0230d6f 100644 --- a/docs/Next/interfaces/AbstractCursorOptions.html +++ b/docs/Next/interfaces/AbstractCursorOptions.html @@ -1,4 +1,4 @@ -AbstractCursorOptions | mongodb

    Interface AbstractCursorOptions

    interface AbstractCursorOptions {
        awaitData?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        comment?: unknown;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noCursorTimeout?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        session?: ClientSession;
        tailable?: boolean;
        useBigInt64?: boolean;
    }

    Hierarchy (view full)

    Properties

    awaitData? +AbstractCursorOptions | mongodb

    Interface AbstractCursorOptions

    interface AbstractCursorOptions {
        awaitData?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        comment?: unknown;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noCursorTimeout?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        session?: ClientSession;
        tailable?: boolean;
        useBigInt64?: boolean;
    }

    Hierarchy (view full)

    Properties

    awaitData? batchSize? bsonRegExp? checkKeys? @@ -67,4 +67,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/AggregateOptions.html b/docs/Next/interfaces/AggregateOptions.html index 80bbea1db05..29119d6a9b1 100644 --- a/docs/Next/interfaces/AggregateOptions.html +++ b/docs/Next/interfaces/AggregateOptions.html @@ -1,4 +1,4 @@ -AggregateOptions | mongodb

    Interface AggregateOptions

    interface AggregateOptions {
        allowDiskUse?: boolean;
        authdb?: string;
        batchSize?: number;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        cursor?: Document;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        out?: string;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    allowDiskUse? +AggregateOptions | mongodb

    Interface AggregateOptions

    interface AggregateOptions {
        allowDiskUse?: boolean;
        authdb?: string;
        batchSize?: number;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        cursor?: Document;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        out?: string;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    allowDiskUse? authdb? batchSize? bsonRegExp? @@ -83,4 +83,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/AggregationCursorOptions.html b/docs/Next/interfaces/AggregationCursorOptions.html index eda8373eeae..b427ef8a9ce 100644 --- a/docs/Next/interfaces/AggregationCursorOptions.html +++ b/docs/Next/interfaces/AggregationCursorOptions.html @@ -1,4 +1,4 @@ -AggregationCursorOptions | mongodb

    Interface AggregationCursorOptions

    interface AggregationCursorOptions {
        allowDiskUse?: boolean;
        authdb?: string;
        awaitData?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        cursor?: Document;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noCursorTimeout?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        out?: string;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        tailable?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    allowDiskUse? +AggregationCursorOptions | mongodb

    Interface AggregationCursorOptions

    interface AggregationCursorOptions {
        allowDiskUse?: boolean;
        authdb?: string;
        awaitData?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        cursor?: Document;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noCursorTimeout?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        out?: string;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        tailable?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    allowDiskUse? authdb? awaitData? batchSize? @@ -96,4 +96,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/AsyncDisposable.html b/docs/Next/interfaces/AsyncDisposable.html index 80e45d50255..2da35056646 100644 --- a/docs/Next/interfaces/AsyncDisposable.html +++ b/docs/Next/interfaces/AsyncDisposable.html @@ -1,2 +1,2 @@ -AsyncDisposable | mongodb

    Interface AsyncDisposable

    interface AsyncDisposable {
        [asyncDispose](): Promise<void>;
    }

    Implemented by

    Methods

    [asyncDispose] -

    Methods

    [asyncDispose]

    Settings

    Member Visibility

    On This Page

    Methods
    +AsyncDisposable | mongodb

    Interface AsyncDisposable

    interface AsyncDisposable {
        [asyncDispose](): Promise<void>;
    }

    Implemented by

    Methods

    [asyncDispose] +

    Methods

    [asyncDispose]

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/docs/Next/interfaces/Auth.html b/docs/Next/interfaces/Auth.html index dbacb87c5d9..984067a49a4 100644 --- a/docs/Next/interfaces/Auth.html +++ b/docs/Next/interfaces/Auth.html @@ -1,5 +1,5 @@ -Auth | mongodb

    Interface Auth

    interface Auth {
        password?: string;
        username?: string;
    }

    Properties

    password? +Auth | mongodb

    Interface Auth

    interface Auth {
        password?: string;
        username?: string;
    }

    Properties

    password? username?

    Properties

    Optionalpassword

    password?: string

    The password for auth

    Optionalusername

    username?: string

    The username for auth

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/AuthMechanismProperties.html b/docs/Next/interfaces/AuthMechanismProperties.html index a0af1dab40a..9a504fffe13 100644 --- a/docs/Next/interfaces/AuthMechanismProperties.html +++ b/docs/Next/interfaces/AuthMechanismProperties.html @@ -1,4 +1,4 @@ -AuthMechanismProperties | mongodb

    Interface AuthMechanismProperties

    interface AuthMechanismProperties {
        ALLOWED_HOSTS?: string[];
        AWS_SESSION_TOKEN?: string;
        CANONICALIZE_HOST_NAME?: GSSAPICanonicalizationValue;
        ENVIRONMENT?: "azure" | "gcp" | "test";
        OIDC_CALLBACK?: OIDCCallbackFunction;
        OIDC_HUMAN_CALLBACK?: OIDCCallbackFunction;
        SERVICE_HOST?: string;
        SERVICE_NAME?: string;
        SERVICE_REALM?: string;
        TOKEN_RESOURCE?: string;
    }

    Hierarchy (view full)

    Properties

    ALLOWED_HOSTS? +AuthMechanismProperties | mongodb

    Interface AuthMechanismProperties

    interface AuthMechanismProperties {
        ALLOWED_HOSTS?: string[];
        AWS_SESSION_TOKEN?: string;
        CANONICALIZE_HOST_NAME?: GSSAPICanonicalizationValue;
        ENVIRONMENT?: "azure" | "gcp" | "test";
        OIDC_CALLBACK?: OIDCCallbackFunction;
        OIDC_HUMAN_CALLBACK?: OIDCCallbackFunction;
        SERVICE_HOST?: string;
        SERVICE_NAME?: string;
        SERVICE_REALM?: string;
        TOKEN_RESOURCE?: string;
    }

    Hierarchy (view full)

    Properties

    ALLOWED_HOSTS? AWS_SESSION_TOKEN? CANONICALIZE_HOST_NAME? ENVIRONMENT? @@ -9,8 +9,8 @@ SERVICE_REALM? TOKEN_RESOURCE?

    Properties

    OptionalALLOWED_HOSTS

    ALLOWED_HOSTS?: string[]

    Allowed hosts that OIDC auth can connect to.

    -

    OptionalAWS_SESSION_TOKEN

    AWS_SESSION_TOKEN?: string

    OptionalCANONICALIZE_HOST_NAME

    CANONICALIZE_HOST_NAME?: GSSAPICanonicalizationValue

    OptionalENVIRONMENT

    ENVIRONMENT?: "azure" | "gcp" | "test"

    The OIDC environment. Note that 'test' is for internal use only.

    -

    OptionalOIDC_CALLBACK

    OIDC_CALLBACK?: OIDCCallbackFunction

    A user provided OIDC machine callback function.

    -

    OptionalOIDC_HUMAN_CALLBACK

    OIDC_HUMAN_CALLBACK?: OIDCCallbackFunction

    A user provided OIDC human interacted callback function.

    -

    OptionalSERVICE_HOST

    SERVICE_HOST?: string

    OptionalSERVICE_NAME

    SERVICE_NAME?: string

    OptionalSERVICE_REALM

    SERVICE_REALM?: string

    OptionalTOKEN_RESOURCE

    TOKEN_RESOURCE?: string

    The resource token for OIDC auth in Azure and GCP.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalAWS_SESSION_TOKEN

    AWS_SESSION_TOKEN?: string

    OptionalCANONICALIZE_HOST_NAME

    CANONICALIZE_HOST_NAME?: GSSAPICanonicalizationValue

    OptionalENVIRONMENT

    ENVIRONMENT?: "azure" | "gcp" | "test"

    The OIDC environment. Note that 'test' is for internal use only.

    +

    OptionalOIDC_CALLBACK

    OIDC_CALLBACK?: OIDCCallbackFunction

    A user provided OIDC machine callback function.

    +

    OptionalOIDC_HUMAN_CALLBACK

    OIDC_HUMAN_CALLBACK?: OIDCCallbackFunction

    A user provided OIDC human interacted callback function.

    +

    OptionalSERVICE_HOST

    SERVICE_HOST?: string

    OptionalSERVICE_NAME

    SERVICE_NAME?: string

    OptionalSERVICE_REALM

    SERVICE_REALM?: string

    OptionalTOKEN_RESOURCE

    TOKEN_RESOURCE?: string

    The resource token for OIDC auth in Azure and GCP.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/AutoEncryptionOptions.html b/docs/Next/interfaces/AutoEncryptionOptions.html index 1530d9b2507..7718c89a5b8 100644 --- a/docs/Next/interfaces/AutoEncryptionOptions.html +++ b/docs/Next/interfaces/AutoEncryptionOptions.html @@ -1,4 +1,4 @@ -AutoEncryptionOptions | mongodb

    Interface AutoEncryptionOptions

    interface AutoEncryptionOptions {
        bypassAutoEncryption?: boolean;
        bypassQueryAnalysis?: boolean;
        encryptedFieldsMap?: Document;
        extraOptions?: {
            cryptSharedLibPath?: string;
            cryptSharedLibRequired?: boolean;
            mongocryptdBypassSpawn?: boolean;
            mongocryptdSpawnArgs?: string[];
            mongocryptdSpawnPath?: string;
            mongocryptdURI?: string;
        };
        keyVaultClient?: MongoClient;
        keyVaultNamespace?: string;
        kmsProviders?: KMSProviders;
        options?: {
            logger?: ((level: AutoEncryptionLoggerLevel, message: string) => void);
        };
        proxyOptions?: ProxyOptions;
        schemaMap?: Document;
        tlsOptions?: CSFLEKMSTlsOptions;
    }

    Properties

    bypassAutoEncryption? +AutoEncryptionOptions | mongodb

    Interface AutoEncryptionOptions

    interface AutoEncryptionOptions {
        bypassAutoEncryption?: boolean;
        bypassQueryAnalysis?: boolean;
        encryptedFieldsMap?: Document;
        extraOptions?: {
            cryptSharedLibPath?: string;
            cryptSharedLibRequired?: boolean;
            mongocryptdBypassSpawn?: boolean;
            mongocryptdSpawnArgs?: string[];
            mongocryptdSpawnPath?: string;
            mongocryptdURI?: string;
        };
        keyVaultClient?: MongoClient;
        keyVaultNamespace?: string;
        kmsProviders?: KMSProviders;
        options?: {
            logger?: ((level: AutoEncryptionLoggerLevel, message: string) => void);
        };
        proxyOptions?: ProxyOptions;
        schemaMap?: Document;
        tlsOptions?: CSFLEKMSTlsOptions;
    }

    Properties

    bypassAutoEncryption? bypassQueryAnalysis? encryptedFieldsMap? extraOptions? @@ -46,4 +46,4 @@ Schemas supplied in the schemaMap only apply to configuring automatic encryption for Client-Side Field Level Encryption. Other validation rules in the JSON schema will not be enforced by the driver and will result in an error.

    OptionaltlsOptions

    tlsOptions?: CSFLEKMSTlsOptions

    The TLS options to use connecting to the KMS provider

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/AzureEncryptionKeyOptions.html b/docs/Next/interfaces/AzureEncryptionKeyOptions.html index 383087ef0b6..eb2b8b23a89 100644 --- a/docs/Next/interfaces/AzureEncryptionKeyOptions.html +++ b/docs/Next/interfaces/AzureEncryptionKeyOptions.html @@ -1,8 +1,8 @@ -AzureEncryptionKeyOptions | mongodb

    Interface AzureEncryptionKeyOptions

    Configuration options for making an Azure encryption key

    +AzureEncryptionKeyOptions | mongodb

    Interface AzureEncryptionKeyOptions

    Configuration options for making an Azure encryption key

    interface AzureEncryptionKeyOptions {
        keyName: string;
        keyVaultEndpoint: string;
        keyVersion?: string;
    }

    Properties

    keyName keyVaultEndpoint keyVersion?

    Properties

    keyName

    keyName: string

    Key name

    keyVaultEndpoint

    keyVaultEndpoint: string

    Key vault URL, typically <name>.vault.azure.net

    OptionalkeyVersion

    keyVersion?: string

    Key version

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.BSONRegExpExtended.html b/docs/Next/interfaces/BSON.BSONRegExpExtended.html index b9790fc2f5f..b189fb62ddd 100644 --- a/docs/Next/interfaces/BSON.BSONRegExpExtended.html +++ b/docs/Next/interfaces/BSON.BSONRegExpExtended.html @@ -1,2 +1,2 @@ -BSONRegExpExtended | mongodb

    Interface BSONRegExpExtended

    interface BSONRegExpExtended {
        $regularExpression: {
            options: string;
            pattern: string;
        };
    }

    Properties

    $regularExpression -

    Properties

    $regularExpression

    $regularExpression: {
        options: string;
        pattern: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    +BSONRegExpExtended | mongodb

    Interface BSONRegExpExtended

    interface BSONRegExpExtended {
        $regularExpression: {
            options: string;
            pattern: string;
        };
    }

    Properties

    $regularExpression +

    Properties

    $regularExpression

    $regularExpression: {
        options: string;
        pattern: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.BSONRegExpExtendedLegacy.html b/docs/Next/interfaces/BSON.BSONRegExpExtendedLegacy.html index d855eb69dad..920f4ea219d 100644 --- a/docs/Next/interfaces/BSON.BSONRegExpExtendedLegacy.html +++ b/docs/Next/interfaces/BSON.BSONRegExpExtendedLegacy.html @@ -1,3 +1,3 @@ -BSONRegExpExtendedLegacy | mongodb

    Interface BSONRegExpExtendedLegacy

    interface BSONRegExpExtendedLegacy {
        $options: string;
        $regex: string | BSONRegExp;
    }

    Properties

    $options +BSONRegExpExtendedLegacy | mongodb

    Interface BSONRegExpExtendedLegacy

    interface BSONRegExpExtendedLegacy {
        $options: string;
        $regex: string | BSONRegExp;
    }

    Properties

    $options $regex -

    Properties

    $options

    $options: string

    $regex

    $regex: string | BSONRegExp

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    $options

    $options: string

    $regex

    $regex: string | BSONRegExp

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.BSONSymbolExtended.html b/docs/Next/interfaces/BSON.BSONSymbolExtended.html index b540fcea8e9..b7057ba9cb2 100644 --- a/docs/Next/interfaces/BSON.BSONSymbolExtended.html +++ b/docs/Next/interfaces/BSON.BSONSymbolExtended.html @@ -1,2 +1,2 @@ -BSONSymbolExtended | mongodb

    Interface BSONSymbolExtended

    interface BSONSymbolExtended {
        $symbol: string;
    }

    Properties

    $symbol -

    Properties

    $symbol

    $symbol: string

    Settings

    Member Visibility

    On This Page

    Properties
    +BSONSymbolExtended | mongodb

    Interface BSONSymbolExtended

    interface BSONSymbolExtended {
        $symbol: string;
    }

    Properties

    $symbol +

    Properties

    $symbol

    $symbol: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.BinaryExtended.html b/docs/Next/interfaces/BSON.BinaryExtended.html index 1e658a547c6..21d2c983ab6 100644 --- a/docs/Next/interfaces/BSON.BinaryExtended.html +++ b/docs/Next/interfaces/BSON.BinaryExtended.html @@ -1,2 +1,2 @@ -BinaryExtended | mongodb

    Interface BinaryExtended

    interface BinaryExtended {
        $binary: {
            base64: string;
            subType: string;
        };
    }

    Properties

    $binary -

    Properties

    $binary

    $binary: {
        base64: string;
        subType: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    +BinaryExtended | mongodb

    Interface BinaryExtended

    interface BinaryExtended {
        $binary: {
            base64: string;
            subType: string;
        };
    }

    Properties

    $binary +

    Properties

    $binary

    $binary: {
        base64: string;
        subType: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.BinaryExtendedLegacy.html b/docs/Next/interfaces/BSON.BinaryExtendedLegacy.html index b25f31a3266..8a3d9f338d4 100644 --- a/docs/Next/interfaces/BSON.BinaryExtendedLegacy.html +++ b/docs/Next/interfaces/BSON.BinaryExtendedLegacy.html @@ -1,3 +1,3 @@ -BinaryExtendedLegacy | mongodb

    Interface BinaryExtendedLegacy

    interface BinaryExtendedLegacy {
        $binary: string;
        $type: string;
    }

    Properties

    $binary +BinaryExtendedLegacy | mongodb

    Interface BinaryExtendedLegacy

    interface BinaryExtendedLegacy {
        $binary: string;
        $type: string;
    }

    Properties

    $binary $type -

    Properties

    $binary

    $binary: string

    $type

    $type: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    $binary

    $binary: string

    $type

    $type: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.CodeExtended.html b/docs/Next/interfaces/BSON.CodeExtended.html index d4f1a9e51a2..2658356b189 100644 --- a/docs/Next/interfaces/BSON.CodeExtended.html +++ b/docs/Next/interfaces/BSON.CodeExtended.html @@ -1,3 +1,3 @@ -CodeExtended | mongodb

    Interface CodeExtended

    interface CodeExtended {
        $code: string;
        $scope?: Document;
    }

    Properties

    $code +CodeExtended | mongodb

    Interface CodeExtended

    interface CodeExtended {
        $code: string;
        $scope?: Document;
    }

    Properties

    $code $scope? -

    Properties

    $code

    $code: string

    Optional$scope

    $scope?: Document

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    $code

    $code: string

    Optional$scope

    $scope?: Document

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.DBRefLike.html b/docs/Next/interfaces/BSON.DBRefLike.html index 2ccbdf0417c..903483335d0 100644 --- a/docs/Next/interfaces/BSON.DBRefLike.html +++ b/docs/Next/interfaces/BSON.DBRefLike.html @@ -1,4 +1,4 @@ -DBRefLike | mongodb

    Interface DBRefLike

    interface DBRefLike {
        $db?: string;
        $id: ObjectId;
        $ref: string;
    }

    Properties

    $db? +DBRefLike | mongodb

    Interface DBRefLike

    interface DBRefLike {
        $db?: string;
        $id: ObjectId;
        $ref: string;
    }

    Properties

    $db? $id $ref -

    Properties

    Optional$db

    $db?: string

    $id

    $id: ObjectId

    $ref

    $ref: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optional$db

    $db?: string

    $id

    $id: ObjectId

    $ref

    $ref: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.Decimal128Extended.html b/docs/Next/interfaces/BSON.Decimal128Extended.html index f13a4f3567b..6d7a49ccb5f 100644 --- a/docs/Next/interfaces/BSON.Decimal128Extended.html +++ b/docs/Next/interfaces/BSON.Decimal128Extended.html @@ -1,2 +1,2 @@ -Decimal128Extended | mongodb

    Interface Decimal128Extended

    interface Decimal128Extended {
        $numberDecimal: string;
    }

    Properties

    $numberDecimal -

    Properties

    $numberDecimal

    $numberDecimal: string

    Settings

    Member Visibility

    On This Page

    Properties
    +Decimal128Extended | mongodb

    Interface Decimal128Extended

    interface Decimal128Extended {
        $numberDecimal: string;
    }

    Properties

    $numberDecimal +

    Properties

    $numberDecimal

    $numberDecimal: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.DeserializeOptions.html b/docs/Next/interfaces/BSON.DeserializeOptions.html index e678fedfc76..19393ca71bb 100644 --- a/docs/Next/interfaces/BSON.DeserializeOptions.html +++ b/docs/Next/interfaces/BSON.DeserializeOptions.html @@ -1,4 +1,4 @@ -DeserializeOptions | mongodb

    Interface DeserializeOptions

    interface DeserializeOptions {
        allowObjectSmallerThanBufferSize?: boolean;
        bsonRegExp?: boolean;
        fieldsAsRaw?: Document;
        index?: number;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        useBigInt64?: boolean;
        validation?: {
            utf8: boolean | Record<string, true> | Record<string, false>;
        };
    }

    Properties

    allowObjectSmallerThanBufferSize? +DeserializeOptions | mongodb

    Interface DeserializeOptions

    interface DeserializeOptions {
        allowObjectSmallerThanBufferSize?: boolean;
        bsonRegExp?: boolean;
        fieldsAsRaw?: Document;
        index?: number;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        useBigInt64?: boolean;
        validation?: {
            utf8: boolean | Record<string, true> | Record<string, false>;
        };
    }

    Properties

    allowObjectSmallerThanBufferSize? bsonRegExp? fieldsAsRaw? index? @@ -29,4 +29,4 @@

    Example

    // disables validation on all keys
     validation: { utf8: false }

    // enables validation only on specified keys a, b, and c
     validation: { utf8: { a: true, b: true, c: true } }

     // disables validation only on specified keys a, b
     validation: { utf8: { a: false, b: false } }
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.Document.html b/docs/Next/interfaces/BSON.Document.html index 2e5c26aa0fb..9b63031d8f2 100644 --- a/docs/Next/interfaces/BSON.Document.html +++ b/docs/Next/interfaces/BSON.Document.html @@ -1 +1 @@ -Document | mongodb

    Interface Document

    Hierarchy (view full)

    Indexable

    • [key: string]: any

    Settings

    Member Visibility
    +Document | mongodb

    Interface Document

    Hierarchy (view full)

    Indexable

    • [key: string]: any

    Settings

    Member Visibility
    diff --git a/docs/Next/interfaces/BSON.DoubleExtended.html b/docs/Next/interfaces/BSON.DoubleExtended.html index 68e4beb43f0..4470846faa7 100644 --- a/docs/Next/interfaces/BSON.DoubleExtended.html +++ b/docs/Next/interfaces/BSON.DoubleExtended.html @@ -1,2 +1,2 @@ -DoubleExtended | mongodb

    Interface DoubleExtended

    interface DoubleExtended {
        $numberDouble: string;
    }

    Properties

    $numberDouble -

    Properties

    $numberDouble

    $numberDouble: string

    Settings

    Member Visibility

    On This Page

    Properties
    +DoubleExtended | mongodb

    Interface DoubleExtended

    interface DoubleExtended {
        $numberDouble: string;
    }

    Properties

    $numberDouble +

    Properties

    $numberDouble

    $numberDouble: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.Int32Extended.html b/docs/Next/interfaces/BSON.Int32Extended.html index d1119c10001..70da8462f6f 100644 --- a/docs/Next/interfaces/BSON.Int32Extended.html +++ b/docs/Next/interfaces/BSON.Int32Extended.html @@ -1,2 +1,2 @@ -Int32Extended | mongodb

    Interface Int32Extended

    interface Int32Extended {
        $numberInt: string;
    }

    Properties

    $numberInt -

    Properties

    $numberInt

    $numberInt: string

    Settings

    Member Visibility

    On This Page

    Properties
    +Int32Extended | mongodb

    Interface Int32Extended

    interface Int32Extended {
        $numberInt: string;
    }

    Properties

    $numberInt +

    Properties

    $numberInt

    $numberInt: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.LongExtended.html b/docs/Next/interfaces/BSON.LongExtended.html index 9530ae4ba76..349cd8ddebe 100644 --- a/docs/Next/interfaces/BSON.LongExtended.html +++ b/docs/Next/interfaces/BSON.LongExtended.html @@ -1,2 +1,2 @@ -LongExtended | mongodb

    Interface LongExtended

    interface LongExtended {
        $numberLong: string;
    }

    Properties

    $numberLong -

    Properties

    $numberLong

    $numberLong: string

    Settings

    Member Visibility

    On This Page

    Properties
    +LongExtended | mongodb

    Interface LongExtended

    interface LongExtended {
        $numberLong: string;
    }

    Properties

    $numberLong +

    Properties

    $numberLong

    $numberLong: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.MaxKeyExtended.html b/docs/Next/interfaces/BSON.MaxKeyExtended.html index 5cb4b8199f4..8996628fe51 100644 --- a/docs/Next/interfaces/BSON.MaxKeyExtended.html +++ b/docs/Next/interfaces/BSON.MaxKeyExtended.html @@ -1,2 +1,2 @@ -MaxKeyExtended | mongodb

    Interface MaxKeyExtended

    interface MaxKeyExtended {
        $maxKey: 1;
    }

    Properties

    $maxKey -

    Properties

    $maxKey

    $maxKey: 1

    Settings

    Member Visibility

    On This Page

    Properties
    +MaxKeyExtended | mongodb

    Interface MaxKeyExtended

    interface MaxKeyExtended {
        $maxKey: 1;
    }

    Properties

    $maxKey +

    Properties

    $maxKey

    $maxKey: 1

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.MinKeyExtended.html b/docs/Next/interfaces/BSON.MinKeyExtended.html index 4e6ea8c2058..a26c718a5d4 100644 --- a/docs/Next/interfaces/BSON.MinKeyExtended.html +++ b/docs/Next/interfaces/BSON.MinKeyExtended.html @@ -1,2 +1,2 @@ -MinKeyExtended | mongodb

    Interface MinKeyExtended

    interface MinKeyExtended {
        $minKey: 1;
    }

    Properties

    $minKey -

    Properties

    $minKey

    $minKey: 1

    Settings

    Member Visibility

    On This Page

    Properties
    +MinKeyExtended | mongodb

    Interface MinKeyExtended

    interface MinKeyExtended {
        $minKey: 1;
    }

    Properties

    $minKey +

    Properties

    $minKey

    $minKey: 1

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.ObjectIdExtended.html b/docs/Next/interfaces/BSON.ObjectIdExtended.html index e2233343ab3..9aef7c13785 100644 --- a/docs/Next/interfaces/BSON.ObjectIdExtended.html +++ b/docs/Next/interfaces/BSON.ObjectIdExtended.html @@ -1,2 +1,2 @@ -ObjectIdExtended | mongodb

    Interface ObjectIdExtended

    interface ObjectIdExtended {
        $oid: string;
    }

    Properties

    $oid -

    Properties

    $oid

    $oid: string

    Settings

    Member Visibility

    On This Page

    Properties
    +ObjectIdExtended | mongodb

    Interface ObjectIdExtended

    interface ObjectIdExtended {
        $oid: string;
    }

    Properties

    $oid +

    Properties

    $oid

    $oid: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.ObjectIdLike.html b/docs/Next/interfaces/BSON.ObjectIdLike.html index 251f60aabbe..ea283f85c57 100644 --- a/docs/Next/interfaces/BSON.ObjectIdLike.html +++ b/docs/Next/interfaces/BSON.ObjectIdLike.html @@ -1,4 +1,4 @@ -ObjectIdLike | mongodb

    Interface ObjectIdLike

    interface ObjectIdLike {
        __id?: string;
        id: string | Uint8Array;
        toHexString(): string;
    }

    Properties

    __id? +ObjectIdLike | mongodb

    Interface ObjectIdLike

    interface ObjectIdLike {
        __id?: string;
        id: string | Uint8Array;
        toHexString(): string;
    }

    Properties

    __id? id

    Methods

    toHexString -

    Properties

    Optional__id

    __id?: string

    id

    id: string | Uint8Array

    Methods

    toHexString

    • toHexString(): string

    • Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Properties

    Optional__id

    __id?: string

    id

    id: string | Uint8Array

    Methods

    toHexString

    • toHexString(): string

    • Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/docs/Next/interfaces/BSON.SerializeOptions.html b/docs/Next/interfaces/BSON.SerializeOptions.html index aae6c905bdc..c40ed24c357 100644 --- a/docs/Next/interfaces/BSON.SerializeOptions.html +++ b/docs/Next/interfaces/BSON.SerializeOptions.html @@ -1,4 +1,4 @@ -SerializeOptions | mongodb

    Interface SerializeOptions

    interface SerializeOptions {
        checkKeys?: boolean;
        ignoreUndefined?: boolean;
        index?: number;
        serializeFunctions?: boolean;
    }

    Properties

    checkKeys? +SerializeOptions | mongodb

    Interface SerializeOptions

    interface SerializeOptions {
        checkKeys?: boolean;
        ignoreUndefined?: boolean;
        index?: number;
        serializeFunctions?: boolean;
    }

    Properties

    checkKeys? ignoreUndefined? index? serializeFunctions? @@ -11,4 +11,4 @@

    Default Value

    0

    OptionalserializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions

    Default Value

    false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSON.TimestampExtended.html b/docs/Next/interfaces/BSON.TimestampExtended.html index b7da1cf5304..851650f64b5 100644 --- a/docs/Next/interfaces/BSON.TimestampExtended.html +++ b/docs/Next/interfaces/BSON.TimestampExtended.html @@ -1,2 +1,2 @@ -TimestampExtended | mongodb

    Interface TimestampExtended

    interface TimestampExtended {
        $timestamp: {
            i: number;
            t: number;
        };
    }

    Properties

    $timestamp -

    Properties

    $timestamp

    $timestamp: {
        i: number;
        t: number;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    +TimestampExtended | mongodb

    Interface TimestampExtended

    interface TimestampExtended {
        $timestamp: {
            i: number;
            t: number;
        };
    }

    Properties

    $timestamp +

    Properties

    $timestamp

    $timestamp: {
        i: number;
        t: number;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BSONSerializeOptions.html b/docs/Next/interfaces/BSONSerializeOptions.html index 0c1f0e42ad1..ccdfa46a1c9 100644 --- a/docs/Next/interfaces/BSONSerializeOptions.html +++ b/docs/Next/interfaces/BSONSerializeOptions.html @@ -1,4 +1,4 @@ -BSONSerializeOptions | mongodb

    Interface BSONSerializeOptions

    BSON Serialization options.

    +BSONSerializeOptions | mongodb

    Interface BSONSerializeOptions

    BSON Serialization options.

    interface BSONSerializeOptions {
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        serializeFunctions?: boolean;
        useBigInt64?: boolean;
    }

    Hierarchy (view full)

    Properties

    bsonRegExp? checkKeys? enableUtf8Validation? @@ -41,4 +41,4 @@

    Remarks

    Default Value

    false

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BulkWriteOperationError.html b/docs/Next/interfaces/BulkWriteOperationError.html index 5023f510ce4..6d8c1c2f7c2 100644 --- a/docs/Next/interfaces/BulkWriteOperationError.html +++ b/docs/Next/interfaces/BulkWriteOperationError.html @@ -1,6 +1,6 @@ -BulkWriteOperationError | mongodb

    Interface BulkWriteOperationError

    interface BulkWriteOperationError {
        code: number;
        errInfo: Document;
        errmsg: string;
        index: number;
        op: Document | DeleteStatement | UpdateStatement;
    }

    Properties

    code +BulkWriteOperationError | mongodb

    Interface BulkWriteOperationError

    interface BulkWriteOperationError {
        code: number;
        errInfo: Document;
        errmsg: string;
        index: number;
        op: Document | DeleteStatement | UpdateStatement;
    }

    Properties

    code errInfo errmsg index op -

    Properties

    code

    code: number

    errInfo

    errInfo: Document

    errmsg

    errmsg: string

    index

    index: number

    op

    op: Document | DeleteStatement | UpdateStatement

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    code

    code: number

    errInfo

    errInfo: Document

    errmsg

    errmsg: string

    index

    index: number

    op

    op: Document | DeleteStatement | UpdateStatement

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/BulkWriteOptions.html b/docs/Next/interfaces/BulkWriteOptions.html index f80ac3e9781..69b6d9fa3a9 100644 --- a/docs/Next/interfaces/BulkWriteOptions.html +++ b/docs/Next/interfaces/BulkWriteOptions.html @@ -1,4 +1,4 @@ -BulkWriteOptions | mongodb

    Interface BulkWriteOptions

    interface BulkWriteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        forceServerObjectId?: boolean;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        ordered?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +BulkWriteOptions | mongodb

    Interface BulkWriteOptions

    interface BulkWriteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        forceServerObjectId?: boolean;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        ordered?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? bypassDocumentValidation? checkKeys? @@ -77,4 +77,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamCollModDocument.html b/docs/Next/interfaces/ChangeStreamCollModDocument.html index d3148627f3a..13f1a1e584c 100644 --- a/docs/Next/interfaces/ChangeStreamCollModDocument.html +++ b/docs/Next/interfaces/ChangeStreamCollModDocument.html @@ -1,4 +1,4 @@ -ChangeStreamCollModDocument | mongodb

    Interface ChangeStreamCollModDocument

    Only present when the showExpandedEvents flag is enabled.

    +ChangeStreamCollModDocument | mongodb

    Interface ChangeStreamCollModDocument

    Only present when the showExpandedEvents flag is enabled.

    See

    https://www.mongodb.com/docs/manual/reference/change-events/modify/#mongodb-data-modify

    interface ChangeStreamCollModDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationType: "modify";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? @@ -29,4 +29,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamCreateDocument.html b/docs/Next/interfaces/ChangeStreamCreateDocument.html index bc391b9f638..d8da7dbcbe9 100644 --- a/docs/Next/interfaces/ChangeStreamCreateDocument.html +++ b/docs/Next/interfaces/ChangeStreamCreateDocument.html @@ -1,4 +1,4 @@ -ChangeStreamCreateDocument | mongodb

    Interface ChangeStreamCreateDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/create/#mongodb-data-create

    +ChangeStreamCreateDocument | mongodb

    Interface ChangeStreamCreateDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/create/#mongodb-data-create

    interface ChangeStreamCreateDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationType: "create";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -28,4 +28,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamCreateIndexDocument.html b/docs/Next/interfaces/ChangeStreamCreateIndexDocument.html index fdab63a4deb..beeec6accf4 100644 --- a/docs/Next/interfaces/ChangeStreamCreateIndexDocument.html +++ b/docs/Next/interfaces/ChangeStreamCreateIndexDocument.html @@ -1,4 +1,4 @@ -ChangeStreamCreateIndexDocument | mongodb

    Interface ChangeStreamCreateIndexDocument

    Only present when the showExpandedEvents flag is enabled.

    +ChangeStreamCreateIndexDocument | mongodb

    Interface ChangeStreamCreateIndexDocument

    Only present when the showExpandedEvents flag is enabled.

    See

    https://www.mongodb.com/docs/manual/reference/change-events/createIndexes/#mongodb-data-createIndexes

    interface ChangeStreamCreateIndexDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "createIndexes";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? @@ -33,4 +33,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamDeleteDocument.html b/docs/Next/interfaces/ChangeStreamDeleteDocument.html index 94b2e22bd6e..394cc2b4150 100644 --- a/docs/Next/interfaces/ChangeStreamDeleteDocument.html +++ b/docs/Next/interfaces/ChangeStreamDeleteDocument.html @@ -1,4 +1,4 @@ -ChangeStreamDeleteDocument | mongodb

    Interface ChangeStreamDeleteDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#delete-event

    +ChangeStreamDeleteDocument | mongodb

    Interface ChangeStreamDeleteDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#delete-event

    interface ChangeStreamDeleteDocument<TSchema> {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
        fullDocumentBeforeChange?: TSchema;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "delete";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -39,4 +39,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamDocumentCollectionUUID.html b/docs/Next/interfaces/ChangeStreamDocumentCollectionUUID.html index 00e9b6918c6..ca7c8c3dac7 100644 --- a/docs/Next/interfaces/ChangeStreamDocumentCollectionUUID.html +++ b/docs/Next/interfaces/ChangeStreamDocumentCollectionUUID.html @@ -1,7 +1,7 @@ -ChangeStreamDocumentCollectionUUID | mongodb

    Interface ChangeStreamDocumentCollectionUUID

    interface ChangeStreamDocumentCollectionUUID {
        collectionUUID: Binary;
    }

    Hierarchy (view full)

    Properties

    collectionUUID +ChangeStreamDocumentCollectionUUID | mongodb

    Interface ChangeStreamDocumentCollectionUUID

    interface ChangeStreamDocumentCollectionUUID {
        collectionUUID: Binary;
    }

    Hierarchy (view full)

    Properties

    collectionUUID

    Properties

    collectionUUID

    collectionUUID: Binary

    The UUID (Binary subtype 4) of the collection that the operation was performed on.

    Only present when the showExpandedEvents flag is enabled.

    NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.

    Since Server Version

    6.1.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamDocumentCommon.html b/docs/Next/interfaces/ChangeStreamDocumentCommon.html index 8a9162ed605..17902de0178 100644 --- a/docs/Next/interfaces/ChangeStreamDocumentCommon.html +++ b/docs/Next/interfaces/ChangeStreamDocumentCommon.html @@ -1,4 +1,4 @@ -ChangeStreamDocumentCommon | mongodb

    Interface ChangeStreamDocumentCommon

    interface ChangeStreamDocumentCommon {
        _id: unknown;
        clusterTime?: Timestamp;
        lsid?: ServerSessionId;
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id +ChangeStreamDocumentCommon | mongodb

    Interface ChangeStreamDocumentCommon

    interface ChangeStreamDocumentCommon {
        _id: unknown;
        clusterTime?: Timestamp;
        lsid?: ServerSessionId;
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? lsid? splitEvent? @@ -19,4 +19,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamDocumentKey.html b/docs/Next/interfaces/ChangeStreamDocumentKey.html index abde318a432..ddce969df6b 100644 --- a/docs/Next/interfaces/ChangeStreamDocumentKey.html +++ b/docs/Next/interfaces/ChangeStreamDocumentKey.html @@ -1,4 +1,4 @@ -ChangeStreamDocumentKey | mongodb

    Interface ChangeStreamDocumentKey<TSchema>

    interface ChangeStreamDocumentKey<TSchema> {
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    documentKey +ChangeStreamDocumentKey | mongodb

    Interface ChangeStreamDocumentKey<TSchema>

    interface ChangeStreamDocumentKey<TSchema> {
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    documentKey

    Properties

    documentKey

    documentKey: {
        _id: InferIdType<TSchema>;
        [shardKey: string]: any;
    }

    For unsharded collections this contains a single field _id. For sharded collections, this will contain all the components of the shard key

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamDocumentOperationDescription.html b/docs/Next/interfaces/ChangeStreamDocumentOperationDescription.html index 3b4853c2df2..8e95ee188de 100644 --- a/docs/Next/interfaces/ChangeStreamDocumentOperationDescription.html +++ b/docs/Next/interfaces/ChangeStreamDocumentOperationDescription.html @@ -1,5 +1,5 @@ -ChangeStreamDocumentOperationDescription | mongodb

    Interface ChangeStreamDocumentOperationDescription

    interface ChangeStreamDocumentOperationDescription {
        operationDescription?: Document;
    }

    Hierarchy (view full)

    Properties

    operationDescription? +ChangeStreamDocumentOperationDescription | mongodb

    Interface ChangeStreamDocumentOperationDescription

    interface ChangeStreamDocumentOperationDescription {
        operationDescription?: Document;
    }

    Hierarchy (view full)

    Properties

    operationDescription?

    Properties

    OptionaloperationDescription

    operationDescription?: Document

    An description of the operation.

    Only present when the showExpandedEvents flag is enabled.

    Since Server Version

    6.1.0

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamDropDatabaseDocument.html b/docs/Next/interfaces/ChangeStreamDropDatabaseDocument.html index d1a7a1eb99e..51f1fe7054d 100644 --- a/docs/Next/interfaces/ChangeStreamDropDatabaseDocument.html +++ b/docs/Next/interfaces/ChangeStreamDropDatabaseDocument.html @@ -1,4 +1,4 @@ -ChangeStreamDropDatabaseDocument | mongodb

    Interface ChangeStreamDropDatabaseDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#dropdatabase-event

    +ChangeStreamDropDatabaseDocument | mongodb

    Interface ChangeStreamDropDatabaseDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#dropdatabase-event

    interface ChangeStreamDropDatabaseDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        lsid?: ServerSessionId;
        ns: {
            db: string;
        };
        operationType: "dropDatabase";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? lsid? @@ -24,4 +24,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamDropDocument.html b/docs/Next/interfaces/ChangeStreamDropDocument.html index 80b96b36f51..2266ae328b9 100644 --- a/docs/Next/interfaces/ChangeStreamDropDocument.html +++ b/docs/Next/interfaces/ChangeStreamDropDocument.html @@ -1,4 +1,4 @@ -ChangeStreamDropDocument | mongodb

    Interface ChangeStreamDropDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#drop-event

    +ChangeStreamDropDocument | mongodb

    Interface ChangeStreamDropDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#drop-event

    interface ChangeStreamDropDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "drop";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -30,4 +30,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamDropIndexDocument.html b/docs/Next/interfaces/ChangeStreamDropIndexDocument.html index 0db879fa5b9..fa3d45c4ba8 100644 --- a/docs/Next/interfaces/ChangeStreamDropIndexDocument.html +++ b/docs/Next/interfaces/ChangeStreamDropIndexDocument.html @@ -1,4 +1,4 @@ -ChangeStreamDropIndexDocument | mongodb

    Interface ChangeStreamDropIndexDocument

    Only present when the showExpandedEvents flag is enabled.

    +ChangeStreamDropIndexDocument | mongodb

    Interface ChangeStreamDropIndexDocument

    Only present when the showExpandedEvents flag is enabled.

    See

    https://www.mongodb.com/docs/manual/reference/change-events/dropIndexes/#mongodb-data-dropIndexes

    interface ChangeStreamDropIndexDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "dropIndexes";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? @@ -33,4 +33,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamInsertDocument.html b/docs/Next/interfaces/ChangeStreamInsertDocument.html index f08d5ff39b5..c9817be7a7c 100644 --- a/docs/Next/interfaces/ChangeStreamInsertDocument.html +++ b/docs/Next/interfaces/ChangeStreamInsertDocument.html @@ -1,4 +1,4 @@ -ChangeStreamInsertDocument | mongodb

    Interface ChangeStreamInsertDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#insert-event

    +ChangeStreamInsertDocument | mongodb

    Interface ChangeStreamInsertDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#insert-event

    interface ChangeStreamInsertDocument<TSchema> {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
        fullDocument: TSchema;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "insert";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -35,4 +35,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamInvalidateDocument.html b/docs/Next/interfaces/ChangeStreamInvalidateDocument.html index 16d607b5cec..861d3a522fa 100644 --- a/docs/Next/interfaces/ChangeStreamInvalidateDocument.html +++ b/docs/Next/interfaces/ChangeStreamInvalidateDocument.html @@ -1,4 +1,4 @@ -ChangeStreamInvalidateDocument | mongodb

    Interface ChangeStreamInvalidateDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#invalidate-event

    +ChangeStreamInvalidateDocument | mongodb

    Interface ChangeStreamInvalidateDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#invalidate-event

    interface ChangeStreamInvalidateDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        lsid?: ServerSessionId;
        operationType: "invalidate";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? lsid? @@ -22,4 +22,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamNameSpace.html b/docs/Next/interfaces/ChangeStreamNameSpace.html index 8ac1b23273f..12b6d7fd0be 100644 --- a/docs/Next/interfaces/ChangeStreamNameSpace.html +++ b/docs/Next/interfaces/ChangeStreamNameSpace.html @@ -1,3 +1,3 @@ -ChangeStreamNameSpace | mongodb

    Interface ChangeStreamNameSpace

    interface ChangeStreamNameSpace {
        coll: string;
        db: string;
    }

    Properties

    coll +ChangeStreamNameSpace | mongodb

    Interface ChangeStreamNameSpace

    interface ChangeStreamNameSpace {
        coll: string;
        db: string;
    }

    Properties

    coll db -

    Properties

    coll

    coll: string

    db

    db: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    coll

    coll: string

    db

    db: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamOptions.html b/docs/Next/interfaces/ChangeStreamOptions.html index 815790d2246..e13f660bc4f 100644 --- a/docs/Next/interfaces/ChangeStreamOptions.html +++ b/docs/Next/interfaces/ChangeStreamOptions.html @@ -1,4 +1,4 @@ -ChangeStreamOptions | mongodb

    Interface ChangeStreamOptions

    Options that can be passed to a ChangeStream. Note that startAfter, resumeAfter, and startAtOperationTime are all mutually exclusive, and the server will error if more than one is specified.

    +ChangeStreamOptions | mongodb

    Interface ChangeStreamOptions

    Options that can be passed to a ChangeStream. Note that startAfter, resumeAfter, and startAtOperationTime are all mutually exclusive, and the server will error if more than one is specified.

    interface ChangeStreamOptions {
        allowDiskUse?: boolean;
        authdb?: string;
        batchSize?: number;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        cursor?: Document;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        fullDocument?: string;
        fullDocumentBeforeChange?: string;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        out?: string;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        resumeAfter?: unknown;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        showExpandedEvents?: boolean;
        startAfter?: unknown;
        startAtOperationTime?: Timestamp;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
    }

    Hierarchy

    Properties

    allowDiskUse? authdb? batchSize? @@ -121,4 +121,4 @@

    Remarks

    OptionalstartAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    -

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamRefineCollectionShardKeyDocument.html b/docs/Next/interfaces/ChangeStreamRefineCollectionShardKeyDocument.html index c8aa1598249..befd4f2ec16 100644 --- a/docs/Next/interfaces/ChangeStreamRefineCollectionShardKeyDocument.html +++ b/docs/Next/interfaces/ChangeStreamRefineCollectionShardKeyDocument.html @@ -1,4 +1,4 @@ -ChangeStreamRefineCollectionShardKeyDocument | mongodb

    Interface ChangeStreamRefineCollectionShardKeyDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/refineCollectionShardKey/#mongodb-data-refineCollectionShardKey

    +ChangeStreamRefineCollectionShardKeyDocument | mongodb

    Interface ChangeStreamRefineCollectionShardKeyDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/refineCollectionShardKey/#mongodb-data-refineCollectionShardKey

    interface ChangeStreamRefineCollectionShardKeyDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "refineCollectionShardKey";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -32,4 +32,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamRenameDocument.html b/docs/Next/interfaces/ChangeStreamRenameDocument.html index b6aaa84065d..fce74dc0a08 100644 --- a/docs/Next/interfaces/ChangeStreamRenameDocument.html +++ b/docs/Next/interfaces/ChangeStreamRenameDocument.html @@ -1,4 +1,4 @@ -ChangeStreamRenameDocument | mongodb

    Interface ChangeStreamRenameDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#rename-event

    +ChangeStreamRenameDocument | mongodb

    Interface ChangeStreamRenameDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#rename-event

    interface ChangeStreamRenameDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "rename";
        splitEvent?: ChangeStreamSplitEvent;
        to: {
            coll: string;
            db: string;
        };
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -32,4 +32,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamReplaceDocument.html b/docs/Next/interfaces/ChangeStreamReplaceDocument.html index 5f707ff0913..f1df54ba0de 100644 --- a/docs/Next/interfaces/ChangeStreamReplaceDocument.html +++ b/docs/Next/interfaces/ChangeStreamReplaceDocument.html @@ -1,4 +1,4 @@ -ChangeStreamReplaceDocument | mongodb

    Interface ChangeStreamReplaceDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#replace-event

    +ChangeStreamReplaceDocument | mongodb

    Interface ChangeStreamReplaceDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#replace-event

    interface ChangeStreamReplaceDocument<TSchema> {
        _id: unknown;
        clusterTime?: Timestamp;
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
        fullDocument: TSchema;
        fullDocumentBeforeChange?: TSchema;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "replace";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    _id clusterTime? documentKey @@ -35,4 +35,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamReshardCollectionDocument.html b/docs/Next/interfaces/ChangeStreamReshardCollectionDocument.html index 8df06dd4e69..663baebb853 100644 --- a/docs/Next/interfaces/ChangeStreamReshardCollectionDocument.html +++ b/docs/Next/interfaces/ChangeStreamReshardCollectionDocument.html @@ -1,4 +1,4 @@ -ChangeStreamReshardCollectionDocument | mongodb

    Interface ChangeStreamReshardCollectionDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/reshardCollection/#mongodb-data-reshardCollection

    +ChangeStreamReshardCollectionDocument | mongodb

    Interface ChangeStreamReshardCollectionDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/reshardCollection/#mongodb-data-reshardCollection

    interface ChangeStreamReshardCollectionDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "reshardCollection";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -32,4 +32,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamShardCollectionDocument.html b/docs/Next/interfaces/ChangeStreamShardCollectionDocument.html index 314bd63c865..46768903b06 100644 --- a/docs/Next/interfaces/ChangeStreamShardCollectionDocument.html +++ b/docs/Next/interfaces/ChangeStreamShardCollectionDocument.html @@ -1,4 +1,4 @@ -ChangeStreamShardCollectionDocument | mongodb

    Interface ChangeStreamShardCollectionDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/shardCollection/#mongodb-data-shardCollection

    +ChangeStreamShardCollectionDocument | mongodb

    Interface ChangeStreamShardCollectionDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/shardCollection/#mongodb-data-shardCollection

    interface ChangeStreamShardCollectionDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "shardCollection";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -32,4 +32,4 @@

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamSplitEvent.html b/docs/Next/interfaces/ChangeStreamSplitEvent.html index f7ce61959e1..5d5109707dc 100644 --- a/docs/Next/interfaces/ChangeStreamSplitEvent.html +++ b/docs/Next/interfaces/ChangeStreamSplitEvent.html @@ -1,5 +1,5 @@ -ChangeStreamSplitEvent | mongodb

    Interface ChangeStreamSplitEvent

    interface ChangeStreamSplitEvent {
        fragment: number;
        of: number;
    }

    Properties

    fragment +ChangeStreamSplitEvent | mongodb

    Interface ChangeStreamSplitEvent

    interface ChangeStreamSplitEvent {
        fragment: number;
        of: number;
    }

    Properties

    fragment of

    Properties

    fragment

    fragment: number

    Which fragment of the change this is.

    of

    of: number

    The total number of fragments.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamUpdateDocument.html b/docs/Next/interfaces/ChangeStreamUpdateDocument.html index f42e334ed07..b20b7cf2d79 100644 --- a/docs/Next/interfaces/ChangeStreamUpdateDocument.html +++ b/docs/Next/interfaces/ChangeStreamUpdateDocument.html @@ -1,4 +1,4 @@ -ChangeStreamUpdateDocument | mongodb

    Interface ChangeStreamUpdateDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#update-event

    +ChangeStreamUpdateDocument | mongodb

    Interface ChangeStreamUpdateDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#update-event

    interface ChangeStreamUpdateDocument<TSchema> {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
        fullDocument?: TSchema;
        fullDocumentBeforeChange?: TSchema;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "update";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
        updateDescription: UpdateDescription<TSchema>;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID @@ -46,4 +46,4 @@ Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    updateDescription

    updateDescription: UpdateDescription<TSchema>

    Contains a description of updated and removed fields in this operation

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientBulkWriteError.html b/docs/Next/interfaces/ClientBulkWriteError.html index 1c2388c52fe..b082643b4c9 100644 --- a/docs/Next/interfaces/ClientBulkWriteError.html +++ b/docs/Next/interfaces/ClientBulkWriteError.html @@ -1,3 +1,3 @@ -ClientBulkWriteError | mongodb

    Interface ClientBulkWriteError

    interface ClientBulkWriteError {
        code: number;
        message: string;
    }

    Properties

    code +ClientBulkWriteError | mongodb

    Interface ClientBulkWriteError

    interface ClientBulkWriteError {
        code: number;
        message: string;
    }

    Properties

    code message -

    Properties

    code

    code: number

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    code

    code: number

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientBulkWriteOptions.html b/docs/Next/interfaces/ClientBulkWriteOptions.html index 7b510070068..7da272ce0ba 100644 --- a/docs/Next/interfaces/ClientBulkWriteOptions.html +++ b/docs/Next/interfaces/ClientBulkWriteOptions.html @@ -1,4 +1,4 @@ -ClientBulkWriteOptions | mongodb

    Interface ClientBulkWriteOptions

    interface ClientBulkWriteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        ordered?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        verboseResults?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +ClientBulkWriteOptions | mongodb

    Interface ClientBulkWriteOptions

    interface ClientBulkWriteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        ordered?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        verboseResults?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? bypassDocumentValidation? checkKeys? @@ -77,4 +77,4 @@

    Remarks

    OptionalverboseResults

    verboseResults?: boolean

    Whether detailed results for each successful operation should be included in the returned BulkWriteResult.

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientBulkWriteResult.html b/docs/Next/interfaces/ClientBulkWriteResult.html index c52114d23a7..9e539ac2409 100644 --- a/docs/Next/interfaces/ClientBulkWriteResult.html +++ b/docs/Next/interfaces/ClientBulkWriteResult.html @@ -1,4 +1,4 @@ -ClientBulkWriteResult | mongodb

    Interface ClientBulkWriteResult

    interface ClientBulkWriteResult {
        acknowledged: boolean;
        deletedCount: number;
        deleteResults?: ReadonlyMap<number, ClientDeleteResult>;
        insertedCount: number;
        insertResults?: ReadonlyMap<number, ClientInsertOneResult>;
        matchedCount: number;
        modifiedCount: number;
        updateResults?: ReadonlyMap<number, ClientUpdateResult>;
        upsertedCount: number;
    }

    Properties

    acknowledged +ClientBulkWriteResult | mongodb

    Interface ClientBulkWriteResult

    interface ClientBulkWriteResult {
        acknowledged: boolean;
        deletedCount: number;
        deleteResults?: ReadonlyMap<number, ClientDeleteResult>;
        insertedCount: number;
        insertResults?: ReadonlyMap<number, ClientInsertOneResult>;
        matchedCount: number;
        modifiedCount: number;
        updateResults?: ReadonlyMap<number, ClientUpdateResult>;
        upsertedCount: number;
    }

    Properties

    acknowledged deletedCount deleteResults? insertedCount @@ -16,4 +16,4 @@

    ReadonlymodifiedCount

    modifiedCount: number

    The total number of documents modified across all update operations.

    Optional ReadonlyupdateResults

    updateResults?: ReadonlyMap<number, ClientUpdateResult>

    The results of each individual update operation that was successfully performed.

    ReadonlyupsertedCount

    upsertedCount: number

    The total number of documents upserted across all update operations.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientDeleteManyModel.html b/docs/Next/interfaces/ClientDeleteManyModel.html index 0f10e9a2403..8aeb08a272c 100644 --- a/docs/Next/interfaces/ClientDeleteManyModel.html +++ b/docs/Next/interfaces/ClientDeleteManyModel.html @@ -1,4 +1,4 @@ -ClientDeleteManyModel | mongodb

    Interface ClientDeleteManyModel<TSchema>

    interface ClientDeleteManyModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "deleteMany";
        namespace: string;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    collation? +ClientDeleteManyModel | mongodb

    Interface ClientDeleteManyModel<TSchema>

    interface ClientDeleteManyModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "deleteMany";
        namespace: string;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    collation? filter hint? name @@ -11,4 +11,4 @@

    A namespace is a combination of the database name and the name of the collection: <database-name>.<collection>. All documents belong to a namespace.

    See

    https://www.mongodb.com/docs/manual/reference/limits/#std-label-faq-dev-namespace

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientDeleteOneModel.html b/docs/Next/interfaces/ClientDeleteOneModel.html index 31f01bc9196..369fd2e890e 100644 --- a/docs/Next/interfaces/ClientDeleteOneModel.html +++ b/docs/Next/interfaces/ClientDeleteOneModel.html @@ -1,4 +1,4 @@ -ClientDeleteOneModel | mongodb

    Interface ClientDeleteOneModel<TSchema>

    interface ClientDeleteOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "deleteOne";
        namespace: string;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    collation? +ClientDeleteOneModel | mongodb

    Interface ClientDeleteOneModel<TSchema>

    interface ClientDeleteOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "deleteOne";
        namespace: string;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    collation? filter hint? name @@ -11,4 +11,4 @@

    A namespace is a combination of the database name and the name of the collection: <database-name>.<collection>. All documents belong to a namespace.

    See

    https://www.mongodb.com/docs/manual/reference/limits/#std-label-faq-dev-namespace

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientDeleteResult.html b/docs/Next/interfaces/ClientDeleteResult.html index 3e78f44df13..e8459b8cc19 100644 --- a/docs/Next/interfaces/ClientDeleteResult.html +++ b/docs/Next/interfaces/ClientDeleteResult.html @@ -1,3 +1,3 @@ -ClientDeleteResult | mongodb

    Interface ClientDeleteResult

    interface ClientDeleteResult {
        deletedCount: number;
    }

    Properties

    deletedCount +ClientDeleteResult | mongodb

    Interface ClientDeleteResult

    interface ClientDeleteResult {
        deletedCount: number;
    }

    Properties

    deletedCount

    Properties

    deletedCount

    deletedCount: number

    The number of documents that were deleted.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientEncryptionCreateDataKeyProviderOptions.html b/docs/Next/interfaces/ClientEncryptionCreateDataKeyProviderOptions.html index 2b36e5f9d42..9f7beb8f54f 100644 --- a/docs/Next/interfaces/ClientEncryptionCreateDataKeyProviderOptions.html +++ b/docs/Next/interfaces/ClientEncryptionCreateDataKeyProviderOptions.html @@ -1,8 +1,8 @@ -ClientEncryptionCreateDataKeyProviderOptions | mongodb

    Interface ClientEncryptionCreateDataKeyProviderOptions

    Options to provide when creating a new data key.

    +ClientEncryptionCreateDataKeyProviderOptions | mongodb

    Interface ClientEncryptionCreateDataKeyProviderOptions

    Options to provide when creating a new data key.

    interface ClientEncryptionCreateDataKeyProviderOptions {
        keyAltNames?: string[];
        keyMaterial?: Buffer | Binary;
        masterKey?:
            | AWSEncryptionKeyOptions
            | AzureEncryptionKeyOptions
            | GCPEncryptionKeyOptions
            | KMIPEncryptionKeyOptions;
    }

    Properties

    keyAltNames? keyMaterial? masterKey?

    Properties

    OptionalkeyAltNames

    keyAltNames?: string[]

    An optional list of string alternate names used to reference a key. If a key is created with alternate names, then encryption may refer to the key by the unique alternate name instead of by _id.

    Optional ExperimentalkeyMaterial

    keyMaterial?: Buffer | Binary

    OptionalmasterKey

    masterKey?:
        | AWSEncryptionKeyOptions
        | AzureEncryptionKeyOptions
        | GCPEncryptionKeyOptions
        | KMIPEncryptionKeyOptions

    Identifies a new KMS-specific key used to encrypt the new data key

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientEncryptionEncryptOptions.html b/docs/Next/interfaces/ClientEncryptionEncryptOptions.html index 740a1b5c1a6..b6e665aad5d 100644 --- a/docs/Next/interfaces/ClientEncryptionEncryptOptions.html +++ b/docs/Next/interfaces/ClientEncryptionEncryptOptions.html @@ -1,4 +1,4 @@ -ClientEncryptionEncryptOptions | mongodb

    Interface ClientEncryptionEncryptOptions

    Options to provide when encrypting data.

    +ClientEncryptionEncryptOptions | mongodb

    Interface ClientEncryptionEncryptOptions

    Options to provide when encrypting data.

    interface ClientEncryptionEncryptOptions {
        algorithm:
            | "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"
            | "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
            | "Indexed"
            | "Unindexed"
            | "Range";
        contentionFactor?: number | bigint;
        keyAltName?: string;
        keyId?: Binary;
        queryType?: "equality" | "range";
        rangeOptions?: RangeOptions;
    }

    Properties

    algorithm contentionFactor? keyAltName? @@ -11,4 +11,4 @@

    OptionalkeyId

    keyId?: Binary

    The id of the Binary dataKey to use for encryption

    OptionalqueryType

    queryType?: "equality" | "range"

    The query type.

    OptionalrangeOptions

    rangeOptions?: RangeOptions

    The index options for a Queryable Encryption field supporting "range" queries.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientEncryptionOptions.html b/docs/Next/interfaces/ClientEncryptionOptions.html index 1abfafe30e5..7374dff24e9 100644 --- a/docs/Next/interfaces/ClientEncryptionOptions.html +++ b/docs/Next/interfaces/ClientEncryptionOptions.html @@ -1,4 +1,4 @@ -ClientEncryptionOptions | mongodb

    Interface ClientEncryptionOptions

    Additional settings to provide when creating a new ClientEncryption instance.

    +ClientEncryptionOptions | mongodb

    Interface ClientEncryptionOptions

    Additional settings to provide when creating a new ClientEncryption instance.

    interface ClientEncryptionOptions {
        keyVaultClient?: MongoClient;
        keyVaultNamespace: string;
        kmsProviders?: KMSProviders;
        proxyOptions?: ProxyOptions;
        tlsOptions?: CSFLEKMSTlsOptions;
    }

    Properties

    keyVaultClient? keyVaultNamespace kmsProviders? @@ -9,4 +9,4 @@

    OptionalkmsProviders

    kmsProviders?: KMSProviders

    Options for specific KMS providers to use

    OptionalproxyOptions

    proxyOptions?: ProxyOptions

    Options for specifying a Socks5 proxy to use for connecting to the KMS.

    OptionaltlsOptions

    tlsOptions?: CSFLEKMSTlsOptions

    TLS options for kms providers to use.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientEncryptionRewrapManyDataKeyProviderOptions.html b/docs/Next/interfaces/ClientEncryptionRewrapManyDataKeyProviderOptions.html index db8217c1cba..3a7ec63ac94 100644 --- a/docs/Next/interfaces/ClientEncryptionRewrapManyDataKeyProviderOptions.html +++ b/docs/Next/interfaces/ClientEncryptionRewrapManyDataKeyProviderOptions.html @@ -1,3 +1,3 @@ -ClientEncryptionRewrapManyDataKeyProviderOptions | mongodb

    Interface ClientEncryptionRewrapManyDataKeyProviderOptionsExperimental

    interface ClientEncryptionRewrapManyDataKeyProviderOptions {
        masterKey?:
            | AWSEncryptionKeyOptions
            | AzureEncryptionKeyOptions
            | GCPEncryptionKeyOptions
            | KMIPEncryptionKeyOptions;
        provider: keyof KMSProviders;
    }

    Properties

    masterKey? +ClientEncryptionRewrapManyDataKeyProviderOptions | mongodb

    Interface ClientEncryptionRewrapManyDataKeyProviderOptionsExperimental

    interface ClientEncryptionRewrapManyDataKeyProviderOptions {
        masterKey?:
            | AWSEncryptionKeyOptions
            | AzureEncryptionKeyOptions
            | GCPEncryptionKeyOptions
            | KMIPEncryptionKeyOptions;
        provider: keyof KMSProviders;
    }

    Properties

    masterKey? provider -

    Properties

    Optional ExperimentalmasterKey

    masterKey?:
        | AWSEncryptionKeyOptions
        | AzureEncryptionKeyOptions
        | GCPEncryptionKeyOptions
        | KMIPEncryptionKeyOptions

    Experimentalprovider

    provider: keyof KMSProviders

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optional ExperimentalmasterKey

    masterKey?:
        | AWSEncryptionKeyOptions
        | AzureEncryptionKeyOptions
        | GCPEncryptionKeyOptions
        | KMIPEncryptionKeyOptions

    Experimentalprovider

    provider: keyof KMSProviders

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientEncryptionRewrapManyDataKeyResult.html b/docs/Next/interfaces/ClientEncryptionRewrapManyDataKeyResult.html index 9cc0edc0e7a..6f799a87331 100644 --- a/docs/Next/interfaces/ClientEncryptionRewrapManyDataKeyResult.html +++ b/docs/Next/interfaces/ClientEncryptionRewrapManyDataKeyResult.html @@ -1,3 +1,3 @@ -ClientEncryptionRewrapManyDataKeyResult | mongodb

    Interface ClientEncryptionRewrapManyDataKeyResultExperimental

    interface ClientEncryptionRewrapManyDataKeyResult {
        bulkWriteResult?: BulkWriteResult;
    }

    Properties

    bulkWriteResult? +ClientEncryptionRewrapManyDataKeyResult | mongodb

    Interface ClientEncryptionRewrapManyDataKeyResultExperimental

    interface ClientEncryptionRewrapManyDataKeyResult {
        bulkWriteResult?: BulkWriteResult;
    }

    Properties

    bulkWriteResult?

    Properties

    Optional ExperimentalbulkWriteResult

    bulkWriteResult?: BulkWriteResult

    The result of rewrapping data keys. If unset, no keys matched the filter.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientInsertOneModel.html b/docs/Next/interfaces/ClientInsertOneModel.html index 4469e0299d1..017925ba654 100644 --- a/docs/Next/interfaces/ClientInsertOneModel.html +++ b/docs/Next/interfaces/ClientInsertOneModel.html @@ -1,4 +1,4 @@ -ClientInsertOneModel | mongodb

    Interface ClientInsertOneModel<TSchema>

    interface ClientInsertOneModel<TSchema> {
        document: OptionalId<TSchema>;
        name: "insertOne";
        namespace: string;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    document +ClientInsertOneModel | mongodb

    Interface ClientInsertOneModel<TSchema>

    interface ClientInsertOneModel<TSchema> {
        document: OptionalId<TSchema>;
        name: "insertOne";
        namespace: string;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    document name namespace

    Properties

    document

    document: OptionalId<TSchema>

    The document to insert.

    @@ -6,4 +6,4 @@

    A namespace is a combination of the database name and the name of the collection: <database-name>.<collection>. All documents belong to a namespace.

    See

    https://www.mongodb.com/docs/manual/reference/limits/#std-label-faq-dev-namespace

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientInsertOneResult.html b/docs/Next/interfaces/ClientInsertOneResult.html index 59b59470891..3be37dc4169 100644 --- a/docs/Next/interfaces/ClientInsertOneResult.html +++ b/docs/Next/interfaces/ClientInsertOneResult.html @@ -1,3 +1,3 @@ -ClientInsertOneResult | mongodb

    Interface ClientInsertOneResult

    interface ClientInsertOneResult {
        insertedId: any;
    }

    Properties

    insertedId +ClientInsertOneResult | mongodb

    Interface ClientInsertOneResult

    interface ClientInsertOneResult {
        insertedId: any;
    }

    Properties

    insertedId

    Properties

    insertedId

    insertedId: any

    The _id of the inserted document.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientMetadata.html b/docs/Next/interfaces/ClientMetadata.html index c76fabb9e98..904742c857b 100644 --- a/docs/Next/interfaces/ClientMetadata.html +++ b/docs/Next/interfaces/ClientMetadata.html @@ -1,8 +1,8 @@ -ClientMetadata | mongodb

    Interface ClientMetadata

    See

    https://github.com/mongodb/specifications/blob/master/source/mongodb-handshake/handshake.rst#hello-command

    +ClientMetadata | mongodb

    Interface ClientMetadata

    See

    https://github.com/mongodb/specifications/blob/master/source/mongodb-handshake/handshake.md#hello-command

    interface ClientMetadata {
        application?: {
            name: string;
        };
        driver: {
            name: string;
            version: string;
        };
        env?: {
            memory_mb?: Int32;
            name:
                | "aws.lambda"
                | "gcp.func"
                | "azure.func"
                | "vercel";
            region?: string;
            timeout_sec?: Int32;
            url?: string;
        };
        os: {
            architecture?: string;
            name?: Platform;
            type: string;
            version?: string;
        };
        platform: string;
    }

    Properties

    application? driver env? os platform

    Properties

    Optionalapplication

    application?: {
        name: string;
    }

    driver

    driver: {
        name: string;
        version: string;
    }

    Optionalenv

    env?: {
        memory_mb?: Int32;
        name:
            | "aws.lambda"
            | "gcp.func"
            | "azure.func"
            | "vercel";
        region?: string;
        timeout_sec?: Int32;
        url?: string;
    }

    FaaS environment information

    -

    os

    os: {
        architecture?: string;
        name?: Platform;
        type: string;
        version?: string;
    }

    platform

    platform: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    os

    os: {
        architecture?: string;
        name?: Platform;
        type: string;
        version?: string;
    }

    platform

    platform: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientMetadataOptions.html b/docs/Next/interfaces/ClientMetadataOptions.html index bc2250178fe..5ad84fba1c8 100644 --- a/docs/Next/interfaces/ClientMetadataOptions.html +++ b/docs/Next/interfaces/ClientMetadataOptions.html @@ -1,3 +1,3 @@ -ClientMetadataOptions | mongodb

    Interface ClientMetadataOptions

    interface ClientMetadataOptions {
        appName?: string;
        driverInfo?: {
            name?: string;
            platform?: string;
            version?: string;
        };
    }

    Properties

    appName? +ClientMetadataOptions | mongodb

    Interface ClientMetadataOptions

    interface ClientMetadataOptions {
        appName?: string;
        driverInfo?: {
            name?: string;
            platform?: string;
            version?: string;
        };
    }

    Properties

    appName? driverInfo? -

    Properties

    OptionalappName

    appName?: string

    OptionaldriverInfo

    driverInfo?: {
        name?: string;
        platform?: string;
        version?: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalappName

    appName?: string

    OptionaldriverInfo

    driverInfo?: {
        name?: string;
        platform?: string;
        version?: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientReplaceOneModel.html b/docs/Next/interfaces/ClientReplaceOneModel.html index e2c551b4722..23486aa53df 100644 --- a/docs/Next/interfaces/ClientReplaceOneModel.html +++ b/docs/Next/interfaces/ClientReplaceOneModel.html @@ -1,4 +1,4 @@ -ClientReplaceOneModel | mongodb

    Interface ClientReplaceOneModel<TSchema>

    interface ClientReplaceOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "replaceOne";
        namespace: string;
        replacement: WithoutId<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    collation? +ClientReplaceOneModel | mongodb

    Interface ClientReplaceOneModel<TSchema>

    interface ClientReplaceOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "replaceOne";
        namespace: string;
        replacement: WithoutId<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    collation? filter hint? name @@ -15,4 +15,4 @@

    See

    https://www.mongodb.com/docs/manual/reference/limits/#std-label-faq-dev-namespace

    replacement

    replacement: WithoutId<TSchema>

    The document with which to replace the matched document.

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientSessionOptions.html b/docs/Next/interfaces/ClientSessionOptions.html index 0d8d4d90c62..82e6bbabc13 100644 --- a/docs/Next/interfaces/ClientSessionOptions.html +++ b/docs/Next/interfaces/ClientSessionOptions.html @@ -1,7 +1,7 @@ -ClientSessionOptions | mongodb

    Interface ClientSessionOptions

    interface ClientSessionOptions {
        causalConsistency?: boolean;
        defaultTransactionOptions?: TransactionOptions;
        snapshot?: boolean;
    }

    Properties

    causalConsistency? +ClientSessionOptions | mongodb

    Interface ClientSessionOptions

    interface ClientSessionOptions {
        causalConsistency?: boolean;
        defaultTransactionOptions?: TransactionOptions;
        snapshot?: boolean;
    }

    Properties

    causalConsistency? defaultTransactionOptions? snapshot?

    Properties

    OptionalcausalConsistency

    causalConsistency?: boolean

    Whether causal consistency should be enabled on this session

    OptionaldefaultTransactionOptions

    defaultTransactionOptions?: TransactionOptions

    The default TransactionOptions to use for transactions started on this session.

    Optionalsnapshot

    snapshot?: boolean

    Whether all read operations should be read from the same snapshot for this session (NOTE: not compatible with causalConsistency=true)

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientUpdateManyModel.html b/docs/Next/interfaces/ClientUpdateManyModel.html index 3102c18bca1..d396acdc437 100644 --- a/docs/Next/interfaces/ClientUpdateManyModel.html +++ b/docs/Next/interfaces/ClientUpdateManyModel.html @@ -1,4 +1,4 @@ -ClientUpdateManyModel | mongodb

    Interface ClientUpdateManyModel<TSchema>

    interface ClientUpdateManyModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "updateMany";
        namespace: string;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    arrayFilters? +ClientUpdateManyModel | mongodb

    Interface ClientUpdateManyModel<TSchema>

    interface ClientUpdateManyModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "updateMany";
        namespace: string;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    arrayFilters? collation? filter hint? @@ -19,4 +19,4 @@ UpdateFilter - A document that contains update operator expressions, Document[] - an aggregation pipeline.

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientUpdateOneModel.html b/docs/Next/interfaces/ClientUpdateOneModel.html index 9ceabcdc453..b08365537eb 100644 --- a/docs/Next/interfaces/ClientUpdateOneModel.html +++ b/docs/Next/interfaces/ClientUpdateOneModel.html @@ -1,4 +1,4 @@ -ClientUpdateOneModel | mongodb

    Interface ClientUpdateOneModel<TSchema>

    interface ClientUpdateOneModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "updateOne";
        namespace: string;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    arrayFilters? +ClientUpdateOneModel | mongodb

    Interface ClientUpdateOneModel<TSchema>

    interface ClientUpdateOneModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        name: "updateOne";
        namespace: string;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    arrayFilters? collation? filter hint? @@ -19,4 +19,4 @@ UpdateFilter - A document that contains update operator expressions, Document[] - an aggregation pipeline.

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientUpdateResult.html b/docs/Next/interfaces/ClientUpdateResult.html index 01c85007baf..b43128cb89d 100644 --- a/docs/Next/interfaces/ClientUpdateResult.html +++ b/docs/Next/interfaces/ClientUpdateResult.html @@ -1,4 +1,4 @@ -ClientUpdateResult | mongodb

    Interface ClientUpdateResult

    interface ClientUpdateResult {
        didUpsert: boolean;
        matchedCount: number;
        modifiedCount: number;
        upsertedId?: any;
    }

    Properties

    didUpsert +ClientUpdateResult | mongodb

    Interface ClientUpdateResult

    interface ClientUpdateResult {
        didUpsert: boolean;
        matchedCount: number;
        modifiedCount: number;
        upsertedId?: any;
    }

    Properties

    didUpsert matchedCount modifiedCount upsertedId? @@ -9,4 +9,4 @@

    It MUST be possible to discern between a BSON Null upserted ID value and this field being unset. If necessary, drivers MAY add a didUpsert boolean field to differentiate between these two cases.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClientWriteModel.html b/docs/Next/interfaces/ClientWriteModel.html index f46fb4a0d7c..8c64b973579 100644 --- a/docs/Next/interfaces/ClientWriteModel.html +++ b/docs/Next/interfaces/ClientWriteModel.html @@ -1,6 +1,6 @@ -ClientWriteModel | mongodb

    Interface ClientWriteModel

    interface ClientWriteModel {
        namespace: string;
    }

    Hierarchy (view full)

    Properties

    namespace +ClientWriteModel | mongodb

    Interface ClientWriteModel

    interface ClientWriteModel {
        namespace: string;
    }

    Hierarchy (view full)

    Properties

    namespace

    Properties

    namespace

    namespace: string

    The namespace for the write.

    A namespace is a combination of the database name and the name of the collection: <database-name>.<collection>. All documents belong to a namespace.

    See

    https://www.mongodb.com/docs/manual/reference/limits/#std-label-faq-dev-namespace

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/CloseOptions.html b/docs/Next/interfaces/CloseOptions.html index e63c6165a07..ef2d22c9f3e 100644 --- a/docs/Next/interfaces/CloseOptions.html +++ b/docs/Next/interfaces/CloseOptions.html @@ -1,4 +1,4 @@ -CloseOptions | mongodb

    Interface CloseOptions

    Deprecated

    This interface is deprecated and will be removed in a future release as it is not used +CloseOptions | mongodb

    Interface CloseOptions

    Deprecated

    This interface is deprecated and will be removed in a future release as it is not used in the driver

    interface CloseOptions {
        force?: boolean;
    }

    Properties

    force? -

    Properties

    Optionalforce

    force?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalforce

    force?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClusterTime.html b/docs/Next/interfaces/ClusterTime.html index 32205105305..0dcc41c2785 100644 --- a/docs/Next/interfaces/ClusterTime.html +++ b/docs/Next/interfaces/ClusterTime.html @@ -1,7 +1,7 @@ -ClusterTime | mongodb

    Interface ClusterTime

    Gossiped in component for the cluster time tracking the state of user databases +ClusterTime | mongodb

    Interface ClusterTime

    Gossiped in component for the cluster time tracking the state of user databases across the cluster. It may optionally include a signature identifying the process that generated such a value.

    interface ClusterTime {
        clusterTime: Timestamp;
        signature?: {
            hash: Binary;
            keyId: Long;
        };
    }

    Properties

    clusterTime signature?

    Properties

    clusterTime

    clusterTime: Timestamp

    Optionalsignature

    signature?: {
        hash: Binary;
        keyId: Long;
    }

    Used to validate the identity of a request or response's ClusterTime.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ClusteredCollectionOptions.html b/docs/Next/interfaces/ClusteredCollectionOptions.html index b2caa6ae537..f11da616f0a 100644 --- a/docs/Next/interfaces/ClusteredCollectionOptions.html +++ b/docs/Next/interfaces/ClusteredCollectionOptions.html @@ -1,6 +1,6 @@ -ClusteredCollectionOptions | mongodb

    Interface ClusteredCollectionOptions

    Configuration options for clustered collections

    +ClusteredCollectionOptions | mongodb

    Interface ClusteredCollectionOptions

    Configuration options for clustered collections

    See

    https://www.mongodb.com/docs/manual/core/clustered-collections/

    interface ClusteredCollectionOptions {
        key: Document;
        name?: string;
        unique: boolean;
    }

    Hierarchy (view full)

    Properties

    key name? unique -

    Properties

    key

    key: Document

    Optionalname

    name?: string

    unique

    unique: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    key

    key: Document

    Optionalname

    name?: string

    unique

    unique: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/CollationOptions.html b/docs/Next/interfaces/CollationOptions.html index 7e8520d4d95..840eb6f2a59 100644 --- a/docs/Next/interfaces/CollationOptions.html +++ b/docs/Next/interfaces/CollationOptions.html @@ -1,4 +1,4 @@ -CollationOptions | mongodb

    Interface CollationOptions

    interface CollationOptions {
        alternate?: string;
        backwards?: boolean;
        caseFirst?: string;
        caseLevel?: boolean;
        locale: string;
        maxVariable?: string;
        normalization?: boolean;
        numericOrdering?: boolean;
        strength?: number;
    }

    Properties

    alternate? +CollationOptions | mongodb

    Interface CollationOptions

    interface CollationOptions {
        alternate?: string;
        backwards?: boolean;
        caseFirst?: string;
        caseLevel?: boolean;
        locale: string;
        maxVariable?: string;
        normalization?: boolean;
        numericOrdering?: boolean;
        strength?: number;
    }

    Properties

    alternate? backwards? caseFirst? caseLevel? @@ -7,4 +7,4 @@ normalization? numericOrdering? strength? -

    Properties

    Optionalalternate

    alternate?: string

    Optionalbackwards

    backwards?: boolean

    OptionalcaseFirst

    caseFirst?: string

    OptionalcaseLevel

    caseLevel?: boolean

    locale

    locale: string

    OptionalmaxVariable

    maxVariable?: string

    Optionalnormalization

    normalization?: boolean

    OptionalnumericOrdering

    numericOrdering?: boolean

    Optionalstrength

    strength?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalalternate

    alternate?: string

    Optionalbackwards

    backwards?: boolean

    OptionalcaseFirst

    caseFirst?: string

    OptionalcaseLevel

    caseLevel?: boolean

    locale

    locale: string

    OptionalmaxVariable

    maxVariable?: string

    Optionalnormalization

    normalization?: boolean

    OptionalnumericOrdering

    numericOrdering?: boolean

    Optionalstrength

    strength?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/CollectionInfo.html b/docs/Next/interfaces/CollectionInfo.html index 5856888d1d7..53ac2f10501 100644 --- a/docs/Next/interfaces/CollectionInfo.html +++ b/docs/Next/interfaces/CollectionInfo.html @@ -1,6 +1,6 @@ -CollectionInfo | mongodb

    Interface CollectionInfo

    interface CollectionInfo {
        idIndex?: Document;
        info?: {
            readOnly?: false;
            uuid?: Binary;
        };
        name: string;
        options?: Document;
        type?: string;
    }

    Hierarchy (view full)

    Properties

    idIndex? +CollectionInfo | mongodb

    Interface CollectionInfo

    interface CollectionInfo {
        idIndex?: Document;
        info?: {
            readOnly?: false;
            uuid?: Binary;
        };
        name: string;
        options?: Document;
        type?: string;
    }

    Hierarchy (view full)

    Properties

    idIndex? info? name options? type? -

    Properties

    OptionalidIndex

    idIndex?: Document

    Optionalinfo

    info?: {
        readOnly?: false;
        uuid?: Binary;
    }

    name

    name: string

    Optionaloptions

    options?: Document

    Optionaltype

    type?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalidIndex

    idIndex?: Document

    Optionalinfo

    info?: {
        readOnly?: false;
        uuid?: Binary;
    }

    name

    name: string

    Optionaloptions

    options?: Document

    Optionaltype

    type?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/CollectionOptions.html b/docs/Next/interfaces/CollectionOptions.html index 9cba4ad176e..c92ce420277 100644 --- a/docs/Next/interfaces/CollectionOptions.html +++ b/docs/Next/interfaces/CollectionOptions.html @@ -1,4 +1,4 @@ -CollectionOptions | mongodb

    Interface CollectionOptions

    interface CollectionOptions {
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        useBigInt64?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    bsonRegExp? +CollectionOptions | mongodb

    Interface CollectionOptions

    interface CollectionOptions {
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        useBigInt64?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    bsonRegExp? checkKeys? enableUtf8Validation? fieldsAsRaw? @@ -46,4 +46,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/CommandOperationOptions.html b/docs/Next/interfaces/CommandOperationOptions.html index 536c3874cf4..1bd33a48366 100644 --- a/docs/Next/interfaces/CommandOperationOptions.html +++ b/docs/Next/interfaces/CommandOperationOptions.html @@ -1,4 +1,4 @@ -CommandOperationOptions | mongodb

    Interface CommandOperationOptions

    interface CommandOperationOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +CommandOperationOptions | mongodb

    Interface CommandOperationOptions

    interface CommandOperationOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -65,4 +65,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ConnectOptions.html b/docs/Next/interfaces/ConnectOptions.html index ea42f454032..c28a2a1e8c0 100644 --- a/docs/Next/interfaces/ConnectOptions.html +++ b/docs/Next/interfaces/ConnectOptions.html @@ -1,2 +1,2 @@ -ConnectOptions | mongodb

    Interface ConnectOptions

    interface ConnectOptions {
        readPreference?: ReadPreference;
    }

    Properties

    readPreference? -

    Properties

    OptionalreadPreference

    readPreference?: ReadPreference

    Settings

    Member Visibility

    On This Page

    Properties
    +ConnectOptions | mongodb

    Interface ConnectOptions

    interface ConnectOptions {
        readPreference?: ReadPreference;
    }

    Properties

    readPreference? +

    Properties

    OptionalreadPreference

    readPreference?: ReadPreference

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ConnectionOptions.html b/docs/Next/interfaces/ConnectionOptions.html index bccc1619af2..c8621e5c201 100644 --- a/docs/Next/interfaces/ConnectionOptions.html +++ b/docs/Next/interfaces/ConnectionOptions.html @@ -1,4 +1,4 @@ -ConnectionOptions | mongodb

    Interface ConnectionOptions

    interface ConnectionOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS?: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        generation: number;
        hints?: number;
        hostAddress: HostAddress;
        id: number | "<monitor>";
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        metadata: ClientMetadata;
        minDHSize?: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
    }

    Hierarchy (view full)

    Properties

    allowPartialTrustChain? +ConnectionOptions | mongodb

    Interface ConnectionOptions

    interface ConnectionOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS?: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        generation: number;
        hints?: number;
        hostAddress: HostAddress;
        id: number | "<monitor>";
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        metadata: ClientMetadata;
        minDHSize?: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
    }

    Hierarchy (view full)

    Properties

    allowPartialTrustChain? ALPNProtocols? autoSelectFamily? autoSelectFamilyAttemptTimeout? @@ -119,4 +119,4 @@ TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.

    OptionalserverApi

    serverApi?: ServerApi

    Optionalservername

    servername?: string

    Optionalsession

    session?: Buffer

    An optional Buffer instance containing a TLS session.

    -

    OptionalsocketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalsocketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ConnectionPoolOptions.html b/docs/Next/interfaces/ConnectionPoolOptions.html index 90f571097fa..701a0cd6a45 100644 --- a/docs/Next/interfaces/ConnectionPoolOptions.html +++ b/docs/Next/interfaces/ConnectionPoolOptions.html @@ -1,4 +1,4 @@ -ConnectionPoolOptions | mongodb

    Interface ConnectionPoolOptions

    interface ConnectionPoolOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS?: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        hints?: number;
        hostAddress: HostAddress;
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        maxConnecting: number;
        maxIdleTimeMS: number;
        maxPoolSize: number;
        metadata: ClientMetadata;
        minDHSize?: number;
        minPoolSize: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
        waitQueueTimeoutMS: number;
    }

    Hierarchy

    Properties

    allowPartialTrustChain? +ConnectionPoolOptions | mongodb

    Interface ConnectionPoolOptions

    interface ConnectionPoolOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS?: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        hints?: number;
        hostAddress: HostAddress;
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        maxConnecting: number;
        maxIdleTimeMS: number;
        maxPoolSize: number;
        metadata: ClientMetadata;
        minDHSize?: number;
        minPoolSize: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
        waitQueueTimeoutMS: number;
    }

    Hierarchy

    Properties

    allowPartialTrustChain? ALPNProtocols? autoSelectFamily? autoSelectFamilyAttemptTimeout? @@ -128,4 +128,4 @@ interoperability. Default: none, see minVersion.

    OptionalserverApi

    serverApi?: ServerApi

    Optionalservername

    servername?: string

    Optionalsession

    session?: Buffer

    An optional Buffer instance containing a TLS session.

    OptionalsocketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    waitQueueTimeoutMS

    waitQueueTimeoutMS: number

    The maximum amount of time operation execution should wait for a connection to become available. The default is 0 which means there is no limit.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/CountDocumentsOptions.html b/docs/Next/interfaces/CountDocumentsOptions.html index a13f2adc359..86551758866 100644 --- a/docs/Next/interfaces/CountDocumentsOptions.html +++ b/docs/Next/interfaces/CountDocumentsOptions.html @@ -1,4 +1,4 @@ -CountDocumentsOptions | mongodb

    Interface CountDocumentsOptions

    interface CountDocumentsOptions {
        allowDiskUse?: boolean;
        authdb?: string;
        batchSize?: number;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        cursor?: Document;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        limit?: number;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        out?: string;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        skip?: number;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    allowDiskUse? +CountDocumentsOptions | mongodb

    Interface CountDocumentsOptions

    interface CountDocumentsOptions {
        allowDiskUse?: boolean;
        authdb?: string;
        batchSize?: number;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        cursor?: Document;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        limit?: number;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        out?: string;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        skip?: number;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    allowDiskUse? authdb? batchSize? bsonRegExp? @@ -87,4 +87,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/CountOptions.html b/docs/Next/interfaces/CountOptions.html index 3e87f9b7196..f12cd9d51ab 100644 --- a/docs/Next/interfaces/CountOptions.html +++ b/docs/Next/interfaces/CountOptions.html @@ -1,4 +1,4 @@ -CountOptions | mongodb

    Interface CountOptions

    interface CountOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: string | Document;
        ignoreUndefined?: boolean;
        limit?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        skip?: number;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +CountOptions | mongodb

    Interface CountOptions

    interface CountOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: string | Document;
        ignoreUndefined?: boolean;
        limit?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        skip?: number;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -72,4 +72,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/CreateCollectionOptions.html b/docs/Next/interfaces/CreateCollectionOptions.html index dcaa6731368..61da1b43f01 100644 --- a/docs/Next/interfaces/CreateCollectionOptions.html +++ b/docs/Next/interfaces/CreateCollectionOptions.html @@ -1,4 +1,4 @@ -CreateCollectionOptions | mongodb

    Interface CreateCollectionOptions

    interface CreateCollectionOptions {
        authdb?: string;
        autoIndexId?: boolean;
        bsonRegExp?: boolean;
        capped?: boolean;
        changeStreamPreAndPostImages?: {
            enabled: boolean;
        };
        checkKeys?: boolean;
        clusteredIndex?: ClusteredCollectionOptions;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        encryptedFields?: Document;
        expireAfterSeconds?: number;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        flags?: number;
        ignoreUndefined?: boolean;
        indexOptionDefaults?: Document;
        max?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        pipeline?: Document[];
        pkFactory?: PkFactory;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        size?: number;
        storageEngine?: Document;
        timeseries?: TimeSeriesCollectionOptions;
        useBigInt64?: boolean;
        validationAction?: string;
        validationLevel?: string;
        validator?: Document;
        viewOn?: string;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +CreateCollectionOptions | mongodb

    Interface CreateCollectionOptions

    interface CreateCollectionOptions {
        authdb?: string;
        autoIndexId?: boolean;
        bsonRegExp?: boolean;
        capped?: boolean;
        changeStreamPreAndPostImages?: {
            enabled: boolean;
        };
        checkKeys?: boolean;
        clusteredIndex?: ClusteredCollectionOptions;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        encryptedFields?: Document;
        expireAfterSeconds?: number;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        flags?: number;
        ignoreUndefined?: boolean;
        indexOptionDefaults?: Document;
        max?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        pipeline?: Document[];
        pkFactory?: PkFactory;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        size?: number;
        storageEngine?: Document;
        timeseries?: TimeSeriesCollectionOptions;
        useBigInt64?: boolean;
        validationAction?: string;
        validationLevel?: string;
        validator?: Document;
        viewOn?: string;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? autoIndexId? bsonRegExp? capped? @@ -101,4 +101,4 @@

    Remarks

    Optionalvalidator

    validator?: Document

    Allows users to specify validation rules or expressions for the collection. For more information, see Document Validation

    OptionalviewOn

    viewOn?: string

    The name of the source collection or view from which to create the view. The name is not the full namespace of the collection or view (i.e., does not include the database name and implies the same database as the view to create)

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/CreateIndexesOptions.html b/docs/Next/interfaces/CreateIndexesOptions.html index a9501eb3cba..9270a54eacc 100644 --- a/docs/Next/interfaces/CreateIndexesOptions.html +++ b/docs/Next/interfaces/CreateIndexesOptions.html @@ -1,4 +1,4 @@ -CreateIndexesOptions | mongodb

    Interface CreateIndexesOptions

    interface CreateIndexesOptions {
        2dsphereIndexVersion?: number;
        authdb?: string;
        background?: boolean;
        bits?: number;
        bsonRegExp?: boolean;
        bucketSize?: number;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        commitQuorum?: string | number;
        dbName?: string;
        default_language?: string;
        enableUtf8Validation?: boolean;
        expireAfterSeconds?: number;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hidden?: boolean;
        ignoreUndefined?: boolean;
        language_override?: string;
        max?: number;
        maxTimeMS?: number;
        min?: number;
        name?: string;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        partialFilterExpression?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sparse?: boolean;
        storageEngine?: Document;
        textIndexVersion?: number;
        unique?: boolean;
        useBigInt64?: boolean;
        version?: number;
        weights?: Document;
        wildcardProjection?: Document;
        willRetryWrite?: boolean;
    }

    Hierarchy

    Properties

    2dsphereIndexVersion? +CreateIndexesOptions | mongodb

    Interface CreateIndexesOptions

    interface CreateIndexesOptions {
        2dsphereIndexVersion?: number;
        authdb?: string;
        background?: boolean;
        bits?: number;
        bsonRegExp?: boolean;
        bucketSize?: number;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        commitQuorum?: string | number;
        dbName?: string;
        default_language?: string;
        enableUtf8Validation?: boolean;
        expireAfterSeconds?: number;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hidden?: boolean;
        ignoreUndefined?: boolean;
        language_override?: string;
        max?: number;
        maxTimeMS?: number;
        min?: number;
        name?: string;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        partialFilterExpression?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sparse?: boolean;
        storageEngine?: Document;
        textIndexVersion?: number;
        unique?: boolean;
        useBigInt64?: boolean;
        version?: number;
        weights?: Document;
        wildcardProjection?: Document;
        willRetryWrite?: boolean;
    }

    Hierarchy

    Properties

    2dsphereIndexVersion? authdb? background? bits? @@ -95,4 +95,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    Optionalversion

    version?: number

    Specifies the index version number, either 0 or 1.

    -

    Optionalweights

    weights?: Document

    OptionalwildcardProjection

    wildcardProjection?: Document

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalweights

    weights?: Document

    OptionalwildcardProjection

    wildcardProjection?: Document

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/CursorStreamOptions.html b/docs/Next/interfaces/CursorStreamOptions.html index 0b352f51d1b..7b780d44213 100644 --- a/docs/Next/interfaces/CursorStreamOptions.html +++ b/docs/Next/interfaces/CursorStreamOptions.html @@ -1,3 +1,3 @@ -CursorStreamOptions | mongodb

    Interface CursorStreamOptions

    interface CursorStreamOptions {
        transform?(this: void, doc: Document): Document;
    }

    Methods

    transform? +CursorStreamOptions | mongodb

    Interface CursorStreamOptions

    interface CursorStreamOptions {
        transform?(this: void, doc: Document): Document;
    }

    Methods

    transform?

    Methods

    Optionaltransform

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Parameters

    Returns Document

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/docs/Next/interfaces/DataKey.html b/docs/Next/interfaces/DataKey.html index 1fa6be151bc..bd2f6de154a 100644 --- a/docs/Next/interfaces/DataKey.html +++ b/docs/Next/interfaces/DataKey.html @@ -1,4 +1,4 @@ -DataKey | mongodb

    Interface DataKey

    The schema for a DataKey in the key vault collection.

    +DataKey | mongodb

    Interface DataKey

    The schema for a DataKey in the key vault collection.

    interface DataKey {
        _id: UUID;
        creationDate: Date;
        keyAltNames?: string[];
        keyMaterial: Binary;
        masterKey: Document;
        status: number;
        updateDate: Date;
        version?: number;
    }

    Properties

    _id creationDate keyAltNames? @@ -7,4 +7,4 @@ status updateDate version? -

    Properties

    _id

    _id: UUID

    creationDate

    creationDate: Date

    OptionalkeyAltNames

    keyAltNames?: string[]

    keyMaterial

    keyMaterial: Binary

    masterKey

    masterKey: Document

    status

    status: number

    updateDate

    updateDate: Date

    Optionalversion

    version?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    _id

    _id: UUID

    creationDate

    creationDate: Date

    OptionalkeyAltNames

    keyAltNames?: string[]

    keyMaterial

    keyMaterial: Binary

    masterKey

    masterKey: Document

    status

    status: number

    updateDate

    updateDate: Date

    Optionalversion

    version?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/DbOptions.html b/docs/Next/interfaces/DbOptions.html index 10b97ed4e39..ab560a81d02 100644 --- a/docs/Next/interfaces/DbOptions.html +++ b/docs/Next/interfaces/DbOptions.html @@ -1,4 +1,4 @@ -DbOptions | mongodb

    Interface DbOptions

    interface DbOptions {
        authSource?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        forceServerObjectId?: boolean;
        ignoreUndefined?: boolean;
        pkFactory?: PkFactory;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcern;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        useBigInt64?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authSource? +DbOptions | mongodb

    Interface DbOptions

    interface DbOptions {
        authSource?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        forceServerObjectId?: boolean;
        ignoreUndefined?: boolean;
        pkFactory?: PkFactory;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcern;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        useBigInt64?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authSource? bsonRegExp? checkKeys? enableUtf8Validation? @@ -54,4 +54,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/DbStatsOptions.html b/docs/Next/interfaces/DbStatsOptions.html index 4fb68642ceb..08ef948907d 100644 --- a/docs/Next/interfaces/DbStatsOptions.html +++ b/docs/Next/interfaces/DbStatsOptions.html @@ -1,4 +1,4 @@ -DbStatsOptions | mongodb

    Interface DbStatsOptions

    interface DbStatsOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        scale?: number;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +DbStatsOptions | mongodb

    Interface DbStatsOptions

    interface DbStatsOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        scale?: number;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -67,4 +67,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/DeleteManyModel.html b/docs/Next/interfaces/DeleteManyModel.html index 86968c7f930..1845e29d638 100644 --- a/docs/Next/interfaces/DeleteManyModel.html +++ b/docs/Next/interfaces/DeleteManyModel.html @@ -1,7 +1,7 @@ -DeleteManyModel | mongodb

    Interface DeleteManyModel<TSchema>

    interface DeleteManyModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
    }

    Type Parameters

    Properties

    collation? +DeleteManyModel | mongodb

    Interface DeleteManyModel<TSchema>

    interface DeleteManyModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
    }

    Type Parameters

    Properties

    collation? filter hint?

    Properties

    Optionalcollation

    collation?: CollationOptions

    Specifies a collation.

    filter

    filter: Filter<TSchema>

    The filter to limit the deleted documents.

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/DeleteOneModel.html b/docs/Next/interfaces/DeleteOneModel.html index 71a75c45689..4cd0b8cf0c7 100644 --- a/docs/Next/interfaces/DeleteOneModel.html +++ b/docs/Next/interfaces/DeleteOneModel.html @@ -1,7 +1,7 @@ -DeleteOneModel | mongodb

    Interface DeleteOneModel<TSchema>

    interface DeleteOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
    }

    Type Parameters

    Properties

    collation? +DeleteOneModel | mongodb

    Interface DeleteOneModel<TSchema>

    interface DeleteOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
    }

    Type Parameters

    Properties

    collation? filter hint?

    Properties

    Optionalcollation

    collation?: CollationOptions

    Specifies a collation.

    filter

    filter: Filter<TSchema>

    The filter to limit the deleted documents.

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/DeleteOptions.html b/docs/Next/interfaces/DeleteOptions.html index a1b6c654060..ee5dc044955 100644 --- a/docs/Next/interfaces/DeleteOptions.html +++ b/docs/Next/interfaces/DeleteOptions.html @@ -1,4 +1,4 @@ -DeleteOptions | mongodb

    Interface DeleteOptions

    interface DeleteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: string | Document;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        ordered?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +DeleteOptions | mongodb

    Interface DeleteOptions

    interface DeleteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: string | Document;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        ordered?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -71,4 +71,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/DeleteResult.html b/docs/Next/interfaces/DeleteResult.html index 0ccbd5e072b..e49b3a722a8 100644 --- a/docs/Next/interfaces/DeleteResult.html +++ b/docs/Next/interfaces/DeleteResult.html @@ -1,5 +1,5 @@ -DeleteResult | mongodb

    Interface DeleteResult

    interface DeleteResult {
        acknowledged: boolean;
        deletedCount: number;
    }

    Properties

    acknowledged +DeleteResult | mongodb

    Interface DeleteResult

    interface DeleteResult {
        acknowledged: boolean;
        deletedCount: number;
    }

    Properties

    acknowledged deletedCount

    Properties

    acknowledged

    acknowledged: boolean

    Indicates whether this write result was acknowledged. If not, then all other members of this result will be undefined.

    deletedCount

    deletedCount: number

    The number of documents that were deleted

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/DeleteStatement.html b/docs/Next/interfaces/DeleteStatement.html index 7121165c500..f03d0ce48c7 100644 --- a/docs/Next/interfaces/DeleteStatement.html +++ b/docs/Next/interfaces/DeleteStatement.html @@ -1,4 +1,4 @@ -DeleteStatement | mongodb

    Interface DeleteStatement

    interface DeleteStatement {
        collation?: CollationOptions;
        hint?: Hint;
        limit: number;
        q: Document;
    }

    Properties

    collation? +DeleteStatement | mongodb

    Interface DeleteStatement

    interface DeleteStatement {
        collation?: CollationOptions;
        hint?: Hint;
        limit: number;
        q: Document;
    }

    Properties

    collation? hint? limit q @@ -6,4 +6,4 @@

    Optionalhint

    hint?: Hint

    A document or string that specifies the index to use to support the query predicate.

    limit

    limit: number

    The number of matching documents to delete.

    q

    q: Document

    The query that matches documents to delete.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/DriverInfo.html b/docs/Next/interfaces/DriverInfo.html index dcf93d01fa2..6c16b20d80b 100644 --- a/docs/Next/interfaces/DriverInfo.html +++ b/docs/Next/interfaces/DriverInfo.html @@ -1,4 +1,4 @@ -DriverInfo | mongodb

    Interface DriverInfo

    interface DriverInfo {
        name?: string;
        platform?: string;
        version?: string;
    }

    Properties

    name? +DriverInfo | mongodb

    Interface DriverInfo

    interface DriverInfo {
        name?: string;
        platform?: string;
        version?: string;
    }

    Properties

    name? platform? version? -

    Properties

    Optionalname

    name?: string

    Optionalplatform

    platform?: string

    Optionalversion

    version?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalname

    name?: string

    Optionalplatform

    platform?: string

    Optionalversion

    version?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/DropCollectionOptions.html b/docs/Next/interfaces/DropCollectionOptions.html index d466a1e0973..2ab3fdf919c 100644 --- a/docs/Next/interfaces/DropCollectionOptions.html +++ b/docs/Next/interfaces/DropCollectionOptions.html @@ -1,4 +1,4 @@ -DropCollectionOptions | mongodb

    Interface DropCollectionOptions

    interface DropCollectionOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        encryptedFields?: Document;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +DropCollectionOptions | mongodb

    Interface DropCollectionOptions

    interface DropCollectionOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        encryptedFields?: Document;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -66,4 +66,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/EndSessionOptions.html b/docs/Next/interfaces/EndSessionOptions.html index 118ddf8c6ae..afe99370813 100644 --- a/docs/Next/interfaces/EndSessionOptions.html +++ b/docs/Next/interfaces/EndSessionOptions.html @@ -1,3 +1,3 @@ -EndSessionOptions | mongodb

    Interface EndSessionOptions

    interface EndSessionOptions {
        force?: boolean;
        forceClear?: boolean;
    }

    Properties

    force? +EndSessionOptions | mongodb

    Interface EndSessionOptions

    interface EndSessionOptions {
        force?: boolean;
        forceClear?: boolean;
    }

    Properties

    force? forceClear? -

    Properties

    Optionalforce

    force?: boolean

    OptionalforceClear

    forceClear?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalforce

    force?: boolean

    OptionalforceClear

    forceClear?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ErrorDescription.html b/docs/Next/interfaces/ErrorDescription.html index 6ddd3d33898..dac57c05541 100644 --- a/docs/Next/interfaces/ErrorDescription.html +++ b/docs/Next/interfaces/ErrorDescription.html @@ -1,6 +1,6 @@ -ErrorDescription | mongodb

    Interface ErrorDescription

    interface ErrorDescription {
        $err?: string;
        errInfo?: Document;
        errmsg?: string;
        errorLabels?: string[];
        message?: string;
    }

    Hierarchy (view full)

    Properties

    $err? +ErrorDescription | mongodb

    Interface ErrorDescription

    interface ErrorDescription {
        $err?: string;
        errInfo?: Document;
        errmsg?: string;
        errorLabels?: string[];
        message?: string;
    }

    Hierarchy (view full)

    Properties

    $err? errInfo? errmsg? errorLabels? message? -

    Properties

    Optional$err

    $err?: string

    OptionalerrInfo

    errInfo?: Document

    Optionalerrmsg

    errmsg?: string

    OptionalerrorLabels

    errorLabels?: string[]

    Optionalmessage

    message?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optional$err

    $err?: string

    OptionalerrInfo

    errInfo?: Document

    Optionalerrmsg

    errmsg?: string

    OptionalerrorLabels

    errorLabels?: string[]

    Optionalmessage

    message?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/EstimatedDocumentCountOptions.html b/docs/Next/interfaces/EstimatedDocumentCountOptions.html index 5f590471ac3..f5cb4cb1a7c 100644 --- a/docs/Next/interfaces/EstimatedDocumentCountOptions.html +++ b/docs/Next/interfaces/EstimatedDocumentCountOptions.html @@ -1,4 +1,4 @@ -EstimatedDocumentCountOptions | mongodb

    Interface EstimatedDocumentCountOptions

    interface EstimatedDocumentCountOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +EstimatedDocumentCountOptions | mongodb

    Interface EstimatedDocumentCountOptions

    interface EstimatedDocumentCountOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -67,4 +67,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ExplainCommandOptions.html b/docs/Next/interfaces/ExplainCommandOptions.html index 1c9ffe223a1..d1800c05e88 100644 --- a/docs/Next/interfaces/ExplainCommandOptions.html +++ b/docs/Next/interfaces/ExplainCommandOptions.html @@ -1,5 +1,5 @@ -ExplainCommandOptions | mongodb

    Interface ExplainCommandOptions

    interface ExplainCommandOptions {
        maxTimeMS?: number;
        verbosity: string;
    }

    Properties

    maxTimeMS? +ExplainCommandOptions | mongodb

    Interface ExplainCommandOptions

    interface ExplainCommandOptions {
        maxTimeMS?: number;
        verbosity: string;
    }

    Properties

    maxTimeMS? verbosity

    Properties

    OptionalmaxTimeMS

    maxTimeMS?: number

    The maxTimeMS setting for the command.

    verbosity

    verbosity: string

    The explain verbosity for the command.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ExplainOptions.html b/docs/Next/interfaces/ExplainOptions.html index ebc527db88c..441b5fa35f2 100644 --- a/docs/Next/interfaces/ExplainOptions.html +++ b/docs/Next/interfaces/ExplainOptions.html @@ -1,4 +1,4 @@ -ExplainOptions | mongodb

    Interface ExplainOptions

    When set, this configures an explain command. Valid values are boolean (for legacy compatibility, +ExplainOptions | mongodb

    Interface ExplainOptions

    When set, this configures an explain command. Valid values are boolean (for legacy compatibility, see ExplainVerbosityLike), a string containing the explain verbosity, or an object containing the verbosity and an optional maxTimeMS.

    Examples of valid usage:

    @@ -12,4 +12,4 @@
    interface ExplainOptions {
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
    }

    Hierarchy (view full)

    Properties

    explain?

    Properties

    Optionalexplain

    explain?: ExplainVerbosityLike | ExplainCommandOptions

    Specifies the verbosity mode for the explain output.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/FilterOperators.html b/docs/Next/interfaces/FilterOperators.html index e662e583702..eae06c7a0e0 100644 --- a/docs/Next/interfaces/FilterOperators.html +++ b/docs/Next/interfaces/FilterOperators.html @@ -1,4 +1,4 @@ -FilterOperators | mongodb

    Interface FilterOperators<TValue>

    interface FilterOperators<TValue> {
        __id?: undefined;
        $all?: readonly any[];
        $bitsAllClear?: BitwiseFilter;
        $bitsAllSet?: BitwiseFilter;
        $bitsAnyClear?: BitwiseFilter;
        $bitsAnySet?: BitwiseFilter;
        $elemMatch?: Document;
        $eq?: TValue;
        $exists?: boolean;
        $expr?: Record<string, any>;
        $geoIntersects?: {
            $geometry: Document;
        };
        $geoWithin?: Document;
        $gt?: TValue;
        $gte?: TValue;
        $in?: readonly TValue[];
        $jsonSchema?: Record<string, any>;
        $lt?: TValue;
        $lte?: TValue;
        $maxDistance?: number;
        $mod?: TValue extends number
            ? [number, number]
            : never;
        $ne?: TValue;
        $near?: Document;
        $nearSphere?: Document;
        $nin?: readonly TValue[];
        $not?: TValue extends string
            ? RegExp | FilterOperators<TValue<TValue>>
            : FilterOperators<TValue>;
        $options?: TValue extends string
            ? string
            : never;
        $rand?: Record<string, never>;
        $regex?: TValue extends string
            ? string | RegExp | BSONRegExp
            : never;
        $size?: TValue extends readonly any[]
            ? number
            : never;
        $type?:
            | "string"
            | "symbol"
            | "undefined"
            | "object"
            | "double"
            | "array"
            | "binData"
            | "objectId"
            | "bool"
            | "date"
            | "null"
            | "regex"
            | "dbPointer"
            | "javascript"
            | "javascriptWithScope"
            | "int"
            | "timestamp"
            | "long"
            | "decimal"
            | "minKey"
            | "maxKey"
            | BSON.BSONType;
        id?: undefined;
        toHexString?: any;
    }

    Type Parameters

    • TValue

    Hierarchy (view full)

    Properties

    __id? +FilterOperators | mongodb

    Interface FilterOperators<TValue>

    interface FilterOperators<TValue> {
        __id?: undefined;
        $all?: readonly any[];
        $bitsAllClear?: BitwiseFilter;
        $bitsAllSet?: BitwiseFilter;
        $bitsAnyClear?: BitwiseFilter;
        $bitsAnySet?: BitwiseFilter;
        $elemMatch?: Document;
        $eq?: TValue;
        $exists?: boolean;
        $expr?: Record<string, any>;
        $geoIntersects?: {
            $geometry: Document;
        };
        $geoWithin?: Document;
        $gt?: TValue;
        $gte?: TValue;
        $in?: readonly TValue[];
        $jsonSchema?: Record<string, any>;
        $lt?: TValue;
        $lte?: TValue;
        $maxDistance?: number;
        $mod?: TValue extends number
            ? [number, number]
            : never;
        $ne?: TValue;
        $near?: Document;
        $nearSphere?: Document;
        $nin?: readonly TValue[];
        $not?: TValue extends string
            ? RegExp | FilterOperators<TValue<TValue>>
            : FilterOperators<TValue>;
        $options?: TValue extends string
            ? string
            : never;
        $rand?: Record<string, never>;
        $regex?: TValue extends string
            ? string | RegExp | BSONRegExp
            : never;
        $size?: TValue extends readonly any[]
            ? number
            : never;
        $type?:
            | "string"
            | "symbol"
            | "undefined"
            | "object"
            | "double"
            | "array"
            | "binData"
            | "objectId"
            | "bool"
            | "date"
            | "null"
            | "regex"
            | "dbPointer"
            | "javascript"
            | "javascriptWithScope"
            | "int"
            | "timestamp"
            | "long"
            | "decimal"
            | "minKey"
            | "maxKey"
            | BSON.BSONType;
        id?: undefined;
        toHexString?: any;
    }

    Type Parameters

    • TValue

    Hierarchy (view full)

    Properties

    __id? $all? $bitsAllClear? $bitsAllSet? @@ -32,4 +32,4 @@

    Methods

    toHexString?

    Properties

    Optional__id

    __id?: undefined

    Optional$all

    $all?: readonly any[]

    Optional$bitsAllClear

    $bitsAllClear?: BitwiseFilter

    Optional$bitsAllSet

    $bitsAllSet?: BitwiseFilter

    Optional$bitsAnyClear

    $bitsAnyClear?: BitwiseFilter

    Optional$bitsAnySet

    $bitsAnySet?: BitwiseFilter

    Optional$elemMatch

    $elemMatch?: Document

    Optional$eq

    $eq?: TValue

    Optional$exists

    $exists?: boolean

    When true, $exists matches the documents that contain the field, including documents where the field value is null.

    -

    Optional$expr

    $expr?: Record<string, any>

    Optional$geoIntersects

    $geoIntersects?: {
        $geometry: Document;
    }

    Optional$geoWithin

    $geoWithin?: Document

    Optional$gt

    $gt?: TValue

    Optional$gte

    $gte?: TValue

    Optional$in

    $in?: readonly TValue[]

    Optional$jsonSchema

    $jsonSchema?: Record<string, any>

    Optional$lt

    $lt?: TValue

    Optional$lte

    $lte?: TValue

    Optional$maxDistance

    $maxDistance?: number

    Optional$mod

    $mod?: TValue extends number
        ? [number, number]
        : never

    Optional$ne

    $ne?: TValue

    Optional$near

    $near?: Document

    Optional$nearSphere

    $nearSphere?: Document

    Optional$nin

    $nin?: readonly TValue[]

    Optional$not

    $not?: TValue extends string
        ? RegExp | FilterOperators<TValue<TValue>>
        : FilterOperators<TValue>

    Optional$options

    $options?: TValue extends string
        ? string
        : never

    Optional$rand

    $rand?: Record<string, never>

    Optional$regex

    $regex?: TValue extends string
        ? string | RegExp | BSONRegExp
        : never

    Optional$size

    $size?: TValue extends readonly any[]
        ? number
        : never

    Optional$type

    $type?:
        | "string"
        | "symbol"
        | "undefined"
        | "object"
        | "double"
        | "array"
        | "binData"
        | "objectId"
        | "bool"
        | "date"
        | "null"
        | "regex"
        | "dbPointer"
        | "javascript"
        | "javascriptWithScope"
        | "int"
        | "timestamp"
        | "long"
        | "decimal"
        | "minKey"
        | "maxKey"
        | BSON.BSONType

    Optionalid

    id?: undefined

    Methods

    OptionaltoHexString

    toHexString

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Optional$expr

    $expr?: Record<string, any>

    Optional$geoIntersects

    $geoIntersects?: {
        $geometry: Document;
    }

    Optional$geoWithin

    $geoWithin?: Document

    Optional$gt

    $gt?: TValue

    Optional$gte

    $gte?: TValue

    Optional$in

    $in?: readonly TValue[]

    Optional$jsonSchema

    $jsonSchema?: Record<string, any>

    Optional$lt

    $lt?: TValue

    Optional$lte

    $lte?: TValue

    Optional$maxDistance

    $maxDistance?: number

    Optional$mod

    $mod?: TValue extends number
        ? [number, number]
        : never

    Optional$ne

    $ne?: TValue

    Optional$near

    $near?: Document

    Optional$nearSphere

    $nearSphere?: Document

    Optional$nin

    $nin?: readonly TValue[]

    Optional$not

    $not?: TValue extends string
        ? RegExp | FilterOperators<TValue<TValue>>
        : FilterOperators<TValue>

    Optional$options

    $options?: TValue extends string
        ? string
        : never

    Optional$rand

    $rand?: Record<string, never>

    Optional$regex

    $regex?: TValue extends string
        ? string | RegExp | BSONRegExp
        : never

    Optional$size

    $size?: TValue extends readonly any[]
        ? number
        : never

    Optional$type

    $type?:
        | "string"
        | "symbol"
        | "undefined"
        | "object"
        | "double"
        | "array"
        | "binData"
        | "objectId"
        | "bool"
        | "date"
        | "null"
        | "regex"
        | "dbPointer"
        | "javascript"
        | "javascriptWithScope"
        | "int"
        | "timestamp"
        | "long"
        | "decimal"
        | "minKey"
        | "maxKey"
        | BSON.BSONType

    Optionalid

    id?: undefined

    Methods

    OptionaltoHexString

    toHexString

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/docs/Next/interfaces/FindOneAndDeleteOptions.html b/docs/Next/interfaces/FindOneAndDeleteOptions.html index d110673f76c..b8628238aa6 100644 --- a/docs/Next/interfaces/FindOneAndDeleteOptions.html +++ b/docs/Next/interfaces/FindOneAndDeleteOptions.html @@ -1,4 +1,4 @@ -FindOneAndDeleteOptions | mongodb

    Interface FindOneAndDeleteOptions

    interface FindOneAndDeleteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Document;
        ignoreUndefined?: boolean;
        includeResultMetadata?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        projection?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sort?: Sort;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +FindOneAndDeleteOptions | mongodb

    Interface FindOneAndDeleteOptions

    interface FindOneAndDeleteOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Document;
        ignoreUndefined?: boolean;
        includeResultMetadata?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        projection?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sort?: Sort;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -75,4 +75,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/FindOneAndReplaceOptions.html b/docs/Next/interfaces/FindOneAndReplaceOptions.html index 65ed8d213fa..2ba4996b95d 100644 --- a/docs/Next/interfaces/FindOneAndReplaceOptions.html +++ b/docs/Next/interfaces/FindOneAndReplaceOptions.html @@ -1,4 +1,4 @@ -FindOneAndReplaceOptions | mongodb

    Interface FindOneAndReplaceOptions

    interface FindOneAndReplaceOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Document;
        ignoreUndefined?: boolean;
        includeResultMetadata?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        projection?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        returnDocument?: ReturnDocument;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sort?: Sort;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +FindOneAndReplaceOptions | mongodb

    Interface FindOneAndReplaceOptions

    interface FindOneAndReplaceOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Document;
        ignoreUndefined?: boolean;
        includeResultMetadata?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        projection?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        returnDocument?: ReturnDocument;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sort?: Sort;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? bypassDocumentValidation? checkKeys? @@ -81,4 +81,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/FindOneAndUpdateOptions.html b/docs/Next/interfaces/FindOneAndUpdateOptions.html index ba58c8e2ece..2f063089ccd 100644 --- a/docs/Next/interfaces/FindOneAndUpdateOptions.html +++ b/docs/Next/interfaces/FindOneAndUpdateOptions.html @@ -1,4 +1,4 @@ -FindOneAndUpdateOptions | mongodb

    Interface FindOneAndUpdateOptions

    interface FindOneAndUpdateOptions {
        arrayFilters?: Document[];
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Document;
        ignoreUndefined?: boolean;
        includeResultMetadata?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        projection?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        returnDocument?: ReturnDocument;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sort?: Sort;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    arrayFilters? +FindOneAndUpdateOptions | mongodb

    Interface FindOneAndUpdateOptions

    interface FindOneAndUpdateOptions {
        arrayFilters?: Document[];
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Document;
        ignoreUndefined?: boolean;
        includeResultMetadata?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        projection?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        returnDocument?: ReturnDocument;
        serializeFunctions?: boolean;
        session?: ClientSession;
        sort?: Sort;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    arrayFilters? authdb? bsonRegExp? bypassDocumentValidation? @@ -83,4 +83,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/FindOptions.html b/docs/Next/interfaces/FindOptions.html index 27436ee28ee..4b1361949d2 100644 --- a/docs/Next/interfaces/FindOptions.html +++ b/docs/Next/interfaces/FindOptions.html @@ -1,4 +1,4 @@ -FindOptions | mongodb

    Interface FindOptions<TSchema>

    interface FindOptions<TSchema> {
        allowDiskUse?: boolean;
        allowPartialResults?: boolean;
        authdb?: string;
        awaitData?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        limit?: number;
        max?: Document;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        min?: Document;
        noCursorTimeout?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        oplogReplay?: boolean;
        projection?: Document;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        returnKey?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        showRecordId?: boolean;
        singleBatch?: boolean;
        skip?: number;
        sort?: Sort;
        tailable?: boolean;
        timeout?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
    }

    Type Parameters

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/GCPEncryptionKeyOptions.html b/docs/Next/interfaces/GCPEncryptionKeyOptions.html index 92e6ae87d36..1de4bffd3d7 100644 --- a/docs/Next/interfaces/GCPEncryptionKeyOptions.html +++ b/docs/Next/interfaces/GCPEncryptionKeyOptions.html @@ -1,4 +1,4 @@ -GCPEncryptionKeyOptions | mongodb

    Interface GCPEncryptionKeyOptions

    Configuration options for making an AWS encryption key

    +GCPEncryptionKeyOptions | mongodb

    Interface GCPEncryptionKeyOptions

    Configuration options for making an AWS encryption key

    interface GCPEncryptionKeyOptions {
        endpoint?: string;
        keyName: string;
        keyRing: string;
        keyVersion?: string;
        location: string;
        projectId: string;
    }

    Properties

    endpoint? keyName keyRing @@ -11,4 +11,4 @@

    OptionalkeyVersion

    keyVersion?: string

    Key version

    location

    location: string

    Location name (e.g. "global")

    projectId

    projectId: string

    GCP project ID

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/GridFSBucketOptions.html b/docs/Next/interfaces/GridFSBucketOptions.html index 38f9c0cd971..8c6c77a3492 100644 --- a/docs/Next/interfaces/GridFSBucketOptions.html +++ b/docs/Next/interfaces/GridFSBucketOptions.html @@ -1,4 +1,4 @@ -GridFSBucketOptions | mongodb

    Interface GridFSBucketOptions

    interface GridFSBucketOptions {
        bucketName?: string;
        chunkSizeBytes?: number;
        readPreference?: ReadPreference;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    bucketName? +GridFSBucketOptions | mongodb

    Interface GridFSBucketOptions

    interface GridFSBucketOptions {
        bucketName?: string;
        chunkSizeBytes?: number;
        readPreference?: ReadPreference;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    bucketName? chunkSizeBytes? readPreference? writeConcern? @@ -6,4 +6,4 @@

    OptionalchunkSizeBytes

    chunkSizeBytes?: number

    Number of bytes stored in each chunk. Defaults to 255KB

    OptionalreadPreference

    readPreference?: ReadPreference

    Read preference to be passed to read operations

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/GridFSBucketReadStreamOptions.html b/docs/Next/interfaces/GridFSBucketReadStreamOptions.html index eb2bef722e2..8b25c22a7d0 100644 --- a/docs/Next/interfaces/GridFSBucketReadStreamOptions.html +++ b/docs/Next/interfaces/GridFSBucketReadStreamOptions.html @@ -1,8 +1,8 @@ -GridFSBucketReadStreamOptions | mongodb

    Interface GridFSBucketReadStreamOptions

    interface GridFSBucketReadStreamOptions {
        end?: number;
        skip?: number;
        sort?: Sort;
        start?: number;
    }

    Hierarchy (view full)

    Properties

    end? +GridFSBucketReadStreamOptions | mongodb

    Interface GridFSBucketReadStreamOptions

    interface GridFSBucketReadStreamOptions {
        end?: number;
        skip?: number;
        sort?: Sort;
        start?: number;
    }

    Hierarchy (view full)

    Properties

    end? skip? sort? start?

    Properties

    Optionalend

    end?: number

    0-indexed non-negative byte offset to the end of the file contents to be returned by the stream. end is non-inclusive

    Optionalskip

    skip?: number

    Optionalsort

    sort?: Sort

    Optionalstart

    start?: number

    0-indexed non-negative byte offset from the beginning of the file

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/GridFSBucketReadStreamOptionsWithRevision.html b/docs/Next/interfaces/GridFSBucketReadStreamOptionsWithRevision.html index 360dcd93f25..86170aafc80 100644 --- a/docs/Next/interfaces/GridFSBucketReadStreamOptionsWithRevision.html +++ b/docs/Next/interfaces/GridFSBucketReadStreamOptionsWithRevision.html @@ -1,4 +1,4 @@ -GridFSBucketReadStreamOptionsWithRevision | mongodb

    Interface GridFSBucketReadStreamOptionsWithRevision

    interface GridFSBucketReadStreamOptionsWithRevision {
        end?: number;
        revision?: number;
        skip?: number;
        sort?: Sort;
        start?: number;
    }

    Hierarchy (view full)

    Properties

    end? +GridFSBucketReadStreamOptionsWithRevision | mongodb

    Interface GridFSBucketReadStreamOptionsWithRevision

    interface GridFSBucketReadStreamOptionsWithRevision {
        end?: number;
        revision?: number;
        skip?: number;
        sort?: Sort;
        start?: number;
    }

    Hierarchy (view full)

    Properties

    end? revision? skip? sort? @@ -9,4 +9,4 @@ gets you the oldest file, 1 gets you the 2nd oldest, -1 gets you the newest.

    Optionalskip

    skip?: number

    Optionalsort

    sort?: Sort

    Optionalstart

    start?: number

    0-indexed non-negative byte offset from the beginning of the file

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/GridFSBucketWriteStreamOptions.html b/docs/Next/interfaces/GridFSBucketWriteStreamOptions.html index e01a9dae366..4e9b6341a95 100644 --- a/docs/Next/interfaces/GridFSBucketWriteStreamOptions.html +++ b/docs/Next/interfaces/GridFSBucketWriteStreamOptions.html @@ -1,4 +1,4 @@ -GridFSBucketWriteStreamOptions | mongodb

    Interface GridFSBucketWriteStreamOptions

    interface GridFSBucketWriteStreamOptions {
        aliases?: string[];
        chunkSizeBytes?: number;
        contentType?: string;
        id?: ObjectId;
        metadata?: Document;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    aliases? +GridFSBucketWriteStreamOptions | mongodb

    Interface GridFSBucketWriteStreamOptions

    interface GridFSBucketWriteStreamOptions {
        aliases?: string[];
        chunkSizeBytes?: number;
        contentType?: string;
        id?: ObjectId;
        metadata?: Document;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    aliases? chunkSizeBytes? contentType? id? @@ -12,4 +12,4 @@

    Optionalid

    id?: ObjectId

    Custom file id for the GridFS file.

    Optionalmetadata

    metadata?: Document

    Object to store in the file document's metadata field

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/GridFSChunk.html b/docs/Next/interfaces/GridFSChunk.html index 627adccdf07..b5ef3433fb2 100644 --- a/docs/Next/interfaces/GridFSChunk.html +++ b/docs/Next/interfaces/GridFSChunk.html @@ -1,5 +1,5 @@ -GridFSChunk | mongodb

    Interface GridFSChunk

    interface GridFSChunk {
        _id: ObjectId;
        data: Uint8Array | Buffer;
        files_id: ObjectId;
        n: number;
    }

    Properties

    _id +GridFSChunk | mongodb

    Interface GridFSChunk

    interface GridFSChunk {
        _id: ObjectId;
        data: Uint8Array | Buffer;
        files_id: ObjectId;
        n: number;
    }

    Properties

    _id data files_id n -

    Properties

    _id

    _id: ObjectId

    data

    data: Uint8Array | Buffer

    files_id

    files_id: ObjectId

    n

    n: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    _id

    _id: ObjectId

    data

    data: Uint8Array | Buffer

    files_id

    files_id: ObjectId

    n

    n: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/GridFSFile.html b/docs/Next/interfaces/GridFSFile.html index ad0442163af..cf5d6e77f98 100644 --- a/docs/Next/interfaces/GridFSFile.html +++ b/docs/Next/interfaces/GridFSFile.html @@ -1,4 +1,4 @@ -GridFSFile | mongodb

    Interface GridFSFile

    interface GridFSFile {
        _id: ObjectId;
        aliases?: string[];
        chunkSize: number;
        contentType?: string;
        filename: string;
        length: number;
        metadata?: Document;
        uploadDate: Date;
    }

    Properties

    _id +GridFSFile | mongodb

    Interface GridFSFile

    interface GridFSFile {
        _id: ObjectId;
        aliases?: string[];
        chunkSize: number;
        contentType?: string;
        filename: string;
        length: number;
        metadata?: Document;
        uploadDate: Date;
    }

    Properties

    _id aliases? chunkSize contentType? @@ -8,4 +8,4 @@ uploadDate

    Properties

    _id

    _id: ObjectId

    Optionalaliases

    aliases?: string[]

    Deprecated

    Will be removed in the next major version.

    chunkSize

    chunkSize: number

    OptionalcontentType

    contentType?: string

    Deprecated

    Will be removed in the next major version.

    -

    filename

    filename: string

    length

    length: number

    Optionalmetadata

    metadata?: Document

    uploadDate

    uploadDate: Date

    Settings

    Member Visibility

    On This Page

    Properties
    +

    filename

    filename: string

    length

    length: number

    Optionalmetadata

    metadata?: Document

    uploadDate

    uploadDate: Date

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/HedgeOptions.html b/docs/Next/interfaces/HedgeOptions.html index 96998faf21e..b161ca2f4a6 100644 --- a/docs/Next/interfaces/HedgeOptions.html +++ b/docs/Next/interfaces/HedgeOptions.html @@ -1,3 +1,3 @@ -HedgeOptions | mongodb

    Interface HedgeOptions

    interface HedgeOptions {
        enabled?: boolean;
    }

    Properties

    enabled? +HedgeOptions | mongodb

    Interface HedgeOptions

    interface HedgeOptions {
        enabled?: boolean;
    }

    Properties

    enabled?

    Properties

    Optionalenabled

    enabled?: boolean

    Explicitly enable or disable hedged reads.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/IdPInfo.html b/docs/Next/interfaces/IdPInfo.html index 566fbf474c4..1445a4c9aca 100644 --- a/docs/Next/interfaces/IdPInfo.html +++ b/docs/Next/interfaces/IdPInfo.html @@ -1,4 +1,4 @@ -IdPInfo | mongodb

    Interface IdPInfo

    The information returned by the server on the IDP server.

    +IdPInfo | mongodb

    Interface IdPInfo

    The information returned by the server on the IDP server.

    interface IdPInfo {
        clientId: string;
        issuer: string;
        requestScopes?: string[];
    }

    Properties

    clientId issuer requestScopes? @@ -7,4 +7,4 @@ be the iss of provided access tokens, and be viable for RFC8414 metadata discovery and RFC9207 identification.

    OptionalrequestScopes

    requestScopes?: string[]

    A list of additional scopes to request from IdP.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/IdPServerResponse.html b/docs/Next/interfaces/IdPServerResponse.html index 4bae8ff08fd..082981c52be 100644 --- a/docs/Next/interfaces/IdPServerResponse.html +++ b/docs/Next/interfaces/IdPServerResponse.html @@ -1,4 +1,4 @@ -IdPServerResponse | mongodb

    Interface IdPServerResponse

    The response from the IdP server with the access token and +IdPServerResponse | mongodb

    Interface IdPServerResponse

    The response from the IdP server with the access token and optional expiration time and refresh token.

    interface IdPServerResponse {
        accessToken: string;
        expiresInSeconds?: number;
        refreshToken?: string;
    }

    Properties

    accessToken expiresInSeconds? @@ -6,4 +6,4 @@

    Properties

    accessToken

    accessToken: string

    The OIDC access token.

    OptionalexpiresInSeconds

    expiresInSeconds?: number

    The time when the access token expires. For future use.

    OptionalrefreshToken

    refreshToken?: string

    The refresh token, if applicable, to be used by the callback to request a new token from the issuer.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/IndexDescription.html b/docs/Next/interfaces/IndexDescription.html index 6341f556ca4..03f68abd2fc 100644 --- a/docs/Next/interfaces/IndexDescription.html +++ b/docs/Next/interfaces/IndexDescription.html @@ -1,4 +1,4 @@ -IndexDescription | mongodb

    Interface IndexDescription

    interface IndexDescription {
        2dsphereIndexVersion?: number;
        background?: boolean;
        bits?: number;
        bucketSize?: number;
        collation?: CollationOptions;
        default_language?: string;
        expireAfterSeconds?: number;
        hidden?: boolean;
        key: {
            [key: string]: IndexDirection;
        } | Map<string, IndexDirection>;
        language_override?: string;
        max?: number;
        min?: number;
        name?: string;
        partialFilterExpression?: Document;
        sparse?: boolean;
        storageEngine?: Document;
        textIndexVersion?: number;
        unique?: boolean;
        version?: number;
        weights?: Document;
        wildcardProjection?: Document;
    }

    Hierarchy

    • Pick<CreateIndexesOptions,
          | "background"
          | "unique"
          | "partialFilterExpression"
          | "sparse"
          | "hidden"
          | "expireAfterSeconds"
          | "storageEngine"
          | "version"
          | "weights"
          | "default_language"
          | "language_override"
          | "textIndexVersion"
          | "2dsphereIndexVersion"
          | "bits"
          | "min"
          | "max"
          | "bucketSize"
          | "wildcardProjection">
      • IndexDescription

    Properties

    2dsphereIndexVersion? +IndexDescription | mongodb

    Interface IndexDescription

    interface IndexDescription {
        2dsphereIndexVersion?: number;
        background?: boolean;
        bits?: number;
        bucketSize?: number;
        collation?: CollationOptions;
        default_language?: string;
        expireAfterSeconds?: number;
        hidden?: boolean;
        key: {
            [key: string]: IndexDirection;
        } | Map<string, IndexDirection>;
        language_override?: string;
        max?: number;
        min?: number;
        name?: string;
        partialFilterExpression?: Document;
        sparse?: boolean;
        storageEngine?: Document;
        textIndexVersion?: number;
        unique?: boolean;
        version?: number;
        weights?: Document;
        wildcardProjection?: Document;
    }

    Hierarchy

    • Pick<CreateIndexesOptions,
          | "background"
          | "unique"
          | "partialFilterExpression"
          | "sparse"
          | "hidden"
          | "expireAfterSeconds"
          | "storageEngine"
          | "version"
          | "weights"
          | "default_language"
          | "language_override"
          | "textIndexVersion"
          | "2dsphereIndexVersion"
          | "bits"
          | "min"
          | "max"
          | "bucketSize"
          | "wildcardProjection">
      • IndexDescription

    Properties

    2dsphereIndexVersion? background? bits? bucketSize? @@ -29,4 +29,4 @@

    OptionalstorageEngine

    storageEngine?: Document

    Allows users to configure the storage engine on a per-index basis when creating an index. (MongoDB 3.0 or higher)

    OptionaltextIndexVersion

    textIndexVersion?: number

    Optionalunique

    unique?: boolean

    Creates an unique index.

    Optionalversion

    version?: number

    Specifies the index version number, either 0 or 1.

    -

    Optionalweights

    weights?: Document

    OptionalwildcardProjection

    wildcardProjection?: Document

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalweights

    weights?: Document

    OptionalwildcardProjection

    wildcardProjection?: Document

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/IndexInformationOptions.html b/docs/Next/interfaces/IndexInformationOptions.html index bb5e6658012..56f45dbfa67 100644 --- a/docs/Next/interfaces/IndexInformationOptions.html +++ b/docs/Next/interfaces/IndexInformationOptions.html @@ -1,4 +1,4 @@ -IndexInformationOptions | mongodb

    Interface IndexInformationOptions

    interface IndexInformationOptions {
        awaitData?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        comment?: unknown;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        full?: boolean;
        ignoreUndefined?: boolean;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noCursorTimeout?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        session?: ClientSession;
        tailable?: boolean;
        useBigInt64?: boolean;
    }

    Hierarchy (view full)

    Properties

    awaitData? +IndexInformationOptions | mongodb

    Interface IndexInformationOptions

    interface IndexInformationOptions {
        awaitData?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        comment?: unknown;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        full?: boolean;
        ignoreUndefined?: boolean;
        maxAwaitTimeMS?: number;
        maxTimeMS?: number;
        noCursorTimeout?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        session?: ClientSession;
        tailable?: boolean;
        useBigInt64?: boolean;
    }

    Hierarchy (view full)

    Properties

    awaitData? batchSize? bsonRegExp? checkKeys? @@ -79,4 +79,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/InsertManyResult.html b/docs/Next/interfaces/InsertManyResult.html index 02b065ad65d..145e7174a56 100644 --- a/docs/Next/interfaces/InsertManyResult.html +++ b/docs/Next/interfaces/InsertManyResult.html @@ -1,7 +1,7 @@ -InsertManyResult | mongodb

    Interface InsertManyResult<TSchema>

    interface InsertManyResult<TSchema> {
        acknowledged: boolean;
        insertedCount: number;
        insertedIds: {
            [key: number]: InferIdType<TSchema>;
        };
    }

    Type Parameters

    Properties

    acknowledged +InsertManyResult | mongodb

    Interface InsertManyResult<TSchema>

    interface InsertManyResult<TSchema> {
        acknowledged: boolean;
        insertedCount: number;
        insertedIds: {
            [key: number]: InferIdType<TSchema>;
        };
    }

    Type Parameters

    Properties

    acknowledged insertedCount insertedIds

    Properties

    acknowledged

    acknowledged: boolean

    Indicates whether this write result was acknowledged. If not, then all other members of this result will be undefined

    insertedCount

    insertedCount: number

    The number of inserted documents for this operations

    insertedIds

    insertedIds: {
        [key: number]: InferIdType<TSchema>;
    }

    Map of the index of the inserted document to the id of the inserted document

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/InsertOneModel.html b/docs/Next/interfaces/InsertOneModel.html index 5d50db35ec2..69ed23d8693 100644 --- a/docs/Next/interfaces/InsertOneModel.html +++ b/docs/Next/interfaces/InsertOneModel.html @@ -1,3 +1,3 @@ -InsertOneModel | mongodb

    Interface InsertOneModel<TSchema>

    interface InsertOneModel<TSchema> {
        document: OptionalId<TSchema>;
    }

    Type Parameters

    Properties

    document +InsertOneModel | mongodb

    Interface InsertOneModel<TSchema>

    interface InsertOneModel<TSchema> {
        document: OptionalId<TSchema>;
    }

    Type Parameters

    Properties

    document

    Properties

    document

    document: OptionalId<TSchema>

    The document to insert.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/InsertOneOptions.html b/docs/Next/interfaces/InsertOneOptions.html index d7ea189964f..344bc6cf264 100644 --- a/docs/Next/interfaces/InsertOneOptions.html +++ b/docs/Next/interfaces/InsertOneOptions.html @@ -1,4 +1,4 @@ -InsertOneOptions | mongodb

    Interface InsertOneOptions

    interface InsertOneOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        forceServerObjectId?: boolean;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +InsertOneOptions | mongodb

    Interface InsertOneOptions

    interface InsertOneOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        forceServerObjectId?: boolean;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? bypassDocumentValidation? checkKeys? @@ -69,4 +69,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/InsertOneResult.html b/docs/Next/interfaces/InsertOneResult.html index ac361551e2f..106f5245819 100644 --- a/docs/Next/interfaces/InsertOneResult.html +++ b/docs/Next/interfaces/InsertOneResult.html @@ -1,5 +1,5 @@ -InsertOneResult | mongodb

    Interface InsertOneResult<TSchema>

    interface InsertOneResult<TSchema> {
        acknowledged: boolean;
        insertedId: InferIdType<TSchema>;
    }

    Type Parameters

    Properties

    acknowledged +InsertOneResult | mongodb

    Interface InsertOneResult<TSchema>

    interface InsertOneResult<TSchema> {
        acknowledged: boolean;
        insertedId: InferIdType<TSchema>;
    }

    Type Parameters

    Properties

    acknowledged insertedId

    Properties

    acknowledged

    acknowledged: boolean

    Indicates whether this write result was acknowledged. If not, then all other members of this result will be undefined

    insertedId

    insertedId: InferIdType<TSchema>

    The identifier that was inserted. If the server generated the identifier, this value will be null as the driver does not have access to that data

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/KMIPEncryptionKeyOptions.html b/docs/Next/interfaces/KMIPEncryptionKeyOptions.html index d1f2107eee0..07d0b900ea4 100644 --- a/docs/Next/interfaces/KMIPEncryptionKeyOptions.html +++ b/docs/Next/interfaces/KMIPEncryptionKeyOptions.html @@ -1,4 +1,4 @@ -KMIPEncryptionKeyOptions | mongodb

    Interface KMIPEncryptionKeyOptions

    Configuration options for making a KMIP encryption key

    +KMIPEncryptionKeyOptions | mongodb

    Interface KMIPEncryptionKeyOptions

    Configuration options for making a KMIP encryption key

    interface KMIPEncryptionKeyOptions {
        delegated?: boolean;
        endpoint?: string;
        keyId?: string;
    }

    Properties

    delegated? endpoint? keyId? @@ -7,4 +7,4 @@

    Optionalendpoint

    endpoint?: string

    Host with optional port.

    OptionalkeyId

    keyId?: string

    keyId is the KMIP Unique Identifier to a 96 byte KMIP Secret Data managed object.

    If keyId is omitted, a random 96 byte KMIP Secret Data managed object will be created.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/KMIPKMSProviderConfiguration.html b/docs/Next/interfaces/KMIPKMSProviderConfiguration.html index 51d79d18042..c63310a4c63 100644 --- a/docs/Next/interfaces/KMIPKMSProviderConfiguration.html +++ b/docs/Next/interfaces/KMIPKMSProviderConfiguration.html @@ -1,5 +1,5 @@ -KMIPKMSProviderConfiguration | mongodb

    Interface KMIPKMSProviderConfiguration

    interface KMIPKMSProviderConfiguration {
        endpoint?: string;
    }

    Properties

    endpoint? +KMIPKMSProviderConfiguration | mongodb

    Interface KMIPKMSProviderConfiguration

    interface KMIPKMSProviderConfiguration {
        endpoint?: string;
    }

    Properties

    endpoint?

    Properties

    Optionalendpoint

    endpoint?: string

    The output endpoint string. The endpoint consists of a hostname and port separated by a colon. E.g. "example.com:123". A port is always present.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/KMSProviders.html b/docs/Next/interfaces/KMSProviders.html index 2b9f3c1b382..c4253b70b25 100644 --- a/docs/Next/interfaces/KMSProviders.html +++ b/docs/Next/interfaces/KMSProviders.html @@ -1,4 +1,4 @@ -KMSProviders | mongodb

    Interface KMSProviders

    Configuration options that are used by specific KMS providers during key generation, encryption, and decryption.

    +KMSProviders | mongodb

    Interface KMSProviders

    Configuration options that are used by specific KMS providers during key generation, encryption, and decryption.

    Named KMS providers are not supported for automatic KMS credential fetching.

    interface KMSProviders {
        aws?: AWSKMSProviderConfiguration | Record<string, never>;
        azure?: AzureKMSProviderConfiguration | Record<string, never>;
        gcp?: GCPKMSProviderConfiguration | Record<string, never>;
        kmip?: KMIPKMSProviderConfiguration;
        local?: LocalKMSProviderConfiguration;
        [key: `aws:${string}`]: AWSKMSProviderConfiguration;
        [key: `local:${string}`]: LocalKMSProviderConfiguration;
        [key: `kmip:${string}`]: KMIPKMSProviderConfiguration;
        [key: `azure:${string}`]: AzureKMSProviderConfiguration;
        [key: `gcp:${string}`]: GCPKMSProviderConfiguration;
    }

    Indexable

    Properties

    aws? azure? @@ -10,4 +10,4 @@

    Optionalgcp

    gcp?: GCPKMSProviderConfiguration | Record<string, never>

    Configuration options for using 'gcp' as your KMS provider

    Optionalkmip

    kmip?: KMIPKMSProviderConfiguration

    Configuration options for using 'kmip' as your KMS provider

    Optionallocal

    local?: LocalKMSProviderConfiguration

    Configuration options for using 'local' as your KMS provider

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ListCollectionsOptions.html b/docs/Next/interfaces/ListCollectionsOptions.html index 201a20dab69..172f35ffb0e 100644 --- a/docs/Next/interfaces/ListCollectionsOptions.html +++ b/docs/Next/interfaces/ListCollectionsOptions.html @@ -1,4 +1,4 @@ -ListCollectionsOptions | mongodb

    Interface ListCollectionsOptions

    interface ListCollectionsOptions {
        authdb?: string;
        authorizedCollections?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        nameOnly?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
    }

    Hierarchy

    Properties

    authdb? +ListCollectionsOptions | mongodb

    Interface ListCollectionsOptions

    interface ListCollectionsOptions {
        authdb?: string;
        authorizedCollections?: boolean;
        batchSize?: number;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        nameOnly?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
    }

    Hierarchy

    Properties

    authdb? authorizedCollections? batchSize? bsonRegExp? @@ -69,4 +69,4 @@

    Remarks

    Optionalsession

    session?: ClientSession

    Specify ClientSession for this command

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    -

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ListDatabasesOptions.html b/docs/Next/interfaces/ListDatabasesOptions.html index 19a852feb87..25c085f9999 100644 --- a/docs/Next/interfaces/ListDatabasesOptions.html +++ b/docs/Next/interfaces/ListDatabasesOptions.html @@ -1,4 +1,4 @@ -ListDatabasesOptions | mongodb

    Interface ListDatabasesOptions

    interface ListDatabasesOptions {
        authdb?: string;
        authorizedDatabases?: boolean;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        filter?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        nameOnly?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +ListDatabasesOptions | mongodb

    Interface ListDatabasesOptions

    interface ListDatabasesOptions {
        authdb?: string;
        authorizedDatabases?: boolean;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        filter?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        nameOnly?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? authorizedDatabases? bsonRegExp? checkKeys? @@ -71,4 +71,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ListDatabasesResult.html b/docs/Next/interfaces/ListDatabasesResult.html index a2b97b7bd7f..e68a7b6478a 100644 --- a/docs/Next/interfaces/ListDatabasesResult.html +++ b/docs/Next/interfaces/ListDatabasesResult.html @@ -1,5 +1,5 @@ -ListDatabasesResult | mongodb

    Interface ListDatabasesResult

    interface ListDatabasesResult {
        databases: ({
            empty?: boolean;
            name: string;
            sizeOnDisk?: number;
        } & Document)[];
        ok: 0 | 1;
        totalSize?: number;
        totalSizeMb?: number;
    }

    Properties

    databases +ListDatabasesResult | mongodb

    Interface ListDatabasesResult

    interface ListDatabasesResult {
        databases: ({
            empty?: boolean;
            name: string;
            sizeOnDisk?: number;
        } & Document)[];
        ok: 0 | 1;
        totalSize?: number;
        totalSizeMb?: number;
    }

    Properties

    databases ok totalSize? totalSizeMb? -

    Properties

    databases

    databases: ({
        empty?: boolean;
        name: string;
        sizeOnDisk?: number;
    } & Document)[]

    ok

    ok: 0 | 1

    OptionaltotalSize

    totalSize?: number

    OptionaltotalSizeMb

    totalSizeMb?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    databases

    databases: ({
        empty?: boolean;
        name: string;
        sizeOnDisk?: number;
    } & Document)[]

    ok

    ok: 0 | 1

    OptionaltotalSize

    totalSize?: number

    OptionaltotalSizeMb

    totalSizeMb?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/LocalKMSProviderConfiguration.html b/docs/Next/interfaces/LocalKMSProviderConfiguration.html index 2aa1a59d358..184fa47dbcb 100644 --- a/docs/Next/interfaces/LocalKMSProviderConfiguration.html +++ b/docs/Next/interfaces/LocalKMSProviderConfiguration.html @@ -1,4 +1,4 @@ -LocalKMSProviderConfiguration | mongodb

    Interface LocalKMSProviderConfiguration

    interface LocalKMSProviderConfiguration {
        key: string | Uint8Array | Binary;
    }

    Properties

    key +LocalKMSProviderConfiguration | mongodb

    Interface LocalKMSProviderConfiguration

    interface LocalKMSProviderConfiguration {
        key: string | Uint8Array | Binary;
    }

    Properties

    key

    Properties

    key

    key: string | Uint8Array | Binary

    The master key used to encrypt/decrypt data keys. A 96-byte long Buffer or base64 encoded string.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ModifyResult.html b/docs/Next/interfaces/ModifyResult.html index 5dc2d1306ff..cb35f0ea1c5 100644 --- a/docs/Next/interfaces/ModifyResult.html +++ b/docs/Next/interfaces/ModifyResult.html @@ -1,4 +1,4 @@ -ModifyResult | mongodb

    Interface ModifyResult<TSchema>

    interface ModifyResult<TSchema> {
        lastErrorObject?: Document;
        ok: 0 | 1;
        value: null | WithId<TSchema>;
    }

    Type Parameters

    Properties

    lastErrorObject? +ModifyResult | mongodb

    Interface ModifyResult<TSchema>

    interface ModifyResult<TSchema> {
        lastErrorObject?: Document;
        ok: 0 | 1;
        value: null | WithId<TSchema>;
    }

    Type Parameters

    Properties

    lastErrorObject? ok value -

    Properties

    OptionallastErrorObject

    lastErrorObject?: Document

    ok

    ok: 0 | 1

    value

    value: null | WithId<TSchema>

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionallastErrorObject

    lastErrorObject?: Document

    ok

    ok: 0 | 1

    value

    value: null | WithId<TSchema>

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/MongoClientOptions.html b/docs/Next/interfaces/MongoClientOptions.html index 66507866ac9..f42700bcad8 100644 --- a/docs/Next/interfaces/MongoClientOptions.html +++ b/docs/Next/interfaces/MongoClientOptions.html @@ -1,4 +1,4 @@ -MongoClientOptions | mongodb

    Interface MongoClientOptions

    Describes all possible URI query options for the mongo client

    +MongoClientOptions | mongodb

    Interface MongoClientOptions

    Describes all possible URI query options for the mongo client

    See

    https://www.mongodb.com/docs/manual/reference/connection-string

    interface MongoClientOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        appName?: string;
        auth?: Auth;
        authMechanism?: AuthMechanism;
        authMechanismProperties?: AuthMechanismProperties;
        authSource?: string;
        autoEncryption?: AutoEncryptionOptions;
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        bsonRegExp?: boolean;
        ca?: string | Buffer | (string | Buffer)[];
        cert?: string | Buffer | (string | Buffer)[];
        checkKeys?: boolean;
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: string | (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS?: number;
        crl?: string | Buffer | (string | Buffer)[];
        directConnection?: boolean;
        driverInfo?: DriverInfo;
        ecdhCurve?: string;
        enableUtf8Validation?: boolean;
        family?: number;
        fieldsAsRaw?: Document;
        forceServerObjectId?: boolean;
        heartbeatFrequencyMS?: number;
        hints?: number;
        ignoreUndefined?: boolean;
        journal?: boolean;
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced?: boolean;
        localAddress?: string;
        localPort?: number;
        localThresholdMS?: number;
        lookup?: LookupFunction;
        maxConnecting?: number;
        maxIdleTimeMS?: number;
        maxPoolSize?: number;
        maxStalenessSeconds?: number;
        minDHSize?: number;
        minHeartbeatFrequencyMS?: number;
        minPoolSize?: number;
        monitorCommands?: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        pkFactory?: PkFactory;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readConcernLevel?: ReadConcernLevel;
        readPreference?: ReadPreference | ReadPreferenceMode;
        readPreferenceTags?: TagSet[];
        rejectUnauthorized?: boolean;
        replicaSet?: string;
        retryReads?: boolean;
        retryWrites?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serializeFunctions?: boolean;
        serverApi?: "1" | ServerApi;
        serverMonitoringMode?: ServerMonitoringMode;
        servername?: string;
        serverSelectionTimeoutMS?: number;
        session?: Buffer;
        socketTimeoutMS?: number;
        srvMaxHosts?: number;
        srvServiceName?: string;
        ssl?: boolean;
        tls?: boolean;
        tlsAllowInvalidCertificates?: boolean;
        tlsAllowInvalidHostnames?: boolean;
        tlsCAFile?: string;
        tlsCertificateKeyFile?: string;
        tlsCertificateKeyFilePassword?: string;
        tlsCRLFile?: string;
        tlsInsecure?: boolean;
        useBigInt64?: boolean;
        w?: W;
        waitQueueTimeoutMS?: number;
        writeConcern?: WriteConcern | WriteConcernSettings;
        wtimeoutMS?: number;
        zlibCompressionLevel?:
            | 0
            | 5
            | 1
            | 3
            | 9
            | 4
            | 2
            | 7
            | 6
            | 8;
    }

    Hierarchy (view full)

    Properties

    allowPartialTrustChain? ALPNProtocols? @@ -99,7 +99,7 @@

    OptionalauthSource

    authSource?: string

    Specify the database name associated with the user’s credentials.

    OptionalautoEncryption

    autoEncryption?: AutoEncryptionOptions

    Optionally enable in-use auto encryption

    Remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error -(see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    +(see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    OptionalwtimeoutMS

    wtimeoutMS?: number

    The write concern timeout

    Deprecated

    Please use the writeConcern option instead

    OptionalzlibCompressionLevel

    zlibCompressionLevel?:
        | 0
        | 5
        | 1
        | 3
        | 9
        | 4
        | 2
        | 7
        | 6
        | 8

    An integer that specifies the compression level if using zlib for network compression.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    allowPartialTrustChainALPNProtocolsappNameauthauthMechanismauthMechanismPropertiesauthSourceautoEncryptionautoSelectFamilyautoSelectFamilyAttemptTimeoutbsonRegExpcacertcheckKeyscheckServerIdentitycipherscompressorsconnectTimeoutMScrldirectConnectiondriverInfoecdhCurveenableUtf8ValidationfamilyfieldsAsRawforceServerObjectIdheartbeatFrequencyMShintsignoreUndefinedjournalkeyloadBalancedlocalAddresslocalPortlocalThresholdMSlookupmaxConnectingmaxIdleTimeMSmaxPoolSizemaxStalenessSecondsminDHSizeminHeartbeatFrequencyMSminPoolSizemonitorCommandsnoDelaypassphrasepfxpkFactorypromoteBufferspromoteLongspromoteValuesproxyHostproxyPasswordproxyPortproxyUsernamerawreadConcernreadConcernLevelreadPreferencereadPreferenceTagsrejectUnauthorizedreplicaSetretryReadsretryWritessecureContextsecureProtocolserializeFunctionsserverApiserverMonitoringModeservernameserverSelectionTimeoutMSsessionsocketTimeoutMSsrvMaxHostssrvServiceNamessltlstlsAllowInvalidCertificatestlsAllowInvalidHostnamestlsCAFiletlsCertificateKeyFiletlsCertificateKeyFilePasswordtlsCRLFiletlsInsecureuseBigInt64wwaitQueueTimeoutMSwriteConcernwtimeoutMSzlibCompressionLevel
    +

    Settings

    Member Visibility

    On This Page

    Properties
    allowPartialTrustChainALPNProtocolsappNameauthauthMechanismauthMechanismPropertiesauthSourceautoEncryptionautoSelectFamilyautoSelectFamilyAttemptTimeoutbsonRegExpcacertcheckKeyscheckServerIdentitycipherscompressorsconnectTimeoutMScrldirectConnectiondriverInfoecdhCurveenableUtf8ValidationfamilyfieldsAsRawforceServerObjectIdheartbeatFrequencyMShintsignoreUndefinedjournalkeyloadBalancedlocalAddresslocalPortlocalThresholdMSlookupmaxConnectingmaxIdleTimeMSmaxPoolSizemaxStalenessSecondsminDHSizeminHeartbeatFrequencyMSminPoolSizemonitorCommandsnoDelaypassphrasepfxpkFactorypromoteBufferspromoteLongspromoteValuesproxyHostproxyPasswordproxyPortproxyUsernamerawreadConcernreadConcernLevelreadPreferencereadPreferenceTagsrejectUnauthorizedreplicaSetretryReadsretryWritessecureContextsecureProtocolserializeFunctionsserverApiserverMonitoringModeservernameserverSelectionTimeoutMSsessionsocketTimeoutMSsrvMaxHostssrvServiceNamessltlstlsAllowInvalidCertificatestlsAllowInvalidHostnamestlsCAFiletlsCertificateKeyFiletlsCertificateKeyFilePasswordtlsCRLFiletlsInsecureuseBigInt64wwaitQueueTimeoutMSwriteConcernwtimeoutMSzlibCompressionLevel
    diff --git a/docs/Next/interfaces/MongoCredentialsOptions.html b/docs/Next/interfaces/MongoCredentialsOptions.html index f2ff2dba173..26d1ac64fd5 100644 --- a/docs/Next/interfaces/MongoCredentialsOptions.html +++ b/docs/Next/interfaces/MongoCredentialsOptions.html @@ -1,7 +1,7 @@ -MongoCredentialsOptions | mongodb

    Interface MongoCredentialsOptions

    interface MongoCredentialsOptions {
        db?: string;
        mechanism?: AuthMechanism;
        mechanismProperties: AuthMechanismProperties;
        password: string;
        source: string;
        username?: string;
    }

    Properties

    db? +MongoCredentialsOptions | mongodb

    Interface MongoCredentialsOptions

    interface MongoCredentialsOptions {
        db?: string;
        mechanism?: AuthMechanism;
        mechanismProperties: AuthMechanismProperties;
        password: string;
        source: string;
        username?: string;
    }

    Properties

    db? mechanism? mechanismProperties password source username? -

    Properties

    Optionaldb

    db?: string

    Optionalmechanism

    mechanism?: AuthMechanism

    mechanismProperties

    mechanismProperties: AuthMechanismProperties

    password

    password: string

    source

    source: string

    Optionalusername

    username?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionaldb

    db?: string

    Optionalmechanism

    mechanism?: AuthMechanism

    mechanismProperties

    mechanismProperties: AuthMechanismProperties

    password

    password: string

    source

    source: string

    Optionalusername

    username?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/MongoNetworkErrorOptions.html b/docs/Next/interfaces/MongoNetworkErrorOptions.html index 3288d19e043..e774ca8a09e 100644 --- a/docs/Next/interfaces/MongoNetworkErrorOptions.html +++ b/docs/Next/interfaces/MongoNetworkErrorOptions.html @@ -1,4 +1,4 @@ -MongoNetworkErrorOptions | mongodb

    Interface MongoNetworkErrorOptions

    interface MongoNetworkErrorOptions {
        beforeHandshake?: boolean;
        cause?: Error;
    }

    Properties

    beforeHandshake? +MongoNetworkErrorOptions | mongodb

    Interface MongoNetworkErrorOptions

    interface MongoNetworkErrorOptions {
        beforeHandshake?: boolean;
        cause?: Error;
    }

    Properties

    beforeHandshake? cause?

    Properties

    OptionalbeforeHandshake

    beforeHandshake?: boolean

    Indicates the timeout happened before a connection handshake completed

    -

    Optionalcause

    cause?: Error

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalcause

    cause?: Error

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/MongoOptions.html b/docs/Next/interfaces/MongoOptions.html index bc9b85e226d..d600facd5e6 100644 --- a/docs/Next/interfaces/MongoOptions.html +++ b/docs/Next/interfaces/MongoOptions.html @@ -1,4 +1,4 @@ -MongoOptions | mongodb

    Interface MongoOptions

    Parsed Mongo Client Options.

    +MongoOptions | mongodb

    Interface MongoOptions

    Parsed Mongo Client Options.

    User supplied options are documented by MongoClientOptions.

    NOTE: The client's options parsing is subject to change to support new features. This type is provided to aid with inspection of options after parsing, it should not be relied upon programmatically.

    @@ -88,7 +88,7 @@ (Protocols should be ordered by their priority.)

    OptionalappName

    appName?: string

    autoEncryption

    autoEncryption: AutoEncryptionOptions

    Optionally enable in-use auto encryption

    Remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error -(see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    +(see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    OptionaltlsCAFile

    tlsCAFile?: string

    OptionaltlsCertificateKeyFile

    tlsCertificateKeyFile?: string

    OptionaltlsCRLFile

    tlsCRLFile?: string

    tlsInsecure

    tlsInsecure: boolean

    Disables various certificate validations.

    waitQueueTimeoutMS

    waitQueueTimeoutMS: number

    The maximum time in milliseconds that a thread can wait for a connection to become available.

    writeConcern

    writeConcern: WriteConcern

    zlibCompressionLevel

    zlibCompressionLevel:
        | 0
        | 1
        | 2
        | 3
        | 4
        | 5
        | 6
        | 7
        | 8
        | 9

    An integer that specifies the compression level if using zlib for network compression.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    allowPartialTrustChainALPNProtocolsappNameautoEncryptionautoSelectFamilyautoSelectFamilyAttemptTimeoutcacertcheckServerIdentitycipherscompressorsconnectTimeoutMScredentialscrldbNamedirectConnectiondriverInfoecdhCurvefamilyforceServerObjectIdheartbeatFrequencyMShintshostskeyloadBalancedlocalAddresslocalPortlocalThresholdMSlookupmaxConnectingmaxIdleTimeMSmaxPoolSizemetadataminDHSizeminHeartbeatFrequencyMSminPoolSizemonitorCommandsnoDelaypassphrasepfxpkFactoryproxyHostproxyPasswordproxyPortproxyUsernamerawreadConcernreadPreferencerejectUnauthorizedreplicaSetretryReadsretryWritessecureContextsecureProtocolserverApiserverMonitoringModeservernameserverSelectionTimeoutMSsessionsocketTimeoutMSsrvHostsrvMaxHostssrvServiceNametlstlsAllowInvalidCertificatestlsAllowInvalidHostnamestlsCAFiletlsCertificateKeyFiletlsCRLFiletlsInsecurewaitQueueTimeoutMSwriteConcernzlibCompressionLevel
    +

    Settings

    Member Visibility

    On This Page

    Properties
    allowPartialTrustChainALPNProtocolsappNameautoEncryptionautoSelectFamilyautoSelectFamilyAttemptTimeoutcacertcheckServerIdentitycipherscompressorsconnectTimeoutMScredentialscrldbNamedirectConnectiondriverInfoecdhCurvefamilyforceServerObjectIdheartbeatFrequencyMShintshostskeyloadBalancedlocalAddresslocalPortlocalThresholdMSlookupmaxConnectingmaxIdleTimeMSmaxPoolSizemetadataminDHSizeminHeartbeatFrequencyMSminPoolSizemonitorCommandsnoDelaypassphrasepfxpkFactoryproxyHostproxyPasswordproxyPortproxyUsernamerawreadConcernreadPreferencerejectUnauthorizedreplicaSetretryReadsretryWritessecureContextsecureProtocolserverApiserverMonitoringModeservernameserverSelectionTimeoutMSsessionsocketTimeoutMSsrvHostsrvMaxHostssrvServiceNametlstlsAllowInvalidCertificatestlsAllowInvalidHostnamestlsCAFiletlsCertificateKeyFiletlsCRLFiletlsInsecurewaitQueueTimeoutMSwriteConcernzlibCompressionLevel
    diff --git a/docs/Next/interfaces/MonitorOptions.html b/docs/Next/interfaces/MonitorOptions.html index 3bce4f67c05..18dba5213b2 100644 --- a/docs/Next/interfaces/MonitorOptions.html +++ b/docs/Next/interfaces/MonitorOptions.html @@ -1,4 +1,4 @@ -MonitorOptions | mongodb

    Interface MonitorOptions

    interface MonitorOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        heartbeatFrequencyMS: number;
        hints?: number;
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        metadata: ClientMetadata;
        minDHSize?: number;
        minHeartbeatFrequencyMS: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        serverMonitoringMode: ServerMonitoringMode;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
    }

    Hierarchy

    Properties

    allowPartialTrustChain? +MonitorOptions | mongodb

    Interface MonitorOptions

    interface MonitorOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        heartbeatFrequencyMS: number;
        hints?: number;
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        metadata: ClientMetadata;
        minDHSize?: number;
        minHeartbeatFrequencyMS: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        serverMonitoringMode: ServerMonitoringMode;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
    }

    Hierarchy

    Properties

    allowPartialTrustChain? ALPNProtocols? autoSelectFamily? autoSelectFamilyAttemptTimeout? @@ -119,4 +119,4 @@ TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.

    OptionalserverApi

    serverApi?: ServerApi

    serverMonitoringMode

    serverMonitoringMode: ServerMonitoringMode

    Optionalservername

    servername?: string

    Optionalsession

    session?: Buffer

    An optional Buffer instance containing a TLS session.

    -

    OptionalsocketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalsocketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/OIDCCallbackParams.html b/docs/Next/interfaces/OIDCCallbackParams.html index 7b71486493b..1e644186f44 100644 --- a/docs/Next/interfaces/OIDCCallbackParams.html +++ b/docs/Next/interfaces/OIDCCallbackParams.html @@ -1,4 +1,4 @@ -OIDCCallbackParams | mongodb

    Interface OIDCCallbackParams

    The parameters that the driver provides to the user supplied +OIDCCallbackParams | mongodb

    Interface OIDCCallbackParams

    The parameters that the driver provides to the user supplied human or machine callback.

    The version number is used to communicate callback API changes that are not breaking but that users may want to know about and review their implementation. Users may wish to check the version @@ -13,4 +13,4 @@

    timeoutContext

    timeoutContext: AbortSignal

    The context in which to timeout the OIDC callback.

    Optionalusername

    username?: string

    Optional username.

    version

    version: 1

    The current OIDC API version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/OIDCResponse.html b/docs/Next/interfaces/OIDCResponse.html index c3f4b014719..33be5d33469 100644 --- a/docs/Next/interfaces/OIDCResponse.html +++ b/docs/Next/interfaces/OIDCResponse.html @@ -1,4 +1,4 @@ -OIDCResponse | mongodb

    Interface OIDCResponse

    The response required to be returned from the machine or +OIDCResponse | mongodb

    Interface OIDCResponse

    The response required to be returned from the machine or human callback workflows' callback.

    interface OIDCResponse {
        accessToken: string;
        expiresInSeconds?: number;
        refreshToken?: string;
    }

    Properties

    accessToken expiresInSeconds? @@ -6,4 +6,4 @@

    Properties

    accessToken

    accessToken: string

    The OIDC access token.

    OptionalexpiresInSeconds

    expiresInSeconds?: number

    The time when the access token expires. For future use.

    OptionalrefreshToken

    refreshToken?: string

    The refresh token, if applicable, to be used by the callback to request a new token from the issuer.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/OperationOptions.html b/docs/Next/interfaces/OperationOptions.html index 738aa25fd3e..de0dbcabe84 100644 --- a/docs/Next/interfaces/OperationOptions.html +++ b/docs/Next/interfaces/OperationOptions.html @@ -1,4 +1,4 @@ -OperationOptions | mongodb

    Interface OperationOptions

    interface OperationOptions {
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
    }

    Hierarchy (view full)

    Properties

    bsonRegExp? +OperationOptions | mongodb

    Interface OperationOptions

    interface OperationOptions {
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        enableUtf8Validation?: boolean;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readPreference?: ReadPreferenceLike;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
    }

    Hierarchy (view full)

    Properties

    bsonRegExp? checkKeys? enableUtf8Validation? fieldsAsRaw? @@ -46,4 +46,4 @@

    Remarks

    Optionalsession

    session?: ClientSession

    Specify ClientSession for this command

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    -

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/PkFactory.html b/docs/Next/interfaces/PkFactory.html index a7840d145fc..f4dd9840776 100644 --- a/docs/Next/interfaces/PkFactory.html +++ b/docs/Next/interfaces/PkFactory.html @@ -1,2 +1,2 @@ -PkFactory | mongodb

    Interface PkFactory

    interface PkFactory {
        createPk(): any;
    }

    Methods

    createPk -

    Methods

    createPk

    Settings

    Member Visibility

    On This Page

    Methods
    +PkFactory | mongodb

    Interface PkFactory

    interface PkFactory {
        createPk(): any;
    }

    Methods

    createPk +

    Methods

    createPk

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/docs/Next/interfaces/ProxyOptions.html b/docs/Next/interfaces/ProxyOptions.html index b1c2546fe56..a2f94562028 100644 --- a/docs/Next/interfaces/ProxyOptions.html +++ b/docs/Next/interfaces/ProxyOptions.html @@ -1,5 +1,5 @@ -ProxyOptions | mongodb

    Interface ProxyOptions

    interface ProxyOptions {
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
    }

    Hierarchy (view full)

    Properties

    proxyHost? +ProxyOptions | mongodb

    Interface ProxyOptions

    interface ProxyOptions {
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
    }

    Hierarchy (view full)

    Properties

    proxyHost? proxyPassword? proxyPort? proxyUsername? -

    Properties

    OptionalproxyHost

    proxyHost?: string

    OptionalproxyPassword

    proxyPassword?: string

    OptionalproxyPort

    proxyPort?: number

    OptionalproxyUsername

    proxyUsername?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalproxyHost

    proxyHost?: string

    OptionalproxyPassword

    proxyPassword?: string

    OptionalproxyPort

    proxyPort?: number

    OptionalproxyUsername

    proxyUsername?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/RangeOptions.html b/docs/Next/interfaces/RangeOptions.html index 4a7e8ae1ec9..e2a02bf99c7 100644 --- a/docs/Next/interfaces/RangeOptions.html +++ b/docs/Next/interfaces/RangeOptions.html @@ -1,4 +1,4 @@ -RangeOptions | mongodb

    Interface RangeOptions

    RangeOptions specifies index options for a Queryable Encryption field supporting "range" queries. +RangeOptions | mongodb

    Interface RangeOptions

    RangeOptions specifies index options for a Queryable Encryption field supporting "range" queries. min, max, sparsity, trimFactor and range must match the values set in the encryptedFields of the destination collection. For double and decimal128, min/max/precision must all be set, or all be unset.

    interface RangeOptions {
        max?: any;
        min?: any;
        precision?: number;
        sparsity?: bigint | Long;
        trimFactor?: number | Int32;
    }

    Properties

    max? @@ -10,4 +10,4 @@

    Optionalmin

    min?: any

    min is the minimum value for the encrypted index. Required if precision is set.

    Optionalprecision

    precision?: number

    Optionalsparsity

    sparsity?: bigint | Long

    sparsity may be used to tune performance. must be non-negative. When omitted, a default value is used.

    OptionaltrimFactor

    trimFactor?: number | Int32

    trimFactor may be used to tune performance. must be non-negative. When omitted, a default value is used.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ReadPreferenceFromOptions.html b/docs/Next/interfaces/ReadPreferenceFromOptions.html index 68e8ae934e4..b4a3e68bc53 100644 --- a/docs/Next/interfaces/ReadPreferenceFromOptions.html +++ b/docs/Next/interfaces/ReadPreferenceFromOptions.html @@ -1,8 +1,8 @@ -ReadPreferenceFromOptions | mongodb

    Interface ReadPreferenceFromOptions

    interface ReadPreferenceFromOptions {
        hedge?: HedgeOptions;
        maxStalenessSeconds?: number;
        readPreference?: ReadPreferenceLike | {
            maxStalenessSeconds?: number;
            mode?: ReadPreferenceMode | undefined;
            preference?: ReadPreferenceMode | undefined;
            tags?: TagSet[];
        };
        readPreferenceTags?: TagSet[];
        session?: ClientSession;
    }

    Hierarchy (view full)

    Properties

    hedge? +ReadPreferenceFromOptions | mongodb

    Interface ReadPreferenceFromOptions

    interface ReadPreferenceFromOptions {
        hedge?: HedgeOptions;
        maxStalenessSeconds?: number;
        readPreference?: ReadPreferenceLike | {
            maxStalenessSeconds?: number;
            mode?: ReadPreferenceMode | undefined;
            preference?: ReadPreferenceMode | undefined;
            tags?: TagSet[];
        };
        readPreferenceTags?: TagSet[];
        session?: ClientSession;
    }

    Hierarchy (view full)

    Properties

    hedge? maxStalenessSeconds? readPreference? readPreferenceTags? session?

    Properties

    Optionalhedge

    hedge?: HedgeOptions

    Server mode in which the same query is dispatched in parallel to multiple replica set members.

    OptionalmaxStalenessSeconds

    maxStalenessSeconds?: number

    Max secondary read staleness in seconds, Minimum value is 90 seconds.

    -

    OptionalreadPreference

    readPreference?: ReadPreferenceLike | {
        maxStalenessSeconds?: number;
        mode?: ReadPreferenceMode | undefined;
        preference?: ReadPreferenceMode | undefined;
        tags?: TagSet[];
    }

    OptionalreadPreferenceTags

    readPreferenceTags?: TagSet[]

    Optionalsession

    session?: ClientSession

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalreadPreference

    readPreference?: ReadPreferenceLike | {
        maxStalenessSeconds?: number;
        mode?: ReadPreferenceMode | undefined;
        preference?: ReadPreferenceMode | undefined;
        tags?: TagSet[];
    }

    OptionalreadPreferenceTags

    readPreferenceTags?: TagSet[]

    Optionalsession

    session?: ClientSession

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ReadPreferenceLikeOptions.html b/docs/Next/interfaces/ReadPreferenceLikeOptions.html index 3ffd791de68..f21e1857dea 100644 --- a/docs/Next/interfaces/ReadPreferenceLikeOptions.html +++ b/docs/Next/interfaces/ReadPreferenceLikeOptions.html @@ -1,6 +1,6 @@ -ReadPreferenceLikeOptions | mongodb

    Interface ReadPreferenceLikeOptions

    interface ReadPreferenceLikeOptions {
        hedge?: HedgeOptions;
        maxStalenessSeconds?: number;
        readPreference?: ReadPreferenceLike | {
            maxStalenessSeconds?: number;
            mode?: ReadPreferenceMode | undefined;
            preference?: ReadPreferenceMode | undefined;
            tags?: TagSet[];
        };
    }

    Hierarchy (view full)

    Properties

    hedge? +ReadPreferenceLikeOptions | mongodb

    Interface ReadPreferenceLikeOptions

    interface ReadPreferenceLikeOptions {
        hedge?: HedgeOptions;
        maxStalenessSeconds?: number;
        readPreference?: ReadPreferenceLike | {
            maxStalenessSeconds?: number;
            mode?: ReadPreferenceMode | undefined;
            preference?: ReadPreferenceMode | undefined;
            tags?: TagSet[];
        };
    }

    Hierarchy (view full)

    Properties

    hedge? maxStalenessSeconds? readPreference?

    Properties

    Optionalhedge

    hedge?: HedgeOptions

    Server mode in which the same query is dispatched in parallel to multiple replica set members.

    OptionalmaxStalenessSeconds

    maxStalenessSeconds?: number

    Max secondary read staleness in seconds, Minimum value is 90 seconds.

    -

    OptionalreadPreference

    readPreference?: ReadPreferenceLike | {
        maxStalenessSeconds?: number;
        mode?: ReadPreferenceMode | undefined;
        preference?: ReadPreferenceMode | undefined;
        tags?: TagSet[];
    }

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalreadPreference

    readPreference?: ReadPreferenceLike | {
        maxStalenessSeconds?: number;
        mode?: ReadPreferenceMode | undefined;
        preference?: ReadPreferenceMode | undefined;
        tags?: TagSet[];
    }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ReadPreferenceOptions.html b/docs/Next/interfaces/ReadPreferenceOptions.html index 41e51fe2077..f5c30f2ced8 100644 --- a/docs/Next/interfaces/ReadPreferenceOptions.html +++ b/docs/Next/interfaces/ReadPreferenceOptions.html @@ -1,5 +1,5 @@ -ReadPreferenceOptions | mongodb

    Interface ReadPreferenceOptions

    interface ReadPreferenceOptions {
        hedge?: HedgeOptions;
        maxStalenessSeconds?: number;
    }

    Hierarchy (view full)

    Properties

    hedge? +ReadPreferenceOptions | mongodb

    Interface ReadPreferenceOptions

    interface ReadPreferenceOptions {
        hedge?: HedgeOptions;
        maxStalenessSeconds?: number;
    }

    Hierarchy (view full)

    Properties

    hedge? maxStalenessSeconds?

    Properties

    Optionalhedge

    hedge?: HedgeOptions

    Server mode in which the same query is dispatched in parallel to multiple replica set members.

    OptionalmaxStalenessSeconds

    maxStalenessSeconds?: number

    Max secondary read staleness in seconds, Minimum value is 90 seconds.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/RenameOptions.html b/docs/Next/interfaces/RenameOptions.html index d85ced5b5bc..31fae3633fe 100644 --- a/docs/Next/interfaces/RenameOptions.html +++ b/docs/Next/interfaces/RenameOptions.html @@ -1,4 +1,4 @@ -RenameOptions | mongodb

    Interface RenameOptions

    interface RenameOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        dropTarget?: boolean;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        new_collection?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +RenameOptions | mongodb

    Interface RenameOptions

    interface RenameOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        dropTarget?: boolean;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        new_collection?: boolean;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? collation? @@ -69,4 +69,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ReplaceOneModel.html b/docs/Next/interfaces/ReplaceOneModel.html index b9e893b2b9e..7a0f3642ffc 100644 --- a/docs/Next/interfaces/ReplaceOneModel.html +++ b/docs/Next/interfaces/ReplaceOneModel.html @@ -1,4 +1,4 @@ -ReplaceOneModel | mongodb

    Interface ReplaceOneModel<TSchema>

    interface ReplaceOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        replacement: WithoutId<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    collation? +ReplaceOneModel | mongodb

    Interface ReplaceOneModel<TSchema>

    interface ReplaceOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        replacement: WithoutId<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    collation? filter hint? replacement @@ -8,4 +8,4 @@

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    replacement

    replacement: WithoutId<TSchema>

    The document with which to replace the matched document.

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ReplaceOptions.html b/docs/Next/interfaces/ReplaceOptions.html index 0ca36f300bc..e2c37a5f390 100644 --- a/docs/Next/interfaces/ReplaceOptions.html +++ b/docs/Next/interfaces/ReplaceOptions.html @@ -1,4 +1,4 @@ -ReplaceOptions | mongodb

    Interface ReplaceOptions

    interface ReplaceOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: string | Document;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +ReplaceOptions | mongodb

    Interface ReplaceOptions

    interface ReplaceOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: string | Document;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? bypassDocumentValidation? checkKeys? @@ -73,4 +73,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ResumeOptions.html b/docs/Next/interfaces/ResumeOptions.html index 0b86fc026fd..7172e87e32b 100644 --- a/docs/Next/interfaces/ResumeOptions.html +++ b/docs/Next/interfaces/ResumeOptions.html @@ -1,4 +1,4 @@ -ResumeOptions | mongodb

    Interface ResumeOptions

    Deprecated

    Please use the ChangeStreamCursorOptions type instead.

    +ResumeOptions | mongodb

    Interface ResumeOptions

    Deprecated

    Please use the ChangeStreamCursorOptions type instead.

    interface ResumeOptions {
        batchSize?: number;
        collation?: CollationOptions;
        fullDocument?: string;
        maxAwaitTimeMS?: number;
        readPreference?: ReadPreference;
        resumeAfter?: unknown;
        startAfter?: unknown;
        startAtOperationTime?: Timestamp;
    }

    Properties

    batchSize? collation? fullDocument? @@ -7,4 +7,4 @@ resumeAfter? startAfter? startAtOperationTime? -

    Properties

    OptionalbatchSize

    batchSize?: number

    Optionalcollation

    collation?: CollationOptions

    OptionalfullDocument

    fullDocument?: string

    OptionalmaxAwaitTimeMS

    maxAwaitTimeMS?: number

    OptionalreadPreference

    readPreference?: ReadPreference

    OptionalresumeAfter

    resumeAfter?: unknown

    OptionalstartAfter

    startAfter?: unknown

    OptionalstartAtOperationTime

    startAtOperationTime?: Timestamp

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalbatchSize

    batchSize?: number

    Optionalcollation

    collation?: CollationOptions

    OptionalfullDocument

    fullDocument?: string

    OptionalmaxAwaitTimeMS

    maxAwaitTimeMS?: number

    OptionalreadPreference

    readPreference?: ReadPreference

    OptionalresumeAfter

    resumeAfter?: unknown

    OptionalstartAfter

    startAfter?: unknown

    OptionalstartAtOperationTime

    startAtOperationTime?: Timestamp

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/RootFilterOperators.html b/docs/Next/interfaces/RootFilterOperators.html index b99a2b91f0a..1ef90132b9a 100644 --- a/docs/Next/interfaces/RootFilterOperators.html +++ b/docs/Next/interfaces/RootFilterOperators.html @@ -1,7 +1,7 @@ -RootFilterOperators | mongodb

    Interface RootFilterOperators<TSchema>

    interface RootFilterOperators<TSchema> {
        $and?: Filter<TSchema>[];
        $comment?: string | Document;
        $nor?: Filter<TSchema>[];
        $or?: Filter<TSchema>[];
        $text?: {
            $caseSensitive?: boolean;
            $diacriticSensitive?: boolean;
            $language?: string;
            $search: string;
        };
        $where?: string | ((this: TSchema) => boolean);
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    $and? +RootFilterOperators | mongodb

    Interface RootFilterOperators<TSchema>

    interface RootFilterOperators<TSchema> {
        $and?: Filter<TSchema>[];
        $comment?: string | Document;
        $nor?: Filter<TSchema>[];
        $or?: Filter<TSchema>[];
        $text?: {
            $caseSensitive?: boolean;
            $diacriticSensitive?: boolean;
            $language?: string;
            $search: string;
        };
        $where?: string | ((this: TSchema) => boolean);
    }

    Type Parameters

    • TSchema

    Hierarchy (view full)

    Properties

    $and? $comment? $nor? $or? $text? $where? -

    Properties

    Optional$and

    $and?: Filter<TSchema>[]

    Optional$comment

    $comment?: string | Document

    Optional$nor

    $nor?: Filter<TSchema>[]

    Optional$or

    $or?: Filter<TSchema>[]

    Optional$text

    $text?: {
        $caseSensitive?: boolean;
        $diacriticSensitive?: boolean;
        $language?: string;
        $search: string;
    }

    Optional$where

    $where?: string | ((this: TSchema) => boolean)

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optional$and

    $and?: Filter<TSchema>[]

    Optional$comment

    $comment?: string | Document

    Optional$nor

    $nor?: Filter<TSchema>[]

    Optional$or

    $or?: Filter<TSchema>[]

    Optional$text

    $text?: {
        $caseSensitive?: boolean;
        $diacriticSensitive?: boolean;
        $language?: string;
        $search: string;
    }

    Optional$where

    $where?: string | ((this: TSchema) => boolean)

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/SearchIndexDescription.html b/docs/Next/interfaces/SearchIndexDescription.html index 374cefdefa4..1a1ae276ff9 100644 --- a/docs/Next/interfaces/SearchIndexDescription.html +++ b/docs/Next/interfaces/SearchIndexDescription.html @@ -1,7 +1,7 @@ -SearchIndexDescription | mongodb

    Interface SearchIndexDescription

    interface SearchIndexDescription {
        definition: Document;
        name?: string;
        type?: string;
    }

    Hierarchy (view full)

    Properties

    definition +SearchIndexDescription | mongodb

    Interface SearchIndexDescription

    interface SearchIndexDescription {
        definition: Document;
        name?: string;
        type?: string;
    }

    Hierarchy (view full)

    Properties

    definition name? type?

    Properties

    definition

    definition: Document

    The index definition.

    Optionalname

    name?: string

    The name of the index.

    Optionaltype

    type?: string

    The type of the index. Currently search or vectorSearch are supported.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/SelectServerOptions.html b/docs/Next/interfaces/SelectServerOptions.html index d27e2048810..c14fd939fa3 100644 --- a/docs/Next/interfaces/SelectServerOptions.html +++ b/docs/Next/interfaces/SelectServerOptions.html @@ -1,7 +1,7 @@ -SelectServerOptions | mongodb

    Interface SelectServerOptions

    interface SelectServerOptions {
        operationName: string;
        previousServer?: ServerDescription;
        readPreference?: ReadPreferenceLike;
        serverSelectionTimeoutMS?: number;
        session?: ClientSession;
    }

    Properties

    operationName +SelectServerOptions | mongodb

    Interface SelectServerOptions

    interface SelectServerOptions {
        operationName: string;
        previousServer?: ServerDescription;
        readPreference?: ReadPreferenceLike;
        serverSelectionTimeoutMS?: number;
        session?: ClientSession;
    }

    Properties

    operationName previousServer? readPreference? serverSelectionTimeoutMS? session?

    Properties

    operationName

    operationName: string

    OptionalpreviousServer

    previousServer?: ServerDescription

    OptionalreadPreference

    readPreference?: ReadPreferenceLike

    OptionalserverSelectionTimeoutMS

    serverSelectionTimeoutMS?: number

    How long to block for server selection before throwing an error

    -

    Optionalsession

    session?: ClientSession

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalsession

    session?: ClientSession

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ServerApi.html b/docs/Next/interfaces/ServerApi.html index 661b8db7216..e6c7c1d9d5e 100644 --- a/docs/Next/interfaces/ServerApi.html +++ b/docs/Next/interfaces/ServerApi.html @@ -1,4 +1,4 @@ -ServerApi | mongodb

    Interface ServerApi

    interface ServerApi {
        deprecationErrors?: boolean;
        strict?: boolean;
        version: "1";
    }

    Properties

    deprecationErrors? +ServerApi | mongodb

    Interface ServerApi

    interface ServerApi {
        deprecationErrors?: boolean;
        strict?: boolean;
        version: "1";
    }

    Properties

    deprecationErrors? strict? version -

    Properties

    OptionaldeprecationErrors

    deprecationErrors?: boolean

    Optionalstrict

    strict?: boolean

    version

    version: "1"

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionaldeprecationErrors

    deprecationErrors?: boolean

    Optionalstrict

    strict?: boolean

    version

    version: "1"

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/StreamDescriptionOptions.html b/docs/Next/interfaces/StreamDescriptionOptions.html index 0aa2402fd18..8bb51c29bd8 100644 --- a/docs/Next/interfaces/StreamDescriptionOptions.html +++ b/docs/Next/interfaces/StreamDescriptionOptions.html @@ -1,4 +1,4 @@ -StreamDescriptionOptions | mongodb

    Interface StreamDescriptionOptions

    interface StreamDescriptionOptions {
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        loadBalanced: boolean;
        logicalSessionTimeoutMinutes?: number;
    }

    Hierarchy (view full)

    Properties

    compressors? +StreamDescriptionOptions | mongodb

    Interface StreamDescriptionOptions

    interface StreamDescriptionOptions {
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        loadBalanced: boolean;
        logicalSessionTimeoutMinutes?: number;
    }

    Hierarchy (view full)

    Properties

    compressors? loadBalanced logicalSessionTimeoutMinutes? -

    Properties

    Optionalcompressors

    compressors?: (
        | "none"
        | "snappy"
        | "zlib"
        | "zstd")[]

    loadBalanced

    loadBalanced: boolean

    OptionallogicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalcompressors

    compressors?: (
        | "none"
        | "snappy"
        | "zlib"
        | "zstd")[]

    loadBalanced

    loadBalanced: boolean

    OptionallogicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/TimeSeriesCollectionOptions.html b/docs/Next/interfaces/TimeSeriesCollectionOptions.html index f0f1417c5c6..d328b04afb3 100644 --- a/docs/Next/interfaces/TimeSeriesCollectionOptions.html +++ b/docs/Next/interfaces/TimeSeriesCollectionOptions.html @@ -1,8 +1,8 @@ -TimeSeriesCollectionOptions | mongodb

    Interface TimeSeriesCollectionOptions

    Configuration options for timeseries collections

    +TimeSeriesCollectionOptions | mongodb

    Interface TimeSeriesCollectionOptions

    Configuration options for timeseries collections

    See

    https://www.mongodb.com/docs/manual/core/timeseries-collections/

    interface TimeSeriesCollectionOptions {
        bucketMaxSpanSeconds?: number;
        bucketRoundingSeconds?: number;
        granularity?: string;
        metaField?: string;
        timeField: string;
    }

    Hierarchy (view full)

    Properties

    bucketMaxSpanSeconds? bucketRoundingSeconds? granularity? metaField? timeField -

    Properties

    OptionalbucketMaxSpanSeconds

    bucketMaxSpanSeconds?: number

    OptionalbucketRoundingSeconds

    bucketRoundingSeconds?: number

    Optionalgranularity

    granularity?: string

    OptionalmetaField

    metaField?: string

    timeField

    timeField: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalbucketMaxSpanSeconds

    bucketMaxSpanSeconds?: number

    OptionalbucketRoundingSeconds

    bucketRoundingSeconds?: number

    Optionalgranularity

    granularity?: string

    OptionalmetaField

    metaField?: string

    timeField

    timeField: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/TopologyDescriptionOptions.html b/docs/Next/interfaces/TopologyDescriptionOptions.html index 6a23ee2a4b1..37199ff69c6 100644 --- a/docs/Next/interfaces/TopologyDescriptionOptions.html +++ b/docs/Next/interfaces/TopologyDescriptionOptions.html @@ -1,3 +1,3 @@ -TopologyDescriptionOptions | mongodb

    Interface TopologyDescriptionOptions

    interface TopologyDescriptionOptions {
        heartbeatFrequencyMS?: number;
        localThresholdMS?: number;
    }

    Properties

    heartbeatFrequencyMS? +TopologyDescriptionOptions | mongodb

    Interface TopologyDescriptionOptions

    interface TopologyDescriptionOptions {
        heartbeatFrequencyMS?: number;
        localThresholdMS?: number;
    }

    Properties

    heartbeatFrequencyMS? localThresholdMS? -

    Properties

    OptionalheartbeatFrequencyMS

    heartbeatFrequencyMS?: number

    OptionallocalThresholdMS

    localThresholdMS?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalheartbeatFrequencyMS

    heartbeatFrequencyMS?: number

    OptionallocalThresholdMS

    localThresholdMS?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/TopologyVersion.html b/docs/Next/interfaces/TopologyVersion.html index 5b08e6f45b6..b4fb4d6f5ed 100644 --- a/docs/Next/interfaces/TopologyVersion.html +++ b/docs/Next/interfaces/TopologyVersion.html @@ -1,3 +1,3 @@ -TopologyVersion | mongodb

    Interface TopologyVersion

    interface TopologyVersion {
        counter: Long;
        processId: ObjectId;
    }

    Properties

    counter +TopologyVersion | mongodb

    Interface TopologyVersion

    interface TopologyVersion {
        counter: Long;
        processId: ObjectId;
    }

    Properties

    counter processId -

    Properties

    counter

    counter: Long

    processId

    processId: ObjectId

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    counter

    counter: Long

    processId

    processId: ObjectId

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/TransactionOptions.html b/docs/Next/interfaces/TransactionOptions.html index 3c4ca38e17c..45d25f981ef 100644 --- a/docs/Next/interfaces/TransactionOptions.html +++ b/docs/Next/interfaces/TransactionOptions.html @@ -1,4 +1,4 @@ -TransactionOptions | mongodb

    Interface TransactionOptions

    Configuration options for a transaction.

    +TransactionOptions | mongodb

    Interface TransactionOptions

    Configuration options for a transaction.

    interface TransactionOptions {
        authdb?: string;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxCommitTimeMS?: number;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern;
    }

    Hierarchy (view full)

    Properties

    authdb? bsonRegExp? checkKeys? @@ -68,4 +68,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern

    A default writeConcern for commands in this transaction

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/UpdateDescription.html b/docs/Next/interfaces/UpdateDescription.html index 01af6160120..bef3fc38ecc 100644 --- a/docs/Next/interfaces/UpdateDescription.html +++ b/docs/Next/interfaces/UpdateDescription.html @@ -1,4 +1,4 @@ -UpdateDescription | mongodb

    Interface UpdateDescription<TSchema>

    interface UpdateDescription<TSchema> {
        disambiguatedPaths?: Document;
        removedFields?: string[];
        truncatedArrays?: {
            field: string;
            newSize: number;
        }[];
        updatedFields?: Partial<TSchema>;
    }

    Type Parameters

    Properties

    disambiguatedPaths? +UpdateDescription | mongodb

    Interface UpdateDescription<TSchema>

    interface UpdateDescription<TSchema> {
        disambiguatedPaths?: Document;
        removedFields?: string[];
        truncatedArrays?: {
            field: string;
            newSize: number;
        }[];
        updatedFields?: Partial<TSchema>;
    }

    Type Parameters

    Properties

    disambiguatedPaths? removedFields? truncatedArrays? updatedFields? @@ -24,4 +24,4 @@
  • newSize: number

    The number of elements in the truncated array.

    • OptionalupdatedFields

    updatedFields?: Partial<TSchema>

    A document containing key:value pairs of names of the fields that were changed, and the new value for those fields.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/UpdateManyModel.html b/docs/Next/interfaces/UpdateManyModel.html index 1f9c62bf64a..944165291db 100644 --- a/docs/Next/interfaces/UpdateManyModel.html +++ b/docs/Next/interfaces/UpdateManyModel.html @@ -1,4 +1,4 @@ -UpdateManyModel | mongodb

    Interface UpdateManyModel<TSchema>

    interface UpdateManyModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    arrayFilters? +UpdateManyModel | mongodb

    Interface UpdateManyModel<TSchema>

    interface UpdateManyModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    arrayFilters? collation? filter hint? @@ -12,4 +12,4 @@ UpdateFilter - A document that contains update operator expressions, Document[] - an aggregation pipeline.

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/UpdateOneModel.html b/docs/Next/interfaces/UpdateOneModel.html index 2ca80dc30d1..c224fbfd8d8 100644 --- a/docs/Next/interfaces/UpdateOneModel.html +++ b/docs/Next/interfaces/UpdateOneModel.html @@ -1,4 +1,4 @@ -UpdateOneModel | mongodb

    Interface UpdateOneModel<TSchema>

    interface UpdateOneModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    arrayFilters? +UpdateOneModel | mongodb

    Interface UpdateOneModel<TSchema>

    interface UpdateOneModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    arrayFilters? collation? filter hint? @@ -12,4 +12,4 @@ UpdateFilter - A document that contains update operator expressions, Document[] - an aggregation pipeline.

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/UpdateOptions.html b/docs/Next/interfaces/UpdateOptions.html index a1fc726ed38..d7fd246ed1f 100644 --- a/docs/Next/interfaces/UpdateOptions.html +++ b/docs/Next/interfaces/UpdateOptions.html @@ -1,4 +1,4 @@ -UpdateOptions | mongodb

    Interface UpdateOptions

    interface UpdateOptions {
        arrayFilters?: Document[];
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    arrayFilters? +UpdateOptions | mongodb

    Interface UpdateOptions

    interface UpdateOptions {
        arrayFilters?: Document[];
        authdb?: string;
        bsonRegExp?: boolean;
        bypassDocumentValidation?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        hint?: Hint;
        ignoreUndefined?: boolean;
        let?: Document;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        upsert?: boolean;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    arrayFilters? authdb? bsonRegExp? bypassDocumentValidation? @@ -75,4 +75,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/UpdateResult.html b/docs/Next/interfaces/UpdateResult.html index e92a46285bf..5907d0c004f 100644 --- a/docs/Next/interfaces/UpdateResult.html +++ b/docs/Next/interfaces/UpdateResult.html @@ -1,4 +1,4 @@ -UpdateResult | mongodb

    Interface UpdateResult<TSchema>

    TSchema is the schema of the collection

    +UpdateResult | mongodb

    Interface UpdateResult<TSchema>

    TSchema is the schema of the collection

    interface UpdateResult<TSchema> {
        acknowledged: boolean;
        matchedCount: number;
        modifiedCount: number;
        upsertedCount: number;
        upsertedId: null | InferIdType<TSchema>;
    }

    Type Parameters

    Properties

    acknowledged matchedCount modifiedCount @@ -9,4 +9,4 @@

    modifiedCount

    modifiedCount: number

    The number of documents that were modified

    upsertedCount

    upsertedCount: number

    The number of documents that were upserted

    upsertedId

    upsertedId: null | InferIdType<TSchema>

    The identifier of the inserted document if an upsert took place

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/UpdateStatement.html b/docs/Next/interfaces/UpdateStatement.html index 7f04492fb29..00ed862df97 100644 --- a/docs/Next/interfaces/UpdateStatement.html +++ b/docs/Next/interfaces/UpdateStatement.html @@ -1,4 +1,4 @@ -UpdateStatement | mongodb

    Interface UpdateStatement

    interface UpdateStatement {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        hint?: Hint;
        multi?: boolean;
        q: Document;
        u: Document | Document[];
        upsert?: boolean;
    }

    Properties

    arrayFilters? +UpdateStatement | mongodb

    Interface UpdateStatement

    interface UpdateStatement {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        hint?: Hint;
        multi?: boolean;
        q: Document;
        u: Document | Document[];
        upsert?: boolean;
    }

    Properties

    arrayFilters? collation? hint? multi? @@ -12,4 +12,4 @@

    q

    q: Document

    The query that matches documents to update.

    u

    u: Document | Document[]

    The modifications to apply.

    Optionalupsert

    upsert?: boolean

    If true, perform an insert if no documents match the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ValidateCollectionOptions.html b/docs/Next/interfaces/ValidateCollectionOptions.html index 286d8bb0db9..b46811d5ced 100644 --- a/docs/Next/interfaces/ValidateCollectionOptions.html +++ b/docs/Next/interfaces/ValidateCollectionOptions.html @@ -1,4 +1,4 @@ -ValidateCollectionOptions | mongodb

    Interface ValidateCollectionOptions

    interface ValidateCollectionOptions {
        authdb?: string;
        background?: boolean;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? +ValidateCollectionOptions | mongodb

    Interface ValidateCollectionOptions

    interface ValidateCollectionOptions {
        authdb?: string;
        background?: boolean;
        bsonRegExp?: boolean;
        checkKeys?: boolean;
        collation?: CollationOptions;
        comment?: unknown;
        dbName?: string;
        enableUtf8Validation?: boolean;
        explain?: ExplainVerbosityLike | ExplainCommandOptions;
        fieldsAsRaw?: Document;
        ignoreUndefined?: boolean;
        maxTimeMS?: number;
        noResponse?: boolean;
        omitReadPreference?: boolean;
        promoteBuffers?: boolean;
        promoteLongs?: boolean;
        promoteValues?: boolean;
        raw?: boolean;
        readConcern?: ReadConcernLike;
        readPreference?: ReadPreferenceLike;
        retryWrites?: boolean;
        serializeFunctions?: boolean;
        session?: ClientSession;
        useBigInt64?: boolean;
        willRetryWrite?: boolean;
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    authdb? background? bsonRegExp? checkKeys? @@ -67,4 +67,4 @@

    Remarks

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/WriteConcernErrorData.html b/docs/Next/interfaces/WriteConcernErrorData.html index 34707bbb65e..c8074cf50d8 100644 --- a/docs/Next/interfaces/WriteConcernErrorData.html +++ b/docs/Next/interfaces/WriteConcernErrorData.html @@ -1,4 +1,4 @@ -WriteConcernErrorData | mongodb

    Interface WriteConcernErrorData

    interface WriteConcernErrorData {
        code: number;
        errInfo?: Document;
        errmsg: string;
    }

    Properties

    code +WriteConcernErrorData | mongodb

    Interface WriteConcernErrorData

    interface WriteConcernErrorData {
        code: number;
        errInfo?: Document;
        errmsg: string;
    }

    Properties

    code errInfo? errmsg -

    Properties

    code

    code: number

    OptionalerrInfo

    errInfo?: Document

    errmsg

    errmsg: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    code

    code: number

    OptionalerrInfo

    errInfo?: Document

    errmsg

    errmsg: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/WriteConcernErrorResult.html b/docs/Next/interfaces/WriteConcernErrorResult.html index 5fc83a34955..6805be45f6e 100644 --- a/docs/Next/interfaces/WriteConcernErrorResult.html +++ b/docs/Next/interfaces/WriteConcernErrorResult.html @@ -1,6 +1,6 @@ -WriteConcernErrorResult | mongodb

    Interface WriteConcernErrorResult

    The type of the result property of MongoWriteConcernError

    +WriteConcernErrorResult | mongodb

    Interface WriteConcernErrorResult

    The type of the result property of MongoWriteConcernError

    interface WriteConcernErrorResult {
        code?: number;
        errorLabels?: string[];
        ok: number;
        writeConcernError: {
            code: number;
            codeName?: string;
            errInfo?: Document;
            errmsg: string;
        };
        [x: string | number]: unknown;
    }

    Indexable

    • [x: string | number]: unknown

    Properties

    code? errorLabels? ok writeConcernError -

    Properties

    Optionalcode

    code?: number

    OptionalerrorLabels

    errorLabels?: string[]

    ok

    ok: number

    writeConcernError

    writeConcernError: {
        code: number;
        codeName?: string;
        errInfo?: Document;
        errmsg: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalcode

    code?: number

    OptionalerrorLabels

    errorLabels?: string[]

    ok

    ok: number

    writeConcernError

    writeConcernError: {
        code: number;
        codeName?: string;
        errInfo?: Document;
        errmsg: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/WriteConcernOptions.html b/docs/Next/interfaces/WriteConcernOptions.html index 47e4cbb15fc..7322119bbaf 100644 --- a/docs/Next/interfaces/WriteConcernOptions.html +++ b/docs/Next/interfaces/WriteConcernOptions.html @@ -1,3 +1,3 @@ -WriteConcernOptions | mongodb

    Interface WriteConcernOptions

    interface WriteConcernOptions {
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    writeConcern? +WriteConcernOptions | mongodb

    Interface WriteConcernOptions

    interface WriteConcernOptions {
        writeConcern?: WriteConcern | WriteConcernSettings;
    }

    Hierarchy (view full)

    Properties

    writeConcern?

    Properties

    OptionalwriteConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/WriteConcernSettings.html b/docs/Next/interfaces/WriteConcernSettings.html index 9b169a8e832..75c5af3a6a5 100644 --- a/docs/Next/interfaces/WriteConcernSettings.html +++ b/docs/Next/interfaces/WriteConcernSettings.html @@ -1,4 +1,4 @@ -WriteConcernSettings | mongodb

    Interface WriteConcernSettings

    interface WriteConcernSettings {
        fsync?: boolean | 1;
        j?: boolean;
        journal?: boolean;
        w?: W;
        wtimeout?: number;
        wtimeoutMS?: number;
    }

    Properties

    fsync? +WriteConcernSettings | mongodb

    Interface WriteConcernSettings

    interface WriteConcernSettings {
        fsync?: boolean | 1;
        j?: boolean;
        journal?: boolean;
        w?: W;
        wtimeout?: number;
        wtimeoutMS?: number;
    }

    Properties

    fsync? j? journal? w? @@ -13,4 +13,4 @@

    Optionalwtimeout

    wtimeout?: number

    The write concern timeout.

    Deprecated

    Will be removed in the next major version. Please use the wtimeoutMS option.

    OptionalwtimeoutMS

    wtimeoutMS?: number

    The write concern timeout

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/modules.html b/docs/Next/modules.html index 6a9772e9ed0..d470fba79fe 100644 --- a/docs/Next/modules.html +++ b/docs/Next/modules.html @@ -1,4 +1,4 @@ -mongodb

    mongodb

    Error

    MongoAPIError +mongodb

    mongodb

    Error

    MongoAPIError MongoAWSError MongoAzureError MongoBatchReExecutionError @@ -416,4 +416,4 @@ ServerType TopologyType configureExplicitResourceManagement -

    Other

    Binary

    Re-exports Binary

    BSONRegExp

    Re-exports BSONRegExp

    BSONSymbol

    Re-exports BSONSymbol

    BSONType

    Re-exports BSONType

    Code

    Re-exports Code

    DBRef

    Re-exports DBRef

    Decimal128

    Re-exports Decimal128

    deserialize

    Re-exports deserialize

    Document

    Re-exports Document

    Double

    Re-exports Double

    Int32

    Re-exports Int32

    Long

    Re-exports Long

    MaxKey

    Re-exports MaxKey

    MinKey

    Re-exports MinKey

    ObjectId

    Re-exports ObjectId

    serialize

    Re-exports serialize

    Timestamp

    Re-exports Timestamp

    UUID

    Re-exports UUID

    Settings

    Member Visibility

    On This Page

    Other
    +

    Other

    Binary

    Re-exports Binary

    BSONRegExp

    Re-exports BSONRegExp

    BSONSymbol

    Re-exports BSONSymbol

    BSONType

    Re-exports BSONType

    Code

    Re-exports Code

    DBRef

    Re-exports DBRef

    Decimal128

    Re-exports Decimal128

    deserialize

    Re-exports deserialize

    Document

    Re-exports Document

    Double

    Re-exports Double

    Int32

    Re-exports Int32

    Long

    Re-exports Long

    MaxKey

    Re-exports MaxKey

    MinKey

    Re-exports MinKey

    ObjectId

    Re-exports ObjectId

    serialize

    Re-exports serialize

    Timestamp

    Re-exports Timestamp

    UUID

    Re-exports UUID

    Settings

    Member Visibility

    On This Page

    Other
    diff --git a/docs/Next/modules/BSON.html b/docs/Next/modules/BSON.html index 6d4b57ab13f..860c6ece56b 100644 --- a/docs/Next/modules/BSON.html +++ b/docs/Next/modules/BSON.html @@ -1,4 +1,4 @@ -BSON | mongodb

    Namespace BSON

    Index

    BSONType

    Binary +BSON | mongodb

    Namespace BSON

    Index

    BSONType

    Binary BSONRegExp BSONSymbol Code @@ -66,4 +66,4 @@ serialize serializeWithBufferAndIndex setInternalBufferSize -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/AbstractCursorEvents.html b/docs/Next/types/AbstractCursorEvents.html index 70ca61ceea0..7fca3f179f8 100644 --- a/docs/Next/types/AbstractCursorEvents.html +++ b/docs/Next/types/AbstractCursorEvents.html @@ -1 +1 @@ -AbstractCursorEvents | mongodb

    Type Alias AbstractCursorEvents

    AbstractCursorEvents: {
        close(): void;
    }

    Settings

    Member Visibility
    +AbstractCursorEvents | mongodb

    Type Alias AbstractCursorEvents

    AbstractCursorEvents: {
        close(): void;
    }

    Settings

    Member Visibility
    diff --git a/docs/Next/types/AcceptedFields.html b/docs/Next/types/AcceptedFields.html index 1348f2eb6f9..dce4c3e8c0d 100644 --- a/docs/Next/types/AcceptedFields.html +++ b/docs/Next/types/AcceptedFields.html @@ -1 +1 @@ -AcceptedFields | mongodb

    Type Alias AcceptedFields<TSchema, FieldType, AssignableType>

    AcceptedFields<TSchema, FieldType, AssignableType>: {
        readonly [key in KeysOfAType<TSchema, FieldType>]?: AssignableType
    }

    Type Parameters

    • TSchema
    • FieldType
    • AssignableType

    Settings

    Member Visibility
    +AcceptedFields | mongodb

    Type Alias AcceptedFields<TSchema, FieldType, AssignableType>

    AcceptedFields<TSchema, FieldType, AssignableType>: {
        readonly [key in KeysOfAType<TSchema, FieldType>]?: AssignableType
    }

    Type Parameters

    • TSchema
    • FieldType
    • AssignableType

    Settings

    Member Visibility
    diff --git a/docs/Next/types/AddToSetOperators.html b/docs/Next/types/AddToSetOperators.html index 6670901fd5b..055b764d13e 100644 --- a/docs/Next/types/AddToSetOperators.html +++ b/docs/Next/types/AddToSetOperators.html @@ -1 +1 @@ -AddToSetOperators | mongodb

    Type Alias AddToSetOperators<Type>

    AddToSetOperators<Type>: {
        $each?: Flatten<Type>[];
    }

    Type Parameters

    • Type

    Settings

    Member Visibility
    +AddToSetOperators | mongodb

    Type Alias AddToSetOperators<Type>

    AddToSetOperators<Type>: {
        $each?: Flatten<Type>[];
    }

    Type Parameters

    • Type

    Settings

    Member Visibility
    diff --git a/docs/Next/types/AlternativeType.html b/docs/Next/types/AlternativeType.html index 55f0cd0e69d..d50d08acb3e 100644 --- a/docs/Next/types/AlternativeType.html +++ b/docs/Next/types/AlternativeType.html @@ -1,4 +1,4 @@ -AlternativeType | mongodb

    Type Alias AlternativeType<T>

    AlternativeType<T>: T extends ReadonlyArray<infer U>
        ? T | RegExpOrString<U>
        : RegExpOrString<T>

    It is possible to search using alternative types in mongodb e.g. +AlternativeType | mongodb

    Type Alias AlternativeType<T>

    AlternativeType<T>: T extends ReadonlyArray<infer U>
        ? T | RegExpOrString<U>
        : RegExpOrString<T>

    It is possible to search using alternative types in mongodb e.g. string types can be searched using a regex in mongo array types can be searched using their element type

    -

    Type Parameters

    • T

    Settings

    Member Visibility
    +

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/docs/Next/types/AnyBulkWriteOperation.html b/docs/Next/types/AnyBulkWriteOperation.html index bf4dbaf697b..431411b5f93 100644 --- a/docs/Next/types/AnyBulkWriteOperation.html +++ b/docs/Next/types/AnyBulkWriteOperation.html @@ -1 +1 @@ -AnyBulkWriteOperation | mongodb

    Type Alias AnyBulkWriteOperation<TSchema>

    AnyBulkWriteOperation<TSchema>:
        | {
            insertOne: InsertOneModel<TSchema>;
        }
        | {
            replaceOne: ReplaceOneModel<TSchema>;
        }
        | {
            updateOne: UpdateOneModel<TSchema>;
        }
        | {
            updateMany: UpdateManyModel<TSchema>;
        }
        | {
            deleteOne: DeleteOneModel<TSchema>;
        }
        | {
            deleteMany: DeleteManyModel<TSchema>;
        }

    Type Parameters

    Settings

    Member Visibility
    +AnyBulkWriteOperation | mongodb

    Type Alias AnyBulkWriteOperation<TSchema>

    AnyBulkWriteOperation<TSchema>:
        | {
            insertOne: InsertOneModel<TSchema>;
        }
        | {
            replaceOne: ReplaceOneModel<TSchema>;
        }
        | {
            updateOne: UpdateOneModel<TSchema>;
        }
        | {
            updateMany: UpdateManyModel<TSchema>;
        }
        | {
            deleteOne: DeleteOneModel<TSchema>;
        }
        | {
            deleteMany: DeleteManyModel<TSchema>;
        }

    Type Parameters

    Settings

    Member Visibility
    diff --git a/docs/Next/types/AnyClientBulkWriteModel.html b/docs/Next/types/AnyClientBulkWriteModel.html index 978ac79d7c8..0f685061c94 100644 --- a/docs/Next/types/AnyClientBulkWriteModel.html +++ b/docs/Next/types/AnyClientBulkWriteModel.html @@ -1,3 +1,3 @@ -AnyClientBulkWriteModel | mongodb

    Type Alias AnyClientBulkWriteModel<TSchema>

    AnyClientBulkWriteModel<TSchema>:
        | ClientInsertOneModel<TSchema>
        | ClientReplaceOneModel<TSchema>
        | ClientUpdateOneModel<TSchema>
        | ClientUpdateManyModel<TSchema>
        | ClientDeleteOneModel<TSchema>
        | ClientDeleteManyModel<TSchema>

    Used to represent any of the client bulk write models that can be passed as an array +AnyClientBulkWriteModel | mongodb

    Type Alias AnyClientBulkWriteModel<TSchema>

    AnyClientBulkWriteModel<TSchema>:
        | ClientInsertOneModel<TSchema>
        | ClientReplaceOneModel<TSchema>
        | ClientUpdateOneModel<TSchema>
        | ClientUpdateManyModel<TSchema>
        | ClientDeleteOneModel<TSchema>
        | ClientDeleteManyModel<TSchema>

    Used to represent any of the client bulk write models that can be passed as an array to MongoClient#bulkWrite.

    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/docs/Next/types/AnyError.html b/docs/Next/types/AnyError.html index 1e1afe5e9dc..cf6041c110d 100644 --- a/docs/Next/types/AnyError.html +++ b/docs/Next/types/AnyError.html @@ -1 +1 @@ -AnyError | mongodb

    Type Alias AnyError

    AnyError: MongoError | Error

    Settings

    Member Visibility
    +AnyError | mongodb

    Type Alias AnyError

    AnyError: MongoError | Error

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ArrayElement.html b/docs/Next/types/ArrayElement.html index 3a50c52f827..ed62a1ba1fc 100644 --- a/docs/Next/types/ArrayElement.html +++ b/docs/Next/types/ArrayElement.html @@ -1 +1 @@ -ArrayElement | mongodb

    Type Alias ArrayElement<Type>

    ArrayElement<Type>: Type extends ReadonlyArray<infer Item>
        ? Item
        : never

    Type Parameters

    • Type

    Settings

    Member Visibility
    +ArrayElement | mongodb

    Type Alias ArrayElement<Type>

    ArrayElement<Type>: Type extends ReadonlyArray<infer Item>
        ? Item
        : never

    Type Parameters

    • Type

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ArrayOperator.html b/docs/Next/types/ArrayOperator.html index de892c60425..84e2c71eb59 100644 --- a/docs/Next/types/ArrayOperator.html +++ b/docs/Next/types/ArrayOperator.html @@ -1 +1 @@ -ArrayOperator | mongodb

    Type Alias ArrayOperator<Type>

    ArrayOperator<Type>: {
        $each?: Flatten<Type>[];
        $position?: number;
        $slice?: number;
        $sort?: Sort;
    }

    Type Parameters

    • Type

    Settings

    Member Visibility
    +ArrayOperator | mongodb

    Type Alias ArrayOperator<Type>

    ArrayOperator<Type>: {
        $each?: Flatten<Type>[];
        $position?: number;
        $slice?: number;
        $sort?: Sort;
    }

    Type Parameters

    • Type

    Settings

    Member Visibility
    diff --git a/docs/Next/types/AuthMechanism.html b/docs/Next/types/AuthMechanism.html index 69518de0aeb..9f668c63de8 100644 --- a/docs/Next/types/AuthMechanism.html +++ b/docs/Next/types/AuthMechanism.html @@ -1 +1 @@ -AuthMechanism | mongodb

    Type Alias AuthMechanism

    AuthMechanism: typeof AuthMechanism[keyof typeof AuthMechanism]

    Settings

    Member Visibility
    +AuthMechanism | mongodb

    Type Alias AuthMechanism

    AuthMechanism: typeof AuthMechanism[keyof typeof AuthMechanism]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/AutoEncryptionExtraOptions.html b/docs/Next/types/AutoEncryptionExtraOptions.html index de62902c08c..79934468558 100644 --- a/docs/Next/types/AutoEncryptionExtraOptions.html +++ b/docs/Next/types/AutoEncryptionExtraOptions.html @@ -1,3 +1,3 @@ -AutoEncryptionExtraOptions | mongodb

    Type Alias AutoEncryptionExtraOptions

    AutoEncryptionExtraOptions: NonNullable<AutoEncryptionOptions["extraOptions"]>

    Extra options related to the mongocryptd process +AutoEncryptionExtraOptions | mongodb

    Type Alias AutoEncryptionExtraOptions

    AutoEncryptionExtraOptions: NonNullable<AutoEncryptionOptions["extraOptions"]>

    Extra options related to the mongocryptd process * Available in MongoDB 6.0 or higher.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/AutoEncryptionLoggerLevel.html b/docs/Next/types/AutoEncryptionLoggerLevel.html index 5011f96510b..3f0984248b3 100644 --- a/docs/Next/types/AutoEncryptionLoggerLevel.html +++ b/docs/Next/types/AutoEncryptionLoggerLevel.html @@ -1,4 +1,4 @@ -AutoEncryptionLoggerLevel | mongodb

    Type Alias AutoEncryptionLoggerLevel

    AutoEncryptionLoggerLevel: typeof AutoEncryptionLoggerLevel[keyof typeof AutoEncryptionLoggerLevel]

    The level of severity of the log message

    +AutoEncryptionLoggerLevel | mongodb

    Type Alias AutoEncryptionLoggerLevel

    AutoEncryptionLoggerLevel: typeof AutoEncryptionLoggerLevel[keyof typeof AutoEncryptionLoggerLevel]

    The level of severity of the log message

    @@ -29,4 +29,4 @@
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/AzureKMSProviderConfiguration.html b/docs/Next/types/AzureKMSProviderConfiguration.html index be688476d77..fe9de091b7e 100644 --- a/docs/Next/types/AzureKMSProviderConfiguration.html +++ b/docs/Next/types/AzureKMSProviderConfiguration.html @@ -1,4 +1,4 @@ -AzureKMSProviderConfiguration | mongodb

    Type Alias AzureKMSProviderConfiguration

    AzureKMSProviderConfiguration: {
        clientId: string;
        clientSecret: string;
        identityPlatformEndpoint?: string;
        tenantId: string;
    } | {
        accessToken: string;
    }

    Type declaration

    • clientId: string

      The client ID to authenticate a registered application

      +AzureKMSProviderConfiguration | mongodb

      Type Alias AzureKMSProviderConfiguration

      AzureKMSProviderConfiguration: {
          clientId: string;
          clientSecret: string;
          identityPlatformEndpoint?: string;
          tenantId: string;
      } | {
          accessToken: string;
      }

      Type declaration

      • clientId: string

        The client ID to authenticate a registered application

      • clientSecret: string

        The client secret to authenticate a registered application

      • OptionalidentityPlatformEndpoint?: string

        If present, a host with optional port. E.g. "example.com" or "example.com:443". This is optional, and only needed if customer is using a non-commercial Azure instance @@ -6,4 +6,4 @@ Defaults to "login.microsoftonline.com"

      • tenantId: string

        The tenant ID identifies the organization for the account

      Type declaration

      • accessToken: string

        If present, an access token to authenticate with Azure.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/BSON.BSONType.html b/docs/Next/types/BSON.BSONType.html index 8b468cf3ded..0cf7a7b376d 100644 --- a/docs/Next/types/BSON.BSONType.html +++ b/docs/Next/types/BSON.BSONType.html @@ -1 +1 @@ -BSONType | mongodb

    Type Alias BSONType

    BSONType: typeof BSON.BSONType[keyof typeof BSON.BSONType]

    Settings

    Member Visibility
    +BSONType | mongodb

    Type Alias BSONType

    BSONType: typeof BSON.BSONType[keyof typeof BSON.BSONType]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/BSON.BinarySequence.html b/docs/Next/types/BSON.BinarySequence.html index 3b2a6cd714b..c1333eeedba 100644 --- a/docs/Next/types/BSON.BinarySequence.html +++ b/docs/Next/types/BSON.BinarySequence.html @@ -1 +1 @@ -BinarySequence | mongodb

    Type Alias BinarySequence

    BinarySequence: Uint8Array | number[]

    Settings

    Member Visibility
    +BinarySequence | mongodb

    Type Alias BinarySequence

    BinarySequence: Uint8Array | number[]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/BSON.CalculateObjectSizeOptions.html b/docs/Next/types/BSON.CalculateObjectSizeOptions.html index 15735bb1387..058d89c1744 100644 --- a/docs/Next/types/BSON.CalculateObjectSizeOptions.html +++ b/docs/Next/types/BSON.CalculateObjectSizeOptions.html @@ -1 +1 @@ -CalculateObjectSizeOptions | mongodb

    Type Alias CalculateObjectSizeOptions

    CalculateObjectSizeOptions: Pick<SerializeOptions, "serializeFunctions" | "ignoreUndefined">

    Settings

    Member Visibility
    +CalculateObjectSizeOptions | mongodb

    Type Alias CalculateObjectSizeOptions

    CalculateObjectSizeOptions: Pick<SerializeOptions, "serializeFunctions" | "ignoreUndefined">

    Settings

    Member Visibility
    diff --git a/docs/Next/types/BSON.EJSONOptions.html b/docs/Next/types/BSON.EJSONOptions.html index aa67456725f..2a850f0540f 100644 --- a/docs/Next/types/BSON.EJSONOptions.html +++ b/docs/Next/types/BSON.EJSONOptions.html @@ -1,7 +1,7 @@ -EJSONOptions | mongodb

    Type Alias EJSONOptions

    EJSONOptions: {
        legacy?: boolean;
        relaxed?: boolean;
        useBigInt64?: boolean;
    }

    Type declaration

    • Optionallegacy?: boolean

      Output using the Extended JSON v1 spec

      +EJSONOptions | mongodb

      Type Alias EJSONOptions

      EJSONOptions: {
          legacy?: boolean;
          relaxed?: boolean;
          useBigInt64?: boolean;
      }

      Type declaration

      • Optionallegacy?: boolean

        Output using the Extended JSON v1 spec

        Default Value

        false

      • Optionalrelaxed?: boolean

        Enable Extended JSON's relaxed mode, which attempts to return native JS types where possible, rather than BSON types

        Default Value

        false

      • OptionaluseBigInt64?: boolean

        Enable native bigint support

        Default Value

        false

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/BSON.LongWithoutOverrides.html b/docs/Next/types/BSON.LongWithoutOverrides.html index eb076279f4c..53b7ebcf784 100644 --- a/docs/Next/types/BSON.LongWithoutOverrides.html +++ b/docs/Next/types/BSON.LongWithoutOverrides.html @@ -1 +1 @@ -LongWithoutOverrides | mongodb

    Type Alias LongWithoutOverrides

    LongWithoutOverrides: (new (low: unknown, high?: number | boolean, unsigned?: boolean) => {
        [P in Exclude<keyof Long, TimestampOverrides>]: Long[P]
    })

    Settings

    Member Visibility
    +LongWithoutOverrides | mongodb

    Type Alias LongWithoutOverrides

    LongWithoutOverrides: (new (low: unknown, high?: number | boolean, unsigned?: boolean) => {
        [P in Exclude<keyof Long, TimestampOverrides>]: Long[P]
    })

    Settings

    Member Visibility
    diff --git a/docs/Next/types/BSON.OnDemand.html b/docs/Next/types/BSON.OnDemand.html index 179eda11a73..976625d4738 100644 --- a/docs/Next/types/BSON.OnDemand.html +++ b/docs/Next/types/BSON.OnDemand.html @@ -1,2 +1,2 @@ -OnDemand | mongodb

    Type Alias OnDemandExperimental

    OnDemand: {
        BSONElement: BSONElement;
        ByteUtils: ByteUtils;
        NumberUtils: NumberUtils;
        parseToElements: ((this: void, bytes: Uint8Array, startOffset?: number) => Iterable<BSONElement>);
    }

    A new set of BSON APIs that are currently experimental and not intended for production use.

    -

    Settings

    Member Visibility
    +OnDemand | mongodb

    Type Alias OnDemandExperimental

    OnDemand: {
        BSONElement: BSONElement;
        ByteUtils: ByteUtils;
        NumberUtils: NumberUtils;
        parseToElements: ((this: void, bytes: Uint8Array, startOffset?: number) => Iterable<BSONElement>);
    }

    A new set of BSON APIs that are currently experimental and not intended for production use.

    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/BSON.TimestampOverrides.html b/docs/Next/types/BSON.TimestampOverrides.html index d39917c40d8..80bd681ed57 100644 --- a/docs/Next/types/BSON.TimestampOverrides.html +++ b/docs/Next/types/BSON.TimestampOverrides.html @@ -1 +1 @@ -TimestampOverrides | mongodb

    Type Alias TimestampOverrides

    TimestampOverrides:
        | "_bsontype"
        | "toExtendedJSON"
        | "fromExtendedJSON"
        | "inspect"

    Settings

    Member Visibility
    +TimestampOverrides | mongodb

    Type Alias TimestampOverrides

    TimestampOverrides:
        | "_bsontype"
        | "toExtendedJSON"
        | "fromExtendedJSON"
        | "inspect"

    Settings

    Member Visibility
    diff --git a/docs/Next/types/BSON.UUIDExtended.html b/docs/Next/types/BSON.UUIDExtended.html index 951206f18fd..d3586ce02f0 100644 --- a/docs/Next/types/BSON.UUIDExtended.html +++ b/docs/Next/types/BSON.UUIDExtended.html @@ -1 +1 @@ -UUIDExtended | mongodb

    Type Alias UUIDExtended

    UUIDExtended: {
        $uuid: string;
    }

    Settings

    Member Visibility
    +UUIDExtended | mongodb

    Type Alias UUIDExtended

    UUIDExtended: {
        $uuid: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/Next/types/BSONTypeAlias.html b/docs/Next/types/BSONTypeAlias.html index 6b6d5bd7112..0d7b1956918 100644 --- a/docs/Next/types/BSONTypeAlias.html +++ b/docs/Next/types/BSONTypeAlias.html @@ -1 +1 @@ -BSONTypeAlias | mongodb

    Type Alias BSONTypeAlias

    BSONTypeAlias: keyof typeof BSON.BSONType

    Settings

    Member Visibility
    +BSONTypeAlias | mongodb

    Type Alias BSONTypeAlias

    BSONTypeAlias: keyof typeof BSON.BSONType

    Settings

    Member Visibility
    diff --git a/docs/Next/types/BatchType.html b/docs/Next/types/BatchType.html index 4288bf14ae7..2071453588f 100644 --- a/docs/Next/types/BatchType.html +++ b/docs/Next/types/BatchType.html @@ -1 +1 @@ -BatchType | mongodb

    Type Alias BatchType

    BatchType: typeof BatchType[keyof typeof BatchType]

    Settings

    Member Visibility
    +BatchType | mongodb

    Type Alias BatchType

    BatchType: typeof BatchType[keyof typeof BatchType]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/BitwiseFilter.html b/docs/Next/types/BitwiseFilter.html index 8d8deca9b71..b7f64eb0d47 100644 --- a/docs/Next/types/BitwiseFilter.html +++ b/docs/Next/types/BitwiseFilter.html @@ -1 +1 @@ -BitwiseFilter | mongodb

    Type Alias BitwiseFilter

    BitwiseFilter: number | Binary | ReadonlyArray<number>

    Settings

    Member Visibility
    +BitwiseFilter | mongodb

    Type Alias BitwiseFilter

    BitwiseFilter: number | Binary | ReadonlyArray<number>

    Settings

    Member Visibility
    diff --git a/docs/Next/types/CSFLEKMSTlsOptions.html b/docs/Next/types/CSFLEKMSTlsOptions.html index ae148911e41..d1123db4b11 100644 --- a/docs/Next/types/CSFLEKMSTlsOptions.html +++ b/docs/Next/types/CSFLEKMSTlsOptions.html @@ -1 +1 @@ -CSFLEKMSTlsOptions | mongodb

    Type Alias CSFLEKMSTlsOptions

    CSFLEKMSTlsOptions: {
        aws?: ClientEncryptionTlsOptions;
        azure?: ClientEncryptionTlsOptions;
        gcp?: ClientEncryptionTlsOptions;
        kmip?: ClientEncryptionTlsOptions;
        local?: ClientEncryptionTlsOptions;
        [key: string]: ClientEncryptionTlsOptions | undefined;
    }

    Settings

    Member Visibility
    +CSFLEKMSTlsOptions | mongodb

    Type Alias CSFLEKMSTlsOptions

    CSFLEKMSTlsOptions: {
        aws?: ClientEncryptionTlsOptions;
        azure?: ClientEncryptionTlsOptions;
        gcp?: ClientEncryptionTlsOptions;
        kmip?: ClientEncryptionTlsOptions;
        local?: ClientEncryptionTlsOptions;
        [key: string]: ClientEncryptionTlsOptions | undefined;
    }

    Settings

    Member Visibility
    diff --git a/docs/Next/types/Callback.html b/docs/Next/types/Callback.html index d84f9ec5397..6165023cdb7 100644 --- a/docs/Next/types/Callback.html +++ b/docs/Next/types/Callback.html @@ -1,2 +1,2 @@ -Callback | mongodb

    Type Alias Callback<T>

    Callback<T>: ((error?: AnyError, result?: T) => void)

    MongoDB Driver style callback

    -

    Type Parameters

    • T = any

    Settings

    Member Visibility
    +Callback | mongodb

    Type Alias Callback<T>

    Callback<T>: ((error?: AnyError, result?: T) => void)

    MongoDB Driver style callback

    +

    Type Parameters

    • T = any

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ChangeStreamDocument.html b/docs/Next/types/ChangeStreamDocument.html index 632276b6637..7c7c32ce443 100644 --- a/docs/Next/types/ChangeStreamDocument.html +++ b/docs/Next/types/ChangeStreamDocument.html @@ -1 +1 @@ -ChangeStreamDocument | mongodb

    Type Alias ChangeStreamDocument<TSchema>

    ChangeStreamDocument<TSchema>:
        | ChangeStreamInsertDocument<TSchema>
        | ChangeStreamUpdateDocument<TSchema>
        | ChangeStreamReplaceDocument<TSchema>
        | ChangeStreamDeleteDocument<TSchema>
        | ChangeStreamDropDocument
        | ChangeStreamRenameDocument
        | ChangeStreamDropDatabaseDocument
        | ChangeStreamInvalidateDocument
        | ChangeStreamCreateIndexDocument
        | ChangeStreamCreateDocument
        | ChangeStreamCollModDocument
        | ChangeStreamDropIndexDocument
        | ChangeStreamShardCollectionDocument
        | ChangeStreamReshardCollectionDocument
        | ChangeStreamRefineCollectionShardKeyDocument

    Type Parameters

    Settings

    Member Visibility
    +ChangeStreamDocument | mongodb

    Type Alias ChangeStreamDocument<TSchema>

    ChangeStreamDocument<TSchema>:
        | ChangeStreamInsertDocument<TSchema>
        | ChangeStreamUpdateDocument<TSchema>
        | ChangeStreamReplaceDocument<TSchema>
        | ChangeStreamDeleteDocument<TSchema>
        | ChangeStreamDropDocument
        | ChangeStreamRenameDocument
        | ChangeStreamDropDatabaseDocument
        | ChangeStreamInvalidateDocument
        | ChangeStreamCreateIndexDocument
        | ChangeStreamCreateDocument
        | ChangeStreamCollModDocument
        | ChangeStreamDropIndexDocument
        | ChangeStreamShardCollectionDocument
        | ChangeStreamReshardCollectionDocument
        | ChangeStreamRefineCollectionShardKeyDocument

    Type Parameters

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ChangeStreamEvents.html b/docs/Next/types/ChangeStreamEvents.html index 422d0766280..3030342e911 100644 --- a/docs/Next/types/ChangeStreamEvents.html +++ b/docs/Next/types/ChangeStreamEvents.html @@ -1 +1 @@ -ChangeStreamEvents | mongodb

    Type Alias ChangeStreamEvents<TSchema, TChange>

    ChangeStreamEvents<TSchema, TChange>: {
        change(change: TChange): void;
        end(): void;
        error(error: Error): void;
        init(response: any): void;
        more(response?: any): void;
        response(): void;
        resumeTokenChanged(token: unknown): void;
    } & AbstractCursorEvents

    Type Parameters

    Settings

    Member Visibility
    +ChangeStreamEvents | mongodb

    Type Alias ChangeStreamEvents<TSchema, TChange>

    ChangeStreamEvents<TSchema, TChange>: {
        change(change: TChange): void;
        end(): void;
        error(error: Error): void;
        init(response: any): void;
        more(response?: any): void;
        response(): void;
        resumeTokenChanged(token: unknown): void;
    } & AbstractCursorEvents

    Type Parameters

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ClientBulkWriteModel.html b/docs/Next/types/ClientBulkWriteModel.html index 5ea32ed7b9d..f8d1b4addcb 100644 --- a/docs/Next/types/ClientBulkWriteModel.html +++ b/docs/Next/types/ClientBulkWriteModel.html @@ -1,6 +1,6 @@ -ClientBulkWriteModel | mongodb

    Type Alias ClientBulkWriteModel<SchemaMap>

    ClientBulkWriteModel<SchemaMap>: {
        [Namespace in keyof SchemaMap]: AnyClientBulkWriteModel<SchemaMap[Namespace]> & {
            namespace: Namespace;
        }
    }[keyof SchemaMap]

    A mapping of namespace strings to collections schemas.

    +ClientBulkWriteModel | mongodb

    Type Alias ClientBulkWriteModel<SchemaMap>

    ClientBulkWriteModel<SchemaMap>: {
        [Namespace in keyof SchemaMap]: AnyClientBulkWriteModel<SchemaMap[Namespace]> & {
            namespace: Namespace;
        }
    }[keyof SchemaMap]

    A mapping of namespace strings to collections schemas.

    Type Parameters

    Example

    type MongoDBSchemas = {
      'db.books': Book;
      'db.authors': Author;
    }

    const model: ClientBulkWriteModel<MongoDBSchemas> = {
      namespace: 'db.books'
      name: 'insertOne',
      document: { title: 'Practical MongoDB Aggregations', authorName: 3 } // error `authorName` cannot be number
    };

    The type of the namespace field narrows other parts of the BulkWriteModel to use the correct schema for type assertions.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ClientEncryptionDataKeyProvider.html b/docs/Next/types/ClientEncryptionDataKeyProvider.html index 95ad252ebae..23c9870a066 100644 --- a/docs/Next/types/ClientEncryptionDataKeyProvider.html +++ b/docs/Next/types/ClientEncryptionDataKeyProvider.html @@ -1,8 +1,8 @@ -ClientEncryptionDataKeyProvider | mongodb

    Type Alias ClientEncryptionDataKeyProvider

    ClientEncryptionDataKeyProvider: keyof KMSProviders

    A data key provider. Allowed values:

    +ClientEncryptionDataKeyProvider | mongodb

    Type Alias ClientEncryptionDataKeyProvider

    ClientEncryptionDataKeyProvider: keyof KMSProviders

    A data key provider. Allowed values:

    • aws, gcp, local, kmip or azure
    • (mongodb-client-encryption>=6.0.1 only) a named key, in the form of: aws:<name>, gcp:<name>, local:<name>, kmip:<name>, azure:<name> where name is an alphanumeric string, underscores allowed.
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ClientEncryptionSocketOptions.html b/docs/Next/types/ClientEncryptionSocketOptions.html index 974e8e9cf09..1ab1ef48c8f 100644 --- a/docs/Next/types/ClientEncryptionSocketOptions.html +++ b/docs/Next/types/ClientEncryptionSocketOptions.html @@ -1,2 +1,2 @@ -ClientEncryptionSocketOptions | mongodb

    Type Alias ClientEncryptionSocketOptions

    ClientEncryptionSocketOptions: Pick<MongoClientOptions, "autoSelectFamily" | "autoSelectFamilyAttemptTimeout">

    Socket options to use for KMS requests.

    -

    Settings

    Member Visibility
    +ClientEncryptionSocketOptions | mongodb

    Type Alias ClientEncryptionSocketOptions

    ClientEncryptionSocketOptions: Pick<MongoClientOptions, "autoSelectFamily" | "autoSelectFamilyAttemptTimeout">

    Socket options to use for KMS requests.

    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ClientEncryptionTlsOptions.html b/docs/Next/types/ClientEncryptionTlsOptions.html index 7094c02c843..6a512c07c84 100644 --- a/docs/Next/types/ClientEncryptionTlsOptions.html +++ b/docs/Next/types/ClientEncryptionTlsOptions.html @@ -1,4 +1,4 @@ -ClientEncryptionTlsOptions | mongodb

    Type Alias ClientEncryptionTlsOptions

    ClientEncryptionTlsOptions: Pick<MongoClientOptions, "tlsCAFile" | "tlsCertificateKeyFile" | "tlsCertificateKeyFilePassword">

    TLS options to use when connecting. The spec specifically calls out which insecure +ClientEncryptionTlsOptions | mongodb

    Type Alias ClientEncryptionTlsOptions

    ClientEncryptionTlsOptions: Pick<MongoClientOptions, "tlsCAFile" | "tlsCertificateKeyFile" | "tlsCertificateKeyFilePassword">

    TLS options to use when connecting. The spec specifically calls out which insecure tls options are not allowed:

    • tlsAllowInvalidCertificates
      • @@ -6,4 +6,4 @@
    • tlsInsecure

    These options are not included in the type, and are ignored if provided.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ClientSessionEvents.html b/docs/Next/types/ClientSessionEvents.html index 171ddb14630..f9715ae2206 100644 --- a/docs/Next/types/ClientSessionEvents.html +++ b/docs/Next/types/ClientSessionEvents.html @@ -1 +1 @@ -ClientSessionEvents | mongodb

    Type Alias ClientSessionEvents

    ClientSessionEvents: {
        ended(session: ClientSession): void;
    }

    Settings

    Member Visibility
    +ClientSessionEvents | mongodb

    Type Alias ClientSessionEvents

    ClientSessionEvents: {
        ended(session: ClientSession): void;
    }

    Settings

    Member Visibility
    diff --git a/docs/Next/types/CommonEvents.html b/docs/Next/types/CommonEvents.html index f51a41130d0..68d089169b0 100644 --- a/docs/Next/types/CommonEvents.html +++ b/docs/Next/types/CommonEvents.html @@ -1 +1 @@ -CommonEvents | mongodb

    Type Alias CommonEvents

    CommonEvents: "newListener" | "removeListener"

    Settings

    Member Visibility
    +CommonEvents | mongodb

    Type Alias CommonEvents

    CommonEvents: "newListener" | "removeListener"

    Settings

    Member Visibility
    diff --git a/docs/Next/types/Compressor.html b/docs/Next/types/Compressor.html index 3b0d143b3ab..2a2ee90f66c 100644 --- a/docs/Next/types/Compressor.html +++ b/docs/Next/types/Compressor.html @@ -1 +1 @@ -Compressor | mongodb

    Type Alias Compressor

    Compressor: typeof Compressor[CompressorName]

    Settings

    Member Visibility
    +Compressor | mongodb

    Type Alias Compressor

    Compressor: typeof Compressor[CompressorName]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/CompressorName.html b/docs/Next/types/CompressorName.html index e4c29b34541..7070b6ec840 100644 --- a/docs/Next/types/CompressorName.html +++ b/docs/Next/types/CompressorName.html @@ -1 +1 @@ -CompressorName | mongodb

    Type Alias CompressorName

    CompressorName: keyof typeof Compressor

    Settings

    Member Visibility
    +CompressorName | mongodb

    Type Alias CompressorName

    CompressorName: keyof typeof Compressor

    Settings

    Member Visibility
    diff --git a/docs/Next/types/Condition.html b/docs/Next/types/Condition.html index fe4991c0021..13d14327116 100644 --- a/docs/Next/types/Condition.html +++ b/docs/Next/types/Condition.html @@ -1 +1 @@ -Condition | mongodb

    Type Alias Condition<T>

    Condition<T>: AlternativeType<T> | FilterOperators<AlternativeType<T>>

    Type Parameters

    • T

    Settings

    Member Visibility
    +Condition | mongodb

    Type Alias Condition<T>

    Condition<T>: AlternativeType<T> | FilterOperators<AlternativeType<T>>

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ConnectionEvents.html b/docs/Next/types/ConnectionEvents.html index 588d140db6f..f5119728f41 100644 --- a/docs/Next/types/ConnectionEvents.html +++ b/docs/Next/types/ConnectionEvents.html @@ -1 +1 @@ -ConnectionEvents | mongodb

    Type Alias ConnectionEvents

    ConnectionEvents: {
        close(): void;
        clusterTimeReceived(clusterTime: Document): void;
        commandFailed(event: CommandFailedEvent): void;
        commandStarted(event: CommandStartedEvent): void;
        commandSucceeded(event: CommandSucceededEvent): void;
        pinned(pinType: string): void;
        unpinned(pinType: string): void;
    }

    Settings

    Member Visibility
    +ConnectionEvents | mongodb

    Type Alias ConnectionEvents

    ConnectionEvents: {
        close(): void;
        clusterTimeReceived(clusterTime: Document): void;
        commandFailed(event: CommandFailedEvent): void;
        commandStarted(event: CommandStartedEvent): void;
        commandSucceeded(event: CommandSucceededEvent): void;
        pinned(pinType: string): void;
        unpinned(pinType: string): void;
    }

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ConnectionPoolEvents.html b/docs/Next/types/ConnectionPoolEvents.html index 7fe5e232c02..361dea56016 100644 --- a/docs/Next/types/ConnectionPoolEvents.html +++ b/docs/Next/types/ConnectionPoolEvents.html @@ -1 +1 @@ -ConnectionPoolEvents | mongodb

    Type Alias ConnectionPoolEvents

    ConnectionPoolEvents: {
        connectionCheckedIn(event: ConnectionCheckedInEvent): void;
        connectionCheckedOut(event: ConnectionCheckedOutEvent): void;
        connectionCheckOutFailed(event: ConnectionCheckOutFailedEvent): void;
        connectionCheckOutStarted(event: ConnectionCheckOutStartedEvent): void;
        connectionClosed(event: ConnectionClosedEvent): void;
        connectionCreated(event: ConnectionCreatedEvent): void;
        connectionPoolCleared(event: ConnectionPoolClearedEvent): void;
        connectionPoolClosed(event: ConnectionPoolClosedEvent): void;
        connectionPoolCreated(event: ConnectionPoolCreatedEvent): void;
        connectionPoolReady(event: ConnectionPoolReadyEvent): void;
        connectionReady(event: ConnectionReadyEvent): void;
    } & Omit<ConnectionEvents, "close" | "message">

    Settings

    Member Visibility
    +ConnectionPoolEvents | mongodb

    Type Alias ConnectionPoolEvents

    ConnectionPoolEvents: {
        connectionCheckedIn(event: ConnectionCheckedInEvent): void;
        connectionCheckedOut(event: ConnectionCheckedOutEvent): void;
        connectionCheckOutFailed(event: ConnectionCheckOutFailedEvent): void;
        connectionCheckOutStarted(event: ConnectionCheckOutStartedEvent): void;
        connectionClosed(event: ConnectionClosedEvent): void;
        connectionCreated(event: ConnectionCreatedEvent): void;
        connectionPoolCleared(event: ConnectionPoolClearedEvent): void;
        connectionPoolClosed(event: ConnectionPoolClosedEvent): void;
        connectionPoolCreated(event: ConnectionPoolCreatedEvent): void;
        connectionPoolReady(event: ConnectionPoolReadyEvent): void;
        connectionReady(event: ConnectionReadyEvent): void;
    } & Omit<ConnectionEvents, "close" | "message">

    Settings

    Member Visibility
    diff --git a/docs/Next/types/CursorFlag.html b/docs/Next/types/CursorFlag.html index 16a5ae7a319..4582918c4c6 100644 --- a/docs/Next/types/CursorFlag.html +++ b/docs/Next/types/CursorFlag.html @@ -1 +1 @@ -CursorFlag | mongodb

    Type Alias CursorFlag

    CursorFlag: typeof CURSOR_FLAGS[number]

    Settings

    Member Visibility
    +CursorFlag | mongodb

    Type Alias CursorFlag

    CursorFlag: typeof CURSOR_FLAGS[number]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/DistinctOptions.html b/docs/Next/types/DistinctOptions.html index 8c53481c997..38745525049 100644 --- a/docs/Next/types/DistinctOptions.html +++ b/docs/Next/types/DistinctOptions.html @@ -1 +1 @@ -DistinctOptions | mongodb

    Type Alias DistinctOptions

    DistinctOptions: CommandOperationOptions

    Settings

    Member Visibility
    +DistinctOptions | mongodb

    Type Alias DistinctOptions

    DistinctOptions: CommandOperationOptions

    Settings

    Member Visibility
    diff --git a/docs/Next/types/DropDatabaseOptions.html b/docs/Next/types/DropDatabaseOptions.html index 02477918fb0..89882232555 100644 --- a/docs/Next/types/DropDatabaseOptions.html +++ b/docs/Next/types/DropDatabaseOptions.html @@ -1 +1 @@ -DropDatabaseOptions | mongodb

    Type Alias DropDatabaseOptions

    DropDatabaseOptions: CommandOperationOptions

    Settings

    Member Visibility
    +DropDatabaseOptions | mongodb

    Type Alias DropDatabaseOptions

    DropDatabaseOptions: CommandOperationOptions

    Settings

    Member Visibility
    diff --git a/docs/Next/types/DropIndexesOptions.html b/docs/Next/types/DropIndexesOptions.html index f4ee44845b2..5b817c856eb 100644 --- a/docs/Next/types/DropIndexesOptions.html +++ b/docs/Next/types/DropIndexesOptions.html @@ -1 +1 @@ -DropIndexesOptions | mongodb

    Type Alias DropIndexesOptions

    DropIndexesOptions: CommandOperationOptions

    Settings

    Member Visibility
    +DropIndexesOptions | mongodb

    Type Alias DropIndexesOptions

    DropIndexesOptions: CommandOperationOptions

    Settings

    Member Visibility
    diff --git a/docs/Next/types/EnhancedOmit.html b/docs/Next/types/EnhancedOmit.html index b4a31d0be46..ae90a953768 100644 --- a/docs/Next/types/EnhancedOmit.html +++ b/docs/Next/types/EnhancedOmit.html @@ -1,2 +1,2 @@ -EnhancedOmit | mongodb

    Type Alias EnhancedOmit<TRecordOrUnion, KeyUnion>

    EnhancedOmit<TRecordOrUnion, KeyUnion>: string extends keyof TRecordOrUnion
        ? TRecordOrUnion
        : TRecordOrUnion extends any
            ? Pick<TRecordOrUnion, Exclude<keyof TRecordOrUnion, KeyUnion>>
            : never

    TypeScript Omit (Exclude to be specific) does not work for objects with an "any" indexed type, and breaks discriminated unions

    -

    Type Parameters

    • TRecordOrUnion
    • KeyUnion

    Settings

    Member Visibility
    +EnhancedOmit | mongodb

    Type Alias EnhancedOmit<TRecordOrUnion, KeyUnion>

    EnhancedOmit<TRecordOrUnion, KeyUnion>: string extends keyof TRecordOrUnion
        ? TRecordOrUnion
        : TRecordOrUnion extends any
            ? Pick<TRecordOrUnion, Exclude<keyof TRecordOrUnion, KeyUnion>>
            : never

    TypeScript Omit (Exclude to be specific) does not work for objects with an "any" indexed type, and breaks discriminated unions

    +

    Type Parameters

    • TRecordOrUnion
    • KeyUnion

    Settings

    Member Visibility
    diff --git a/docs/Next/types/EventEmitterWithState.html b/docs/Next/types/EventEmitterWithState.html index 930c325da06..797efe5e1b3 100644 --- a/docs/Next/types/EventEmitterWithState.html +++ b/docs/Next/types/EventEmitterWithState.html @@ -1 +1 @@ -EventEmitterWithState | mongodb

    Type Alias EventEmitterWithState

    EventEmitterWithState: {}

    Settings

    Member Visibility
    +EventEmitterWithState | mongodb

    Type Alias EventEmitterWithState

    EventEmitterWithState: {}

    Settings

    Member Visibility
    diff --git a/docs/Next/types/EventsDescription.html b/docs/Next/types/EventsDescription.html index b24004ef5a6..ee3a9b14bd5 100644 --- a/docs/Next/types/EventsDescription.html +++ b/docs/Next/types/EventsDescription.html @@ -1,2 +1,2 @@ -EventsDescription | mongodb

    Type Alias EventsDescription

    EventsDescription: Record<string, GenericListener>

    Event description type

    -

    Settings

    Member Visibility
    +EventsDescription | mongodb

    Type Alias EventsDescription

    EventsDescription: Record<string, GenericListener>

    Event description type

    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ExplainVerbosity.html b/docs/Next/types/ExplainVerbosity.html index 676fe1c4099..8633b6f5c31 100644 --- a/docs/Next/types/ExplainVerbosity.html +++ b/docs/Next/types/ExplainVerbosity.html @@ -1 +1 @@ -ExplainVerbosity | mongodb

    Type Alias ExplainVerbosity

    ExplainVerbosity: string

    Settings

    Member Visibility
    +ExplainVerbosity | mongodb

    Type Alias ExplainVerbosity

    ExplainVerbosity: string

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ExplainVerbosityLike.html b/docs/Next/types/ExplainVerbosityLike.html index 289927f2051..8a6ed8b03ad 100644 --- a/docs/Next/types/ExplainVerbosityLike.html +++ b/docs/Next/types/ExplainVerbosityLike.html @@ -1,3 +1,3 @@ -ExplainVerbosityLike | mongodb

    Type Alias ExplainVerbosityLike

    ExplainVerbosityLike: ExplainVerbosity | boolean

    For backwards compatibility, true is interpreted as "allPlansExecution" +ExplainVerbosityLike | mongodb

    Type Alias ExplainVerbosityLike

    ExplainVerbosityLike: ExplainVerbosity | boolean

    For backwards compatibility, true is interpreted as "allPlansExecution" and false as "queryPlanner".

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/Filter.html b/docs/Next/types/Filter.html index ec1952a26fb..fd63db6b4d0 100644 --- a/docs/Next/types/Filter.html +++ b/docs/Next/types/Filter.html @@ -1,2 +1,2 @@ -Filter | mongodb

    Type Alias Filter<TSchema>

    Filter<TSchema>: {
        [P in keyof WithId<TSchema>]?: Condition<WithId<TSchema>[P]>
    } & RootFilterOperators<WithId<TSchema>>

    A MongoDB filter can be some portion of the schema or a set of operators

    -

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +Filter | mongodb

    Type Alias Filter<TSchema>

    Filter<TSchema>: {
        [P in keyof WithId<TSchema>]?: Condition<WithId<TSchema>[P]>
    } & RootFilterOperators<WithId<TSchema>>

    A MongoDB filter can be some portion of the schema or a set of operators

    +

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/types/FilterOperations.html b/docs/Next/types/FilterOperations.html index 6e2253b0bdb..04793c16ec5 100644 --- a/docs/Next/types/FilterOperations.html +++ b/docs/Next/types/FilterOperations.html @@ -1 +1 @@ -FilterOperations | mongodb

    Type Alias FilterOperations<T>

    FilterOperations<T>: T extends Record<string, any>
        ? {
            [key in keyof T]?: FilterOperators<T[key]>
        }
        : FilterOperators<T>

    Type Parameters

    • T

    Settings

    Member Visibility
    +FilterOperations | mongodb

    Type Alias FilterOperations<T>

    FilterOperations<T>: T extends Record<string, any>
        ? {
            [key in keyof T]?: FilterOperators<T[key]>
        }
        : FilterOperators<T>

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/docs/Next/types/Flatten.html b/docs/Next/types/Flatten.html index 1a9e0b23814..793a71708ab 100644 --- a/docs/Next/types/Flatten.html +++ b/docs/Next/types/Flatten.html @@ -1 +1 @@ -Flatten | mongodb

    Type Alias Flatten<Type>

    Flatten<Type>: Type extends ReadonlyArray<infer Item>
        ? Item
        : Type

    Type Parameters

    • Type

    Settings

    Member Visibility
    +Flatten | mongodb

    Type Alias Flatten<Type>

    Flatten<Type>: Type extends ReadonlyArray<infer Item>
        ? Item
        : Type

    Type Parameters

    • Type

    Settings

    Member Visibility
    diff --git a/docs/Next/types/GCPKMSProviderConfiguration.html b/docs/Next/types/GCPKMSProviderConfiguration.html index bdd8c328798..c7cfd5e8672 100644 --- a/docs/Next/types/GCPKMSProviderConfiguration.html +++ b/docs/Next/types/GCPKMSProviderConfiguration.html @@ -1,6 +1,6 @@ -GCPKMSProviderConfiguration | mongodb

    Type Alias GCPKMSProviderConfiguration

    GCPKMSProviderConfiguration: {
        email: string;
        endpoint?: string;
        privateKey: string | Buffer;
    } | {
        accessToken: string;
    }

    Type declaration

    • email: string

      The service account email to authenticate

      +GCPKMSProviderConfiguration | mongodb

      Type Alias GCPKMSProviderConfiguration

      GCPKMSProviderConfiguration: {
          email: string;
          endpoint?: string;
          privateKey: string | Buffer;
      } | {
          accessToken: string;
      }

      Type declaration

      • email: string

        The service account email to authenticate

      • Optionalendpoint?: string

        If present, a host with optional port. E.g. "example.com" or "example.com:443". Defaults to "oauth2.googleapis.com"

      • privateKey: string | Buffer

        A PKCS#8 encrypted key. This can either be a base64 string or a binary representation

      Type declaration

      • accessToken: string

        If present, an access token to authenticate with GCP.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/GSSAPICanonicalizationValue.html b/docs/Next/types/GSSAPICanonicalizationValue.html index 43c4d756240..54583bf605f 100644 --- a/docs/Next/types/GSSAPICanonicalizationValue.html +++ b/docs/Next/types/GSSAPICanonicalizationValue.html @@ -1 +1 @@ -GSSAPICanonicalizationValue | mongodb

    Type Alias GSSAPICanonicalizationValue

    GSSAPICanonicalizationValue: typeof GSSAPICanonicalizationValue[keyof typeof GSSAPICanonicalizationValue]

    Settings

    Member Visibility
    +GSSAPICanonicalizationValue | mongodb

    Type Alias GSSAPICanonicalizationValue

    GSSAPICanonicalizationValue: typeof GSSAPICanonicalizationValue[keyof typeof GSSAPICanonicalizationValue]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/GenericListener.html b/docs/Next/types/GenericListener.html index 0345ff7bc36..500768689bd 100644 --- a/docs/Next/types/GenericListener.html +++ b/docs/Next/types/GenericListener.html @@ -1 +1 @@ -GenericListener | mongodb

    Type Alias GenericListener

    GenericListener: ((...args: any[]) => void)

    Settings

    Member Visibility
    +GenericListener | mongodb

    Type Alias GenericListener

    GenericListener: ((...args: any[]) => void)

    Settings

    Member Visibility
    diff --git a/docs/Next/types/GridFSBucketEvents.html b/docs/Next/types/GridFSBucketEvents.html index d149eb803db..0fe7eb4df5a 100644 --- a/docs/Next/types/GridFSBucketEvents.html +++ b/docs/Next/types/GridFSBucketEvents.html @@ -1 +1 @@ -GridFSBucketEvents | mongodb

    Type Alias GridFSBucketEvents

    GridFSBucketEvents: {
        index(): void;
    }

    Settings

    Member Visibility
    +GridFSBucketEvents | mongodb

    Type Alias GridFSBucketEvents

    GridFSBucketEvents: {
        index(): void;
    }

    Settings

    Member Visibility
    diff --git a/docs/Next/types/Hint.html b/docs/Next/types/Hint.html index 7758c576737..ddafb04fb18 100644 --- a/docs/Next/types/Hint.html +++ b/docs/Next/types/Hint.html @@ -1 +1 @@ -Hint | mongodb

    Type Alias Hint

    Hint: string | Document

    Settings

    Member Visibility
    +Hint | mongodb

    Type Alias Hint

    Hint: string | Document

    Settings

    Member Visibility
    diff --git a/docs/Next/types/IndexDescriptionCompact.html b/docs/Next/types/IndexDescriptionCompact.html index edb0af4a75c..4da0499ddd9 100644 --- a/docs/Next/types/IndexDescriptionCompact.html +++ b/docs/Next/types/IndexDescriptionCompact.html @@ -1 +1 @@ -IndexDescriptionCompact | mongodb

    Type Alias IndexDescriptionCompact

    IndexDescriptionCompact: Record<string, [name: string, direction: IndexDirection][]>

    Settings

    Member Visibility
    +IndexDescriptionCompact | mongodb

    Type Alias IndexDescriptionCompact

    IndexDescriptionCompact: Record<string, [name: string, direction: IndexDirection][]>

    Settings

    Member Visibility
    diff --git a/docs/Next/types/IndexDescriptionInfo.html b/docs/Next/types/IndexDescriptionInfo.html index e93f4af3065..333f6a3d0a7 100644 --- a/docs/Next/types/IndexDescriptionInfo.html +++ b/docs/Next/types/IndexDescriptionInfo.html @@ -1,2 +1,2 @@ -IndexDescriptionInfo | mongodb

    Type Alias IndexDescriptionInfo

    IndexDescriptionInfo: Omit<IndexDescription, "key" | "version"> & {
        key: {
            [key: string]: IndexDirection;
        };
        v?: IndexDescription["version"];
    } & Document

    The index information returned by the listIndexes command. https://www.mongodb.com/docs/manual/reference/command/listIndexes/#mongodb-dbcommand-dbcmd.listIndexes

    -

    Settings

    Member Visibility
    +IndexDescriptionInfo | mongodb

    Type Alias IndexDescriptionInfo

    IndexDescriptionInfo: Omit<IndexDescription, "key" | "version"> & {
        key: {
            [key: string]: IndexDirection;
        };
        v?: IndexDescription["version"];
    } & Document

    The index information returned by the listIndexes command. https://www.mongodb.com/docs/manual/reference/command/listIndexes/#mongodb-dbcommand-dbcmd.listIndexes

    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/IndexDirection.html b/docs/Next/types/IndexDirection.html index ef6d9e7a621..ef74f164508 100644 --- a/docs/Next/types/IndexDirection.html +++ b/docs/Next/types/IndexDirection.html @@ -1 +1 @@ -IndexDirection | mongodb

    Type Alias IndexDirection

    IndexDirection:
        | -1
        | 1
        | "2d"
        | "2dsphere"
        | "text"
        | "geoHaystack"
        | "hashed"
        | number

    Settings

    Member Visibility
    +IndexDirection | mongodb

    Type Alias IndexDirection

    IndexDirection:
        | -1
        | 1
        | "2d"
        | "2dsphere"
        | "text"
        | "geoHaystack"
        | "hashed"
        | number

    Settings

    Member Visibility
    diff --git a/docs/Next/types/IndexSpecification.html b/docs/Next/types/IndexSpecification.html index 4b803de786c..78419dbec68 100644 --- a/docs/Next/types/IndexSpecification.html +++ b/docs/Next/types/IndexSpecification.html @@ -1 +1 @@ -IndexSpecification | mongodb

    Type Alias IndexSpecification

    IndexSpecification: OneOrMore<
        | string
        | [string, IndexDirection]
        | {
            [key: string]: IndexDirection;
        }
        | Map<string, IndexDirection>>

    Settings

    Member Visibility
    +IndexSpecification | mongodb

    Type Alias IndexSpecification

    IndexSpecification: OneOrMore<
        | string
        | [string, IndexDirection]
        | {
            [key: string]: IndexDirection;
        }
        | Map<string, IndexDirection>>

    Settings

    Member Visibility
    diff --git a/docs/Next/types/InferIdType.html b/docs/Next/types/InferIdType.html index 002de539db3..0562df73d1f 100644 --- a/docs/Next/types/InferIdType.html +++ b/docs/Next/types/InferIdType.html @@ -1,2 +1,2 @@ -InferIdType | mongodb

    Type Alias InferIdType<TSchema>

    InferIdType<TSchema>: TSchema extends {
            _id: infer IdType;
        }
        ? Record<any, never> extends IdType
            ? never
            : IdType
        : TSchema extends {
                _id?: infer IdType;
            }
            ? unknown extends IdType
                ? ObjectId
                : IdType
            : ObjectId

    Given an object shaped type, return the type of the _id field or default to ObjectId

    -

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +InferIdType | mongodb

    Type Alias InferIdType<TSchema>

    InferIdType<TSchema>: TSchema extends {
            _id: infer IdType;
        }
        ? Record<any, never> extends IdType
            ? never
            : IdType
        : TSchema extends {
                _id?: infer IdType;
            }
            ? unknown extends IdType
                ? ObjectId
                : IdType
            : ObjectId

    Given an object shaped type, return the type of the _id field or default to ObjectId

    +

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/types/IntegerType.html b/docs/Next/types/IntegerType.html index d28199d5945..aace753b099 100644 --- a/docs/Next/types/IntegerType.html +++ b/docs/Next/types/IntegerType.html @@ -1 +1 @@ -IntegerType | mongodb

    Type Alias IntegerType

    IntegerType:
        | number
        | Int32
        | Long
        | bigint

    Settings

    Member Visibility
    +IntegerType | mongodb

    Type Alias IntegerType

    IntegerType:
        | number
        | Int32
        | Long
        | bigint

    Settings

    Member Visibility
    diff --git a/docs/Next/types/IsAny.html b/docs/Next/types/IsAny.html index 2063a1b1a0f..25890b293b6 100644 --- a/docs/Next/types/IsAny.html +++ b/docs/Next/types/IsAny.html @@ -1 +1 @@ -IsAny | mongodb

    Type Alias IsAny<Type, ResultIfAny, ResultIfNotAny>

    IsAny<Type, ResultIfAny, ResultIfNotAny>: true extends false & Type
        ? ResultIfAny
        : ResultIfNotAny

    Type Parameters

    • Type
    • ResultIfAny
    • ResultIfNotAny

    Settings

    Member Visibility
    +IsAny | mongodb

    Type Alias IsAny<Type, ResultIfAny, ResultIfNotAny>

    IsAny<Type, ResultIfAny, ResultIfNotAny>: true extends false & Type
        ? ResultIfAny
        : ResultIfNotAny

    Type Parameters

    • Type
    • ResultIfAny
    • ResultIfNotAny

    Settings

    Member Visibility
    diff --git a/docs/Next/types/Join.html b/docs/Next/types/Join.html index a0e4c28a95d..6f4e35ed8c6 100644 --- a/docs/Next/types/Join.html +++ b/docs/Next/types/Join.html @@ -1 +1 @@ -Join | mongodb

    Type Alias Join<T, D>

    Join<T, D>: T extends []
        ? ""
        : T extends [string | number]
            ? `${T[0]}`
            : T extends [string | number, ...(infer R)]
                ? `${T[0]}${D}${Join<R, D>}`
                : string

    Type Parameters

    • T extends unknown[]
    • D extends string

    Settings

    Member Visibility
    +Join | mongodb

    Type Alias Join<T, D>

    Join<T, D>: T extends []
        ? ""
        : T extends [string | number]
            ? `${T[0]}`
            : T extends [string | number, ...(infer R)]
                ? `${T[0]}${D}${Join<R, D>}`
                : string

    Type Parameters

    • T extends unknown[]
    • D extends string

    Settings

    Member Visibility
    diff --git a/docs/Next/types/KeysOfAType.html b/docs/Next/types/KeysOfAType.html index 58bc0d536f4..e441586b7fa 100644 --- a/docs/Next/types/KeysOfAType.html +++ b/docs/Next/types/KeysOfAType.html @@ -1 +1 @@ -KeysOfAType | mongodb

    Type Alias KeysOfAType<TSchema, Type>

    KeysOfAType<TSchema, Type>: {
        [key in keyof TSchema]: NonNullable<TSchema[key]> extends Type
            ? key
            : never
    }[keyof TSchema]

    Type Parameters

    • TSchema
    • Type

    Settings

    Member Visibility
    +KeysOfAType | mongodb

    Type Alias KeysOfAType<TSchema, Type>

    KeysOfAType<TSchema, Type>: {
        [key in keyof TSchema]: NonNullable<TSchema[key]> extends Type
            ? key
            : never
    }[keyof TSchema]

    Type Parameters

    • TSchema
    • Type

    Settings

    Member Visibility
    diff --git a/docs/Next/types/KeysOfOtherType.html b/docs/Next/types/KeysOfOtherType.html index d7c78ac92c5..efffdff1f16 100644 --- a/docs/Next/types/KeysOfOtherType.html +++ b/docs/Next/types/KeysOfOtherType.html @@ -1 +1 @@ -KeysOfOtherType | mongodb

    Type Alias KeysOfOtherType<TSchema, Type>

    KeysOfOtherType<TSchema, Type>: {
        [key in keyof TSchema]: NonNullable<TSchema[key]> extends Type
            ? never
            : key
    }[keyof TSchema]

    Type Parameters

    • TSchema
    • Type

    Settings

    Member Visibility
    +KeysOfOtherType | mongodb

    Type Alias KeysOfOtherType<TSchema, Type>

    KeysOfOtherType<TSchema, Type>: {
        [key in keyof TSchema]: NonNullable<TSchema[key]> extends Type
            ? never
            : key
    }[keyof TSchema]

    Type Parameters

    • TSchema
    • Type

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ListIndexesOptions.html b/docs/Next/types/ListIndexesOptions.html index ef9f016b540..9c09f03d1e9 100644 --- a/docs/Next/types/ListIndexesOptions.html +++ b/docs/Next/types/ListIndexesOptions.html @@ -1 +1 @@ -ListIndexesOptions | mongodb

    Type Alias ListIndexesOptions

    ListIndexesOptions: AbstractCursorOptions

    Settings

    Member Visibility
    +ListIndexesOptions | mongodb

    Type Alias ListIndexesOptions

    ListIndexesOptions: AbstractCursorOptions

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ListSearchIndexesOptions.html b/docs/Next/types/ListSearchIndexesOptions.html index 8fe8701cf1a..313855ed359 100644 --- a/docs/Next/types/ListSearchIndexesOptions.html +++ b/docs/Next/types/ListSearchIndexesOptions.html @@ -1 +1 @@ -ListSearchIndexesOptions | mongodb

    Type Alias ListSearchIndexesOptions

    ListSearchIndexesOptions: Omit<AggregateOptions, "readConcern" | "writeConcern">

    Settings

    Member Visibility
    +ListSearchIndexesOptions | mongodb

    Type Alias ListSearchIndexesOptions

    ListSearchIndexesOptions: Omit<AggregateOptions, "readConcern" | "writeConcern">

    Settings

    Member Visibility
    diff --git a/docs/Next/types/MatchKeysAndValues.html b/docs/Next/types/MatchKeysAndValues.html index f44bc00998d..fc532f6531c 100644 --- a/docs/Next/types/MatchKeysAndValues.html +++ b/docs/Next/types/MatchKeysAndValues.html @@ -1 +1 @@ -MatchKeysAndValues | mongodb

    Type Alias MatchKeysAndValues<TSchema>

    MatchKeysAndValues<TSchema>: Readonly<Partial<TSchema>> & Record<string, any>

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +MatchKeysAndValues | mongodb

    Type Alias MatchKeysAndValues<TSchema>

    MatchKeysAndValues<TSchema>: Readonly<Partial<TSchema>> & Record<string, any>

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/types/MongoClientEvents.html b/docs/Next/types/MongoClientEvents.html index 56497d6390a..fc0f7e6ac83 100644 --- a/docs/Next/types/MongoClientEvents.html +++ b/docs/Next/types/MongoClientEvents.html @@ -1 +1 @@ -MongoClientEvents | mongodb

    Type Alias MongoClientEvents

    MongoClientEvents: Pick<TopologyEvents, typeof MONGO_CLIENT_EVENTS[number]> & {
        open(mongoClient: MongoClient): void;
    }

    Settings

    Member Visibility
    +MongoClientEvents | mongodb

    Type Alias MongoClientEvents

    MongoClientEvents: Pick<TopologyEvents, typeof MONGO_CLIENT_EVENTS[number]> & {
        open(mongoClient: MongoClient): void;
    }

    Settings

    Member Visibility
    diff --git a/docs/Next/types/MongoErrorLabel.html b/docs/Next/types/MongoErrorLabel.html index 2dac96567b5..8ee6d0cafbf 100644 --- a/docs/Next/types/MongoErrorLabel.html +++ b/docs/Next/types/MongoErrorLabel.html @@ -1 +1 @@ -MongoErrorLabel | mongodb

    Type Alias MongoErrorLabel

    MongoErrorLabel: typeof MongoErrorLabel[keyof typeof MongoErrorLabel]

    Settings

    Member Visibility
    +MongoErrorLabel | mongodb

    Type Alias MongoErrorLabel

    MongoErrorLabel: typeof MongoErrorLabel[keyof typeof MongoErrorLabel]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/MonitorEvents.html b/docs/Next/types/MonitorEvents.html index aff5624a3f5..d17e3a07e67 100644 --- a/docs/Next/types/MonitorEvents.html +++ b/docs/Next/types/MonitorEvents.html @@ -1 +1 @@ -MonitorEvents | mongodb

    Type Alias MonitorEvents

    MonitorEvents: {
        close(): void;
        resetConnectionPool(): void;
        resetServer(error?: MongoError): void;
        serverHeartbeatFailed(event: ServerHeartbeatFailedEvent): void;
        serverHeartbeatStarted(event: ServerHeartbeatStartedEvent): void;
        serverHeartbeatSucceeded(event: ServerHeartbeatSucceededEvent): void;
    } & EventEmitterWithState

    Settings

    Member Visibility
    +MonitorEvents | mongodb

    Type Alias MonitorEvents

    MonitorEvents: {
        close(): void;
        resetConnectionPool(): void;
        resetServer(error?: MongoError): void;
        serverHeartbeatFailed(event: ServerHeartbeatFailedEvent): void;
        serverHeartbeatStarted(event: ServerHeartbeatStartedEvent): void;
        serverHeartbeatSucceeded(event: ServerHeartbeatSucceededEvent): void;
    } & EventEmitterWithState

    Settings

    Member Visibility
    diff --git a/docs/Next/types/NestedPaths.html b/docs/Next/types/NestedPaths.html index 0422df82bda..111ef86a60a 100644 --- a/docs/Next/types/NestedPaths.html +++ b/docs/Next/types/NestedPaths.html @@ -1,8 +1,8 @@ -NestedPaths | mongodb

    Type Alias NestedPaths<Type, Depth>

    NestedPaths<Type, Depth>: Depth["length"] extends 8
        ? []
        : Type extends
                | string
                | number
                | bigint
                | boolean
                | Date
                | RegExp
                | Buffer
                | Uint8Array
                | ((...args: any[]) => any)
                | {
                    _bsontype: string;
                }
            ? []
            : Type extends ReadonlyArray<infer ArrayType>
                ? [] | [number, ...NestedPaths<ArrayType, [...Depth, 1]>]
                : Type extends Map<string, any>
                    ? [string]
                    : Type extends object
                        ? {
                            [Key in Extract<keyof Type, string>]: Type[Key] extends Type
                                ? [Key]
                                : Type extends Type[Key]
                                    ? [Key]
                                    : (...)[(...)] extends ReadonlyArray<(...)>
                                        ? (...) extends (...)
                                            ? (...)
                                            : (...)
                                        : (...) | (...)
                        }[Extract<keyof Type, string>]
                        : []

    returns tuple of strings (keys to be joined on '.') that represent every path into a schema +NestedPaths | mongodb

    Type Alias NestedPaths<Type, Depth>

    NestedPaths<Type, Depth>: Depth["length"] extends 8
        ? []
        : Type extends
                | string
                | number
                | bigint
                | boolean
                | Date
                | RegExp
                | Buffer
                | Uint8Array
                | ((...args: any[]) => any)
                | {
                    _bsontype: string;
                }
            ? []
            : Type extends ReadonlyArray<infer ArrayType>
                ? [] | [number, ...NestedPaths<ArrayType, [...Depth, 1]>]
                : Type extends Map<string, any>
                    ? [string]
                    : Type extends object
                        ? {
                            [Key in Extract<keyof Type, string>]: Type[Key] extends Type
                                ? [Key]
                                : Type extends Type[Key]
                                    ? [Key]
                                    : (...)[(...)] extends ReadonlyArray<(...)>
                                        ? (...) extends (...)
                                            ? (...)
                                            : (...)
                                        : (...) | (...)
                        }[Extract<keyof Type, string>]
                        : []

    returns tuple of strings (keys to be joined on '.') that represent every path into a schema https://www.mongodb.com/docs/manual/tutorial/query-embedded-documents/

    Type Parameters

    • Type
    • Depth extends number[]

    Remarks

    Through testing we determined that a depth of 8 is safe for the typescript compiler and provides reasonable compilation times. This number is otherwise not special and should be changed if issues are found with this level of checking. Beyond this depth any helpers that make use of NestedPaths should devolve to not asserting any type safety on the input.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/NestedPathsOfType.html b/docs/Next/types/NestedPathsOfType.html index a9abe8ec15c..a744af31bff 100644 --- a/docs/Next/types/NestedPathsOfType.html +++ b/docs/Next/types/NestedPathsOfType.html @@ -1,3 +1,3 @@ -NestedPathsOfType | mongodb

    Type Alias NestedPathsOfType<TSchema, Type>

    NestedPathsOfType<TSchema, Type>: KeysOfAType<{
        [Property in Join<NestedPaths<TSchema, []>, ".">]: PropertyType<TSchema, Property>
    }, Type>

    returns keys (strings) for every path into a schema with a value of type +NestedPathsOfType | mongodb

    Type Alias NestedPathsOfType<TSchema, Type>

    NestedPathsOfType<TSchema, Type>: KeysOfAType<{
        [Property in Join<NestedPaths<TSchema, []>, ".">]: PropertyType<TSchema, Property>
    }, Type>

    returns keys (strings) for every path into a schema with a value of type https://www.mongodb.com/docs/manual/tutorial/query-embedded-documents/

    -

    Type Parameters

    • TSchema
    • Type

    Settings

    Member Visibility
    +

    Type Parameters

    • TSchema
    • Type

    Settings

    Member Visibility
    diff --git a/docs/Next/types/NonObjectIdLikeDocument.html b/docs/Next/types/NonObjectIdLikeDocument.html index a582a1ea3ee..f0b01640b7c 100644 --- a/docs/Next/types/NonObjectIdLikeDocument.html +++ b/docs/Next/types/NonObjectIdLikeDocument.html @@ -1,2 +1,2 @@ -NonObjectIdLikeDocument | mongodb

    Type Alias NonObjectIdLikeDocument

    NonObjectIdLikeDocument: {
        [key in keyof ObjectIdLike]?: never
    } & Document

    A type that extends Document but forbids anything that "looks like" an object id.

    -

    Settings

    Member Visibility
    +NonObjectIdLikeDocument | mongodb

    Type Alias NonObjectIdLikeDocument

    NonObjectIdLikeDocument: {
        [key in keyof ObjectIdLike]?: never
    } & Document

    A type that extends Document but forbids anything that "looks like" an object id.

    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/NotAcceptedFields.html b/docs/Next/types/NotAcceptedFields.html index 91a6eafe5cb..31e5ffb6d57 100644 --- a/docs/Next/types/NotAcceptedFields.html +++ b/docs/Next/types/NotAcceptedFields.html @@ -1,2 +1,2 @@ -NotAcceptedFields | mongodb

    Type Alias NotAcceptedFields<TSchema, FieldType>

    NotAcceptedFields<TSchema, FieldType>: {
        readonly [key in KeysOfOtherType<TSchema, FieldType>]?: never
    }

    It avoids using fields with not acceptable types

    -

    Type Parameters

    • TSchema
    • FieldType

    Settings

    Member Visibility
    +NotAcceptedFields | mongodb

    Type Alias NotAcceptedFields<TSchema, FieldType>

    NotAcceptedFields<TSchema, FieldType>: {
        readonly [key in KeysOfOtherType<TSchema, FieldType>]?: never
    }

    It avoids using fields with not acceptable types

    +

    Type Parameters

    • TSchema
    • FieldType

    Settings

    Member Visibility
    diff --git a/docs/Next/types/NumericType.html b/docs/Next/types/NumericType.html index d855800441b..d074abd1337 100644 --- a/docs/Next/types/NumericType.html +++ b/docs/Next/types/NumericType.html @@ -1 +1 @@ -NumericType | mongodb

    Type Alias NumericType

    NumericType: IntegerType | Decimal128 | Double

    Settings

    Member Visibility
    +NumericType | mongodb

    Type Alias NumericType

    NumericType: IntegerType | Decimal128 | Double

    Settings

    Member Visibility
    diff --git a/docs/Next/types/OIDCCallbackFunction.html b/docs/Next/types/OIDCCallbackFunction.html index 0a6b19de8b5..f29d2cae08d 100644 --- a/docs/Next/types/OIDCCallbackFunction.html +++ b/docs/Next/types/OIDCCallbackFunction.html @@ -1,2 +1,2 @@ -OIDCCallbackFunction | mongodb

    Type Alias OIDCCallbackFunction

    OIDCCallbackFunction: ((params: OIDCCallbackParams) => Promise<OIDCResponse>)

    The signature of the human or machine callback functions.

    -

    Settings

    Member Visibility
    +OIDCCallbackFunction | mongodb

    Type Alias OIDCCallbackFunction

    OIDCCallbackFunction: ((params: OIDCCallbackParams) => Promise<OIDCResponse>)

    The signature of the human or machine callback functions.

    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/OneOrMore.html b/docs/Next/types/OneOrMore.html index d6ebd8c12bf..4d60d8a3be3 100644 --- a/docs/Next/types/OneOrMore.html +++ b/docs/Next/types/OneOrMore.html @@ -1 +1 @@ -OneOrMore | mongodb

    Type Alias OneOrMore<T>

    OneOrMore<T>: T | ReadonlyArray<T>

    Type Parameters

    • T

    Settings

    Member Visibility
    +OneOrMore | mongodb

    Type Alias OneOrMore<T>

    OneOrMore<T>: T | ReadonlyArray<T>

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/docs/Next/types/OnlyFieldsOfType.html b/docs/Next/types/OnlyFieldsOfType.html index 61754f1854f..49a175e2e17 100644 --- a/docs/Next/types/OnlyFieldsOfType.html +++ b/docs/Next/types/OnlyFieldsOfType.html @@ -1 +1 @@ -OnlyFieldsOfType | mongodb

    Type Alias OnlyFieldsOfType<TSchema, FieldType, AssignableType>

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], AssignableType extends FieldType
        ? Record<string, FieldType>
        : Record<string, AssignableType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type Parameters

    • TSchema
    • FieldType = any
    • AssignableType = FieldType

    Settings

    Member Visibility
    +OnlyFieldsOfType | mongodb

    Type Alias OnlyFieldsOfType<TSchema, FieldType, AssignableType>

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], AssignableType extends FieldType
        ? Record<string, FieldType>
        : Record<string, AssignableType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type Parameters

    • TSchema
    • FieldType = any
    • AssignableType = FieldType

    Settings

    Member Visibility
    diff --git a/docs/Next/types/OperationTime.html b/docs/Next/types/OperationTime.html index dd6c83d584e..5d932ae66a3 100644 --- a/docs/Next/types/OperationTime.html +++ b/docs/Next/types/OperationTime.html @@ -1,3 +1,3 @@ -OperationTime | mongodb

    Type Alias OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    +OperationTime | mongodb

    Type Alias OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    See

    https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/OptionalId.html b/docs/Next/types/OptionalId.html index 3904e368443..b93c20febad 100644 --- a/docs/Next/types/OptionalId.html +++ b/docs/Next/types/OptionalId.html @@ -1,2 +1,2 @@ -OptionalId | mongodb

    Type Alias OptionalId<TSchema>

    OptionalId<TSchema>: EnhancedOmit<TSchema, "_id"> & {
        _id?: InferIdType<TSchema>;
    }

    Add an optional _id field to an object shaped type

    -

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +OptionalId | mongodb

    Type Alias OptionalId<TSchema>

    OptionalId<TSchema>: EnhancedOmit<TSchema, "_id"> & {
        _id?: InferIdType<TSchema>;
    }

    Add an optional _id field to an object shaped type

    +

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/types/OptionalUnlessRequiredId.html b/docs/Next/types/OptionalUnlessRequiredId.html index b098d044ec9..14704d9353a 100644 --- a/docs/Next/types/OptionalUnlessRequiredId.html +++ b/docs/Next/types/OptionalUnlessRequiredId.html @@ -1,3 +1,3 @@ -OptionalUnlessRequiredId | mongodb

    Type Alias OptionalUnlessRequiredId<TSchema>

    OptionalUnlessRequiredId<TSchema>: TSchema extends {
            _id: any;
        }
        ? TSchema
        : OptionalId<TSchema>

    Adds an optional _id field to an object shaped type, unless the _id field is required on that type. +OptionalUnlessRequiredId | mongodb

    Type Alias OptionalUnlessRequiredId<TSchema>

    OptionalUnlessRequiredId<TSchema>: TSchema extends {
            _id: any;
        }
        ? TSchema
        : OptionalId<TSchema>

    Adds an optional _id field to an object shaped type, unless the _id field is required on that type. In the case _id is required, this method continues to require_id.

    -

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ProfilingLevel.html b/docs/Next/types/ProfilingLevel.html index 8c43001cbb6..a55a05fd79b 100644 --- a/docs/Next/types/ProfilingLevel.html +++ b/docs/Next/types/ProfilingLevel.html @@ -1 +1 @@ -ProfilingLevel | mongodb

    Type Alias ProfilingLevel

    ProfilingLevel: typeof ProfilingLevel[keyof typeof ProfilingLevel]

    Settings

    Member Visibility
    +ProfilingLevel | mongodb

    Type Alias ProfilingLevel

    ProfilingLevel: typeof ProfilingLevel[keyof typeof ProfilingLevel]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ProfilingLevelOptions.html b/docs/Next/types/ProfilingLevelOptions.html index a3e9cf36a7d..8e0292fc6ea 100644 --- a/docs/Next/types/ProfilingLevelOptions.html +++ b/docs/Next/types/ProfilingLevelOptions.html @@ -1 +1 @@ -ProfilingLevelOptions | mongodb

    Type Alias ProfilingLevelOptions

    ProfilingLevelOptions: CommandOperationOptions

    Settings

    Member Visibility
    +ProfilingLevelOptions | mongodb

    Type Alias ProfilingLevelOptions

    ProfilingLevelOptions: CommandOperationOptions

    Settings

    Member Visibility
    diff --git a/docs/Next/types/PropertyType.html b/docs/Next/types/PropertyType.html index fb2b3419d5a..517bb09869f 100644 --- a/docs/Next/types/PropertyType.html +++ b/docs/Next/types/PropertyType.html @@ -1 +1 @@ -PropertyType | mongodb

    Type Alias PropertyType<Type, Property>

    PropertyType<Type, Property>: string extends Property
        ? unknown
        : Property extends keyof Type
            ? Type[Property]
            : Property extends `${number}`
                ? Type extends ReadonlyArray<infer ArrayType>
                    ? ArrayType
                    : unknown
                : Property extends `${infer Key}.${infer Rest}`
                    ? Key extends `${number}`
                        ? Type extends ReadonlyArray<infer ArrayType>
                            ? PropertyType<ArrayType, Rest>
                            : unknown
                        : Key extends keyof Type
                            ? Type[Key] extends Map<string, infer MapType>
                                ? MapType
                                : PropertyType<Type[Key], Rest>
                            : unknown
                    : unknown

    Type Parameters

    • Type
    • Property extends string

    Settings

    Member Visibility
    +PropertyType | mongodb

    Type Alias PropertyType<Type, Property>

    PropertyType<Type, Property>: string extends Property
        ? unknown
        : Property extends keyof Type
            ? Type[Property]
            : Property extends `${number}`
                ? Type extends ReadonlyArray<infer ArrayType>
                    ? ArrayType
                    : unknown
                : Property extends `${infer Key}.${infer Rest}`
                    ? Key extends `${number}`
                        ? Type extends ReadonlyArray<infer ArrayType>
                            ? PropertyType<ArrayType, Rest>
                            : unknown
                        : Key extends keyof Type
                            ? Type[Key] extends Map<string, infer MapType>
                                ? MapType
                                : PropertyType<Type[Key], Rest>
                            : unknown
                    : unknown

    Type Parameters

    • Type
    • Property extends string

    Settings

    Member Visibility
    diff --git a/docs/Next/types/PullAllOperator.html b/docs/Next/types/PullAllOperator.html index 7f3b470a8d7..f2839c6d165 100644 --- a/docs/Next/types/PullAllOperator.html +++ b/docs/Next/types/PullAllOperator.html @@ -1 +1 @@ -PullAllOperator | mongodb

    Type Alias PullAllOperator<TSchema>

    PullAllOperator<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: TSchema[key]
    } & NotAcceptedFields<TSchema, ReadonlyArray<any>> & {
        [key: string]: ReadonlyArray<any>;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +PullAllOperator | mongodb

    Type Alias PullAllOperator<TSchema>

    PullAllOperator<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: TSchema[key]
    } & NotAcceptedFields<TSchema, ReadonlyArray<any>> & {
        [key: string]: ReadonlyArray<any>;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/types/PullOperator.html b/docs/Next/types/PullOperator.html index 946e21b846d..1f0dea0e79a 100644 --- a/docs/Next/types/PullOperator.html +++ b/docs/Next/types/PullOperator.html @@ -1 +1 @@ -PullOperator | mongodb

    Type Alias PullOperator<TSchema>

    PullOperator<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: Partial<Flatten<TSchema[key]>> | FilterOperations<Flatten<TSchema[key]>>
    } & NotAcceptedFields<TSchema, ReadonlyArray<any>> & {
        [key: string]: FilterOperators<any> | any;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +PullOperator | mongodb

    Type Alias PullOperator<TSchema>

    PullOperator<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: Partial<Flatten<TSchema[key]>> | FilterOperations<Flatten<TSchema[key]>>
    } & NotAcceptedFields<TSchema, ReadonlyArray<any>> & {
        [key: string]: FilterOperators<any> | any;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/types/PushOperator.html b/docs/Next/types/PushOperator.html index cc66ae65d32..80182ded2b7 100644 --- a/docs/Next/types/PushOperator.html +++ b/docs/Next/types/PushOperator.html @@ -1 +1 @@ -PushOperator | mongodb

    Type Alias PushOperator<TSchema>

    PushOperator<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: Flatten<TSchema[key]> | ArrayOperator<Flatten<TSchema[key]>[]>
    } & NotAcceptedFields<TSchema, ReadonlyArray<any>> & {
        [key: string]: ArrayOperator<any> | any;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +PushOperator | mongodb

    Type Alias PushOperator<TSchema>

    PushOperator<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: Flatten<TSchema[key]> | ArrayOperator<Flatten<TSchema[key]>[]>
    } & NotAcceptedFields<TSchema, ReadonlyArray<any>> & {
        [key: string]: ArrayOperator<any> | any;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ReadConcernLevel.html b/docs/Next/types/ReadConcernLevel.html index 4516956a360..5708df345fe 100644 --- a/docs/Next/types/ReadConcernLevel.html +++ b/docs/Next/types/ReadConcernLevel.html @@ -1 +1 @@ -ReadConcernLevel | mongodb

    Type Alias ReadConcernLevel

    ReadConcernLevel: typeof ReadConcernLevel[keyof typeof ReadConcernLevel]

    Settings

    Member Visibility
    +ReadConcernLevel | mongodb

    Type Alias ReadConcernLevel

    ReadConcernLevel: typeof ReadConcernLevel[keyof typeof ReadConcernLevel]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ReadConcernLike.html b/docs/Next/types/ReadConcernLike.html index 6834431fc54..b926131692e 100644 --- a/docs/Next/types/ReadConcernLike.html +++ b/docs/Next/types/ReadConcernLike.html @@ -1 +1 @@ -ReadConcernLike | mongodb

    Type Alias ReadConcernLike

    ReadConcernLike: ReadConcern | {
        level: ReadConcernLevel;
    } | ReadConcernLevel

    Settings

    Member Visibility
    +ReadConcernLike | mongodb

    Type Alias ReadConcernLike

    ReadConcernLike: ReadConcern | {
        level: ReadConcernLevel;
    } | ReadConcernLevel

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ReadPreferenceLike.html b/docs/Next/types/ReadPreferenceLike.html index fa5d79925cb..9e48a9304bf 100644 --- a/docs/Next/types/ReadPreferenceLike.html +++ b/docs/Next/types/ReadPreferenceLike.html @@ -1 +1 @@ -ReadPreferenceLike | mongodb

    Type Alias ReadPreferenceLike

    ReadPreferenceLike: ReadPreference | ReadPreferenceMode

    Settings

    Member Visibility
    +ReadPreferenceLike | mongodb

    Type Alias ReadPreferenceLike

    ReadPreferenceLike: ReadPreference | ReadPreferenceMode

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ReadPreferenceMode.html b/docs/Next/types/ReadPreferenceMode.html index 4d3e59e2fa0..784658a238f 100644 --- a/docs/Next/types/ReadPreferenceMode.html +++ b/docs/Next/types/ReadPreferenceMode.html @@ -1 +1 @@ -ReadPreferenceMode | mongodb

    Type Alias ReadPreferenceMode

    ReadPreferenceMode: typeof ReadPreferenceMode[keyof typeof ReadPreferenceMode]

    Settings

    Member Visibility
    +ReadPreferenceMode | mongodb

    Type Alias ReadPreferenceMode

    ReadPreferenceMode: typeof ReadPreferenceMode[keyof typeof ReadPreferenceMode]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/RegExpOrString.html b/docs/Next/types/RegExpOrString.html index 29163265e8d..461091bc9f7 100644 --- a/docs/Next/types/RegExpOrString.html +++ b/docs/Next/types/RegExpOrString.html @@ -1 +1 @@ -RegExpOrString | mongodb

    Type Alias RegExpOrString<T>

    RegExpOrString<T>: T extends string
        ? BSONRegExp | RegExp | T
        : T

    Type Parameters

    • T

    Settings

    Member Visibility
    +RegExpOrString | mongodb

    Type Alias RegExpOrString<T>

    RegExpOrString<T>: T extends string
        ? BSONRegExp | RegExp | T
        : T

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/docs/Next/types/RemoveUserOptions.html b/docs/Next/types/RemoveUserOptions.html index c04383e51cf..ea8d8a83025 100644 --- a/docs/Next/types/RemoveUserOptions.html +++ b/docs/Next/types/RemoveUserOptions.html @@ -1 +1 @@ -RemoveUserOptions | mongodb

    Type Alias RemoveUserOptions

    RemoveUserOptions: CommandOperationOptions

    Settings

    Member Visibility
    +RemoveUserOptions | mongodb

    Type Alias RemoveUserOptions

    RemoveUserOptions: CommandOperationOptions

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ResumeToken.html b/docs/Next/types/ResumeToken.html index 0cd87caa544..77f4c052bb8 100644 --- a/docs/Next/types/ResumeToken.html +++ b/docs/Next/types/ResumeToken.html @@ -1,3 +1,3 @@ -ResumeToken | mongodb

    Type Alias ResumeToken

    ResumeToken: unknown

    Represents the logical starting point for a new ChangeStream or resuming a ChangeStream on the server.

    +ResumeToken | mongodb

    Type Alias ResumeToken

    ResumeToken: unknown

    Represents the logical starting point for a new ChangeStream or resuming a ChangeStream on the server.

    See

    https://www.mongodb.com/docs/manual/changeStreams/#std-label-change-stream-resume

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ReturnDocument.html b/docs/Next/types/ReturnDocument.html index da906ca0ad5..a242f7fc724 100644 --- a/docs/Next/types/ReturnDocument.html +++ b/docs/Next/types/ReturnDocument.html @@ -1 +1 @@ -ReturnDocument | mongodb

    Type Alias ReturnDocument

    ReturnDocument: typeof ReturnDocument[keyof typeof ReturnDocument]

    Settings

    Member Visibility
    +ReturnDocument | mongodb

    Type Alias ReturnDocument

    ReturnDocument: typeof ReturnDocument[keyof typeof ReturnDocument]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/RunCommandOptions.html b/docs/Next/types/RunCommandOptions.html index 6dcba17beb2..7377aeb5767 100644 --- a/docs/Next/types/RunCommandOptions.html +++ b/docs/Next/types/RunCommandOptions.html @@ -1,3 +1,3 @@ -RunCommandOptions | mongodb

    Type Alias RunCommandOptions

    RunCommandOptions: {
        readPreference?: ReadPreferenceLike;
        session?: ClientSession;
    } & BSONSerializeOptions

    Type declaration

    Settings

    Member Visibility
    diff --git a/docs/Next/types/RunCursorCommandOptions.html b/docs/Next/types/RunCursorCommandOptions.html index ecb661f7fd1..f16d8ceabb3 100644 --- a/docs/Next/types/RunCursorCommandOptions.html +++ b/docs/Next/types/RunCursorCommandOptions.html @@ -1 +1 @@ -RunCursorCommandOptions | mongodb

    Type Alias RunCursorCommandOptions

    RunCursorCommandOptions: {
        readPreference?: ReadPreferenceLike;
        session?: ClientSession;
    } & BSONSerializeOptions

    Settings

    Member Visibility
    +RunCursorCommandOptions | mongodb

    Type Alias RunCursorCommandOptions

    RunCursorCommandOptions: {
        readPreference?: ReadPreferenceLike;
        session?: ClientSession;
    } & BSONSerializeOptions

    Settings

    Member Visibility
    diff --git a/docs/Next/types/SchemaMember.html b/docs/Next/types/SchemaMember.html index 56d6fb50091..81ff7d8b950 100644 --- a/docs/Next/types/SchemaMember.html +++ b/docs/Next/types/SchemaMember.html @@ -1 +1 @@ -SchemaMember | mongodb

    Type Alias SchemaMember<T, V>

    SchemaMember<T, V>: {
        [P in keyof T]?: V
    } | {
        [key: string]: V;
    }

    Type Parameters

    • T
    • V

    Settings

    Member Visibility
    +SchemaMember | mongodb

    Type Alias SchemaMember<T, V>

    SchemaMember<T, V>: {
        [P in keyof T]?: V
    } | {
        [key: string]: V;
    }

    Type Parameters

    • T
    • V

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ServerApiVersion.html b/docs/Next/types/ServerApiVersion.html index 482ef23daa5..e5e5416f0b1 100644 --- a/docs/Next/types/ServerApiVersion.html +++ b/docs/Next/types/ServerApiVersion.html @@ -1 +1 @@ -ServerApiVersion | mongodb

    Type Alias ServerApiVersion

    ServerApiVersion: typeof ServerApiVersion[keyof typeof ServerApiVersion]

    Settings

    Member Visibility
    +ServerApiVersion | mongodb

    Type Alias ServerApiVersion

    ServerApiVersion: typeof ServerApiVersion[keyof typeof ServerApiVersion]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ServerEvents.html b/docs/Next/types/ServerEvents.html index 6f3def51271..f51b84eb60b 100644 --- a/docs/Next/types/ServerEvents.html +++ b/docs/Next/types/ServerEvents.html @@ -1 +1 @@ -ServerEvents | mongodb

    Type Alias ServerEvents

    ServerEvents: {
        closed(): void;
        descriptionReceived(description: ServerDescription): void;
        ended(): void;
        serverHeartbeatFailed(event: ServerHeartbeatFailedEvent): void;
        serverHeartbeatStarted(event: ServerHeartbeatStartedEvent): void;
        serverHeartbeatSucceeded(event: ServerHeartbeatSucceededEvent): void;
    } & ConnectionPoolEvents & EventEmitterWithState

    Settings

    Member Visibility
    +ServerEvents | mongodb

    Type Alias ServerEvents

    ServerEvents: {
        closed(): void;
        descriptionReceived(description: ServerDescription): void;
        ended(): void;
        serverHeartbeatFailed(event: ServerHeartbeatFailedEvent): void;
        serverHeartbeatStarted(event: ServerHeartbeatStartedEvent): void;
        serverHeartbeatSucceeded(event: ServerHeartbeatSucceededEvent): void;
    } & ConnectionPoolEvents & EventEmitterWithState

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ServerMonitoringMode.html b/docs/Next/types/ServerMonitoringMode.html index 01c785c0393..ea515e624e5 100644 --- a/docs/Next/types/ServerMonitoringMode.html +++ b/docs/Next/types/ServerMonitoringMode.html @@ -1 +1 @@ -ServerMonitoringMode | mongodb

    Type Alias ServerMonitoringMode

    ServerMonitoringMode: typeof ServerMonitoringMode[keyof typeof ServerMonitoringMode]

    Settings

    Member Visibility
    +ServerMonitoringMode | mongodb

    Type Alias ServerMonitoringMode

    ServerMonitoringMode: typeof ServerMonitoringMode[keyof typeof ServerMonitoringMode]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ServerSessionId.html b/docs/Next/types/ServerSessionId.html index c9a3271e9ca..f08d828de55 100644 --- a/docs/Next/types/ServerSessionId.html +++ b/docs/Next/types/ServerSessionId.html @@ -1 +1 @@ -ServerSessionId | mongodb

    Type Alias ServerSessionId

    ServerSessionId: {
        id: Binary;
    }

    Settings

    Member Visibility
    +ServerSessionId | mongodb

    Type Alias ServerSessionId

    ServerSessionId: {
        id: Binary;
    }

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ServerType.html b/docs/Next/types/ServerType.html index 6dbd3c318eb..c73228225ae 100644 --- a/docs/Next/types/ServerType.html +++ b/docs/Next/types/ServerType.html @@ -1 +1 @@ -ServerType | mongodb

    Type Alias ServerType

    ServerType: typeof ServerType[keyof typeof ServerType]

    Settings

    Member Visibility
    +ServerType | mongodb

    Type Alias ServerType

    ServerType: typeof ServerType[keyof typeof ServerType]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/SetFields.html b/docs/Next/types/SetFields.html index aea385568ee..b6e86684f3d 100644 --- a/docs/Next/types/SetFields.html +++ b/docs/Next/types/SetFields.html @@ -1 +1 @@ -SetFields | mongodb

    Type Alias SetFields<TSchema>

    SetFields<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any> | undefined>]?: OptionalId<Flatten<TSchema[key]>> | AddToSetOperators<OptionalId<Flatten<TSchema[key]>>[]>
    } & IsAny<TSchema[keyof TSchema], object, NotAcceptedFields<TSchema, ReadonlyArray<any> | undefined>> & {
        [key: string]: AddToSetOperators<any> | any;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +SetFields | mongodb

    Type Alias SetFields<TSchema>

    SetFields<TSchema>: {
        readonly [key in KeysOfAType<TSchema, ReadonlyArray<any> | undefined>]?: OptionalId<Flatten<TSchema[key]>> | AddToSetOperators<OptionalId<Flatten<TSchema[key]>>[]>
    } & IsAny<TSchema[keyof TSchema], object, NotAcceptedFields<TSchema, ReadonlyArray<any> | undefined>> & {
        [key: string]: AddToSetOperators<any> | any;
    }

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/types/SetProfilingLevelOptions.html b/docs/Next/types/SetProfilingLevelOptions.html index 639ddd92f63..cf174770b25 100644 --- a/docs/Next/types/SetProfilingLevelOptions.html +++ b/docs/Next/types/SetProfilingLevelOptions.html @@ -1 +1 @@ -SetProfilingLevelOptions | mongodb

    Type Alias SetProfilingLevelOptions

    SetProfilingLevelOptions: CommandOperationOptions

    Settings

    Member Visibility
    +SetProfilingLevelOptions | mongodb

    Type Alias SetProfilingLevelOptions

    SetProfilingLevelOptions: CommandOperationOptions

    Settings

    Member Visibility
    diff --git a/docs/Next/types/Sort.html b/docs/Next/types/Sort.html index 09e1419ac8c..5dc2a30ad20 100644 --- a/docs/Next/types/Sort.html +++ b/docs/Next/types/Sort.html @@ -1 +1 @@ -Sort | mongodb

    Type Alias Sort

    Sort:
        | string
        | Exclude<SortDirection, {
            $meta: string;
        }>
        | string[]
        | {
            [key: string]: SortDirection;
        }
        | Map<string, SortDirection>
        | [string, SortDirection][]
        | [string, SortDirection]

    Settings

    Member Visibility
    +Sort | mongodb

    Type Alias Sort

    Sort:
        | string
        | Exclude<SortDirection, {
            $meta: string;
        }>
        | string[]
        | {
            [key: string]: SortDirection;
        }
        | Map<string, SortDirection>
        | [string, SortDirection][]
        | [string, SortDirection]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/SortDirection.html b/docs/Next/types/SortDirection.html index 8998d4de4a3..809f464b8ac 100644 --- a/docs/Next/types/SortDirection.html +++ b/docs/Next/types/SortDirection.html @@ -1 +1 @@ -SortDirection | mongodb

    Type Alias SortDirection

    SortDirection:
        | 1
        | -1
        | "asc"
        | "desc"
        | "ascending"
        | "descending"
        | {
            $meta: string;
        }

    Settings

    Member Visibility
    +SortDirection | mongodb

    Type Alias SortDirection

    SortDirection:
        | 1
        | -1
        | "asc"
        | "desc"
        | "ascending"
        | "descending"
        | {
            $meta: string;
        }

    Settings

    Member Visibility
    diff --git a/docs/Next/types/Stream.html b/docs/Next/types/Stream.html index ae8e1daef10..45c50996648 100644 --- a/docs/Next/types/Stream.html +++ b/docs/Next/types/Stream.html @@ -1 +1 @@ -Stream | mongodb

    Type Alias Stream

    Stream: Socket | TLSSocket

    Settings

    Member Visibility
    +Stream | mongodb

    Type Alias Stream

    Stream: Socket | TLSSocket

    Settings

    Member Visibility
    diff --git a/docs/Next/types/StrictFilter.html b/docs/Next/types/StrictFilter.html index db1349dab47..8efe1f6354f 100644 --- a/docs/Next/types/StrictFilter.html +++ b/docs/Next/types/StrictFilter.html @@ -1 +1 @@ -StrictFilter | mongodb

    Type Alias StrictFilter<TSchema>Experimental

    StrictFilter<TSchema>: Partial<TSchema> | {
        [Property in Join<NestedPaths<WithId<TSchema>, []>, ".">]?: Condition<PropertyType<WithId<TSchema>, Property>>
    } & RootFilterOperators<WithId<TSchema>>

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +StrictFilter | mongodb

    Type Alias StrictFilter<TSchema>Experimental

    StrictFilter<TSchema>: Partial<TSchema> | {
        [Property in Join<NestedPaths<WithId<TSchema>, []>, ".">]?: Condition<PropertyType<WithId<TSchema>, Property>>
    } & RootFilterOperators<WithId<TSchema>>

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/types/StrictMatchKeysAndValues.html b/docs/Next/types/StrictMatchKeysAndValues.html index ddb15654965..7733ba94506 100644 --- a/docs/Next/types/StrictMatchKeysAndValues.html +++ b/docs/Next/types/StrictMatchKeysAndValues.html @@ -1 +1 @@ -StrictMatchKeysAndValues | mongodb

    Type Alias StrictMatchKeysAndValues<TSchema>Experimental

    StrictMatchKeysAndValues<TSchema>: Readonly<{
        [Property in Join<NestedPaths<TSchema, []>, ".">]?: PropertyType<TSchema, Property>
    } & {
        [Property in `${NestedPathsOfType<TSchema, any[]>}.$${`[${string}]` | ""}`]?: ArrayElement<PropertyType<TSchema, Property extends `${infer Key}.$${string}`
            ? Key
            : never>>
    } & {
        [Property in `${NestedPathsOfType<TSchema, Record<string, any>[]>}.$${`[${string}]` | ""}.${string}`]?: any
    } & Document>

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +StrictMatchKeysAndValues | mongodb

    Type Alias StrictMatchKeysAndValues<TSchema>Experimental

    StrictMatchKeysAndValues<TSchema>: Readonly<{
        [Property in Join<NestedPaths<TSchema, []>, ".">]?: PropertyType<TSchema, Property>
    } & {
        [Property in `${NestedPathsOfType<TSchema, any[]>}.$${`[${string}]` | ""}`]?: ArrayElement<PropertyType<TSchema, Property extends `${infer Key}.$${string}`
            ? Key
            : never>>
    } & {
        [Property in `${NestedPathsOfType<TSchema, Record<string, any>[]>}.$${`[${string}]` | ""}.${string}`]?: any
    } & Document>

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/types/StrictUpdateFilter.html b/docs/Next/types/StrictUpdateFilter.html index ab6c80ae8b3..39329f51f55 100644 --- a/docs/Next/types/StrictUpdateFilter.html +++ b/docs/Next/types/StrictUpdateFilter.html @@ -1 +1 @@ -StrictUpdateFilter | mongodb

    Type Alias StrictUpdateFilter<TSchema>Experimental

    StrictUpdateFilter<TSchema>: {
        $addToSet?: SetFields<TSchema>;
        $bit?: OnlyFieldsOfType<TSchema, NumericType | undefined, {
            and: IntegerType;
        } | {
            or: IntegerType;
        } | {
            xor: IntegerType;
        }>;
        $currentDate?: OnlyFieldsOfType<TSchema, Date | Timestamp, true | {
            $type: "date" | "timestamp";
        }>;
        $inc?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $max?: StrictMatchKeysAndValues<TSchema>;
        $min?: StrictMatchKeysAndValues<TSchema>;
        $mul?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $pop?: OnlyFieldsOfType<TSchema, ReadonlyArray<any>, 1 | -1>;
        $pull?: PullOperator<TSchema>;
        $pullAll?: PullAllOperator<TSchema>;
        $push?: PushOperator<TSchema>;
        $rename?: Record<string, string>;
        $set?: StrictMatchKeysAndValues<TSchema>;
        $setOnInsert?: StrictMatchKeysAndValues<TSchema>;
        $unset?: OnlyFieldsOfType<TSchema, any, "" | true | 1>;
    } & Document

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +StrictUpdateFilter | mongodb

    Type Alias StrictUpdateFilter<TSchema>Experimental

    StrictUpdateFilter<TSchema>: {
        $addToSet?: SetFields<TSchema>;
        $bit?: OnlyFieldsOfType<TSchema, NumericType | undefined, {
            and: IntegerType;
        } | {
            or: IntegerType;
        } | {
            xor: IntegerType;
        }>;
        $currentDate?: OnlyFieldsOfType<TSchema, Date | Timestamp, true | {
            $type: "date" | "timestamp";
        }>;
        $inc?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $max?: StrictMatchKeysAndValues<TSchema>;
        $min?: StrictMatchKeysAndValues<TSchema>;
        $mul?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $pop?: OnlyFieldsOfType<TSchema, ReadonlyArray<any>, 1 | -1>;
        $pull?: PullOperator<TSchema>;
        $pullAll?: PullAllOperator<TSchema>;
        $push?: PushOperator<TSchema>;
        $rename?: Record<string, string>;
        $set?: StrictMatchKeysAndValues<TSchema>;
        $setOnInsert?: StrictMatchKeysAndValues<TSchema>;
        $unset?: OnlyFieldsOfType<TSchema, any, "" | true | 1>;
    } & Document

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/types/SupportedNodeConnectionOptions.html b/docs/Next/types/SupportedNodeConnectionOptions.html index b593978d22c..cc568919763 100644 --- a/docs/Next/types/SupportedNodeConnectionOptions.html +++ b/docs/Next/types/SupportedNodeConnectionOptions.html @@ -1 +1 @@ -SupportedNodeConnectionOptions | mongodb

    Type Alias SupportedNodeConnectionOptions

    SupportedNodeConnectionOptions: SupportedTLSConnectionOptions & SupportedTLSSocketOptions & SupportedSocketOptions

    Settings

    Member Visibility
    +SupportedNodeConnectionOptions | mongodb

    Type Alias SupportedNodeConnectionOptions

    SupportedNodeConnectionOptions: SupportedTLSConnectionOptions & SupportedTLSSocketOptions & SupportedSocketOptions

    Settings

    Member Visibility
    diff --git a/docs/Next/types/SupportedSocketOptions.html b/docs/Next/types/SupportedSocketOptions.html index 21da66e5961..2c4c765175a 100644 --- a/docs/Next/types/SupportedSocketOptions.html +++ b/docs/Next/types/SupportedSocketOptions.html @@ -1 +1 @@ -SupportedSocketOptions | mongodb

    Type Alias SupportedSocketOptions

    SupportedSocketOptions: Pick<TcpNetConnectOpts & {
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
    }, typeof LEGAL_TCP_SOCKET_OPTIONS[number]>

    Settings

    Member Visibility
    +SupportedSocketOptions | mongodb

    Type Alias SupportedSocketOptions

    SupportedSocketOptions: Pick<TcpNetConnectOpts & {
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
    }, typeof LEGAL_TCP_SOCKET_OPTIONS[number]>

    Settings

    Member Visibility
    diff --git a/docs/Next/types/SupportedTLSConnectionOptions.html b/docs/Next/types/SupportedTLSConnectionOptions.html index 20ad6d59c3f..b890dbed4b6 100644 --- a/docs/Next/types/SupportedTLSConnectionOptions.html +++ b/docs/Next/types/SupportedTLSConnectionOptions.html @@ -1 +1 @@ -SupportedTLSConnectionOptions | mongodb

    Type Alias SupportedTLSConnectionOptions

    SupportedTLSConnectionOptions: Pick<TLSConnectionOptions & {
        allowPartialTrustChain?: boolean;
    }, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>

    Settings

    Member Visibility
    +SupportedTLSConnectionOptions | mongodb

    Type Alias SupportedTLSConnectionOptions

    SupportedTLSConnectionOptions: Pick<TLSConnectionOptions & {
        allowPartialTrustChain?: boolean;
    }, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>

    Settings

    Member Visibility
    diff --git a/docs/Next/types/SupportedTLSSocketOptions.html b/docs/Next/types/SupportedTLSSocketOptions.html index e501e0b4ed2..8e7d0181e54 100644 --- a/docs/Next/types/SupportedTLSSocketOptions.html +++ b/docs/Next/types/SupportedTLSSocketOptions.html @@ -1 +1 @@ -SupportedTLSSocketOptions | mongodb

    Type Alias SupportedTLSSocketOptions

    SupportedTLSSocketOptions: Pick<TLSSocketOptions, Extract<keyof TLSSocketOptions, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>>

    Settings

    Member Visibility
    +SupportedTLSSocketOptions | mongodb

    Type Alias SupportedTLSSocketOptions

    SupportedTLSSocketOptions: Pick<TLSSocketOptions, Extract<keyof TLSSocketOptions, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>>

    Settings

    Member Visibility
    diff --git a/docs/Next/types/TagSet.html b/docs/Next/types/TagSet.html index 6c98028e751..db183e5e3d3 100644 --- a/docs/Next/types/TagSet.html +++ b/docs/Next/types/TagSet.html @@ -1 +1 @@ -TagSet | mongodb

    Type Alias TagSet

    TagSet: {
        [key: string]: string;
    }

    Settings

    Member Visibility
    +TagSet | mongodb

    Type Alias TagSet

    TagSet: {
        [key: string]: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/Next/types/TopologyEvents.html b/docs/Next/types/TopologyEvents.html index db684858904..c3bb4b80e55 100644 --- a/docs/Next/types/TopologyEvents.html +++ b/docs/Next/types/TopologyEvents.html @@ -1 +1 @@ -TopologyEvents | mongodb

    Type Alias TopologyEvents

    TopologyEvents: {
        close(): void;
        error(error: Error): void;
        serverClosed(event: ServerClosedEvent): void;
        serverDescriptionChanged(event: ServerDescriptionChangedEvent): void;
        serverOpening(event: ServerOpeningEvent): void;
        timeout(): void;
        topologyClosed(event: TopologyClosedEvent): void;
        topologyDescriptionChanged(event: TopologyDescriptionChangedEvent): void;
        topologyOpening(event: TopologyOpeningEvent): void;
    } & Omit<ServerEvents, "connect"> & ConnectionPoolEvents & ConnectionEvents & EventEmitterWithState

    Settings

    Member Visibility
    +TopologyEvents | mongodb

    Type Alias TopologyEvents

    TopologyEvents: {
        close(): void;
        error(error: Error): void;
        serverClosed(event: ServerClosedEvent): void;
        serverDescriptionChanged(event: ServerDescriptionChangedEvent): void;
        serverOpening(event: ServerOpeningEvent): void;
        timeout(): void;
        topologyClosed(event: TopologyClosedEvent): void;
        topologyDescriptionChanged(event: TopologyDescriptionChangedEvent): void;
        topologyOpening(event: TopologyOpeningEvent): void;
    } & Omit<ServerEvents, "connect"> & ConnectionPoolEvents & ConnectionEvents & EventEmitterWithState

    Settings

    Member Visibility
    diff --git a/docs/Next/types/TopologyType.html b/docs/Next/types/TopologyType.html index 2a3ec21f32e..3b3ccc658ff 100644 --- a/docs/Next/types/TopologyType.html +++ b/docs/Next/types/TopologyType.html @@ -1 +1 @@ -TopologyType | mongodb

    Type Alias TopologyType

    TopologyType: typeof TopologyType[keyof typeof TopologyType]

    Settings

    Member Visibility
    +TopologyType | mongodb

    Type Alias TopologyType

    TopologyType: typeof TopologyType[keyof typeof TopologyType]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/UpdateFilter.html b/docs/Next/types/UpdateFilter.html index 57780312fca..ebc91a268c8 100644 --- a/docs/Next/types/UpdateFilter.html +++ b/docs/Next/types/UpdateFilter.html @@ -1 +1 @@ -UpdateFilter | mongodb

    Type Alias UpdateFilter<TSchema>

    UpdateFilter<TSchema>: {
        $addToSet?: SetFields<TSchema>;
        $bit?: OnlyFieldsOfType<TSchema, NumericType | undefined, {
            and: IntegerType;
        } | {
            or: IntegerType;
        } | {
            xor: IntegerType;
        }>;
        $currentDate?: OnlyFieldsOfType<TSchema, Date | Timestamp, true | {
            $type: "date" | "timestamp";
        }>;
        $inc?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $max?: MatchKeysAndValues<TSchema>;
        $min?: MatchKeysAndValues<TSchema>;
        $mul?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $pop?: OnlyFieldsOfType<TSchema, ReadonlyArray<any>, 1 | -1>;
        $pull?: PullOperator<TSchema>;
        $pullAll?: PullAllOperator<TSchema>;
        $push?: PushOperator<TSchema>;
        $rename?: Record<string, string>;
        $set?: MatchKeysAndValues<TSchema>;
        $setOnInsert?: MatchKeysAndValues<TSchema>;
        $unset?: OnlyFieldsOfType<TSchema, any, "" | true | 1>;
    } & Document

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +UpdateFilter | mongodb

    Type Alias UpdateFilter<TSchema>

    UpdateFilter<TSchema>: {
        $addToSet?: SetFields<TSchema>;
        $bit?: OnlyFieldsOfType<TSchema, NumericType | undefined, {
            and: IntegerType;
        } | {
            or: IntegerType;
        } | {
            xor: IntegerType;
        }>;
        $currentDate?: OnlyFieldsOfType<TSchema, Date | Timestamp, true | {
            $type: "date" | "timestamp";
        }>;
        $inc?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $max?: MatchKeysAndValues<TSchema>;
        $min?: MatchKeysAndValues<TSchema>;
        $mul?: OnlyFieldsOfType<TSchema, NumericType | undefined>;
        $pop?: OnlyFieldsOfType<TSchema, ReadonlyArray<any>, 1 | -1>;
        $pull?: PullOperator<TSchema>;
        $pullAll?: PullAllOperator<TSchema>;
        $push?: PushOperator<TSchema>;
        $rename?: Record<string, string>;
        $set?: MatchKeysAndValues<TSchema>;
        $setOnInsert?: MatchKeysAndValues<TSchema>;
        $unset?: OnlyFieldsOfType<TSchema, any, "" | true | 1>;
    } & Document

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/types/W.html b/docs/Next/types/W.html index 33f6c3b24ad..714812d140d 100644 --- a/docs/Next/types/W.html +++ b/docs/Next/types/W.html @@ -1 +1 @@ -W | mongodb

    Type Alias W

    W: number | "majority"

    Settings

    Member Visibility
    +W | mongodb

    Type Alias W

    W: number | "majority"

    Settings

    Member Visibility
    diff --git a/docs/Next/types/WithId.html b/docs/Next/types/WithId.html index 29bb8ddb605..75c172e4333 100644 --- a/docs/Next/types/WithId.html +++ b/docs/Next/types/WithId.html @@ -1,2 +1,2 @@ -WithId | mongodb

    Type Alias WithId<TSchema>

    WithId<TSchema>: EnhancedOmit<TSchema, "_id"> & {
        _id: InferIdType<TSchema>;
    }

    Add an _id field to an object shaped type

    -

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +WithId | mongodb

    Type Alias WithId<TSchema>

    WithId<TSchema>: EnhancedOmit<TSchema, "_id"> & {
        _id: InferIdType<TSchema>;
    }

    Add an _id field to an object shaped type

    +

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/types/WithSessionCallback.html b/docs/Next/types/WithSessionCallback.html index e0583d39d64..d9dcfe7571f 100644 --- a/docs/Next/types/WithSessionCallback.html +++ b/docs/Next/types/WithSessionCallback.html @@ -1 +1 @@ -WithSessionCallback | mongodb

    Type Alias WithSessionCallback<T>

    WithSessionCallback<T>: ((session: ClientSession) => Promise<T>)

    Type Parameters

    • T = unknown

    Settings

    Member Visibility
    +WithSessionCallback | mongodb

    Type Alias WithSessionCallback<T>

    WithSessionCallback<T>: ((session: ClientSession) => Promise<T>)

    Type Parameters

    • T = unknown

    Settings

    Member Visibility
    diff --git a/docs/Next/types/WithTransactionCallback.html b/docs/Next/types/WithTransactionCallback.html index 4c09c2aa6df..2b74c347bc1 100644 --- a/docs/Next/types/WithTransactionCallback.html +++ b/docs/Next/types/WithTransactionCallback.html @@ -1 +1 @@ -WithTransactionCallback | mongodb

    Type Alias WithTransactionCallback<T>

    WithTransactionCallback<T>: ((session: ClientSession) => Promise<T>)

    Type Parameters

    • T = any

    Settings

    Member Visibility
    +WithTransactionCallback | mongodb

    Type Alias WithTransactionCallback<T>

    WithTransactionCallback<T>: ((session: ClientSession) => Promise<T>)

    Type Parameters

    • T = any

    Settings

    Member Visibility
    diff --git a/docs/Next/types/WithoutId.html b/docs/Next/types/WithoutId.html index 09df72a1f00..6ea70410909 100644 --- a/docs/Next/types/WithoutId.html +++ b/docs/Next/types/WithoutId.html @@ -1,2 +1,2 @@ -WithoutId | mongodb

    Type Alias WithoutId<TSchema>

    WithoutId<TSchema>: Omit<TSchema, "_id">

    Remove the _id field from an object shaped type

    -

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    +WithoutId | mongodb

    Type Alias WithoutId<TSchema>

    WithoutId<TSchema>: Omit<TSchema, "_id">

    Remove the _id field from an object shaped type

    +

    Type Parameters

    • TSchema

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/AuthMechanism-1.html b/docs/Next/variables/AuthMechanism-1.html index 732733b8b5d..129ab7672ab 100644 --- a/docs/Next/variables/AuthMechanism-1.html +++ b/docs/Next/variables/AuthMechanism-1.html @@ -1 +1 @@ -AuthMechanism | mongodb

    Variable AuthMechanismConst

    AuthMechanism: Readonly<{
        MONGODB_AWS: "MONGODB-AWS";
        MONGODB_CR: "MONGODB-CR";
        MONGODB_DEFAULT: "DEFAULT";
        MONGODB_GSSAPI: "GSSAPI";
        MONGODB_OIDC: "MONGODB-OIDC";
        MONGODB_PLAIN: "PLAIN";
        MONGODB_SCRAM_SHA1: "SCRAM-SHA-1";
        MONGODB_SCRAM_SHA256: "SCRAM-SHA-256";
        MONGODB_X509: "MONGODB-X509";
    }> = ...

    Settings

    Member Visibility
    +AuthMechanism | mongodb

    Variable AuthMechanismConst

    AuthMechanism: Readonly<{
        MONGODB_AWS: "MONGODB-AWS";
        MONGODB_CR: "MONGODB-CR";
        MONGODB_DEFAULT: "DEFAULT";
        MONGODB_GSSAPI: "GSSAPI";
        MONGODB_OIDC: "MONGODB-OIDC";
        MONGODB_PLAIN: "PLAIN";
        MONGODB_SCRAM_SHA1: "SCRAM-SHA-1";
        MONGODB_SCRAM_SHA256: "SCRAM-SHA-256";
        MONGODB_X509: "MONGODB-X509";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/AutoEncryptionLoggerLevel-1.html b/docs/Next/variables/AutoEncryptionLoggerLevel-1.html index de7adccea2e..345b13efef7 100644 --- a/docs/Next/variables/AutoEncryptionLoggerLevel-1.html +++ b/docs/Next/variables/AutoEncryptionLoggerLevel-1.html @@ -1 +1 @@ -AutoEncryptionLoggerLevel | mongodb

    Variable AutoEncryptionLoggerLevelConst

    AutoEncryptionLoggerLevel: Readonly<{
        Error: 1;
        FatalError: 0;
        Info: 3;
        Trace: 4;
        Warning: 2;
    }> = ...

    Settings

    Member Visibility
    +AutoEncryptionLoggerLevel | mongodb

    Variable AutoEncryptionLoggerLevelConst

    AutoEncryptionLoggerLevel: Readonly<{
        Error: 1;
        FatalError: 0;
        Info: 3;
        Trace: 4;
        Warning: 2;
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/BSON.BSONType-1.html b/docs/Next/variables/BSON.BSONType-1.html index 0207270c159..782485e99c0 100644 --- a/docs/Next/variables/BSON.BSONType-1.html +++ b/docs/Next/variables/BSON.BSONType-1.html @@ -1 +1 @@ -BSONType | mongodb

    Variable BSONTypeConst

    BSONType: Readonly<{
        array: 4;
        binData: 5;
        bool: 8;
        date: 9;
        dbPointer: 12;
        decimal: 19;
        double: 1;
        int: 16;
        javascript: 13;
        javascriptWithScope: 15;
        long: 18;
        maxKey: 127;
        minKey: -1;
        null: 10;
        object: 3;
        objectId: 7;
        regex: 11;
        string: 2;
        symbol: 14;
        timestamp: 17;
        undefined: 6;
    }>

    Settings

    Member Visibility
    +BSONType | mongodb

    Variable BSONTypeConst

    BSONType: Readonly<{
        array: 4;
        binData: 5;
        bool: 8;
        date: 9;
        dbPointer: 12;
        decimal: 19;
        double: 1;
        int: 16;
        javascript: 13;
        javascriptWithScope: 15;
        long: 18;
        maxKey: 127;
        minKey: -1;
        null: 10;
        object: 3;
        objectId: 7;
        regex: 11;
        string: 2;
        symbol: 14;
        timestamp: 17;
        undefined: 6;
    }>

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/BSON.EJSON.html b/docs/Next/variables/BSON.EJSON.html index 2c5d7979fce..8d02df6652d 100644 --- a/docs/Next/variables/BSON.EJSON.html +++ b/docs/Next/variables/BSON.EJSON.html @@ -1 +1 @@ -EJSON | mongodb

    Variable EJSONConst

    EJSON: {
        deserialize: typeof EJSONdeserialize;
        parse: typeof parse;
        serialize: typeof EJSONserialize;
        stringify: typeof stringify;
    }

    Settings

    Member Visibility
    +EJSON | mongodb

    Variable EJSONConst

    EJSON: {
        deserialize: typeof EJSONdeserialize;
        parse: typeof parse;
        serialize: typeof EJSONserialize;
        stringify: typeof stringify;
    }

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/BSON.LongWithoutOverridesClass.html b/docs/Next/variables/BSON.LongWithoutOverridesClass.html index f405d249383..41c25b68c39 100644 --- a/docs/Next/variables/BSON.LongWithoutOverridesClass.html +++ b/docs/Next/variables/BSON.LongWithoutOverridesClass.html @@ -1 +1 @@ -LongWithoutOverridesClass | mongodb

    Variable LongWithoutOverridesClassConst

    LongWithoutOverridesClass: LongWithoutOverrides

    Settings

    Member Visibility
    +LongWithoutOverridesClass | mongodb

    Variable LongWithoutOverridesClassConst

    LongWithoutOverridesClass: LongWithoutOverrides

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/BSON.onDemand-1.html b/docs/Next/variables/BSON.onDemand-1.html index 5ef89229b6d..4d9bad1571b 100644 --- a/docs/Next/variables/BSON.onDemand-1.html +++ b/docs/Next/variables/BSON.onDemand-1.html @@ -1 +1 @@ -onDemand | mongodb

    Variable onDemandConst Experimental

    onDemand: OnDemand

    Settings

    Member Visibility
    +onDemand | mongodb

    Variable onDemandConst Experimental

    onDemand: OnDemand

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/BatchType-1.html b/docs/Next/variables/BatchType-1.html index a8186f26e2b..2d1d7e35518 100644 --- a/docs/Next/variables/BatchType-1.html +++ b/docs/Next/variables/BatchType-1.html @@ -1 +1 @@ -BatchType | mongodb

    Variable BatchTypeConst

    BatchType: Readonly<{
        DELETE: 3;
        INSERT: 1;
        UPDATE: 2;
    }> = ...

    Settings

    Member Visibility
    +BatchType | mongodb

    Variable BatchTypeConst

    BatchType: Readonly<{
        DELETE: 3;
        INSERT: 1;
        UPDATE: 2;
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/CURSOR_FLAGS.html b/docs/Next/variables/CURSOR_FLAGS.html index 8a0cb79e1f7..1f671c5d74e 100644 --- a/docs/Next/variables/CURSOR_FLAGS.html +++ b/docs/Next/variables/CURSOR_FLAGS.html @@ -1 +1 @@ -CURSOR_FLAGS | mongodb

    Variable CURSOR_FLAGSConst

    CURSOR_FLAGS: readonly ["tailable", "oplogReplay", "noCursorTimeout", "awaitData", "exhaust", "partial"] = ...

    Settings

    Member Visibility
    +CURSOR_FLAGS | mongodb

    Variable CURSOR_FLAGSConst

    CURSOR_FLAGS: readonly ["tailable", "oplogReplay", "noCursorTimeout", "awaitData", "exhaust", "partial"] = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/Compressor-1.html b/docs/Next/variables/Compressor-1.html index 1646623cc77..53d97b38606 100644 --- a/docs/Next/variables/Compressor-1.html +++ b/docs/Next/variables/Compressor-1.html @@ -1 +1 @@ -Compressor | mongodb

    Variable CompressorConst

    Compressor: Readonly<{
        none: 0;
        snappy: 1;
        zlib: 2;
        zstd: 3;
    }> = ...

    Settings

    Member Visibility
    +Compressor | mongodb

    Variable CompressorConst

    Compressor: Readonly<{
        none: 0;
        snappy: 1;
        zlib: 2;
        zstd: 3;
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/ExplainVerbosity-1.html b/docs/Next/variables/ExplainVerbosity-1.html index e116a390c74..4be767c6c58 100644 --- a/docs/Next/variables/ExplainVerbosity-1.html +++ b/docs/Next/variables/ExplainVerbosity-1.html @@ -1 +1 @@ -ExplainVerbosity | mongodb

    Variable ExplainVerbosityConst

    ExplainVerbosity: Readonly<{
        allPlansExecution: "allPlansExecution";
        executionStats: "executionStats";
        queryPlanner: "queryPlanner";
        queryPlannerExtended: "queryPlannerExtended";
    }> = ...

    Settings

    Member Visibility
    +ExplainVerbosity | mongodb

    Variable ExplainVerbosityConst

    ExplainVerbosity: Readonly<{
        allPlansExecution: "allPlansExecution";
        executionStats: "executionStats";
        queryPlanner: "queryPlanner";
        queryPlannerExtended: "queryPlannerExtended";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/GSSAPICanonicalizationValue-1.html b/docs/Next/variables/GSSAPICanonicalizationValue-1.html index 49a72fd94bc..3977a84c6f2 100644 --- a/docs/Next/variables/GSSAPICanonicalizationValue-1.html +++ b/docs/Next/variables/GSSAPICanonicalizationValue-1.html @@ -1 +1 @@ -GSSAPICanonicalizationValue | mongodb

    Variable GSSAPICanonicalizationValueConst

    GSSAPICanonicalizationValue: Readonly<{
        forward: "forward";
        forwardAndReverse: "forwardAndReverse";
        none: "none";
        off: false;
        on: true;
    }> = ...

    Settings

    Member Visibility
    +GSSAPICanonicalizationValue | mongodb

    Variable GSSAPICanonicalizationValueConst

    GSSAPICanonicalizationValue: Readonly<{
        forward: "forward";
        forwardAndReverse: "forwardAndReverse";
        none: "none";
        off: false;
        on: true;
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/LEGAL_TCP_SOCKET_OPTIONS.html b/docs/Next/variables/LEGAL_TCP_SOCKET_OPTIONS.html index b5b6f067361..f7396aa26ec 100644 --- a/docs/Next/variables/LEGAL_TCP_SOCKET_OPTIONS.html +++ b/docs/Next/variables/LEGAL_TCP_SOCKET_OPTIONS.html @@ -1 +1 @@ -LEGAL_TCP_SOCKET_OPTIONS | mongodb

    Variable LEGAL_TCP_SOCKET_OPTIONSConst

    LEGAL_TCP_SOCKET_OPTIONS: readonly ["autoSelectFamily", "autoSelectFamilyAttemptTimeout", "family", "hints", "localAddress", "localPort", "lookup"] = ...

    Settings

    Member Visibility
    +LEGAL_TCP_SOCKET_OPTIONS | mongodb

    Variable LEGAL_TCP_SOCKET_OPTIONSConst

    LEGAL_TCP_SOCKET_OPTIONS: readonly ["autoSelectFamily", "autoSelectFamilyAttemptTimeout", "family", "hints", "localAddress", "localPort", "lookup"] = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/LEGAL_TLS_SOCKET_OPTIONS.html b/docs/Next/variables/LEGAL_TLS_SOCKET_OPTIONS.html index 1843a62f729..0c2afc513cd 100644 --- a/docs/Next/variables/LEGAL_TLS_SOCKET_OPTIONS.html +++ b/docs/Next/variables/LEGAL_TLS_SOCKET_OPTIONS.html @@ -1 +1 @@ -LEGAL_TLS_SOCKET_OPTIONS | mongodb

    Variable LEGAL_TLS_SOCKET_OPTIONSConst

    LEGAL_TLS_SOCKET_OPTIONS: readonly ["allowPartialTrustChain", "ALPNProtocols", "ca", "cert", "checkServerIdentity", "ciphers", "crl", "ecdhCurve", "key", "minDHSize", "passphrase", "pfx", "rejectUnauthorized", "secureContext", "secureProtocol", "servername", "session"] = ...

    Settings

    Member Visibility
    +LEGAL_TLS_SOCKET_OPTIONS | mongodb

    Variable LEGAL_TLS_SOCKET_OPTIONSConst

    LEGAL_TLS_SOCKET_OPTIONS: readonly ["allowPartialTrustChain", "ALPNProtocols", "ca", "cert", "checkServerIdentity", "ciphers", "crl", "ecdhCurve", "key", "minDHSize", "passphrase", "pfx", "rejectUnauthorized", "secureContext", "secureProtocol", "servername", "session"] = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/MONGO_CLIENT_EVENTS.html b/docs/Next/variables/MONGO_CLIENT_EVENTS.html index faa090db8c8..52a3d491af3 100644 --- a/docs/Next/variables/MONGO_CLIENT_EVENTS.html +++ b/docs/Next/variables/MONGO_CLIENT_EVENTS.html @@ -1 +1 @@ -MONGO_CLIENT_EVENTS | mongodb

    Variable MONGO_CLIENT_EVENTSConst

    MONGO_CLIENT_EVENTS: readonly ["connectionPoolCreated", "connectionPoolReady", "connectionPoolCleared", "connectionPoolClosed", "connectionCreated", "connectionReady", "connectionClosed", "connectionCheckOutStarted", "connectionCheckOutFailed", "connectionCheckedOut", "connectionCheckedIn", "commandStarted", "commandSucceeded", "commandFailed", "serverOpening", "serverClosed", "serverDescriptionChanged", "topologyOpening", "topologyClosed", "topologyDescriptionChanged", "error", "timeout", "close", "serverHeartbeatStarted", "serverHeartbeatSucceeded", "serverHeartbeatFailed"] = ...

    Settings

    Member Visibility
    +MONGO_CLIENT_EVENTS | mongodb

    Variable MONGO_CLIENT_EVENTSConst

    MONGO_CLIENT_EVENTS: readonly ["connectionPoolCreated", "connectionPoolReady", "connectionPoolCleared", "connectionPoolClosed", "connectionCreated", "connectionReady", "connectionClosed", "connectionCheckOutStarted", "connectionCheckOutFailed", "connectionCheckedOut", "connectionCheckedIn", "commandStarted", "commandSucceeded", "commandFailed", "serverOpening", "serverClosed", "serverDescriptionChanged", "topologyOpening", "topologyClosed", "topologyDescriptionChanged", "error", "timeout", "close", "serverHeartbeatStarted", "serverHeartbeatSucceeded", "serverHeartbeatFailed"] = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/MongoErrorLabel-1.html b/docs/Next/variables/MongoErrorLabel-1.html index c92dcd565f2..bde7f85cb7a 100644 --- a/docs/Next/variables/MongoErrorLabel-1.html +++ b/docs/Next/variables/MongoErrorLabel-1.html @@ -1 +1 @@ -MongoErrorLabel | mongodb

    Variable MongoErrorLabelConst

    MongoErrorLabel: Readonly<{
        HandshakeError: "HandshakeError";
        InterruptInUseConnections: "InterruptInUseConnections";
        NoWritesPerformed: "NoWritesPerformed";
        PoolRequstedRetry: "PoolRequstedRetry";
        ResetPool: "ResetPool";
        ResumableChangeStreamError: "ResumableChangeStreamError";
        RetryableWriteError: "RetryableWriteError";
        TransientTransactionError: "TransientTransactionError";
        UnknownTransactionCommitResult: "UnknownTransactionCommitResult";
    }> = ...

    Settings

    Member Visibility
    +MongoErrorLabel | mongodb

    Variable MongoErrorLabelConst

    MongoErrorLabel: Readonly<{
        HandshakeError: "HandshakeError";
        InterruptInUseConnections: "InterruptInUseConnections";
        NoWritesPerformed: "NoWritesPerformed";
        PoolRequstedRetry: "PoolRequstedRetry";
        ResetPool: "ResetPool";
        ResumableChangeStreamError: "ResumableChangeStreamError";
        RetryableWriteError: "RetryableWriteError";
        TransientTransactionError: "TransientTransactionError";
        UnknownTransactionCommitResult: "UnknownTransactionCommitResult";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/ProfilingLevel-1.html b/docs/Next/variables/ProfilingLevel-1.html index 80881e80d42..8dc90ea3ea3 100644 --- a/docs/Next/variables/ProfilingLevel-1.html +++ b/docs/Next/variables/ProfilingLevel-1.html @@ -1 +1 @@ -ProfilingLevel | mongodb

    Variable ProfilingLevelConst

    ProfilingLevel: Readonly<{
        all: "all";
        off: "off";
        slowOnly: "slow_only";
    }> = ...

    Settings

    Member Visibility
    +ProfilingLevel | mongodb

    Variable ProfilingLevelConst

    ProfilingLevel: Readonly<{
        all: "all";
        off: "off";
        slowOnly: "slow_only";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/ReadConcernLevel-1.html b/docs/Next/variables/ReadConcernLevel-1.html index 439570c034d..3c5b5536ee6 100644 --- a/docs/Next/variables/ReadConcernLevel-1.html +++ b/docs/Next/variables/ReadConcernLevel-1.html @@ -1 +1 @@ -ReadConcernLevel | mongodb

    Variable ReadConcernLevelConst

    ReadConcernLevel: Readonly<{
        available: "available";
        linearizable: "linearizable";
        local: "local";
        majority: "majority";
        snapshot: "snapshot";
    }> = ...

    Settings

    Member Visibility
    +ReadConcernLevel | mongodb

    Variable ReadConcernLevelConst

    ReadConcernLevel: Readonly<{
        available: "available";
        linearizable: "linearizable";
        local: "local";
        majority: "majority";
        snapshot: "snapshot";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/ReadPreferenceMode-1.html b/docs/Next/variables/ReadPreferenceMode-1.html index c141a0b7c55..b5c5a703bbf 100644 --- a/docs/Next/variables/ReadPreferenceMode-1.html +++ b/docs/Next/variables/ReadPreferenceMode-1.html @@ -1 +1 @@ -ReadPreferenceMode | mongodb

    Variable ReadPreferenceModeConst

    ReadPreferenceMode: Readonly<{
        nearest: "nearest";
        primary: "primary";
        primaryPreferred: "primaryPreferred";
        secondary: "secondary";
        secondaryPreferred: "secondaryPreferred";
    }> = ...

    Settings

    Member Visibility
    +ReadPreferenceMode | mongodb

    Variable ReadPreferenceModeConst

    ReadPreferenceMode: Readonly<{
        nearest: "nearest";
        primary: "primary";
        primaryPreferred: "primaryPreferred";
        secondary: "secondary";
        secondaryPreferred: "secondaryPreferred";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/ReturnDocument-1.html b/docs/Next/variables/ReturnDocument-1.html index cd6b8eafe65..7c0127a2a5a 100644 --- a/docs/Next/variables/ReturnDocument-1.html +++ b/docs/Next/variables/ReturnDocument-1.html @@ -1 +1 @@ -ReturnDocument | mongodb

    Variable ReturnDocumentConst

    ReturnDocument: Readonly<{
        AFTER: "after";
        BEFORE: "before";
    }> = ...

    Settings

    Member Visibility
    +ReturnDocument | mongodb

    Variable ReturnDocumentConst

    ReturnDocument: Readonly<{
        AFTER: "after";
        BEFORE: "before";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/ServerApiVersion-1.html b/docs/Next/variables/ServerApiVersion-1.html index 7cdedf63e05..5263c664012 100644 --- a/docs/Next/variables/ServerApiVersion-1.html +++ b/docs/Next/variables/ServerApiVersion-1.html @@ -1 +1 @@ -ServerApiVersion | mongodb

    Variable ServerApiVersionConst

    ServerApiVersion: Readonly<{
        v1: "1";
    }> = ...

    Settings

    Member Visibility
    +ServerApiVersion | mongodb

    Variable ServerApiVersionConst

    ServerApiVersion: Readonly<{
        v1: "1";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/ServerMonitoringMode-1.html b/docs/Next/variables/ServerMonitoringMode-1.html index 9ba6cd9d2c4..768074f8352 100644 --- a/docs/Next/variables/ServerMonitoringMode-1.html +++ b/docs/Next/variables/ServerMonitoringMode-1.html @@ -1 +1 @@ -ServerMonitoringMode | mongodb

    Variable ServerMonitoringModeConst

    ServerMonitoringMode: Readonly<{
        auto: "auto";
        poll: "poll";
        stream: "stream";
    }> = ...

    Settings

    Member Visibility
    +ServerMonitoringMode | mongodb

    Variable ServerMonitoringModeConst

    ServerMonitoringMode: Readonly<{
        auto: "auto";
        poll: "poll";
        stream: "stream";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/ServerType-1.html b/docs/Next/variables/ServerType-1.html index 80441e1e81e..184726b3c7d 100644 --- a/docs/Next/variables/ServerType-1.html +++ b/docs/Next/variables/ServerType-1.html @@ -1,2 +1,2 @@ -ServerType | mongodb

    Variable ServerTypeConst

    ServerType: Readonly<{
        LoadBalancer: "LoadBalancer";
        Mongos: "Mongos";
        PossiblePrimary: "PossiblePrimary";
        RSArbiter: "RSArbiter";
        RSGhost: "RSGhost";
        RSOther: "RSOther";
        RSPrimary: "RSPrimary";
        RSSecondary: "RSSecondary";
        Standalone: "Standalone";
        Unknown: "Unknown";
    }> = ...

    An enumeration of server types we know about

    -

    Settings

    Member Visibility
    +ServerType | mongodb

    Variable ServerTypeConst

    ServerType: Readonly<{
        LoadBalancer: "LoadBalancer";
        Mongos: "Mongos";
        PossiblePrimary: "PossiblePrimary";
        RSArbiter: "RSArbiter";
        RSGhost: "RSGhost";
        RSOther: "RSOther";
        RSPrimary: "RSPrimary";
        RSSecondary: "RSSecondary";
        Standalone: "Standalone";
        Unknown: "Unknown";
    }> = ...

    An enumeration of server types we know about

    +

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/TopologyType-1.html b/docs/Next/variables/TopologyType-1.html index d483d005696..47a80375bcf 100644 --- a/docs/Next/variables/TopologyType-1.html +++ b/docs/Next/variables/TopologyType-1.html @@ -1,2 +1,2 @@ -TopologyType | mongodb

    Variable TopologyTypeConst

    TopologyType: Readonly<{
        LoadBalanced: "LoadBalanced";
        ReplicaSetNoPrimary: "ReplicaSetNoPrimary";
        ReplicaSetWithPrimary: "ReplicaSetWithPrimary";
        Sharded: "Sharded";
        Single: "Single";
        Unknown: "Unknown";
    }> = ...

    An enumeration of topology types we know about

    -

    Settings

    Member Visibility
    +TopologyType | mongodb

    Variable TopologyTypeConst

    TopologyType: Readonly<{
        LoadBalanced: "LoadBalanced";
        ReplicaSetNoPrimary: "ReplicaSetNoPrimary";
        ReplicaSetWithPrimary: "ReplicaSetWithPrimary";
        Sharded: "Sharded";
        Single: "Single";
        Unknown: "Unknown";
    }> = ...

    An enumeration of topology types we know about

    +

    Settings

    Member Visibility