diff --git a/docs/Next/classes/ClientSession.html b/docs/Next/classes/ClientSession.html index 4c3b9d35ddf..8cf1fbf84aa 100644 --- a/docs/Next/classes/ClientSession.html +++ b/docs/Next/classes/ClientSession.html @@ -10,45 +10,45 @@

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

-

Accessors

Accessors

Methods

Methods

Returns void

Returns void

Returns boolean

Returns void

stackTraceLimit: number

Accessors

Methods

Methods

stackTraceLimit: number

Accessors

Methods

Methods

stackTraceLimit: number

Accessors

Methods

Methods

Hierarchy

Index

Constructors

Properties

cause?: Error
code?: string | number
+

Parameters

Returns MongoBulkWriteError

Properties

cause?: Error
code?: string | number

This is a number in MongoServerError and a string in MongoDriverError

privateremarks

Define the type override on the subclasses when we can use the override keyword

-
codeName?: string
connectionGeneration?: number
errInfo?: Document
message: string
ok?: number
stack?: string
topologyVersion?: TopologyVersion
writeConcernError?: Document
writeErrors: OneOrMore<WriteError> = []
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any
+
codeName?: string
connectionGeneration?: number
errInfo?: Document
message: string
ok?: number
stack?: string
topologyVersion?: TopologyVersion
writeConcernError?: Document
writeErrors: OneOrMore<WriteError> = []
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

Type declaration

stackTraceLimit: number

Accessors

  • get deletedCount(): number
  • get errmsg(): string
  • +

    Returns number

  • get errmsg(): string
  • Legacy name for server error responses

    -

    Returns string

  • get errorLabels(): string[]
  • Returns string[]

  • get insertedCount(): number
  • get errorLabels(): string[]
  • Returns string[]

  • get insertedCount(): number
  • get insertedIds(): {}
  • Inserted document generated Id's, hash key is the index of the originating operation

    @@ -26,7 +26,7 @@

    Number of documents upserted.

    Returns number

  • get upsertedIds(): {}
  • Upserted document generated Id's, hash key is the index of the originating operation

    -

    Returns {}

    • [key: number]: any

Methods

  • addErrorLabel(label: string): void
  • hasErrorLabel(label: string): boolean

Methods

  • addErrorLabel(label: string): void
  • hasErrorLabel(label: string): boolean
stackTraceLimit: number

Accessors

  • get errmsg(): string
  • Legacy name for server error responses

    -

    Returns string

  • get errorLabels(): string[]
  • Returns string[]

  • get name(): string

Methods

  • addErrorLabel(label: string): void
  • hasErrorLabel(label: string): boolean
  • get errorLabels(): string[]
  • Returns string[]

  • get name(): string

Methods

  • addErrorLabel(label: string): void
  • hasErrorLabel(label: string): boolean
  • Checks the error to see if it has an error label

    Parameters

    • label: string

      The error label to check for

      diff --git a/docs/Next/classes/MongoClient.html b/docs/Next/classes/MongoClient.html index 4db0a7f422e..a8c84546c5e 100644 --- a/docs/Next/classes/MongoClient.html +++ b/docs/Next/classes/MongoClient.html @@ -3,7 +3,7 @@
      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' });
      -

Hierarchy

Index

Constructors

Properties

captureRejectionSymbol: typeof captureRejectionSymbol
captureRejections: boolean
+

Hierarchy

Index

Constructors

Properties

captureRejectionSymbol: typeof captureRejectionSymbol
captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

defaultMaxListeners: number
errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' @@ -12,25 +12,25 @@

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

-

Accessors

  • get serverApi(): Readonly<undefined | ServerApi>

Methods

  • close(): Promise<void>
  • close(force: boolean): Promise<void>
  • close(callback: Callback<void>): void
  • close(force: boolean, callback: Callback<void>): void

Accessors

  • get serverApi(): Readonly<undefined | ServerApi>

Methods

  • close(): Promise<void>
  • close(force: boolean): Promise<void>
  • close(callback: Callback<void>): void
  • close(force: boolean, callback: Callback<void>): void
  • Create a new Db instance sharing the current socket connections.

    Parameters

    • Optional dbName: string

      The name of the database we want to use. If not provided, use database name from connection string.

    • Optional options: DbOptions

      Optional settings for Db construction

      -

    Returns Db

  • emit<EventKey>(event: symbol | EventKey, ...args: Parameters<MongoClientEvents[EventKey]>): boolean
  • Type parameters

    • EventKey: "error" | "timeout" | "close" | "open" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionPoolReady" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed"

    Parameters

    Returns boolean

  • eventNames(): string[]

Returns Db

  • emit<EventKey>(event: symbol | EventKey, ...args: Parameters<MongoClientEvents[EventKey]>): boolean
  • Type parameters

    • EventKey: "error" | "timeout" | "close" | "open" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionPoolReady" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed"

    Parameters

    Returns boolean

  • eventNames(): string[]
  • getMaxListeners(): number
  • listenerCount<EventKey>(type: string | symbol | EventKey): number
  • Type parameters

    • EventKey: "error" | "timeout" | "close" | "open" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionPoolReady" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed"

    Parameters

    • type: string | symbol | EventKey

    Returns number

  • listeners<EventKey>(event: string | symbol | EventKey): MongoClientEvents[EventKey][]
  • Type parameters

    • EventKey: "error" | "timeout" | "close" | "open" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionPoolReady" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed"

    Parameters

    • event: string | symbol | EventKey

    Returns MongoClientEvents[EventKey][]

  • Type parameters

    • EventKey: "error" | "timeout" | "close" | "open" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionPoolReady" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed"

    Parameters

    Returns MongoClient

  • Parameters

    Returns MongoClient

  • Parameters

    Returns MongoClient

  • rawListeners<EventKey>(event: string | symbol | EventKey): MongoClientEvents[EventKey][]
  • Type parameters

    • EventKey: "error" | "timeout" | "close" | "open" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionPoolReady" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed"

    Parameters

    • event: string | symbol | EventKey

    Returns MongoClientEvents[EventKey][]

  • removeAllListeners<EventKey>(event?: string | symbol | EventKey): MongoClient
  • Type parameters

    • EventKey: "error" | "timeout" | "close" | "open" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionPoolReady" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed"

    Parameters

    • Optional event: string | symbol | EventKey

    Returns MongoClient

  • getMaxListeners(): number
  • listenerCount<EventKey>(type: string | symbol | EventKey): number
  • Type parameters

    • EventKey: "error" | "timeout" | "close" | "open" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionPoolReady" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed"

    Parameters

    • type: string | symbol | EventKey

    Returns number

  • listeners<EventKey>(event: string | symbol | EventKey): MongoClientEvents[EventKey][]
  • Type parameters

    • EventKey: "error" | "timeout" | "close" | "open" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionPoolReady" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed"

    Parameters

    • event: string | symbol | EventKey

    Returns MongoClientEvents[EventKey][]

  • Type parameters

    • EventKey: "error" | "timeout" | "close" | "open" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionPoolReady" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed"

    Parameters

    Returns MongoClient

  • Parameters

    Returns MongoClient

  • Parameters

    Returns MongoClient

  • rawListeners<EventKey>(event: string | symbol | EventKey): MongoClientEvents[EventKey][]
  • Type parameters

    • EventKey: "error" | "timeout" | "close" | "open" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionPoolReady" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed"

    Parameters

    • event: string | symbol | EventKey

    Returns MongoClientEvents[EventKey][]

  • removeAllListeners<EventKey>(event?: string | symbol | EventKey): MongoClient
  • Type parameters

    • EventKey: "error" | "timeout" | "close" | "open" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionPoolReady" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed"

    Parameters

    • Optional event: string | symbol | EventKey

    Returns MongoClient

  • Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this cluster. Will ignore all changes to system collections, as well as the local, admin, and config databases.

    @@ -47,18 +47,18 @@

    An array of aggregation pipeline stages through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.

  • options: ChangeStreamOptions = {}

    Optional settings for the command

    -

Returns ChangeStream<TSchema, TChange>

Returns ChangeStream<TSchema, TChange>

  • Runs a given operation with an implicitly created session. The lifetime of the session will be handled without the need for user interaction.

    NOTE: presently the operation MUST return a Promise (either explicit or implicitly as an async function)

    Parameters

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • getEventListeners(emitter: EventEmitter | _DOMEventTarget, name: string | symbol): Function[]
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • Checks the error to see if it has an error label

      Parameters

      • label: string

        The error label to check for

        diff --git a/docs/Next/classes/MongoRuntimeError.html b/docs/Next/classes/MongoRuntimeError.html index 36acc722cf5..ead793b19aa 100644 --- a/docs/Next/classes/MongoRuntimeError.html +++ b/docs/Next/classes/MongoRuntimeError.html @@ -2,15 +2,15 @@

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

        privateremarks

        Should never be directly instantiated.

        -

    Hierarchy

    Index

    Constructors

    Properties

    cause?: Error
    code?: string | number
    +

    Hierarchy

    Index

    Constructors

    Properties

    cause?: Error
    code?: string | number

    This is a number in MongoServerError and a string in MongoDriverError

    privateremarks

    Define the type override on the subclasses when we can use the override keyword

    -
    connectionGeneration?: number
    message: string
    stack?: string
    topologyVersion?: TopologyVersion
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Type declaration

      • (err: Error, stackTraces: CallSite[]): any
      • +
    connectionGeneration?: number
    message: string
    stack?: string
    topologyVersion?: TopologyVersion
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Type declaration

    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • +

      Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • Checks the error to see if it has an error label

      Parameters

      • label: string

        The error label to check for

        diff --git a/docs/Next/classes/MongoUnexpectedServerResponseError.html b/docs/Next/classes/MongoUnexpectedServerResponseError.html index 5c67489afec..39fffe63e3e 100644 --- a/docs/Next/classes/MongoUnexpectedServerResponseError.html +++ b/docs/Next/classes/MongoUnexpectedServerResponseError.html @@ -12,15 +12,15 @@

        Example

        selection returns a server that does not support retryable operations, this error is used. This scenario is unlikely as retryable support would also have been determined on the first attempt but it is possible the state change could report a selectable server that does not support retries.

        -

    Hierarchy

    Index

    Constructors

    Properties

    cause?: Error
    code?: string | number
    +

    Hierarchy

    Index

    Constructors

    Properties

    cause?: Error
    code?: string | number

    This is a number in MongoServerError and a string in MongoDriverError

    privateremarks

    Define the type override on the subclasses when we can use the override keyword

    -
    connectionGeneration?: number
    message: string
    stack?: string
    topologyVersion?: TopologyVersion
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Type declaration

      • (err: Error, stackTraces: CallSite[]): any
      • +
    connectionGeneration?: number
    message: string
    stack?: string
    topologyVersion?: TopologyVersion
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Type declaration

    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • +

      Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    stackTraceLimit: number

    Accessors

    • get errmsg(): string
    • Legacy name for server error responses

      -

      Returns string

    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    • get errorLabels(): string[]
    • Returns string[]

    • get name(): string

    Methods

    • addErrorLabel(label: string): void
    • hasErrorLabel(label: string): boolean
    keyVaultClient?: MongoClient

    A MongoClient used to fetch keys from a key vault

    -
    keyVaultNamespace?: string
    +
    keyVaultNamespace?: string

    The namespace where keys are stored in the key vault

    -
    kmsProviders?: { aws?: { accessKeyId: string; secretAccessKey: string; sessionToken?: string }; azure?: { clientId: string; clientSecret: string; identityPlatformEndpoint?: string; tenantId: string }; gcp?: { email: string; endpoint?: string; privateKey: string | Buffer }; kmip?: { endpoint?: string }; local?: { key: string | Buffer } }
    +
    kmsProviders?: { aws?: { accessKeyId: string; secretAccessKey: string; sessionToken?: string }; azure?: { clientId: string; clientSecret: string; identityPlatformEndpoint?: string; tenantId: string }; gcp?: { email: string; endpoint?: string; privateKey: string | Buffer }; kmip?: { endpoint?: string }; local?: { key: string | Buffer } }

    Configuration options that are used by specific KMS providers during key generation, encryption, and decryption.

    Type declaration

    • Optional aws?: { accessKeyId: string; secretAccessKey: string; sessionToken?: string }

      Configuration options for using 'aws' as your KMS provider

      @@ -80,14 +80,14 @@
      • key: string | Buffer

        The master key used to encrypt/decrypt data keys. A 96-byte long Buffer or base64 encoded string.

        -
    options?: { logger?: any }

    Type declaration

    options?: { logger?: any }

    Type declaration

    proxyOptions?: ProxyOptions
    schemaMap?: Document
    +

    Parameters

    Returns void

    proxyOptions?: ProxyOptions
    schemaMap?: Document

    A map of namespaces to a local JSON schema for encryption

    NOTE: Supplying options.schemaMap provides more security than relying on JSON Schemas obtained from the server. It protects against a malicious server advertising a false JSON Schema, which could trick the client into sending decrypted data that should be encrypted. 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.

    -
    +

    The TLS options to use connecting to the KMS provider

    Type declaration

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/AutoEncryptionTlsOptions.html b/docs/Next/interfaces/AutoEncryptionTlsOptions.html index ecfda40fb1e..dca69a6528b 100644 --- a/docs/Next/interfaces/AutoEncryptionTlsOptions.html +++ b/docs/Next/interfaces/AutoEncryptionTlsOptions.html @@ -1,13 +1,13 @@ -AutoEncryptionTlsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AutoEncryptionTlsOptions

    Hierarchy

    • AutoEncryptionTlsOptions

    Index

    Properties

    tlsCAFile?: string
    +AutoEncryptionTlsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AutoEncryptionTlsOptions

    Hierarchy

    • AutoEncryptionTlsOptions

    Index

    Properties

    tlsCAFile?: string

    Specifies the location of a local .pem file that contains the root certificate chain from the Certificate Authority. This file is used to validate the certificate presented by the KMS provider.

    -
    tlsCertificateKeyFile?: string
    +
    tlsCertificateKeyFile?: string

    Specifies the location of a local .pem file that contains either the client's TLS/SSL certificate and key or only the client's TLS/SSL key when tlsCertificateFile is used to provide the certificate.

    -
    tlsCertificateKeyFilePassword?: string
    +
    tlsCertificateKeyFilePassword?: string

    Specifies the password to de-crypt the tlsCertificateKeyFile.

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/CloseOptions.html b/docs/Next/interfaces/CloseOptions.html index 1188e2191c2..2d6a0128a90 100644 --- a/docs/Next/interfaces/CloseOptions.html +++ b/docs/Next/interfaces/CloseOptions.html @@ -1 +1 @@ -CloseOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CloseOptions

    Hierarchy

    • CloseOptions

    Index

    Properties

    Properties

    force?: boolean

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +CloseOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CloseOptions

    Hierarchy

    • CloseOptions

    Index

    Properties

    Properties

    force?: boolean

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ConnectionPoolOptions.html b/docs/Next/interfaces/ConnectionPoolOptions.html index 896eb41cd5e..1a2670987c1 100644 --- a/docs/Next/interfaces/ConnectionPoolOptions.html +++ b/docs/Next/interfaces/ConnectionPoolOptions.html @@ -58,15 +58,15 @@ passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

    -
    loadBalanced: boolean
    +
    loadBalanced: boolean

    If we are in load balancer mode.

    -
    localAddress?: string
    localPort?: number
    logicalSessionTimeoutMinutes?: number
    lookup?: LookupFunction
    maxConnecting: number
    +
    localAddress?: string
    localPort?: number
    logicalSessionTimeoutMinutes?: number
    lookup?: LookupFunction
    maxConnecting: number

    The maximum number of connections that may be in the process of being established concurrently by the connection pool.

    -
    maxIdleTimeMS: number
    +
    maxIdleTimeMS: number

    The maximum amount of time a connection should remain idle in the connection pool before being marked idle.

    -
    maxPoolSize: number
    +
    maxPoolSize: number

    The maximum number of connections that may be associated with a pool at a given time. This includes in use and available connections.

    -
    metadata: ClientMetadata
    minDHSize?: number
    minPoolSize: number
    +
    metadata: ClientMetadata
    minDHSize?: number
    minPoolSize: number

    The minimum number of connections that MUST exist at any moment in a single connection pool.

    monitorCommands: boolean
    noDelay?: boolean
    passphrase?: string

    Shared passphrase used for a single private key and/or a PFX.

    @@ -96,6 +96,6 @@ any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.

    -
    serverApi?: ServerApi
    servername?: string
    session?: Buffer
    socketTimeoutMS?: number
    tls: boolean
    waitQueueTimeoutMS: number
    +
    serverApi?: ServerApi
    servername?: string
    session?: Buffer
    socketTimeoutMS?: number
    tls: boolean
    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.

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/DriverInfo.html b/docs/Next/interfaces/DriverInfo.html index 9a37fdd7661..e33e1adec57 100644 --- a/docs/Next/interfaces/DriverInfo.html +++ b/docs/Next/interfaces/DriverInfo.html @@ -1 +1 @@ -DriverInfo | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface DriverInfo

    Hierarchy

    • DriverInfo

    Index

    Properties

    name?: string
    platform?: string
    version?: string

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DriverInfo | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface DriverInfo

    Hierarchy

    • DriverInfo

    Index

    Properties

    name?: string
    platform?: string
    version?: string

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ErrorDescription.html b/docs/Next/interfaces/ErrorDescription.html index ab0972d2ced..b22332faa04 100644 --- a/docs/Next/interfaces/ErrorDescription.html +++ b/docs/Next/interfaces/ErrorDescription.html @@ -1 +1 @@ -ErrorDescription | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ErrorDescription

    Hierarchy

    Index

    Properties

    $err?: string
    errInfo?: Document
    errmsg?: string
    errorLabels?: string[]
    message?: string

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ErrorDescription | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ErrorDescription

    Hierarchy

    Index

    Properties

    $err?: string
    errInfo?: Document
    errmsg?: string
    errorLabels?: string[]
    message?: string

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/MongoClientOptions.html b/docs/Next/interfaces/MongoClientOptions.html index cb409d27be1..54fe68745d0 100644 --- a/docs/Next/interfaces/MongoClientOptions.html +++ b/docs/Next/interfaces/MongoClientOptions.html @@ -4,17 +4,17 @@

    Hierarchy

    Index

    Properties

    ALPNProtocols?: string[] | Uint8Array | Uint8Array[]

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

    -
    appName?: string
    +
    appName?: string

    The name of the application that created this MongoClient instance. MongoDB 3.4 and newer will print this value in the server log upon establishing each connection. It is also recorded in the slow query log and profile collections

    -
    auth?: Auth
    +
    auth?: Auth

    The auth settings for when connection to server.

    -
    authMechanism?: AuthMechanism
    +
    authMechanism?: AuthMechanism

    Specify the authentication mechanism that MongoDB will use to authenticate the connection.

    -
    authMechanismProperties?: AuthMechanismProperties
    +
    authMechanismProperties?: AuthMechanismProperties

    Specify properties for the specified authMechanism as a comma-separated list of colon-separated key-value pairs.

    -
    authSource?: string
    +
    authSource?: string

    Specify the database name associated with the user’s credentials.

    -
    autoEncryption?: AutoEncryptionOptions
    +
    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.

    @@ -67,15 +67,15 @@ information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.

    -
    compressors?: string | ("none" | "snappy" | "zlib" | "zstd")[]
    +
    compressors?: string | ("none" | "snappy" | "zlib" | "zstd")[]

    An array or comma-delimited string of compressors to enable network compression for communication between this client and a mongod/mongos instance.

    -
    connectTimeoutMS?: number
    +
    connectTimeoutMS?: number

    The time in milliseconds to attempt a connection before timing out.

    crl?: string | Buffer | (string | Buffer)[]

    PEM formatted CRLs (Certificate Revocation Lists).

    -
    directConnection?: boolean
    +
    directConnection?: boolean

    Allow a driver to force a Single topology type with a connection string containing one host

    -
    driverInfo?: DriverInfo
    +
    driverInfo?: DriverInfo

    Allows a wrapping driver to amend the client metadata generated by the driver to include information about the wrapping driver

    ecdhCurve?: string

    A string describing a named curve or a colon separated list of curve @@ -89,18 +89,18 @@

    Enable utf8 validation when deserializing BSON documents. Defaults to true.

    family?: number
    fieldsAsRaw?: Document

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    -
    forceServerObjectId?: boolean
    +
    forceServerObjectId?: boolean

    Force server to assign _id values instead of driver

    -
    heartbeatFrequencyMS?: number
    +
    heartbeatFrequencyMS?: number

    heartbeatFrequencyMS controls when the driver checks the state of the MongoDB deployment. Specify the interval (in milliseconds) between checks, counted from the end of the previous check until the beginning of the next one.

    hints?: number
    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -
    journal?: boolean
    +
    journal?: boolean

    The journal write concern

    deprecated

    Please use the writeConcern option instead

    -
    keepAlive?: boolean
    +
    keepAlive?: boolean

    TCP Connection keep alive enabled

    -
    keepAliveInitialDelay?: number
    +
    keepAliveInitialDelay?: number

    The number of milliseconds to wait before initiating keepAlive on the TCP socket

    key?: string | Buffer | (string | Buffer | KeyObject)[]

    Private keys in PEM format. PEM allows the option of private keys @@ -111,29 +111,29 @@ passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

    -
    loadBalanced?: boolean
    +
    loadBalanced?: boolean

    Instruct the driver it is connecting to a load balancer fronting a mongos like service

    -
    localAddress?: string
    localPort?: number
    localThresholdMS?: number
    +
    localAddress?: string
    localPort?: number
    localThresholdMS?: number

    The size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.

    -
    logger?: Logger
    +
    logger?: Logger

    Custom logger object

    -
    loggerLevel?: LoggerLevel
    +
    loggerLevel?: LoggerLevel

    The logging level

    -
    lookup?: LookupFunction
    maxConnecting?: number
    +
    lookup?: LookupFunction
    maxConnecting?: number

    The maximum number of connections that may be in the process of being established concurrently by the connection pool.

    -
    maxIdleTimeMS?: number
    +
    maxIdleTimeMS?: number

    The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed.

    -
    maxPoolSize?: number
    +
    maxPoolSize?: number

    The maximum number of connections in the connection pool.

    -
    maxStalenessSeconds?: number
    +
    maxStalenessSeconds?: number

    Specifies, in seconds, how stale a secondary can be before the client stops using it for read operations.

    -
    minDHSize?: number
    minHeartbeatFrequencyMS?: number
    +
    minDHSize?: number
    minHeartbeatFrequencyMS?: number

    Sets the minimum heartbeat frequency. In the event that the driver has to frequently re-check a server's availability, it will wait at least this long since the previous check to avoid wasted effort.

    -
    minPoolSize?: number
    +
    minPoolSize?: number

    The minimum number of connections in the connection pool.

    -
    monitorCommands?: boolean
    +
    monitorCommands?: boolean

    Enable command monitoring for this client

    -
    noDelay?: boolean
    +
    noDelay?: boolean

    TCP Connection no delay

    passphrase?: string

    Shared passphrase used for a single private key and/or a PFX.

    @@ -146,9 +146,9 @@ passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

    -
    pkFactory?: PkFactory
    +
    pkFactory?: PkFactory

    A primary key factory function for generation of custom _id keys

    -
    promiseLibrary?: any
    +
    promiseLibrary?: any

    A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible

    deprecated

    Setting a custom promise library is deprecated the next major version will use the global Promise constructor only.

    promoteBuffers?: boolean
    @@ -157,13 +157,13 @@

    when deserializing a Long will fit it into a Number if it's smaller than 53 bits

    promoteValues?: boolean

    when deserializing will promote BSON values to their Node.js closest equivalent types.

    -
    proxyHost?: string
    +
    proxyHost?: string

    Configures a Socks5 proxy host used for creating TCP connections.

    -
    proxyPassword?: string
    +
    proxyPassword?: string

    Configures a Socks5 proxy password when the proxy in proxyHost requires username/password authentication.

    -
    proxyPort?: number
    +
    proxyPort?: number

    Configures a Socks5 proxy port used for creating TCP connections.

    -
    proxyUsername?: string
    +
    proxyUsername?: string

    Configures a Socks5 proxy username when the proxy in proxyHost requires username/password authentication.

    raw?: boolean

    Enabling the raw option will return a Node.js Buffer @@ -176,24 +176,24 @@

    remarks

    Please note there is a known limitation where this option cannot be used at the MongoClient level (see NODE-3946). It does correctly work at Db, Collection, and per operation the same as other BSON options work.

    -
    readConcern?: ReadConcernLike
    +
    readConcern?: ReadConcernLike

    Specify a read concern for the collection (only MongoDB 3.2 or higher supported)

    -
    readConcernLevel?: ReadConcernLevel
    +
    readConcernLevel?: ReadConcernLevel

    The level of isolation

    -
    +

    Specifies the read preferences for this connection

    -
    readPreferenceTags?: TagSet[]
    +
    readPreferenceTags?: TagSet[]

    Specifies the tags document as a comma-separated list of colon-separated key-value pairs.

    rejectUnauthorized?: boolean

    If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.

    default

    true

    -
    replicaSet?: string
    +
    replicaSet?: string

    Specifies the name of the replica set, if the mongod is a member of a replica set.

    -
    retryReads?: boolean
    +
    retryReads?: boolean

    Enables retryable reads.

    -
    retryWrites?: boolean
    +
    retryWrites?: boolean

    Enable retryable writes.

    secureContext?: SecureContext

    An optional TLS context object from tls.createSecureContext()

    @@ -209,60 +209,60 @@ interoperability. Default: none, see minVersion.

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -
    serverApi?: "1" | ServerApi
    +
    serverApi?: "1" | ServerApi

    Server API version

    -
    serverSelectionTimeoutMS?: number
    +
    serverSelectionTimeoutMS?: number

    Specifies how long (in milliseconds) to block for server selection before throwing an exception.

    -
    servername?: string
    session?: Buffer
    socketTimeoutMS?: number
    +
    servername?: string
    session?: Buffer
    socketTimeoutMS?: number

    The time in milliseconds to attempt a send or receive on a socket before the attempt times out.

    -
    srvMaxHosts?: number
    +
    srvMaxHosts?: number

    The maximum number of hosts to connect to when using an srv connection string, a setting of 0 means unlimited hosts

    -
    srvServiceName?: string
    +
    srvServiceName?: string

    Modifies the srv URI to look like:

    _{srvServiceName}._tcp.{hostname}.{domainname}

    Querying this DNS URI is expected to respond with SRV records

    -
    ssl?: boolean
    +
    ssl?: boolean

    A boolean to enable or disables TLS/SSL for the connection. (The ssl option is equivalent to the tls option.)

    -
    sslCA?: string
    +
    sslCA?: string

    SSL Certificate file path.

    -
    sslCRL?: string
    +
    sslCRL?: string

    SSL Certificate revocation list file path.

    -
    sslCert?: string
    +
    sslCert?: string

    SSL Certificate file path.

    -
    sslKey?: string
    +
    sslKey?: string

    SSL Key file file path.

    -
    sslPass?: string
    +
    sslPass?: string

    SSL Certificate pass phrase.

    -
    sslValidate?: boolean
    +
    sslValidate?: boolean

    Validate mongod server certificate against Certificate Authority

    -
    tls?: boolean
    +
    tls?: boolean

    Enables or disables TLS/SSL for the connection.

    -
    tlsAllowInvalidCertificates?: boolean
    +
    tlsAllowInvalidCertificates?: boolean

    Bypasses validation of the certificates presented by the mongod/mongos instance

    -
    tlsAllowInvalidHostnames?: boolean
    +
    tlsAllowInvalidHostnames?: boolean

    Disables hostname validation of the certificate presented by the mongod/mongos instance.

    -
    tlsCAFile?: string
    +
    tlsCAFile?: string

    Specifies the location of a local .pem file that contains the root certificate chain from the Certificate Authority. This file is used to validate the certificate presented by the mongod/mongos instance.

    -
    tlsCertificateFile?: string
    +
    tlsCertificateFile?: string

    Specifies the location of a local TLS Certificate

    -
    tlsCertificateKeyFile?: string
    +
    tlsCertificateKeyFile?: string

    Specifies the location of a local .pem file that contains either the client's TLS/SSL certificate and key or only the client's TLS/SSL key when tlsCertificateFile is used to provide the certificate.

    -
    tlsCertificateKeyFilePassword?: string
    +
    tlsCertificateKeyFilePassword?: string

    Specifies the password to de-crypt the tlsCertificateKeyFile.

    -
    tlsInsecure?: boolean
    +
    tlsInsecure?: boolean

    Disables various certificate validations.

    -
    w?: W
    +
    w?: W

    The write concern w value

    deprecated

    Please use the writeConcern option instead

    -
    waitQueueTimeoutMS?: number
    +
    waitQueueTimeoutMS?: number

    The maximum time in milliseconds that a thread can wait for a connection to become available.

    -
    +

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

    see

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

    -
    wtimeoutMS?: number
    +
    wtimeoutMS?: number

    The write concern timeout

    deprecated

    Please use the writeConcern option instead

    -
    zlibCompressionLevel?: 0 | 3 | 9 | 4 | 5 | 1 | 2 | 6 | 8 | 7
    +
    zlibCompressionLevel?: 0 | 3 | 9 | 4 | 5 | 1 | 2 | 6 | 8 | 7

    An integer that specifies the compression level if using zlib for network compression.

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/MongoNetworkErrorOptions.html b/docs/Next/interfaces/MongoNetworkErrorOptions.html index 8f0781500e3..1101546cfbc 100644 --- a/docs/Next/interfaces/MongoNetworkErrorOptions.html +++ b/docs/Next/interfaces/MongoNetworkErrorOptions.html @@ -1,3 +1,3 @@ -MongoNetworkErrorOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MongoNetworkErrorOptions

    Hierarchy

    • MongoNetworkErrorOptions

    Index

    Properties

    Properties

    beforeHandshake: boolean
    +MongoNetworkErrorOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MongoNetworkErrorOptions

    Hierarchy

    • MongoNetworkErrorOptions

    Index

    Properties

    Properties

    beforeHandshake: boolean

    Indicates the timeout happened before a connection handshake completed

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/MongoOptions.html b/docs/Next/interfaces/MongoOptions.html index 9398b298b67..65e8f593756 100644 --- a/docs/Next/interfaces/MongoOptions.html +++ b/docs/Next/interfaces/MongoOptions.html @@ -3,7 +3,7 @@

    Hierarchy

    • Required<Pick<MongoClientOptions, "autoEncryption" | "connectTimeoutMS" | "directConnection" | "driverInfo" | "forceServerObjectId" | "minHeartbeatFrequencyMS" | "heartbeatFrequencyMS" | "keepAlive" | "keepAliveInitialDelay" | "localThresholdMS" | "logger" | "maxConnecting" | "maxIdleTimeMS" | "maxPoolSize" | "minPoolSize" | "monitorCommands" | "noDelay" | "pkFactory" | "promiseLibrary" | "raw" | "replicaSet" | "retryReads" | "retryWrites" | "serverSelectionTimeoutMS" | "socketTimeoutMS" | "srvMaxHosts" | "srvServiceName" | "tlsAllowInvalidCertificates" | "tlsAllowInvalidHostnames" | "tlsInsecure" | "waitQueueTimeoutMS" | "zlibCompressionLevel">>
    • SupportedNodeConnectionOptions
      • MongoOptions

    Index

    Properties

    ALPNProtocols?: string[] | Uint8Array | Uint8Array[]

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

    -
    autoEncrypter?: AutoEncrypter
    autoEncryption: AutoEncryptionOptions
    +
    autoEncrypter?: AutoEncrypter
    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.

    @@ -52,13 +52,13 @@ information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.

    -
    compressors: ("none" | "snappy" | "zlib" | "zstd")[]
    connectTimeoutMS: number
    +
    compressors: ("none" | "snappy" | "zlib" | "zstd")[]
    connectTimeoutMS: number

    The time in milliseconds to attempt a connection before timing out.

    -
    credentials?: MongoCredentials
    crl?: string | Buffer | (string | Buffer)[]
    +
    credentials?: MongoCredentials
    crl?: string | Buffer | (string | Buffer)[]

    PEM formatted CRLs (Certificate Revocation Lists).

    -
    dbName: string
    directConnection: boolean
    +
    dbName: string
    directConnection: boolean

    Allow a driver to force a Single topology type with a connection string containing one host

    -
    driverInfo: DriverInfo
    +
    driverInfo: DriverInfo

    Allows a wrapping driver to amend the client metadata generated by the driver to include information about the wrapping driver

    ecdhCurve?: string

    A string describing a named curve or a colon separated list of curve @@ -68,13 +68,13 @@ recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.

    -
    family?: number
    forceServerObjectId: boolean
    +
    family?: number
    forceServerObjectId: boolean

    Force server to assign _id values instead of driver

    -
    heartbeatFrequencyMS: number
    +
    heartbeatFrequencyMS: number

    heartbeatFrequencyMS controls when the driver checks the state of the MongoDB deployment. Specify the interval (in milliseconds) between checks, counted from the end of the previous check until the beginning of the next one.

    -
    hints?: number
    hosts: HostAddress[]
    keepAlive: boolean
    +
    hints?: number
    hosts: HostAddress[]
    keepAlive: boolean

    TCP Connection keep alive enabled

    -
    keepAliveInitialDelay: number
    +
    keepAliveInitialDelay: number

    The number of milliseconds to wait before initiating keepAlive on the TCP socket

    key?: string | Buffer | (string | Buffer | KeyObject)[]

    Private keys in PEM format. PEM allows the option of private keys @@ -85,23 +85,23 @@ passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

    -
    loadBalanced: boolean
    localAddress?: string
    localPort?: number
    localThresholdMS: number
    +
    loadBalanced: boolean
    localAddress?: string
    localPort?: number
    localThresholdMS: number

    The size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.

    -
    logger: Logger
    +
    logger: Logger

    Custom logger object

    -
    lookup?: LookupFunction
    maxConnecting: number
    +
    lookup?: LookupFunction
    maxConnecting: number

    The maximum number of connections that may be in the process of being established concurrently by the connection pool.

    -
    maxIdleTimeMS: number
    +
    maxIdleTimeMS: number

    The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed.

    -
    maxPoolSize: number
    +
    maxPoolSize: number

    The maximum number of connections in the connection pool.

    -
    metadata: ClientMetadata
    minDHSize?: number
    minHeartbeatFrequencyMS: number
    +
    metadata: ClientMetadata
    minDHSize?: number
    minHeartbeatFrequencyMS: number

    Sets the minimum heartbeat frequency. In the event that the driver has to frequently re-check a server's availability, it will wait at least this long since the previous check to avoid wasted effort.

    -
    minPoolSize: number
    +
    minPoolSize: number

    The minimum number of connections in the connection pool.

    -
    monitorCommands: boolean
    +
    monitorCommands: boolean

    Enable command monitoring for this client

    -
    noDelay: boolean
    +
    noDelay: boolean

    TCP Connection no delay

    passphrase?: string

    Shared passphrase used for a single private key and/or a PFX.

    @@ -114,12 +114,12 @@ passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

    -
    pkFactory: PkFactory
    +
    pkFactory: PkFactory

    A primary key factory function for generation of custom _id keys

    -
    promiseLibrary: any
    +
    promiseLibrary: any

    A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible

    deprecated

    Setting a custom promise library is deprecated the next major version will use the global Promise constructor only.

    -
    proxyHost?: string
    proxyPassword?: string
    proxyPort?: number
    proxyUsername?: string
    raw: boolean
    +
    proxyHost?: string
    proxyPassword?: string
    proxyPort?: number
    proxyUsername?: string
    raw: boolean

    Enabling the raw option will return a Node.js Buffer which is allocated using allocUnsafe API. See this section from the Node.js Docs here @@ -130,16 +130,16 @@

    remarks

    Please note there is a known limitation where this option cannot be used at the MongoClient level (see NODE-3946). It does correctly work at Db, Collection, and per operation the same as other BSON options work.

    -
    readConcern: ReadConcern
    readPreference: ReadPreference
    rejectUnauthorized?: boolean
    +
    readConcern: ReadConcern
    readPreference: ReadPreference
    rejectUnauthorized?: boolean

    If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.

    default

    true

    -
    replicaSet: string
    +
    replicaSet: string

    Specifies the name of the replica set, if the mongod is a member of a replica set.

    -
    retryReads: boolean
    +
    retryReads: boolean

    Enables retryable reads.

    -
    retryWrites: boolean
    +
    retryWrites: boolean

    Enable retryable writes.

    secureContext?: SecureContext

    An optional TLS context object from tls.createSecureContext()

    @@ -153,17 +153,17 @@ any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.

    -
    serverApi: ServerApi
    serverSelectionTimeoutMS: number
    +
    serverApi: ServerApi
    serverSelectionTimeoutMS: number

    Specifies how long (in milliseconds) to block for server selection before throwing an exception.

    -
    servername?: string
    session?: Buffer
    socketTimeoutMS: number
    +
    servername?: string
    session?: Buffer
    socketTimeoutMS: number

    The time in milliseconds to attempt a send or receive on a socket before the attempt times out.

    -
    srvHost?: string
    srvMaxHosts: number
    +
    srvHost?: string
    srvMaxHosts: number

    The maximum number of hosts to connect to when using an srv connection string, a setting of 0 means unlimited hosts

    -
    srvServiceName: string
    +
    srvServiceName: string

    Modifies the srv URI to look like:

    _{srvServiceName}._tcp.{hostname}.{domainname}

    Querying this DNS URI is expected to respond with SRV records

    -
    tls: boolean
    +
    tls: boolean
    tlsAllowInvalidCertificates: boolean
    +
    tlsAllowInvalidCertificates: boolean

    Bypasses validation of the certificates presented by the mongod/mongos instance

    -
    tlsAllowInvalidHostnames: boolean
    +
    tlsAllowInvalidHostnames: boolean

    Disables hostname validation of the certificate presented by the mongod/mongos instance.

    -
    tlsInsecure: boolean
    +
    tlsInsecure: boolean

    Disables various certificate validations.

    -
    waitQueueTimeoutMS: number
    +
    waitQueueTimeoutMS: number

    The maximum time in milliseconds that a thread can wait for a connection to become available.

    -
    writeConcern: WriteConcern
    zlibCompressionLevel: 0 | 3 | 9 | 4 | 5 | 1 | 2 | 6 | 8 | 7
    +
    writeConcern: WriteConcern
    zlibCompressionLevel: 0 | 3 | 9 | 4 | 5 | 1 | 2 | 6 | 8 | 7

    An integer that specifies the compression level if using zlib for network compression.

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/PkFactory.html b/docs/Next/interfaces/PkFactory.html index 0377f8ab2fa..186b53ea19e 100644 --- a/docs/Next/interfaces/PkFactory.html +++ b/docs/Next/interfaces/PkFactory.html @@ -1 +1 @@ -PkFactory | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PkFactory

    Hierarchy

    • PkFactory

    Index

    Methods

    Methods

    • createPk(): any

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PkFactory | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PkFactory

    Hierarchy

    • PkFactory

    Index

    Methods

    Methods

    • createPk(): any

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ServerApi.html b/docs/Next/interfaces/ServerApi.html index 85332bf8bf3..3535b406332 100644 --- a/docs/Next/interfaces/ServerApi.html +++ b/docs/Next/interfaces/ServerApi.html @@ -1 +1 @@ -ServerApi | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ServerApi

    Hierarchy

    • ServerApi

    Index

    Properties

    deprecationErrors?: boolean
    strict?: boolean
    version: "1"

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ServerApi | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ServerApi

    Hierarchy

    • ServerApi

    Index

    Properties

    deprecationErrors?: boolean
    strict?: boolean
    version: "1"

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/TopologyOptions.html b/docs/Next/interfaces/TopologyOptions.html index e8e84403078..0b013d6b7ed 100644 --- a/docs/Next/interfaces/TopologyOptions.html +++ b/docs/Next/interfaces/TopologyOptions.html @@ -70,13 +70,13 @@ passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

    -
    loadBalanced: boolean
    localAddress?: string
    localPort?: number
    logicalSessionTimeoutMinutes?: number
    lookup?: LookupFunction
    maxConnecting: number
    +
    loadBalanced: boolean
    localAddress?: string
    localPort?: number
    logicalSessionTimeoutMinutes?: number
    lookup?: LookupFunction
    maxConnecting: number

    The maximum number of connections that may be in the process of being established concurrently by the connection pool.

    -
    maxIdleTimeMS: number
    +
    maxIdleTimeMS: number

    The maximum amount of time a connection should remain idle in the connection pool before being marked idle.

    -
    maxPoolSize: number
    +
    maxPoolSize: number

    The maximum number of connections that may be associated with a pool at a given time. This includes in use and available connections.

    -
    metadata: ClientMetadata
    minDHSize?: number
    minHeartbeatFrequencyMS: number
    minPoolSize: number
    +
    metadata: ClientMetadata
    minDHSize?: number
    minHeartbeatFrequencyMS: number
    minPoolSize: number

    The minimum number of connections that MUST exist at any moment in a single connection pool.

    monitorCommands: boolean
    noDelay?: boolean
    passphrase?: string

    Shared passphrase used for a single private key and/or a PFX.

    @@ -131,6 +131,6 @@

    MongoDB server API version

    serverSelectionTimeoutMS: number

    How long to block for server selection before throwing an error

    -
    servername?: string
    session?: Buffer
    socketTimeoutMS?: number
    srvHost?: string
    srvMaxHosts: number
    srvServiceName: string
    tls: boolean
    waitQueueTimeoutMS: number
    +
    servername?: string
    session?: Buffer
    socketTimeoutMS?: number
    srvHost?: string
    srvMaxHosts: number
    srvServiceName: string
    tls: boolean
    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.

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/modules.html b/docs/Next/modules.html index 1078f17b57c..b0128a8e365 100644 --- a/docs/Next/modules.html +++ b/docs/Next/modules.html @@ -2,9 +2,9 @@

    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

    AnyBulkWriteOperation<TSchema>: { insertOne: InsertOneModel<TSchema> } | { replaceOne: ReplaceOneModel<TSchema> } | { updateOne: UpdateOneModel<TSchema> } | { updateMany: UpdateManyModel<TSchema> } | { deleteOne: DeleteOneModel<TSchema> } | { deleteMany: DeleteManyModel<TSchema> }

    Type parameters

    AnyError: MongoError | Error
    ArrayElement<Type>: Type extends ReadonlyArray<infer Item> ? Item : never

    Type parameters

    ArrayOperator<Type>: { $each?: Flatten<Type>[]; $position?: number; $slice?: number; $sort?: Sort }

    Type parameters

    Type declaration

    • Optional $each?: Flatten<Type>[]
    • Optional $position?: number
    • Optional $slice?: number
    • Optional $sort?: Sort
    AuthMechanism: typeof AuthMechanism[keyof typeof AuthMechanism]
    AutoEncryptionLoggerLevel: typeof AutoEncryptionLoggerLevel[keyof typeof AutoEncryptionLoggerLevel]
    BSONType: typeof BSONType[keyof typeof BSONType]
    BSONTypeAlias: keyof typeof BSONType
    BatchType: typeof BatchType[keyof typeof BatchType]
    BitwiseFilter: number | Binary | ReadonlyArray<number>
    Callback<T>: (error?: AnyError, result?: T) => void

    Type parameters

    Type declaration

      • +

        Type parameters

        • T

    AnyBulkWriteOperation<TSchema>: { insertOne: InsertOneModel<TSchema> } | { replaceOne: ReplaceOneModel<TSchema> } | { updateOne: UpdateOneModel<TSchema> } | { updateMany: UpdateManyModel<TSchema> } | { deleteOne: DeleteOneModel<TSchema> } | { deleteMany: DeleteManyModel<TSchema> }

    Type parameters

    AnyError: MongoError | Error
    ArrayElement<Type>: Type extends ReadonlyArray<infer Item> ? Item : never

    Type parameters

    ArrayOperator<Type>: { $each?: Flatten<Type>[]; $position?: number; $slice?: number; $sort?: Sort }

    Type parameters

    Type declaration

    • Optional $each?: Flatten<Type>[]
    • Optional $position?: number
    • Optional $slice?: number
    • Optional $sort?: Sort
    AuthMechanism: typeof AuthMechanism[keyof typeof AuthMechanism]
    AutoEncryptionLoggerLevel: typeof AutoEncryptionLoggerLevel[keyof typeof AutoEncryptionLoggerLevel]
    BSONType: typeof BSONType[keyof typeof BSONType]
    BSONTypeAlias: keyof typeof BSONType
    BatchType: typeof BatchType[keyof typeof BatchType]
    BitwiseFilter: number | Binary | ReadonlyArray<number>
    Callback<T>: (error?: AnyError, result?: T) => void

    Type parameters

    Type declaration

      • MongoDB Driver style callback

        -

        Parameters

        • Optional error: AnyError
        • Optional result: T

        Returns void

    Type parameters

    ChangeStreamEvents<TSchema, TChange>: { change: any; end: any; error: any; init: any; more: any; response: any; resumeTokenChanged: any } & AbstractCursorEvents

    Type parameters

    ClientSessionEvents: { ended: any }

    Type declaration

    CommonEvents: "newListener" | "removeListener"
    Compressor: typeof Compressor[CompressorName]
    CompressorName: keyof typeof Compressor

    Type parameters

    ConnectionEvents: { close: any; clusterTimeReceived: any; commandFailed: any; commandStarted: any; commandSucceeded: any; message: any; pinned: any; unpinned: any }

    Type declaration

    ConnectionPoolEvents: { connectionCheckOutFailed: any; connectionCheckOutStarted: any; connectionCheckedIn: any; connectionCheckedOut: any; connectionClosed: any; connectionCreated: any; connectionPoolCleared: any; connectionPoolClosed: any; connectionPoolCreated: any; connectionPoolReady: any; connectionReady: any } & Omit<ConnectionEvents, "close" | "message">
    CursorFlag: typeof CURSOR_FLAGS[number]
    DistinctOptions: CommandOperationOptions
    DropDatabaseOptions: CommandOperationOptions
    DropIndexesOptions: CommandOperationOptions
    EnhancedOmit<TRecordOrUnion, KeyUnion>: string extends keyof TRecordOrUnion ? TRecordOrUnion : TRecordOrUnion extends any ? Pick<TRecordOrUnion, Exclude<keyof TRecordOrUnion, KeyUnion>> : never
    +

    Parameters

    Returns void

    Type parameters

    ChangeStreamEvents<TSchema, TChange>: { change: any; end: any; error: any; init: any; more: any; response: any; resumeTokenChanged: any } & AbstractCursorEvents

    Type parameters

    ClientSessionEvents: { ended: any }

    Type declaration

    CommonEvents: "newListener" | "removeListener"
    Compressor: typeof Compressor[CompressorName]
    CompressorName: keyof typeof Compressor

    Type parameters

    ConnectionEvents: { close: any; clusterTimeReceived: any; commandFailed: any; commandStarted: any; commandSucceeded: any; message: any; pinned: any; unpinned: any }

    Type declaration

    ConnectionPoolEvents: { connectionCheckOutFailed: any; connectionCheckOutStarted: any; connectionCheckedIn: any; connectionCheckedOut: any; connectionClosed: any; connectionCreated: any; connectionPoolCleared: any; connectionPoolClosed: any; connectionPoolCreated: any; connectionPoolReady: any; connectionReady: any } & Omit<ConnectionEvents, "close" | "message">
    CursorFlag: typeof CURSOR_FLAGS[number]
    DistinctOptions: CommandOperationOptions
    DropDatabaseOptions: CommandOperationOptions
    DropIndexesOptions: CommandOperationOptions
    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 @public

    Type parameters

    EventEmitterWithState: { }

    Type declaration

      EventsDescription: Record<string, GenericListener>

      Event description type

      @@ -16,7 +16,7 @@

      A MongoDB filter can be some portion of the schema or a set of operators @public

      Type parameters

      FilterOperations<T>: T extends Record<string, any> ? { [ key in keyof T]?: FilterOperators<T[key]> } : FilterOperators<T>

      Type parameters

      FinalizeFunction<TKey, TValue>: (key: TKey, reducedValue: TValue) => TValue

      Type parameters

      Type declaration

        • (key: TKey, reducedValue: TValue): TValue
        • Parameters

          • key: TKey
          • reducedValue: TValue

          Returns TValue

      Flatten<Type>: Type extends ReadonlyArray<infer Item> ? Item : Type

      Type parameters

      GSSAPICanonicalizationValue: typeof GSSAPICanonicalizationValue[keyof typeof GSSAPICanonicalizationValue]
      GenericListener: (...args: any[]) => void

      Type declaration

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

      GridFSBucketEvents: { index: any }

      Type declaration

      Hint: string | Document
      IndexDirection: -1 | 1 | "2d" | "2dsphere" | "text" | "geoHaystack" | "hashed" | number
      IndexSpecification: OneOrMore<string | [string, IndexDirection] | {} | Map<string, IndexDirection>>
      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 @public

      -

      Type parameters

      IntegerType: number | Int32 | Long
      IsAny<Type, ResultIfAny, ResultIfNotAny>: true extends false & Type ? ResultIfAny : ResultIfNotAny

      Type parameters

      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

      KeysOfAType<TSchema, Type>: { [ key in keyof TSchema]: NonNullable<TSchema[key]> extends Type ? key : never }[keyof TSchema]

      Type parameters

      KeysOfOtherType<TSchema, Type>: { [ key in keyof TSchema]: NonNullable<TSchema[key]> extends Type ? never : key }[keyof TSchema]

      Type parameters

      LoggerFunction: (message?: any, ...optionalParams: any[]) => void

      Type declaration

        • (message?: any, ...optionalParams: any[]): void
        • Parameters

          • Optional message: any
          • Rest ...optionalParams: any[]

          Returns void

      LoggerLevel: typeof LoggerLevel[keyof typeof LoggerLevel]
      MapFunction<TSchema>: (this: TSchema) => void

      Type parameters

      Type declaration

        • (this: TSchema): void
        • Parameters

          • this: TSchema

          Returns void

      MatchKeysAndValues<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

      MongoClientEvents: Pick<TopologyEvents, typeof MONGO_CLIENT_EVENTS[number]> & { open: any }
      MongoErrorLabel: typeof MongoErrorLabel[keyof typeof MongoErrorLabel]
      MonitorEvents: { close: any; resetConnectionPool: any; resetServer: any; serverHeartbeatFailed: any; serverHeartbeatStarted: any; serverHeartbeatSucceeded: any } & EventEmitterWithState
      NestedPaths<Type, Depth>: Depth["length"] extends 8 ? [] : Type extends string | number | 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] : Type[Key] extends ReadonlyArray<infer ArrayType> ? Type extends ArrayType ? [Key] : ArrayType extends Type ? [Key] : [Key, ...NestedPaths<Type[Key], [...Depth, 1]>] : [Key, ...NestedPaths<Type[Key], [...Depth, 1]>] | [Key] }[Extract<keyof Type, string>] : []
      remarks

      Through testing we determined that a depth of 8 is safe for the typescript compiler +

      Type parameters

      IntegerType: number | Int32 | Long
      IsAny<Type, ResultIfAny, ResultIfNotAny>: true extends false & Type ? ResultIfAny : ResultIfNotAny

      Type parameters

      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

      KeysOfAType<TSchema, Type>: { [ key in keyof TSchema]: NonNullable<TSchema[key]> extends Type ? key : never }[keyof TSchema]

      Type parameters

      KeysOfOtherType<TSchema, Type>: { [ key in keyof TSchema]: NonNullable<TSchema[key]> extends Type ? never : key }[keyof TSchema]

      Type parameters

      LoggerFunction: (message?: any, ...optionalParams: any[]) => void

      Type declaration

        • (message?: any, ...optionalParams: any[]): void
        • Parameters

          • Optional message: any
          • Rest ...optionalParams: any[]

          Returns void

      LoggerLevel: typeof LoggerLevel[keyof typeof LoggerLevel]
      MapFunction<TSchema>: (this: TSchema) => void

      Type parameters

      Type declaration

        • (this: TSchema): void
        • Parameters

          • this: TSchema

          Returns void

      MatchKeysAndValues<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

      MongoClientEvents: Pick<TopologyEvents, typeof MONGO_CLIENT_EVENTS[number]> & { open: any }
      MongoErrorLabel: typeof MongoErrorLabel[keyof typeof MongoErrorLabel]
      MonitorEvents: { close: any; resetConnectionPool: any; resetServer: any; serverHeartbeatFailed: any; serverHeartbeatStarted: any; serverHeartbeatSucceeded: any } & EventEmitterWithState
      NestedPaths<Type, Depth>: Depth["length"] extends 8 ? [] : Type extends string | number | 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] : Type[Key] extends ReadonlyArray<infer ArrayType> ? Type extends ArrayType ? [Key] : ArrayType extends Type ? [Key] : [Key, ...NestedPaths<Type[Key], [...Depth, 1]>] : [Key, ...NestedPaths<Type[Key], [...Depth, 1]>] | [Key] }[Extract<keyof Type, string>] : []
      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 @@ -39,12 +39,12 @@

      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

      PullAllOperator<TSchema>: ({ readonly [ key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: TSchema[key] } & NotAcceptedFields<TSchema, ReadonlyArray<any>>) & {}

      Type parameters

      PullOperator<TSchema>: ({ readonly [ key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: Partial<Flatten<TSchema[key]>> | FilterOperations<Flatten<TSchema[key]>> } & NotAcceptedFields<TSchema, ReadonlyArray<any>>) & {}

      Type parameters

      PushOperator<TSchema>: ({ readonly [ key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: Flatten<TSchema[key]> | ArrayOperator<Flatten<TSchema[key]>[]> } & NotAcceptedFields<TSchema, ReadonlyArray<any>>) & {}

      Type parameters

      ReadConcernLevel: typeof ReadConcernLevel[keyof typeof ReadConcernLevel]
      ReadConcernLike: ReadConcern | { level: ReadConcernLevel } | ReadConcernLevel
      ReadPreferenceLike: ReadPreference | ReadPreferenceMode
      ReadPreferenceMode: typeof ReadPreferenceMode[keyof typeof ReadPreferenceMode]
      ReduceFunction<TKey, TValue>: (key: TKey, values: TValue[]) => TValue

      Type parameters

      Type declaration

        • (key: TKey, values: TValue[]): TValue
        • Parameters

          • key: TKey
          • values: TValue[]

          Returns TValue

      RegExpOrString<T>: T extends string ? BSONRegExp | RegExp | T : T

      Type parameters

      RemoveUserOptions: CommandOperationOptions
      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

      -
      ReturnDocument: typeof ReturnDocument[keyof typeof ReturnDocument]
      RunCommandOptions: CommandOperationOptions
      SchemaMember<T, V>: { [ P in keyof T]?: V } | {}

      Type parameters

      ServerApiVersion: typeof ServerApiVersion[keyof typeof ServerApiVersion]
      ServerEvents: { closed: any; connect: any; descriptionReceived: any; ended: any; serverHeartbeatFailed: any; serverHeartbeatStarted: any; serverHeartbeatSucceeded: any } & ConnectionPoolEvents & EventEmitterWithState
      ServerOptions: Omit<ConnectionPoolOptions, "id" | "generation" | "hostAddress"> & MonitorOptions
      ServerSelector: (topologyDescription: TopologyDescription, servers: ServerDescription[]) => ServerDescription[]

      Type declaration

      ServerSessionId: { id: Binary }

      Type declaration

      ServerType: typeof ServerType[keyof typeof ServerType]
      SetFields<TSchema>: ({ readonly [ key in KeysOfAType<TSchema, ReadonlyArray<any> | undefined>]?: OptionalId<Flatten<TSchema[key]>> | AddToSetOperators<OptionalId<Flatten<TSchema[key]>>[]> } & NotAcceptedFields<TSchema, ReadonlyArray<any> | undefined>) & {}

      Type parameters

      SetProfilingLevelOptions: CommandOperationOptions
      Sort: string | Exclude<SortDirection, { $meta: string }> | string[] | {} | Map<string, SortDirection> | [string, SortDirection][] | [string, SortDirection]
      SortDirection: 1 | -1 | "asc" | "desc" | "ascending" | "descending" | { $meta: string }
      Stream: Socket | TLSSocket
      SupportedSocketOptions: Pick<TcpNetConnectOpts, typeof LEGAL_TCP_SOCKET_OPTIONS[number]>
      SupportedTLSConnectionOptions: Pick<TLSConnectionOptions, Extract<keyof TLSConnectionOptions, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>>
      SupportedTLSSocketOptions: Pick<TLSSocketOptions, Extract<keyof TLSSocketOptions, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>>
      TagSet: {}

      Type declaration

      • [key: string]: string
      TopologyEvents: { close: any; connect: any; error: any; serverClosed: any; serverDescriptionChanged: any; serverOpening: any; timeout: any; topologyClosed: any; topologyDescriptionChanged: any; topologyOpening: any } & Omit<ServerEvents, "connect"> & ConnectionPoolEvents & ConnectionEvents & EventEmitterWithState
      TopologyType: typeof TopologyType[keyof typeof TopologyType]
      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

      W: number | "majority"
      WithId<TSchema>: EnhancedOmit<TSchema, "_id"> & { _id: InferIdType<TSchema> }
      +
      ReturnDocument: typeof ReturnDocument[keyof typeof ReturnDocument]
      RunCommandOptions: CommandOperationOptions
      SchemaMember<T, V>: { [ P in keyof T]?: V } | {}

      Type parameters

      ServerApiVersion: typeof ServerApiVersion[keyof typeof ServerApiVersion]
      ServerEvents: { closed: any; connect: any; descriptionReceived: any; ended: any; serverHeartbeatFailed: any; serverHeartbeatStarted: any; serverHeartbeatSucceeded: any } & ConnectionPoolEvents & EventEmitterWithState
      ServerOptions: Omit<ConnectionPoolOptions, "id" | "generation" | "hostAddress"> & MonitorOptions
      ServerSelector: (topologyDescription: TopologyDescription, servers: ServerDescription[]) => ServerDescription[]

      Type declaration

      ServerSessionId: { id: Binary }

      Type declaration

      ServerType: typeof ServerType[keyof typeof ServerType]
      SetFields<TSchema>: ({ readonly [ key in KeysOfAType<TSchema, ReadonlyArray<any> | undefined>]?: OptionalId<Flatten<TSchema[key]>> | AddToSetOperators<OptionalId<Flatten<TSchema[key]>>[]> } & NotAcceptedFields<TSchema, ReadonlyArray<any> | undefined>) & {}

      Type parameters

      SetProfilingLevelOptions: CommandOperationOptions
      Sort: string | Exclude<SortDirection, { $meta: string }> | string[] | {} | Map<string, SortDirection> | [string, SortDirection][] | [string, SortDirection]
      SortDirection: 1 | -1 | "asc" | "desc" | "ascending" | "descending" | { $meta: string }
      Stream: Socket | TLSSocket
      SupportedSocketOptions: Pick<TcpNetConnectOpts, typeof LEGAL_TCP_SOCKET_OPTIONS[number]>
      SupportedTLSConnectionOptions: Pick<TLSConnectionOptions, Extract<keyof TLSConnectionOptions, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>>
      SupportedTLSSocketOptions: Pick<TLSSocketOptions, Extract<keyof TLSSocketOptions, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>>
      TagSet: {}

      Type declaration

      • [key: string]: string
      TopologyEvents: { close: any; connect: any; error: any; serverClosed: any; serverDescriptionChanged: any; serverOpening: any; timeout: any; topologyClosed: any; topologyDescriptionChanged: any; topologyOpening: any } & Omit<ServerEvents, "connect"> & ConnectionPoolEvents & ConnectionEvents & EventEmitterWithState
      TopologyType: typeof TopologyType[keyof typeof TopologyType]
      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

      W: number | "majority"
      WithId<TSchema>: EnhancedOmit<TSchema, "_id"> & { _id: InferIdType<TSchema> }

      Add an _id field to an object shaped type @public

      -

      Type parameters

      WithSessionCallback: (session: ClientSession) => Promise<any>

      Type declaration

      WithTransactionCallback<T>: (session: ClientSession) => Promise<T>

      Type parameters

      Type declaration

      WithoutId<TSchema>: Omit<TSchema, "_id">
      +

      Type parameters

      WithSessionCallback: (session: ClientSession) => Promise<any>

      Type declaration

      WithTransactionCallback<T>: (session: ClientSession) => Promise<T>

      Type parameters

      Type declaration

      WithoutId<TSchema>: Omit<TSchema, "_id">

      Remove the _id field from an object shaped type @public

      -

      Type parameters

      Variables

      AuthMechanism: Readonly<{ MONGODB_AWS: "MONGODB-AWS"; MONGODB_CR: "MONGODB-CR"; MONGODB_DEFAULT: "DEFAULT"; MONGODB_GSSAPI: "GSSAPI"; MONGODB_PLAIN: "PLAIN"; MONGODB_SCRAM_SHA1: "SCRAM-SHA-1"; MONGODB_SCRAM_SHA256: "SCRAM-SHA-256"; MONGODB_X509: "MONGODB-X509" }> = ...
      AutoEncryptionLoggerLevel: Readonly<{ Error: 1; FatalError: 0; Info: 3; Trace: 4; Warning: 2 }> = ...
      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 }> = ...
      BatchType: Readonly<{ DELETE: 3; INSERT: 1; UPDATE: 2 }> = ...
      CURSOR_FLAGS: readonly ["tailable", "oplogReplay", "noCursorTimeout", "awaitData", "exhaust", "partial"] = ...
      Compressor: Readonly<{ none: 0; snappy: 1; zlib: 2; zstd: 3 }> = ...
      ExplainVerbosity: Readonly<{ allPlansExecution: "allPlansExecution"; executionStats: "executionStats"; queryPlanner: "queryPlanner"; queryPlannerExtended: "queryPlannerExtended" }> = ...
      GSSAPICanonicalizationValue: Readonly<{ forward: "forward"; forwardAndReverse: "forwardAndReverse"; none: "none"; off: false; on: true }> = ...
      LEGAL_TCP_SOCKET_OPTIONS: readonly ["family", "hints", "localAddress", "localPort", "lookup"] = ...
      LEGAL_TLS_SOCKET_OPTIONS: readonly ["ALPNProtocols", "ca", "cert", "checkServerIdentity", "ciphers", "crl", "ecdhCurve", "key", "minDHSize", "passphrase", "pfx", "rejectUnauthorized", "secureContext", "secureProtocol", "servername", "session"] = ...
      LoggerLevel: Readonly<{ DEBUG: "debug"; ERROR: "error"; INFO: "info"; WARN: "warn"; debug: "debug"; error: "error"; info: "info"; warn: "warn" }> = ...
      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"] = ...
      Map: MapConstructor
      MongoErrorLabel: Readonly<{ HandshakeError: "HandshakeError"; NoWritesPerformed: "NoWritesPerformed"; ResetPool: "ResetPool"; ResumableChangeStreamError: "ResumableChangeStreamError"; RetryableWriteError: "RetryableWriteError"; TransientTransactionError: "TransientTransactionError"; UnknownTransactionCommitResult: "UnknownTransactionCommitResult" }> = ...
      ObjectID: typeof ObjectId = ObjectId
      deprecated

      Please use ObjectId

      -
      ProfilingLevel: Readonly<{ all: "all"; off: "off"; slowOnly: "slow_only" }> = ...
      ReadConcernLevel: Readonly<{ available: "available"; linearizable: "linearizable"; local: "local"; majority: "majority"; snapshot: "snapshot" }> = ...
      ReadPreferenceMode: Readonly<{ nearest: "nearest"; primary: "primary"; primaryPreferred: "primaryPreferred"; secondary: "secondary"; secondaryPreferred: "secondaryPreferred" }> = ...
      ReturnDocument: Readonly<{ AFTER: "after"; BEFORE: "before" }> = ...
      ServerApiVersion: Readonly<{ v1: "1" }> = ...
      ServerType: Readonly<{ LoadBalancer: "LoadBalancer"; Mongos: "Mongos"; PossiblePrimary: "PossiblePrimary"; RSArbiter: "RSArbiter"; RSGhost: "RSGhost"; RSOther: "RSOther"; RSPrimary: "RSPrimary"; RSSecondary: "RSSecondary"; Standalone: "Standalone"; Unknown: "Unknown" }> = ...
      +

      Type parameters

      Variables

      AuthMechanism: Readonly<{ MONGODB_AWS: "MONGODB-AWS"; MONGODB_CR: "MONGODB-CR"; MONGODB_DEFAULT: "DEFAULT"; MONGODB_GSSAPI: "GSSAPI"; MONGODB_PLAIN: "PLAIN"; MONGODB_SCRAM_SHA1: "SCRAM-SHA-1"; MONGODB_SCRAM_SHA256: "SCRAM-SHA-256"; MONGODB_X509: "MONGODB-X509" }> = ...
      AutoEncryptionLoggerLevel: Readonly<{ Error: 1; FatalError: 0; Info: 3; Trace: 4; Warning: 2 }> = ...
      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 }> = ...
      BatchType: Readonly<{ DELETE: 3; INSERT: 1; UPDATE: 2 }> = ...
      CURSOR_FLAGS: readonly ["tailable", "oplogReplay", "noCursorTimeout", "awaitData", "exhaust", "partial"] = ...
      Compressor: Readonly<{ none: 0; snappy: 1; zlib: 2; zstd: 3 }> = ...
      ExplainVerbosity: Readonly<{ allPlansExecution: "allPlansExecution"; executionStats: "executionStats"; queryPlanner: "queryPlanner"; queryPlannerExtended: "queryPlannerExtended" }> = ...
      GSSAPICanonicalizationValue: Readonly<{ forward: "forward"; forwardAndReverse: "forwardAndReverse"; none: "none"; off: false; on: true }> = ...
      LEGAL_TCP_SOCKET_OPTIONS: readonly ["family", "hints", "localAddress", "localPort", "lookup"] = ...
      LEGAL_TLS_SOCKET_OPTIONS: readonly ["ALPNProtocols", "ca", "cert", "checkServerIdentity", "ciphers", "crl", "ecdhCurve", "key", "minDHSize", "passphrase", "pfx", "rejectUnauthorized", "secureContext", "secureProtocol", "servername", "session"] = ...
      LoggerLevel: Readonly<{ DEBUG: "debug"; ERROR: "error"; INFO: "info"; WARN: "warn"; debug: "debug"; error: "error"; info: "info"; warn: "warn" }> = ...
      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"] = ...
      Map: MapConstructor
      MongoErrorLabel: Readonly<{ HandshakeError: "HandshakeError"; InterruptInUseConnections: "InterruptInUseConnections"; NoWritesPerformed: "NoWritesPerformed"; ResetPool: "ResetPool"; ResumableChangeStreamError: "ResumableChangeStreamError"; RetryableWriteError: "RetryableWriteError"; TransientTransactionError: "TransientTransactionError"; UnknownTransactionCommitResult: "UnknownTransactionCommitResult" }> = ...
      ObjectID: typeof ObjectId = ObjectId
      deprecated

      Please use ObjectId

      +
      ProfilingLevel: Readonly<{ all: "all"; off: "off"; slowOnly: "slow_only" }> = ...
      ReadConcernLevel: Readonly<{ available: "available"; linearizable: "linearizable"; local: "local"; majority: "majority"; snapshot: "snapshot" }> = ...
      ReadPreferenceMode: Readonly<{ nearest: "nearest"; primary: "primary"; primaryPreferred: "primaryPreferred"; secondary: "secondary"; secondaryPreferred: "secondaryPreferred" }> = ...
      ReturnDocument: Readonly<{ AFTER: "after"; BEFORE: "before" }> = ...
      ServerApiVersion: Readonly<{ v1: "1" }> = ...
      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

      TopologyType: Readonly<{ LoadBalanced: "LoadBalanced"; ReplicaSetNoPrimary: "ReplicaSetNoPrimary"; ReplicaSetWithPrimary: "ReplicaSetWithPrimary"; Sharded: "Sharded"; Single: "Single"; Unknown: "Unknown" }> = ...

      An enumeration of topology types we know about

      diff --git a/docs/index.html b/docs/index.html index a7070bc04ec..ed0cd84fc60 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,7 +1,7 @@ - +