From 721d0b56ea0abe1bdad51d5f4626f82ba2f83f44 Mon Sep 17 00:00:00 2001 From: baileympearson Date: Wed, 17 Aug 2022 20:54:04 +0000 Subject: [PATCH] [create-pull-request] automated change --- docs/Next/classes/GridFSBucketReadStream.html | 2 +- docs/Next/classes/MongoClient.html | 20 +-- .../interfaces/AbstractCursorOptions.html | 4 +- docs/Next/interfaces/AddUserOptions.html | 4 +- docs/Next/interfaces/AggregateOptions.html | 4 +- .../interfaces/AggregationCursorOptions.html | 4 +- docs/Next/interfaces/Auth.html | 4 +- .../Next/interfaces/BSONSerializeOptions.html | 4 +- docs/Next/interfaces/BulkWriteOptions.html | 4 +- docs/Next/interfaces/ChangeStreamOptions.html | 4 +- docs/Next/interfaces/CollStatsOptions.html | 4 +- docs/Next/interfaces/CollectionOptions.html | 4 +- .../interfaces/CommandOperationOptions.html | 4 +- .../interfaces/CountDocumentsOptions.html | 4 +- docs/Next/interfaces/CountOptions.html | 4 +- .../interfaces/CreateCollectionOptions.html | 4 +- .../Next/interfaces/CreateIndexesOptions.html | 4 +- docs/Next/interfaces/DbOptions.html | 4 +- docs/Next/interfaces/DbStatsOptions.html | 4 +- docs/Next/interfaces/DeleteOptions.html | 4 +- docs/Next/interfaces/DriverInfo.html | 2 +- .../interfaces/DropCollectionOptions.html | 4 +- .../EstimatedDocumentCountOptions.html | 4 +- docs/Next/interfaces/EvalOptions.html | 4 +- .../interfaces/FindOneAndDeleteOptions.html | 4 +- .../interfaces/FindOneAndReplaceOptions.html | 4 +- .../interfaces/FindOneAndUpdateOptions.html | 4 +- docs/Next/interfaces/FindOptions.html | 4 +- docs/Next/interfaces/InsertOneOptions.html | 4 +- .../interfaces/ListCollectionsOptions.html | 4 +- .../Next/interfaces/ListDatabasesOptions.html | 4 +- docs/Next/interfaces/ListIndexesOptions.html | 4 +- docs/Next/interfaces/MapReduceOptions.html | 4 +- docs/Next/interfaces/MongoClientOptions.html | 134 +++++++++--------- docs/Next/interfaces/MongoOptions.html | 70 ++++----- docs/Next/interfaces/OperationOptions.html | 4 +- docs/Next/interfaces/PkFactory.html | 2 +- docs/Next/interfaces/RenameOptions.html | 4 +- docs/Next/interfaces/ReplaceOptions.html | 4 +- docs/Next/interfaces/ServerApi.html | 2 +- docs/Next/interfaces/TopologyOptions.html | 4 +- docs/Next/interfaces/TransactionOptions.html | 4 +- docs/Next/interfaces/UpdateOptions.html | 4 +- .../interfaces/ValidateCollectionOptions.html | 4 +- docs/Next/modules.html | 10 +- 45 files changed, 195 insertions(+), 195 deletions(-) diff --git a/docs/Next/classes/GridFSBucketReadStream.html b/docs/Next/classes/GridFSBucketReadStream.html index 0dd997f5c95..fac511bfa47 100644 --- a/docs/Next/classes/GridFSBucketReadStream.html +++ b/docs/Next/classes/GridFSBucketReadStream.html @@ -54,7 +54,7 @@

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.

-

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<any>

  • Returns AsyncIterableIterator<any>

Optional _construct

  • _construct(callback: (error?: null | Error) => void): void

  • Parameters

    • callback: (error?: null | Error) => void
        • (error?: null | Error): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

_destroy

  • _destroy(error: null | Error, callback: (error?: null | Error) => void): void

  • Parameters

    • error: null | Error
    • callback: (error?: null | Error) => void
        • (error?: null | Error): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

abort

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<any>

  • Returns AsyncIterableIterator<any>

Optional _construct

  • _construct(callback: (error?: null | Error) => void): void

  • Parameters

    • callback: (error?: null | Error) => void
        • (error?: null | Error): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

_destroy

  • _destroy(error: null | Error, callback: (error?: null | Error) => void): void

  • Parameters

    • error: null | Error
    • callback: (error?: null | Error) => void
        • (error?: null | Error): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

abort

  • Marks this stream as aborted (will never push another data event) and kills the underlying cursor. Will emit the 'end' event, and then the 'close' event once the cursor is successfully killed.

    diff --git a/docs/Next/classes/MongoClient.html b/docs/Next/classes/MongoClient.html index d4f6a2f6086..68f77a0ccbd 100644 --- a/docs/Next/classes/MongoClient.html +++ b/docs/Next/classes/MongoClient.html @@ -5,7 +5,7 @@
    example
    // Connect using the MongoClient.connect static method
    const MongoClient = require('mongodb').MongoClient;
    const test = require('assert');
    // Connection url
    const url = 'mongodb://localhost:27017';
    // Database Name
    const dbName = 'test';
    // Connect using MongoClient
    MongoClient.connect(url, function(err, client) {
      const db = client.db(dbName);
      client.close();
    });
    -

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
+

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

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

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

autoEncrypter

bsonOptions

logger

options

readConcern

readPreference

serverApi

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

writeConcern

Methods

addListener

close

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

Accessors

autoEncrypter

bsonOptions

logger

options

readConcern

readPreference

serverApi

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

writeConcern

Methods

addListener

close

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

connect

connect

db

db

  • 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

  • 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" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed"

    Parameters

    Returns boolean

eventNames

  • eventNames(): string[]

getLogger

Returns Db

emit

  • 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" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed"

    Parameters

    Returns boolean

eventNames

  • eventNames(): string[]

getLogger

getMaxListeners

  • getMaxListeners(): number

listenerCount

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

  • Type parameters

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

    Parameters

    • type: string | symbol | EventKey

    Returns number

listeners

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

  • Type parameters

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

    Parameters

    • event: string | symbol | EventKey

    Returns MongoClientEvents[EventKey][]

off

on

once

prependListener

prependOnceListener

rawListeners

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

  • Type parameters

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

    Parameters

    • event: string | symbol | EventKey

    Returns MongoClientEvents[EventKey][]

removeAllListeners

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

  • Type parameters

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

    Parameters

    • Optional event: string | symbol | EventKey

    Returns MongoClient

removeListener

setMaxListeners

startSession

getMaxListeners

  • getMaxListeners(): number

listenerCount

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

  • Type parameters

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

    Parameters

    • type: string | symbol | EventKey

    Returns number

listeners

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

  • Type parameters

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

    Parameters

    • event: string | symbol | EventKey

    Returns MongoClientEvents[EventKey][]

off

on

once

prependListener

prependOnceListener

rawListeners

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

  • Type parameters

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

    Parameters

    • event: string | symbol | EventKey

    Returns MongoClientEvents[EventKey][]

removeAllListeners

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

  • Type parameters

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

    Parameters

    • Optional event: string | symbol | EventKey

    Returns MongoClient

removeListener

setMaxListeners

startSession

watch

watch

  • 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.

    @@ -46,17 +46,17 @@

    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>

withSession

Returns ChangeStream<TSchema, TChange>

withSession

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

Static connect

Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]

    • Returns a copy of the array of listeners for the event named eventName.

      For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

      diff --git a/docs/Next/interfaces/AbstractCursorOptions.html b/docs/Next/interfaces/AbstractCursorOptions.html index c10bfb0ee93..7a400531228 100644 --- a/docs/Next/interfaces/AbstractCursorOptions.html +++ b/docs/Next/interfaces/AbstractCursorOptions.html @@ -14,7 +14,7 @@

      In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

      In server versions 4.4 and above, 'comment' can be any valid BSON type.

      -

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    @@ -32,7 +32,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

    Optional readPreference

    readPreference?: ReadPreferenceLike

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    diff --git a/docs/Next/interfaces/AddUserOptions.html b/docs/Next/interfaces/AddUserOptions.html index 7e5293bc8fd..7c2dbe0a3a7 100644 --- a/docs/Next/interfaces/AddUserOptions.html +++ b/docs/Next/interfaces/AddUserOptions.html @@ -12,7 +12,7 @@

    Optional customData

    customData?: Document

    Custom data associated with the user (only Mongodb 2.6 or higher)

    Optional dbName

    dbName?: string

    Optional digestPassword

    digestPassword?: null
    deprecated

    Please use db.command('createUser', ...) instead for this option

    -

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -27,7 +27,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/AggregateOptions.html b/docs/Next/interfaces/AggregateOptions.html index 21f849cd11f..d36afcca736 100644 --- a/docs/Next/interfaces/AggregateOptions.html +++ b/docs/Next/interfaces/AggregateOptions.html @@ -17,7 +17,7 @@

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    Optional cursor

    cursor?: Document

    Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -40,7 +40,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/AggregationCursorOptions.html b/docs/Next/interfaces/AggregationCursorOptions.html index c5555391aa0..20f020185d1 100644 --- a/docs/Next/interfaces/AggregationCursorOptions.html +++ b/docs/Next/interfaces/AggregationCursorOptions.html @@ -22,7 +22,7 @@

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    Optional cursor

    cursor?: Document

    Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -47,7 +47,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/Auth.html b/docs/Next/interfaces/Auth.html index 7f5ce27f7e5..df8f50f0b7d 100644 --- a/docs/Next/interfaces/Auth.html +++ b/docs/Next/interfaces/Auth.html @@ -1,5 +1,5 @@ -Auth | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface Auth

    Hierarchy

    • Auth

    Index

    Properties

    Properties

    Optional password

    password?: string
    +Auth | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface Auth

    Hierarchy

    • Auth

    Index

    Properties

    Properties

    Optional password

    password?: string

    The password for auth

    -

    Optional username

    username?: string
    +

    Optional username

    username?: string

    The username for auth

    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/BSONSerializeOptions.html b/docs/Next/interfaces/BSONSerializeOptions.html index 3c5ec983f3c..00234330ccd 100644 --- a/docs/Next/interfaces/BSONSerializeOptions.html +++ b/docs/Next/interfaces/BSONSerializeOptions.html @@ -4,7 +4,7 @@

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

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

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    diff --git a/docs/Next/interfaces/BulkWriteOptions.html b/docs/Next/interfaces/BulkWriteOptions.html index 7cbd1bd8ac4..dae2eea204a 100644 --- a/docs/Next/interfaces/BulkWriteOptions.html +++ b/docs/Next/interfaces/BulkWriteOptions.html @@ -11,7 +11,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -33,7 +33,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/ChangeStreamOptions.html b/docs/Next/interfaces/ChangeStreamOptions.html index cb056260880..dff677a252c 100644 --- a/docs/Next/interfaces/ChangeStreamOptions.html +++ b/docs/Next/interfaces/ChangeStreamOptions.html @@ -20,7 +20,7 @@

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    Optional cursor

    cursor?: Document

    Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -62,7 +62,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/CollStatsOptions.html b/docs/Next/interfaces/CollStatsOptions.html index 6c340c5477a..f68eadea86d 100644 --- a/docs/Next/interfaces/CollStatsOptions.html +++ b/docs/Next/interfaces/CollStatsOptions.html @@ -9,7 +9,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -24,7 +24,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/CollectionOptions.html b/docs/Next/interfaces/CollectionOptions.html index 7389eb1ecc7..b99eac8706b 100644 --- a/docs/Next/interfaces/CollectionOptions.html +++ b/docs/Next/interfaces/CollectionOptions.html @@ -2,7 +2,7 @@

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    @@ -14,7 +14,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/CommandOperationOptions.html b/docs/Next/interfaces/CommandOperationOptions.html index 8cfae6dfbc8..b685f1cd117 100644 --- a/docs/Next/interfaces/CommandOperationOptions.html +++ b/docs/Next/interfaces/CommandOperationOptions.html @@ -9,7 +9,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -24,7 +24,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/CountDocumentsOptions.html b/docs/Next/interfaces/CountDocumentsOptions.html index 28714c8bd6c..123fc656bfb 100644 --- a/docs/Next/interfaces/CountDocumentsOptions.html +++ b/docs/Next/interfaces/CountDocumentsOptions.html @@ -17,7 +17,7 @@

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    Optional cursor

    cursor?: Document

    Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -42,7 +42,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/CountOptions.html b/docs/Next/interfaces/CountOptions.html index a2560931f0c..243b4e28db2 100644 --- a/docs/Next/interfaces/CountOptions.html +++ b/docs/Next/interfaces/CountOptions.html @@ -9,7 +9,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -30,7 +30,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/CreateCollectionOptions.html b/docs/Next/interfaces/CreateCollectionOptions.html index 69b71494cae..10e698ded66 100644 --- a/docs/Next/interfaces/CreateCollectionOptions.html +++ b/docs/Next/interfaces/CreateCollectionOptions.html @@ -17,7 +17,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional encryptedFields

    encryptedFields?: Document
    experimental

    Optional expireAfterSeconds

    expireAfterSeconds?: number

    The number of seconds after which a document in a timeseries or clustered collection expires.

    @@ -44,7 +44,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/CreateIndexesOptions.html b/docs/Next/interfaces/CreateIndexesOptions.html index 4412002bca7..05e8713fe3e 100644 --- a/docs/Next/interfaces/CreateIndexesOptions.html +++ b/docs/Next/interfaces/CreateIndexesOptions.html @@ -13,7 +13,7 @@

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    Optional commitQuorum

    commitQuorum?: string | number

    (MongoDB 4.4. or higher) Specifies how many data-bearing members of a replica set, including the primary, must complete the index builds successfully before the primary marks the indexes as ready. This option accepts the same values for the "w" field in a write concern plus "votingMembers", which indicates all voting data-bearing nodes.

    -

    Optional dbName

    dbName?: string

    Optional default_language

    default_language?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional default_language

    default_language?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional expireAfterSeconds

    expireAfterSeconds?: number

    Allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher)

    @@ -40,7 +40,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/DbOptions.html b/docs/Next/interfaces/DbOptions.html index 008d17bbc7b..8e067c36133 100644 --- a/docs/Next/interfaces/DbOptions.html +++ b/docs/Next/interfaces/DbOptions.html @@ -4,7 +4,7 @@

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    @@ -20,7 +20,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcern

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

    diff --git a/docs/Next/interfaces/DbStatsOptions.html b/docs/Next/interfaces/DbStatsOptions.html index 8735f7edb0b..e93a6374c43 100644 --- a/docs/Next/interfaces/DbStatsOptions.html +++ b/docs/Next/interfaces/DbStatsOptions.html @@ -9,7 +9,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -24,7 +24,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/DeleteOptions.html b/docs/Next/interfaces/DeleteOptions.html index a41dba1c2e4..f72736edda8 100644 --- a/docs/Next/interfaces/DeleteOptions.html +++ b/docs/Next/interfaces/DeleteOptions.html @@ -9,7 +9,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -30,7 +30,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    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

    Properties

    Optional name

    name?: string

    Optional platform

    platform?: string

    Optional version

    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

    Properties

    Optional name

    name?: string

    Optional platform

    platform?: string

    Optional version

    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/DropCollectionOptions.html b/docs/Next/interfaces/DropCollectionOptions.html index 9b50f3f1d23..3c85abf5ced 100644 --- a/docs/Next/interfaces/DropCollectionOptions.html +++ b/docs/Next/interfaces/DropCollectionOptions.html @@ -9,7 +9,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional encryptedFields

    encryptedFields?: Document
    experimental

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -24,7 +24,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/EstimatedDocumentCountOptions.html b/docs/Next/interfaces/EstimatedDocumentCountOptions.html index 73f3c95ab80..ad937cd6607 100644 --- a/docs/Next/interfaces/EstimatedDocumentCountOptions.html +++ b/docs/Next/interfaces/EstimatedDocumentCountOptions.html @@ -9,7 +9,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -27,7 +27,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/EvalOptions.html b/docs/Next/interfaces/EvalOptions.html index fc7c67a1ac4..a780958cadf 100644 --- a/docs/Next/interfaces/EvalOptions.html +++ b/docs/Next/interfaces/EvalOptions.html @@ -9,7 +9,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -24,7 +24,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/FindOneAndDeleteOptions.html b/docs/Next/interfaces/FindOneAndDeleteOptions.html index 49cfe467b8d..8e85ca4f21e 100644 --- a/docs/Next/interfaces/FindOneAndDeleteOptions.html +++ b/docs/Next/interfaces/FindOneAndDeleteOptions.html @@ -9,7 +9,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -30,7 +30,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/FindOneAndReplaceOptions.html b/docs/Next/interfaces/FindOneAndReplaceOptions.html index 50a5aded4c6..4ca37787126 100644 --- a/docs/Next/interfaces/FindOneAndReplaceOptions.html +++ b/docs/Next/interfaces/FindOneAndReplaceOptions.html @@ -11,7 +11,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -32,7 +32,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/FindOneAndUpdateOptions.html b/docs/Next/interfaces/FindOneAndUpdateOptions.html index f8bfefbd955..529d2b74e1a 100644 --- a/docs/Next/interfaces/FindOneAndUpdateOptions.html +++ b/docs/Next/interfaces/FindOneAndUpdateOptions.html @@ -13,7 +13,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -34,7 +34,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/FindOptions.html b/docs/Next/interfaces/FindOptions.html index a847b503d58..57afae2e005 100644 --- a/docs/Next/interfaces/FindOptions.html +++ b/docs/Next/interfaces/FindOptions.html @@ -19,7 +19,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -55,7 +55,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/InsertOneOptions.html b/docs/Next/interfaces/InsertOneOptions.html index 20885f6904c..d98b6ba92d3 100644 --- a/docs/Next/interfaces/InsertOneOptions.html +++ b/docs/Next/interfaces/InsertOneOptions.html @@ -11,7 +11,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -28,7 +28,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/ListCollectionsOptions.html b/docs/Next/interfaces/ListCollectionsOptions.html index 10c29ee483a..8b9352f12c8 100644 --- a/docs/Next/interfaces/ListCollectionsOptions.html +++ b/docs/Next/interfaces/ListCollectionsOptions.html @@ -13,7 +13,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -30,7 +30,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/ListDatabasesOptions.html b/docs/Next/interfaces/ListDatabasesOptions.html index 9337f3406d8..03ee45afd48 100644 --- a/docs/Next/interfaces/ListDatabasesOptions.html +++ b/docs/Next/interfaces/ListDatabasesOptions.html @@ -11,7 +11,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -30,7 +30,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/ListIndexesOptions.html b/docs/Next/interfaces/ListIndexesOptions.html index 22ae8924541..4f67c8e9bb8 100644 --- a/docs/Next/interfaces/ListIndexesOptions.html +++ b/docs/Next/interfaces/ListIndexesOptions.html @@ -11,7 +11,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

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

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/MapReduceOptions.html b/docs/Next/interfaces/MapReduceOptions.html index 6fbe8fdf5a9..993e6de1784 100644 --- a/docs/Next/interfaces/MapReduceOptions.html +++ b/docs/Next/interfaces/MapReduceOptions.html @@ -11,7 +11,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -38,7 +38,7 @@

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

    Optional query

    query?: Document

    Query filter object.

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/MongoClientOptions.html b/docs/Next/interfaces/MongoClientOptions.html index da5eb6f6061..4694c9f1b42 100644 --- a/docs/Next/interfaces/MongoClientOptions.html +++ b/docs/Next/interfaces/MongoClientOptions.html @@ -4,17 +4,17 @@

    Hierarchy

    Index

    Properties

    Properties

    Optional ALPNProtocols

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

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

    -

    Optional appName

    appName?: string
    +

    Optional appName

    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

    -

    Optional auth

    auth?: Auth
    +

    Optional auth

    auth?: Auth

    The auth settings for when connection to server.

    -

    Optional authMechanism

    authMechanism?: AuthMechanism
    +

    Optional authMechanism

    authMechanism?: AuthMechanism

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

    -

    Optional authMechanismProperties

    authMechanismProperties?: AuthMechanismProperties
    +

    Optional authMechanismProperties

    authMechanismProperties?: AuthMechanismProperties

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

    -

    Optional authSource

    authSource?: string
    +

    Optional authSource

    authSource?: string

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

    -

    Optional autoEncryption

    autoEncryption?: AutoEncryptionOptions
    +

    Optional autoEncryption

    autoEncryption?: AutoEncryptionOptions

    Optionally enable client side 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.

    @@ -63,15 +63,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.

    -

    Optional compressors

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

    Optional compressors

    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.

    -

    Optional connectTimeoutMS

    connectTimeoutMS?: number
    +

    Optional connectTimeoutMS

    connectTimeoutMS?: number

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

    Optional crl

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

    PEM formatted CRLs (Certificate Revocation Lists).

    -

    Optional directConnection

    directConnection?: boolean
    +

    Optional directConnection

    directConnection?: boolean

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

    -

    Optional driverInfo

    driverInfo?: DriverInfo
    +

    Optional driverInfo

    driverInfo?: DriverInfo

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

    Optional ecdhCurve

    ecdhCurve?: string

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

    -

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional family

    family?: number

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional forceServerObjectId

    forceServerObjectId?: boolean
    +

    Optional forceServerObjectId

    forceServerObjectId?: boolean

    Force server to assign _id values instead of driver

    -

    Optional heartbeatFrequencyMS

    heartbeatFrequencyMS?: number
    +

    Optional heartbeatFrequencyMS

    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.

    Optional hints

    hints?: number

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional journal

    journal?: boolean
    +

    Optional journal

    journal?: boolean

    The journal write concern

    deprecated

    Please use the writeConcern option instead

    -

    Optional keepAlive

    keepAlive?: boolean
    +

    Optional keepAlive

    keepAlive?: boolean

    TCP Connection keep alive enabled

    -

    Optional keepAliveInitialDelay

    keepAliveInitialDelay?: number
    +

    Optional keepAliveInitialDelay

    keepAliveInitialDelay?: number

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

    Optional key

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

    Private keys in PEM format. PEM allows the option of private keys @@ -107,29 +107,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.

    -

    Optional loadBalanced

    loadBalanced?: boolean
    +

    Optional loadBalanced

    loadBalanced?: boolean

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

    -

    Optional localAddress

    localAddress?: string

    Optional localPort

    localPort?: number

    Optional localThresholdMS

    localThresholdMS?: number
    +

    Optional localAddress

    localAddress?: string

    Optional localPort

    localPort?: number

    Optional localThresholdMS

    localThresholdMS?: number

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

    -

    Optional logger

    logger?: Logger
    +

    Optional logger

    logger?: Logger

    Custom logger object

    -

    Optional loggerLevel

    loggerLevel?: LoggerLevel
    +

    Optional loggerLevel

    loggerLevel?: LoggerLevel

    The logging level

    -

    Optional lookup

    lookup?: LookupFunction

    Optional maxConnecting

    maxConnecting?: number
    +

    Optional lookup

    lookup?: LookupFunction

    Optional maxConnecting

    maxConnecting?: number

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

    -

    Optional maxIdleTimeMS

    maxIdleTimeMS?: number
    +

    Optional maxIdleTimeMS

    maxIdleTimeMS?: number

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

    -

    Optional maxPoolSize

    maxPoolSize?: number
    +

    Optional maxPoolSize

    maxPoolSize?: number

    The maximum number of connections in the connection pool.

    -

    Optional maxStalenessSeconds

    maxStalenessSeconds?: number
    +

    Optional maxStalenessSeconds

    maxStalenessSeconds?: number

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

    -

    Optional minDHSize

    minDHSize?: number

    Optional minHeartbeatFrequencyMS

    minHeartbeatFrequencyMS?: number
    +

    Optional minDHSize

    minDHSize?: number

    Optional minHeartbeatFrequencyMS

    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.

    -

    Optional minPoolSize

    minPoolSize?: number
    +

    Optional minPoolSize

    minPoolSize?: number

    The minimum number of connections in the connection pool.

    -

    Optional monitorCommands

    monitorCommands?: boolean
    +

    Optional monitorCommands

    monitorCommands?: boolean

    Enable command monitoring for this client

    -

    Optional noDelay

    noDelay?: boolean
    +

    Optional noDelay

    noDelay?: boolean

    TCP Connection no delay

    Optional passphrase

    passphrase?: string

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

    @@ -142,9 +142,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.

    -

    Optional pkFactory

    pkFactory?: PkFactory
    +

    Optional pkFactory

    pkFactory?: PkFactory

    A primary key factory function for generation of custom _id keys

    -

    Optional promiseLibrary

    promiseLibrary?: any
    +

    Optional promiseLibrary

    promiseLibrary?: any

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

    Optional promoteBuffers

    promoteBuffers?: boolean

    when deserializing a Binary will return it as a node.js Buffer instance.

    @@ -152,34 +152,34 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional proxyHost

    proxyHost?: string
    +

    Optional proxyHost

    proxyHost?: string

    Configures a Socks5 proxy host used for creating TCP connections.

    -

    Optional proxyPassword

    proxyPassword?: string
    +

    Optional proxyPassword

    proxyPassword?: string

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

    -

    Optional proxyPort

    proxyPort?: number
    +

    Optional proxyPort

    proxyPort?: number

    Configures a Socks5 proxy port used for creating TCP connections.

    -

    Optional proxyUsername

    proxyUsername?: string
    +

    Optional proxyUsername

    proxyUsername?: string

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return document results as raw BSON buffers

    -

    Optional readConcern

    readConcern?: ReadConcernLike
    +

    Optional readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readConcernLevel

    readConcernLevel?: ReadConcernLevel
    +

    Optional readConcernLevel

    readConcernLevel?: ReadConcernLevel

    The level of isolation

    -

    Optional readPreference

    readPreference?: ReadPreference | ReadPreferenceMode
    +

    Optional readPreference

    readPreference?: ReadPreference | ReadPreferenceMode

    Specifies the read preferences for this connection

    -

    Optional readPreferenceTags

    readPreferenceTags?: TagSet[]
    +

    Optional readPreferenceTags

    readPreferenceTags?: TagSet[]

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

    Optional rejectUnauthorized

    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

    -

    Optional replicaSet

    replicaSet?: string
    +

    Optional replicaSet

    replicaSet?: string

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

    -

    Optional retryReads

    retryReads?: boolean
    +

    Optional retryReads

    retryReads?: boolean

    Enables retryable reads.

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Enable retryable writes.

    Optional secureContext

    secureContext?: SecureContext

    An optional TLS context object from tls.createSecureContext()

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

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional serverApi

    serverApi?: "1" | ServerApi
    +

    Optional serverApi

    serverApi?: "1" | ServerApi

    Server API version

    -

    Optional serverSelectionTimeoutMS

    serverSelectionTimeoutMS?: number
    +

    Optional serverSelectionTimeoutMS

    serverSelectionTimeoutMS?: number

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

    -

    Optional servername

    servername?: string

    Optional session

    session?: Buffer

    Optional socketTimeoutMS

    socketTimeoutMS?: number
    +

    Optional servername

    servername?: string

    Optional session

    session?: Buffer

    Optional socketTimeoutMS

    socketTimeoutMS?: number

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

    -

    Optional srvMaxHosts

    srvMaxHosts?: number
    +

    Optional srvMaxHosts

    srvMaxHosts?: number

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

    -

    Optional srvServiceName

    srvServiceName?: string
    +

    Optional srvServiceName

    srvServiceName?: string

    Modifies the srv URI to look like:

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

    Querying this DNS URI is expected to respond with SRV records

    -

    Optional ssl

    ssl?: boolean
    +

    Optional ssl

    ssl?: boolean

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

    -

    Optional sslCA

    sslCA?: string
    +

    Optional sslCA

    sslCA?: string

    SSL Certificate file path.

    -

    Optional sslCRL

    sslCRL?: string
    +

    Optional sslCRL

    sslCRL?: string

    SSL Certificate revocation list file path.

    -

    Optional sslCert

    sslCert?: string
    +

    Optional sslCert

    sslCert?: string

    SSL Certificate file path.

    -

    Optional sslKey

    sslKey?: string
    +

    Optional sslKey

    sslKey?: string

    SSL Key file file path.

    -

    Optional sslPass

    sslPass?: string
    +

    Optional sslPass

    sslPass?: string

    SSL Certificate pass phrase.

    -

    Optional sslValidate

    sslValidate?: boolean
    +

    Optional sslValidate

    sslValidate?: boolean

    Validate mongod server certificate against Certificate Authority

    -

    Optional tls

    tls?: boolean
    +

    Optional tls

    tls?: boolean

    Enables or disables TLS/SSL for the connection.

    -

    Optional tlsAllowInvalidCertificates

    tlsAllowInvalidCertificates?: boolean
    +

    Optional tlsAllowInvalidCertificates

    tlsAllowInvalidCertificates?: boolean

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

    -

    Optional tlsAllowInvalidHostnames

    tlsAllowInvalidHostnames?: boolean
    +

    Optional tlsAllowInvalidHostnames

    tlsAllowInvalidHostnames?: boolean

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

    -

    Optional tlsCAFile

    tlsCAFile?: string
    +

    Optional tlsCAFile

    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.

    -

    Optional tlsCertificateFile

    tlsCertificateFile?: string
    +

    Optional tlsCertificateFile

    tlsCertificateFile?: string

    Specifies the location of a local TLS Certificate

    -

    Optional tlsCertificateKeyFile

    tlsCertificateKeyFile?: string
    +

    Optional tlsCertificateKeyFile

    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.

    -

    Optional tlsCertificateKeyFilePassword

    tlsCertificateKeyFilePassword?: string
    +

    Optional tlsCertificateKeyFilePassword

    tlsCertificateKeyFilePassword?: string

    Specifies the password to de-crypt the tlsCertificateKeyFile.

    -

    Optional tlsInsecure

    tlsInsecure?: boolean
    +

    Optional tlsInsecure

    tlsInsecure?: boolean

    Disables various certificate validations.

    -

    Optional w

    w?: W
    +

    Optional w

    w?: W

    The write concern w value

    deprecated

    Please use the writeConcern option instead

    -

    Optional waitQueueTimeoutMS

    waitQueueTimeoutMS?: number
    +

    Optional waitQueueTimeoutMS

    waitQueueTimeoutMS?: number

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

    -

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

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

    see

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

    -

    Optional wtimeoutMS

    wtimeoutMS?: number
    +

    Optional wtimeoutMS

    wtimeoutMS?: number

    The write concern timeout

    deprecated

    Please use the writeConcern option instead

    -

    Optional zlibCompressionLevel

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

    Optional zlibCompressionLevel

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

    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/MongoOptions.html b/docs/Next/interfaces/MongoOptions.html index 577d7c4ea68..d9462b5bf9c 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

    Properties

    Optional ALPNProtocols

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

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

    -

    Optional autoEncrypter

    autoEncrypter?: AutoEncrypter

    autoEncryption

    autoEncryption: AutoEncryptionOptions
    +

    Optional autoEncrypter

    autoEncrypter?: AutoEncrypter

    autoEncryption

    autoEncryption: AutoEncryptionOptions

    Optionally enable client side 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.

    @@ -48,13 +48,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

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

    connectTimeoutMS

    connectTimeoutMS: number
    +

    compressors

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

    connectTimeoutMS

    connectTimeoutMS: number

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

    -

    Optional credentials

    credentials?: MongoCredentials

    Optional crl

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

    Optional credentials

    credentials?: MongoCredentials

    Optional crl

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

    PEM formatted CRLs (Certificate Revocation Lists).

    -

    dbName

    dbName: string

    directConnection

    directConnection: boolean
    +

    dbName

    dbName: string

    directConnection

    directConnection: boolean

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

    -

    driverInfo

    driverInfo: DriverInfo
    +

    driverInfo

    driverInfo: DriverInfo

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

    Optional ecdhCurve

    ecdhCurve?: string

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

    -

    Optional family

    family?: number

    forceServerObjectId

    forceServerObjectId: boolean
    +

    Optional family

    family?: number

    forceServerObjectId

    forceServerObjectId: boolean

    Force server to assign _id values instead of driver

    -

    heartbeatFrequencyMS

    heartbeatFrequencyMS: number
    +

    heartbeatFrequencyMS

    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.

    -

    Optional hints

    hints?: number

    hosts

    hosts: HostAddress[]

    keepAlive

    keepAlive: boolean
    +

    Optional hints

    hints?: number

    hosts

    hosts: HostAddress[]

    keepAlive

    keepAlive: boolean

    TCP Connection keep alive enabled

    -

    keepAliveInitialDelay

    keepAliveInitialDelay: number
    +

    keepAliveInitialDelay

    keepAliveInitialDelay: number

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

    Optional key

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

    Private keys in PEM format. PEM allows the option of private keys @@ -81,23 +81,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

    loadBalanced: boolean

    Optional localAddress

    localAddress?: string

    Optional localPort

    localPort?: number

    localThresholdMS

    localThresholdMS: number
    +

    loadBalanced

    loadBalanced: boolean

    Optional localAddress

    localAddress?: string

    Optional localPort

    localPort?: number

    localThresholdMS

    localThresholdMS: number

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

    -

    logger

    logger: Logger
    +

    logger

    logger: Logger

    Custom logger object

    -

    Optional lookup

    lookup?: LookupFunction

    maxConnecting

    maxConnecting: number
    +

    Optional lookup

    lookup?: LookupFunction

    maxConnecting

    maxConnecting: number

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

    -

    maxIdleTimeMS

    maxIdleTimeMS: number
    +

    maxIdleTimeMS

    maxIdleTimeMS: number

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

    -

    maxPoolSize

    maxPoolSize: number
    +

    maxPoolSize

    maxPoolSize: number

    The maximum number of connections in the connection pool.

    -

    metadata

    metadata: ClientMetadata

    Optional minDHSize

    minDHSize?: number

    minHeartbeatFrequencyMS

    minHeartbeatFrequencyMS: number
    +

    metadata

    metadata: ClientMetadata

    Optional minDHSize

    minDHSize?: number

    minHeartbeatFrequencyMS

    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

    minPoolSize: number
    +

    minPoolSize

    minPoolSize: number

    The minimum number of connections in the connection pool.

    -

    monitorCommands

    monitorCommands: boolean
    +

    monitorCommands

    monitorCommands: boolean

    Enable command monitoring for this client

    -

    noDelay

    noDelay: boolean
    +

    noDelay

    noDelay: boolean

    TCP Connection no delay

    Optional passphrase

    passphrase?: string

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

    @@ -110,22 +110,22 @@ 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

    pkFactory: PkFactory

    A primary key factory function for generation of custom _id keys

    -

    promiseLibrary

    promiseLibrary: any
    +

    promiseLibrary

    promiseLibrary: any

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

    -

    Optional proxyHost

    proxyHost?: string

    Optional proxyPassword

    proxyPassword?: string

    Optional proxyPort

    proxyPort?: number

    Optional proxyUsername

    proxyUsername?: string

    raw

    raw: boolean
    +

    Optional proxyHost

    proxyHost?: string

    Optional proxyPassword

    proxyPassword?: string

    Optional proxyPort

    proxyPort?: number

    Optional proxyUsername

    proxyUsername?: string

    raw

    raw: boolean

    Return document results as raw BSON buffers

    -

    readConcern

    readConcern: ReadConcern

    readPreference

    readPreference: ReadPreference

    Optional rejectUnauthorized

    rejectUnauthorized?: boolean
    +

    readConcern

    readConcern: ReadConcern

    readPreference

    readPreference: ReadPreference

    Optional rejectUnauthorized

    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

    replicaSet: string
    +

    replicaSet

    replicaSet: string

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

    -

    retryReads

    retryReads: boolean
    +

    retryReads

    retryReads: boolean

    Enables retryable reads.

    -

    retryWrites

    retryWrites: boolean
    +

    retryWrites

    retryWrites: boolean

    Enable retryable writes.

    Optional secureContext

    secureContext?: SecureContext

    An optional TLS context object from tls.createSecureContext()

    @@ -139,17 +139,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: ServerApi

    serverSelectionTimeoutMS

    serverSelectionTimeoutMS: number
    +

    serverApi

    serverApi: ServerApi

    serverSelectionTimeoutMS

    serverSelectionTimeoutMS: number

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

    -

    Optional servername

    servername?: string

    Optional session

    session?: Buffer

    socketTimeoutMS

    socketTimeoutMS: number
    +

    Optional servername

    servername?: string

    Optional session

    session?: Buffer

    socketTimeoutMS

    socketTimeoutMS: number

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

    -

    Optional srvHost

    srvHost?: string

    srvMaxHosts

    srvMaxHosts: number
    +

    Optional srvHost

    srvHost?: string

    srvMaxHosts

    srvMaxHosts: number

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

    -

    srvServiceName

    srvServiceName: string
    +

    srvServiceName

    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

    tls: boolean
    +

    tls

    tls: boolean

    NOTE ABOUT TLS Options

    @@ -198,14 +198,14 @@

    Additional options:

    boolean -

    tlsAllowInvalidCertificates

    tlsAllowInvalidCertificates: boolean
    +

    tlsAllowInvalidCertificates

    tlsAllowInvalidCertificates: boolean

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

    -

    tlsAllowInvalidHostnames

    tlsAllowInvalidHostnames: boolean
    +

    tlsAllowInvalidHostnames

    tlsAllowInvalidHostnames: boolean

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

    -

    tlsInsecure

    tlsInsecure: boolean
    +

    tlsInsecure

    tlsInsecure: boolean

    Disables various certificate validations.

    -

    waitQueueTimeoutMS

    waitQueueTimeoutMS: number
    +

    waitQueueTimeoutMS

    waitQueueTimeoutMS: number

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

    -

    writeConcern

    writeConcern: WriteConcern

    zlibCompressionLevel

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

    writeConcern

    writeConcern: WriteConcern

    zlibCompressionLevel

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

    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/OperationOptions.html b/docs/Next/interfaces/OperationOptions.html index cfd0e9cf97f..2b61acd87f7 100644 --- a/docs/Next/interfaces/OperationOptions.html +++ b/docs/Next/interfaces/OperationOptions.html @@ -2,7 +2,7 @@

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    @@ -14,7 +14,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readPreference

    readPreference?: ReadPreferenceLike

    The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

    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

    • 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

    • 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/RenameOptions.html b/docs/Next/interfaces/RenameOptions.html index 6d44a553203..f06870721e1 100644 --- a/docs/Next/interfaces/RenameOptions.html +++ b/docs/Next/interfaces/RenameOptions.html @@ -11,7 +11,7 @@

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    Optional dbName

    dbName?: string

    Optional dropTarget

    dropTarget?: boolean

    Drop the target name collection if it previously exists.

    -

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -28,7 +28,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/ReplaceOptions.html b/docs/Next/interfaces/ReplaceOptions.html index 0e68d7b113c..ba4108fa503 100644 --- a/docs/Next/interfaces/ReplaceOptions.html +++ b/docs/Next/interfaces/ReplaceOptions.html @@ -11,7 +11,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -30,7 +30,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    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

    Properties

    Optional deprecationErrors

    deprecationErrors?: boolean

    Optional strict

    strict?: boolean

    version

    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

    Properties

    Optional deprecationErrors

    deprecationErrors?: boolean

    Optional strict

    strict?: boolean

    version

    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 64a41163e49..a8617e36025 100644 --- a/docs/Next/interfaces/TopologyOptions.html +++ b/docs/Next/interfaces/TopologyOptions.html @@ -51,7 +51,7 @@ recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.

    -

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional family

    family?: number

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    @@ -91,7 +91,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional proxyHost

    proxyHost?: string

    Optional proxyPassword

    proxyPassword?: string

    Optional proxyPort

    proxyPort?: number

    Optional proxyUsername

    proxyUsername?: string

    Optional raw

    raw?: boolean
    +

    Optional proxyHost

    proxyHost?: string

    Optional proxyPassword

    proxyPassword?: string

    Optional proxyPort

    proxyPort?: number

    Optional proxyUsername

    proxyUsername?: string

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional rejectUnauthorized

    rejectUnauthorized?: boolean

    If true the server will reject any connection which is not diff --git a/docs/Next/interfaces/TransactionOptions.html b/docs/Next/interfaces/TransactionOptions.html index 8a87660fb77..e7ec605e9f4 100644 --- a/docs/Next/interfaces/TransactionOptions.html +++ b/docs/Next/interfaces/TransactionOptions.html @@ -11,7 +11,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -28,7 +28,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

    A default read concern for commands in this transaction

    diff --git a/docs/Next/interfaces/UpdateOptions.html b/docs/Next/interfaces/UpdateOptions.html index 92787a1cfac..348fe57a421 100644 --- a/docs/Next/interfaces/UpdateOptions.html +++ b/docs/Next/interfaces/UpdateOptions.html @@ -13,7 +13,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    @@ -32,7 +32,7 @@

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/interfaces/ValidateCollectionOptions.html b/docs/Next/interfaces/ValidateCollectionOptions.html index 26bd797314b..389015b0242 100644 --- a/docs/Next/interfaces/ValidateCollectionOptions.html +++ b/docs/Next/interfaces/ValidateCollectionOptions.html @@ -11,7 +11,7 @@

    In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

    In server versions 4.4 and above, 'comment' can be any valid BSON type.

    -

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional dbName

    dbName?: string

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

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

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

    Optional promoteValues

    promoteValues?: boolean

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

    -

    Optional raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    Optional readConcern

    readConcern?: ReadConcernLike

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

    diff --git a/docs/Next/modules.html b/docs/Next/modules.html index 0a3e9cf67c5..1a058483c4c 100644 --- a/docs/Next/modules.html +++ b/docs/Next/modules.html @@ -16,7 +16,7 @@

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

    Type parameters

    FilterOperations

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

    Type parameters

    FinalizeFunction

    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

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

    Type parameters

    GSSAPICanonicalizationValue

    GSSAPICanonicalizationValue: typeof GSSAPICanonicalizationValue[keyof typeof GSSAPICanonicalizationValue]

    GenericListener

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

    Type declaration

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

      • Parameters

        • Rest ...args: any[]

        Returns void

    GridFSBucketEvents

    GridFSBucketEvents: { index: any }

    Type declaration

    Hint

    Hint: string | Document

    IndexDirection

    IndexDirection: -1 | 1 | "2d" | "2dsphere" | "text" | "geoHaystack" | number

    IndexSpecification

    IndexSpecification: OneOrMore<string | [string, IndexDirection] | {} | Map<string, IndexDirection>>

    InferIdType

    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

    IntegerType: number | Int32 | Long

    IsAny

    IsAny<Type, ResultIfAny, ResultIfNotAny>: true extends false & Type ? ResultIfAny : ResultIfNotAny

    Type parameters

    Join

    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

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

    Type parameters

    KeysOfOtherType

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

    Type parameters

    LoggerFunction

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

    Type declaration

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

      • Parameters

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

        Returns void

    LoggerLevel

    LoggerLevel: typeof LoggerLevel[keyof typeof LoggerLevel]

    MapFunction

    MapFunction<TSchema>: (this: TSchema) => void

    Type parameters

    Type declaration

      • (this: TSchema): void

      • Parameters

        • this: TSchema

        Returns void

    MatchKeysAndValues

    MatchKeysAndValues<TSchema>: Readonly<{ [ Property in Join<NestedPaths<TSchema, false>, ".">]?: PropertyType<TSchema, Property, false> }>

    Type parameters

    MongoClientEvents

    MongoClientEvents: Pick<TopologyEvents, typeof MONGO_CLIENT_EVENTS[number]> & { open: any }

    MongoErrorLabel

    MongoErrorLabel: typeof MongoErrorLabel[keyof typeof MongoErrorLabel]

    MonitorEvents

    MonitorEvents: { close: any; resetConnectionPool: any; resetServer: any; serverHeartbeatFailed: any; serverHeartbeatStarted: any; serverHeartbeatSucceeded: any } & EventEmitterWithState

    NestedPaths

    NestedPaths<Type, AllowToSkipArrayIndex>: Type extends unknown ? Type extends string | number | boolean | Date | RegExp | Buffer | Uint8Array | ((...args: any[]) => any) | { _bsontype: string } ? never : Type extends ReadonlyArray<infer ArrayType> ? [...(AllowToSkipArrayIndex extends true ? [] : never) | [number | `$${"" | `[${string}]`}`], ...[] | NestedPaths<ArrayType, AllowToSkipArrayIndex>] : 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], AllowToSkipArrayIndex>] : [Key, ...[] | NestedPaths<Type[Key], AllowToSkipArrayIndex>] }[Extract<keyof Type, string>] : never : never

    Type parameters

    NonObjectIdLikeDocument

    NonObjectIdLikeDocument: { [ key in keyof ObjectIdLike]?: never } & Document

    NotAcceptedFields

    NotAcceptedFields<TSchema, FieldType>: { readonly [ key in KeysOfOtherType<TSchema, FieldType>]?: never }
    +

    Type parameters

    IntegerType

    IntegerType: number | Int32 | Long

    IsAny

    IsAny<Type, ResultIfAny, ResultIfNotAny>: true extends false & Type ? ResultIfAny : ResultIfNotAny

    Type parameters

    Join

    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

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

    Type parameters

    KeysOfOtherType

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

    Type parameters

    LoggerFunction

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

    Type declaration

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

      • Parameters

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

        Returns void

    LoggerLevel

    LoggerLevel: typeof LoggerLevel[keyof typeof LoggerLevel]

    MapFunction

    MapFunction<TSchema>: (this: TSchema) => void

    Type parameters

    Type declaration

      • (this: TSchema): void

      • Parameters

        • this: TSchema

        Returns void

    MatchKeysAndValues

    MatchKeysAndValues<TSchema>: Readonly<{ [ Property in Join<NestedPaths<TSchema, false>, ".">]?: PropertyType<TSchema, Property, false> }>

    Type parameters

    MongoClientEvents

    MongoClientEvents: Pick<TopologyEvents, typeof MONGO_CLIENT_EVENTS[number]> & { open: any }

    MongoErrorLabel

    MongoErrorLabel: typeof MongoErrorLabel[keyof typeof MongoErrorLabel]

    MonitorEvents

    MonitorEvents: { close: any; resetConnectionPool: any; resetServer: any; serverHeartbeatFailed: any; serverHeartbeatStarted: any; serverHeartbeatSucceeded: any } & EventEmitterWithState

    NestedPaths

    NestedPaths<Type, AllowToSkipArrayIndex>: Type extends unknown ? Type extends string | number | boolean | Date | RegExp | Buffer | Uint8Array | ((...args: any[]) => any) | { _bsontype: string } ? never : Type extends ReadonlyArray<infer ArrayType> ? [...(AllowToSkipArrayIndex extends true ? [] : never) | [number | `$${"" | `[${string}]`}`], ...[] | NestedPaths<ArrayType, AllowToSkipArrayIndex>] : 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], AllowToSkipArrayIndex>] : [Key, ...[] | NestedPaths<Type[Key], AllowToSkipArrayIndex>] }[Extract<keyof Type, string>] : never : never

    Type parameters

    NonObjectIdLikeDocument

    NonObjectIdLikeDocument: { [ key in keyof ObjectIdLike]?: never } & Document

    NotAcceptedFields

    NotAcceptedFields<TSchema, FieldType>: { readonly [ key in KeysOfOtherType<TSchema, FieldType>]?: never }

    It avoids using fields with not acceptable types @public

    Type parameters

    NumericType

    NumericType: IntegerType | Decimal128 | Double

    OneOrMore

    OneOrMore<T>: T | ReadonlyArray<T>

    Type parameters

    OnlyFieldsOfType

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], Record<string, FieldType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type parameters

    OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    @@ -34,12 +34,12 @@

    PropertyType

    PropertyType<Type, Property, AllowToSkipArrayIndex>: Type extends unknown ? string extends Property ? Type extends Map<string, infer MapType> ? MapType : never : (AllowToSkipArrayIndex extends false ? never : Type extends ReadonlyArray<infer ArrayType> ? PropertyType<ArrayType, Property, AllowToSkipArrayIndex> : never) | (Property extends keyof Type ? Type[Property] : Property extends `${number | `$${"" | `[${string}]`}`}` ? Type extends ReadonlyArray<infer ArrayType> ? ArrayType : never : Property extends `${infer Key}.${infer Rest}` ? Key extends `${number | `$${"" | `[${string}]`}`}` ? Type extends ReadonlyArray<infer ArrayType> ? PropertyType<ArrayType, Rest, AllowToSkipArrayIndex> : never : Key extends keyof Type ? PropertyType<Type[Key], Rest, AllowToSkipArrayIndex> : never : never) : never

    Type parameters

    PullAllOperator

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

    Type parameters

    PullOperator

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

    Type parameters

    PushOperator

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

    Type parameters

    ReadConcernLevel

    ReadConcernLevel: typeof ReadConcernLevel[keyof typeof ReadConcernLevel]

    ReadConcernLike

    ReadConcernLike: ReadConcern | { level: ReadConcernLevel } | ReadConcernLevel

    ReadPreferenceLike

    ReadPreferenceLike: ReadPreference | ReadPreferenceMode

    ReadPreferenceMode

    ReadPreferenceMode: typeof ReadPreferenceMode[keyof typeof ReadPreferenceMode]

    ReduceFunction

    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

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

    Type parameters

    RemoveUserOptions

    RemoveUserOptions: CommandOperationOptions

    ResumeToken

    ResumeToken: unknown

    Represents the logical starting point for a new ChangeStream or resuming a ChangeStream on the server.

    see

    https://www.mongodb.com/docs/manual/changeStreams/#std-label-change-stream-resume

    -

    ReturnDocument

    ReturnDocument: typeof ReturnDocument[keyof typeof ReturnDocument]

    RunCommandOptions

    RunCommandOptions: CommandOperationOptions

    SchemaMember

    SchemaMember<T, V>: { [ P in keyof T]?: V } | {}

    Type parameters

    ServerApiVersion

    ServerApiVersion: typeof ServerApiVersion[keyof typeof ServerApiVersion]

    ServerEvents

    ServerEvents: { closed: any; connect: any; descriptionReceived: any; ended: any; serverHeartbeatFailed: any; serverHeartbeatStarted: any; serverHeartbeatSucceeded: any } & ConnectionPoolEvents & EventEmitterWithState

    ServerOptions

    ServerOptions: Omit<ConnectionPoolOptions, "id" | "generation" | "hostAddress"> & MonitorOptions

    ServerSelector

    ServerSelector: (topologyDescription: TopologyDescription, servers: ServerDescription[]) => ServerDescription[]

    Type declaration

    ServerSessionId

    ServerSessionId: { id: Binary }

    Type declaration

    ServerType

    ServerType: typeof ServerType[keyof typeof ServerType]

    SetFields

    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

    SetProfilingLevelOptions: CommandOperationOptions

    Sort

    Sort: string | Exclude<SortDirection, { $meta: string }> | string[] | {} | Map<string, SortDirection> | [string, SortDirection][] | [string, SortDirection]

    SortDirection

    SortDirection: 1 | -1 | "asc" | "desc" | "ascending" | "descending" | { $meta: string }

    Stream

    Stream: Socket | TLSSocket

    SupportedNodeConnectionOptions

    SupportedNodeConnectionOptions: SupportedTLSConnectionOptions & SupportedTLSSocketOptions & SupportedSocketOptions

    SupportedSocketOptions

    SupportedSocketOptions: Pick<TcpNetConnectOpts, typeof LEGAL_TCP_SOCKET_OPTIONS[number]>

    SupportedTLSConnectionOptions

    SupportedTLSConnectionOptions: Pick<TLSConnectionOptions, Extract<keyof TLSConnectionOptions, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>>

    SupportedTLSSocketOptions

    SupportedTLSSocketOptions: Pick<TLSSocketOptions, Extract<keyof TLSSocketOptions, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>>

    TagSet

    TagSet: {}

    Type declaration

    • [key: string]: string

    TopologyEvents

    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

    TopologyType: typeof TopologyType[keyof typeof TopologyType]

    UpdateFilter

    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

    W: number | "majority"

    WithId

    WithId<TSchema>: EnhancedOmit<TSchema, "_id"> & { _id: InferIdType<TSchema> }
    +

    ReturnDocument

    ReturnDocument: typeof ReturnDocument[keyof typeof ReturnDocument]

    RunCommandOptions

    RunCommandOptions: CommandOperationOptions

    SchemaMember

    SchemaMember<T, V>: { [ P in keyof T]?: V } | {}

    Type parameters

    ServerApiVersion

    ServerApiVersion: typeof ServerApiVersion[keyof typeof ServerApiVersion]

    ServerEvents

    ServerEvents: { closed: any; connect: any; descriptionReceived: any; ended: any; serverHeartbeatFailed: any; serverHeartbeatStarted: any; serverHeartbeatSucceeded: any } & ConnectionPoolEvents & EventEmitterWithState

    ServerOptions

    ServerOptions: Omit<ConnectionPoolOptions, "id" | "generation" | "hostAddress"> & MonitorOptions

    ServerSelector

    ServerSelector: (topologyDescription: TopologyDescription, servers: ServerDescription[]) => ServerDescription[]

    Type declaration

    ServerSessionId

    ServerSessionId: { id: Binary }

    Type declaration

    ServerType

    ServerType: typeof ServerType[keyof typeof ServerType]

    SetFields

    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

    SetProfilingLevelOptions: CommandOperationOptions

    Sort

    Sort: string | Exclude<SortDirection, { $meta: string }> | string[] | {} | Map<string, SortDirection> | [string, SortDirection][] | [string, SortDirection]

    SortDirection

    SortDirection: 1 | -1 | "asc" | "desc" | "ascending" | "descending" | { $meta: string }

    Stream

    Stream: Socket | TLSSocket

    SupportedNodeConnectionOptions

    SupportedNodeConnectionOptions: SupportedTLSConnectionOptions & SupportedTLSSocketOptions & SupportedSocketOptions

    SupportedSocketOptions

    SupportedSocketOptions: Pick<TcpNetConnectOpts, typeof LEGAL_TCP_SOCKET_OPTIONS[number]>

    SupportedTLSConnectionOptions

    SupportedTLSConnectionOptions: Pick<TLSConnectionOptions, Extract<keyof TLSConnectionOptions, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>>

    SupportedTLSSocketOptions

    SupportedTLSSocketOptions: Pick<TLSSocketOptions, Extract<keyof TLSSocketOptions, typeof LEGAL_TLS_SOCKET_OPTIONS[number]>>

    TagSet

    TagSet: {}

    Type declaration

    • [key: string]: string

    TopologyEvents

    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

    TopologyType: typeof TopologyType[keyof typeof TopologyType]

    UpdateFilter

    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

    W: number | "majority"

    WithId

    WithId<TSchema>: EnhancedOmit<TSchema, "_id"> & { _id: InferIdType<TSchema> }

    Add an _id field to an object shaped type @public

    -

    Type parameters

    WithSessionCallback

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

    Type declaration

    WithTransactionCallback

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

    Type parameters

    Type declaration

    WithoutId

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

    Type parameters

    WithSessionCallback

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

    Type declaration

    WithTransactionCallback

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

    Type parameters

    Type declaration

    WithoutId

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

    Remove the _id field from an object shaped type @public

    -

    Type parameters

    Variables

    Const AuthMechanism

    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" }> = ...

    Const AutoEncryptionLoggerLevel

    AutoEncryptionLoggerLevel: Readonly<{ Error: 1; FatalError: 0; Info: 3; Trace: 4; Warning: 2 }> = ...

    Const BSONType

    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 }> = ...

    Const BatchType

    BatchType: Readonly<{ DELETE: 3; INSERT: 1; UPDATE: 2 }> = ...

    Const CURSOR_FLAGS

    CURSOR_FLAGS: readonly ["tailable", "oplogReplay", "noCursorTimeout", "awaitData", "exhaust", "partial"] = ...

    Const Compressor

    Compressor: Readonly<{ none: 0; snappy: 1; zlib: 2; zstd: 3 }> = ...

    Const ExplainVerbosity

    ExplainVerbosity: Readonly<{ allPlansExecution: "allPlansExecution"; executionStats: "executionStats"; queryPlanner: "queryPlanner"; queryPlannerExtended: "queryPlannerExtended" }> = ...

    Const GSSAPICanonicalizationValue

    GSSAPICanonicalizationValue: Readonly<{ forward: "forward"; forwardAndReverse: "forwardAndReverse"; none: "none"; off: false; on: true }> = ...

    Const LEGAL_TCP_SOCKET_OPTIONS

    LEGAL_TCP_SOCKET_OPTIONS: readonly ["family", "hints", "localAddress", "localPort", "lookup"] = ...

    Const LEGAL_TLS_SOCKET_OPTIONS

    LEGAL_TLS_SOCKET_OPTIONS: readonly ["ALPNProtocols", "ca", "cert", "checkServerIdentity", "ciphers", "crl", "ecdhCurve", "key", "minDHSize", "passphrase", "pfx", "rejectUnauthorized", "secureContext", "secureProtocol", "servername", "session"] = ...

    Const LoggerLevel

    LoggerLevel: Readonly<{ DEBUG: "debug"; ERROR: "error"; INFO: "info"; WARN: "warn"; debug: "debug"; error: "error"; info: "info"; warn: "warn" }> = ...

    Const MONGO_CLIENT_EVENTS

    MONGO_CLIENT_EVENTS: readonly ["connectionPoolCreated", "connectionPoolClosed", "connectionCreated", "connectionReady", "connectionClosed", "connectionCheckOutStarted", "connectionCheckOutFailed", "connectionCheckedOut", "connectionCheckedIn", "connectionPoolCleared", "commandStarted", "commandSucceeded", "commandFailed", "serverOpening", "serverClosed", "serverDescriptionChanged", "topologyOpening", "topologyClosed", "topologyDescriptionChanged", "error", "timeout", "close", "serverHeartbeatStarted", "serverHeartbeatSucceeded", "serverHeartbeatFailed"] = ...

    Map

    Map: MapConstructor

    Const MongoErrorLabel

    MongoErrorLabel: Readonly<{ HandshakeError: "HandshakeError"; ResumableChangeStreamError: "ResumableChangeStreamError"; RetryableWriteError: "RetryableWriteError"; TransientTransactionError: "TransientTransactionError"; UnknownTransactionCommitResult: "UnknownTransactionCommitResult" }> = ...

    Const ObjectID

    ObjectID: typeof ObjectId = ObjectId
    deprecated

    Please use ObjectId

    -

    Const ProfilingLevel

    ProfilingLevel: Readonly<{ all: "all"; off: "off"; slowOnly: "slow_only" }> = ...

    Const ReadConcernLevel

    ReadConcernLevel: Readonly<{ available: "available"; linearizable: "linearizable"; local: "local"; majority: "majority"; snapshot: "snapshot" }> = ...

    Const ReadPreferenceMode

    ReadPreferenceMode: Readonly<{ nearest: "nearest"; primary: "primary"; primaryPreferred: "primaryPreferred"; secondary: "secondary"; secondaryPreferred: "secondaryPreferred" }> = ...

    Const ReturnDocument

    ReturnDocument: Readonly<{ AFTER: "after"; BEFORE: "before" }> = ...

    Const ServerApiVersion

    ServerApiVersion: Readonly<{ v1: "1" }> = ...

    Const ServerType

    ServerType: Readonly<{ LoadBalancer: "LoadBalancer"; Mongos: "Mongos"; PossiblePrimary: "PossiblePrimary"; RSArbiter: "RSArbiter"; RSGhost: "RSGhost"; RSOther: "RSOther"; RSPrimary: "RSPrimary"; RSSecondary: "RSSecondary"; Standalone: "Standalone"; Unknown: "Unknown" }> = ...
    +

    Type parameters

    • TSchema

    Variables

    Const AuthMechanism

    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" }> = ...

    Const AutoEncryptionLoggerLevel

    AutoEncryptionLoggerLevel: Readonly<{ Error: 1; FatalError: 0; Info: 3; Trace: 4; Warning: 2 }> = ...

    Const BSONType

    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 }> = ...

    Const BatchType

    BatchType: Readonly<{ DELETE: 3; INSERT: 1; UPDATE: 2 }> = ...

    Const CURSOR_FLAGS

    CURSOR_FLAGS: readonly ["tailable", "oplogReplay", "noCursorTimeout", "awaitData", "exhaust", "partial"] = ...

    Const Compressor

    Compressor: Readonly<{ none: 0; snappy: 1; zlib: 2; zstd: 3 }> = ...

    Const ExplainVerbosity

    ExplainVerbosity: Readonly<{ allPlansExecution: "allPlansExecution"; executionStats: "executionStats"; queryPlanner: "queryPlanner"; queryPlannerExtended: "queryPlannerExtended" }> = ...

    Const GSSAPICanonicalizationValue

    GSSAPICanonicalizationValue: Readonly<{ forward: "forward"; forwardAndReverse: "forwardAndReverse"; none: "none"; off: false; on: true }> = ...

    Const LEGAL_TCP_SOCKET_OPTIONS

    LEGAL_TCP_SOCKET_OPTIONS: readonly ["family", "hints", "localAddress", "localPort", "lookup"] = ...

    Const LEGAL_TLS_SOCKET_OPTIONS

    LEGAL_TLS_SOCKET_OPTIONS: readonly ["ALPNProtocols", "ca", "cert", "checkServerIdentity", "ciphers", "crl", "ecdhCurve", "key", "minDHSize", "passphrase", "pfx", "rejectUnauthorized", "secureContext", "secureProtocol", "servername", "session"] = ...

    Const LoggerLevel

    LoggerLevel: Readonly<{ DEBUG: "debug"; ERROR: "error"; INFO: "info"; WARN: "warn"; debug: "debug"; error: "error"; info: "info"; warn: "warn" }> = ...

    Const MONGO_CLIENT_EVENTS

    MONGO_CLIENT_EVENTS: readonly ["connectionPoolCreated", "connectionPoolClosed", "connectionCreated", "connectionReady", "connectionClosed", "connectionCheckOutStarted", "connectionCheckOutFailed", "connectionCheckedOut", "connectionCheckedIn", "connectionPoolCleared", "commandStarted", "commandSucceeded", "commandFailed", "serverOpening", "serverClosed", "serverDescriptionChanged", "topologyOpening", "topologyClosed", "topologyDescriptionChanged", "error", "timeout", "close", "serverHeartbeatStarted", "serverHeartbeatSucceeded", "serverHeartbeatFailed"] = ...

    Map

    Map: MapConstructor

    Const MongoErrorLabel

    MongoErrorLabel: Readonly<{ HandshakeError: "HandshakeError"; ResumableChangeStreamError: "ResumableChangeStreamError"; RetryableWriteError: "RetryableWriteError"; TransientTransactionError: "TransientTransactionError"; UnknownTransactionCommitResult: "UnknownTransactionCommitResult" }> = ...

    Const ObjectID

    ObjectID: typeof ObjectId = ObjectId
    deprecated

    Please use ObjectId

    +

    Const ProfilingLevel

    ProfilingLevel: Readonly<{ all: "all"; off: "off"; slowOnly: "slow_only" }> = ...

    Const ReadConcernLevel

    ReadConcernLevel: Readonly<{ available: "available"; linearizable: "linearizable"; local: "local"; majority: "majority"; snapshot: "snapshot" }> = ...

    Const ReadPreferenceMode

    ReadPreferenceMode: Readonly<{ nearest: "nearest"; primary: "primary"; primaryPreferred: "primaryPreferred"; secondary: "secondary"; secondaryPreferred: "secondaryPreferred" }> = ...

    Const ReturnDocument

    ReturnDocument: Readonly<{ AFTER: "after"; BEFORE: "before" }> = ...

    Const ServerApiVersion

    ServerApiVersion: Readonly<{ v1: "1" }> = ...

    Const ServerType

    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

    Const TopologyType

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

    An enumeration of topology types we know about