diff --git a/docs/Next/classes/AbstractCursor.html b/docs/Next/classes/AbstractCursor.html index b8bcacd971d..9b784a14547 100644 --- a/docs/Next/classes/AbstractCursor.html +++ b/docs/Next/classes/AbstractCursor.html @@ -1,4 +1,4 @@ -AbstractCursor | mongodb
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractCursor<TSchema, CursorEvents>

Type parameters

Hierarchy

Index

Events

Properties

Accessors

Methods

Events

Static Readonly CLOSE

CLOSE: "close" = ...

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
+AbstractCursor | mongodb
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractCursor<TSchema, CursorEvents>

Type parameters

Hierarchy

Index

Events

Properties

Accessors

Methods

Events

Static Readonly CLOSE

CLOSE: "close" = ...

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' @@ -7,27 +7,27 @@

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

closed

  • get closed(): boolean

id

  • get id(): undefined | Long

killed

  • get killed(): boolean

loadBalanced

  • get loadBalanced(): boolean

namespace

readConcern

readPreference

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterator<TSchema, void, undefined>

addCursorFlag

  • addCursorFlag(flag: "tailable" | "awaitData" | "noCursorTimeout" | "oplogReplay" | "exhaust" | "partial", value: boolean): AbstractCursor<TSchema, CursorEvents>

Accessors

closed

  • get closed(): boolean

id

  • get id(): undefined | Long

killed

  • get killed(): boolean

loadBalanced

  • get loadBalanced(): boolean

namespace

readConcern

readPreference

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterator<TSchema, void, undefined>

addCursorFlag

  • addCursorFlag(flag: "tailable" | "awaitData" | "noCursorTimeout" | "oplogReplay" | "exhaust" | "partial", value: boolean): AbstractCursor<TSchema, CursorEvents>

  • Add a cursor flag to the cursor

    Parameters

    • flag: "tailable" | "awaitData" | "noCursorTimeout" | "oplogReplay" | "exhaust" | "partial"

      The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.

    • value: boolean

      The flag boolean value.

      -

    Returns AbstractCursor<TSchema, CursorEvents>

addListener

batchSize

Returns AbstractCursor<TSchema, CursorEvents>

addListener

batchSize

bufferedCount

  • bufferedCount(): number

Returns AbstractCursor<TSchema, CursorEvents>

bufferedCount

  • bufferedCount(): number

Abstract clone

Abstract clone

close

emit

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

  • Type parameters

    • EventKey: string | number | symbol

    Parameters

    • event: symbol | EventKey
    • Rest ...args: Parameters<CursorEvents[EventKey]>

    Returns boolean

eventNames

  • eventNames(): string[]

forEach

  • forEach(iterator: (doc: TSchema) => boolean | void): Promise<void>
  • forEach(iterator: (doc: TSchema) => boolean | void, callback: Callback<void>): void

close

emit

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

  • Type parameters

    • EventKey: string | number | symbol

    Parameters

    • event: symbol | EventKey
    • Rest ...args: Parameters<CursorEvents[EventKey]>

    Returns boolean

eventNames

  • eventNames(): string[]

forEach

  • forEach(iterator: (doc: TSchema) => boolean | void): Promise<void>
  • forEach(iterator: (doc: TSchema) => boolean | void, callback: Callback<void>): void

  • Iterates over all the documents for this cursor using the iterator, callback pattern.

    Parameters

    • iterator: (doc: TSchema) => boolean | void

      The iteration callback.

      -
        • (doc: TSchema): boolean | void

        • Parameters

          • doc: TSchema

          Returns boolean | void

    Returns Promise<void>

  • Parameters

    • iterator: (doc: TSchema) => boolean | void
        • (doc: TSchema): boolean | void

        • Parameters

          • doc: TSchema

          Returns boolean | void

    • callback: Callback<void>

    Returns void

getMaxListeners

  • getMaxListeners(): number

hasNext

  • hasNext(): Promise<boolean>
  • hasNext(callback: Callback<boolean>): void

listenerCount

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

listeners

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

map

Returns Promise<void>

  • Parameters

    • iterator: (doc: TSchema) => boolean | void
        • (doc: TSchema): boolean | void

        • Parameters

          • doc: TSchema

          Returns boolean | void

    • callback: Callback<void>

    Returns void

    • getMaxListeners

    • getMaxListeners(): number

    hasNext

    • hasNext(): Promise<boolean>
    • hasNext(callback: Callback<boolean>): void

    listenerCount

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

    listeners

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

    map

    • Map all documents using the provided function If there is a transform set on the cursor, that will be called first and the result passed to this function's transform.

      @@ -39,28 +39,28 @@

      Type parameters

      • T = any

      Parameters

      • transform: (doc: TSchema) => T

        The mapping transformation method.

        -
          • (doc: TSchema): T

          • Parameters

            • doc: TSchema

            Returns T

      Returns AbstractCursor<T, AbstractCursorEvents>

    maxTimeMS

    Returns AbstractCursor<T, AbstractCursorEvents>

    maxTimeMS

    • Set a maxTimeMS on the cursor query, allowing for hard timeout limits on queries (Only supported on MongoDB 2.6 or higher)

      Parameters

      • value: number

        Number of milliseconds to wait before aborting the query.

        -

      Returns AbstractCursor<TSchema, CursorEvents>

    next

    • next(): Promise<null | TSchema>
    • next(callback: Callback<null | TSchema>): void
    • next(callback?: Callback<null | TSchema>): void | Promise<null | TSchema>

    Returns AbstractCursor<TSchema, CursorEvents>

    next

    • next(): Promise<null | TSchema>
    • next(callback: Callback<null | TSchema>): void
    • next(callback?: Callback<null | TSchema>): void | Promise<null | TSchema>

    off

    on

    once

    prependListener

    prependOnceListener

    rawListeners

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

    readBufferedDocuments

    • readBufferedDocuments(number?: number): TSchema[]

    off

    on

    once

    prependListener

    prependOnceListener

    rawListeners

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

    readBufferedDocuments

    • readBufferedDocuments(number?: number): TSchema[]

    removeAllListeners

    • removeAllListeners<EventKey>(event?: string | symbol | EventKey): AbstractCursor<TSchema, CursorEvents>

    removeListener

    rewind

    • rewind(): void

    removeAllListeners

    • removeAllListeners<EventKey>(event?: string | symbol | EventKey): AbstractCursor<TSchema, CursorEvents>

    removeListener

    rewind

    • rewind(): void

    • Rewind this cursor to its uninitialized state. Any options that are present on the cursor will remain in effect. Iterating this cursor will cause new queries to be sent to the server, even if the resultant data has already been retrieved by this cursor.

      -

      Returns void

    setMaxListeners

    stream

    toArray

    • toArray(): Promise<TSchema[]>
    • toArray(callback: Callback<TSchema[]>): void

    setMaxListeners

    stream

    toArray

    • toArray(): Promise<TSchema[]>
    • toArray(callback: Callback<TSchema[]>): void

    • Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contains partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.

      -

      Returns Promise<TSchema[]>

    • Parameters

      Returns void

    tryNext

    • tryNext(): Promise<null | TSchema>
    • tryNext(callback: Callback<null | TSchema>): void

    tryNext

    • tryNext(): Promise<null | TSchema>
    • tryNext(callback: Callback<null | TSchema>): void

    withReadConcern

    withReadConcern

    withReadPreference

    withReadPreference

    • Set the ReadPreference for the cursor.

      Parameters

      • readPreference: ReadPreferenceLike

        The new read preference for the cursor.

        diff --git a/docs/Next/classes/Admin.html b/docs/Next/classes/Admin.html index 9fe65ed39a9..ddda1c7dc4f 100644 --- a/docs/Next/classes/Admin.html +++ b/docs/Next/classes/Admin.html @@ -4,32 +4,32 @@

        ADMIN Cannot directly be instantiated

        example
        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) {
          // Use the admin database for the operation
          const adminDb = client.db(dbName).admin();

          // List all the available databases
          adminDb.listDatabases(function(err, dbs) {
            expect(err).to.not.exist;
            test.ok(dbs.databases.length > 0);
            client.close();
          });
        });
        -

    Hierarchy

    • Admin

    Index

    Methods

    Methods

    addUser

    Hierarchy

    • Admin

    Index

    Methods

    Methods

    addUser

    buildInfo

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    • username: string
    • password: string

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • buildInfo

    command

    command

    listDatabases

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • listDatabases

    ping

    ping

    removeUser

    removeUser

    replSetGetStatus

    Returns Promise<boolean>

  • Parameters

    • username: string
    • callback: Callback<boolean>

    Returns void

  • Parameters

    Returns Promise<boolean>

  • Parameters

    Returns void

    • replSetGetStatus

    serverInfo

    serverInfo

    serverStatus

    serverStatus

    validateCollection

    validateCollection

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/AggregationCursor.html b/docs/Next/classes/AggregationCursor.html index 691dc20e041..f03f032befe 100644 --- a/docs/Next/classes/AggregationCursor.html +++ b/docs/Next/classes/AggregationCursor.html @@ -3,7 +3,7 @@ allowing for iteration over the results returned from the underlying query. It supports one by one document iteration, conversion to an array or can be iterated as a Node 4.X or higher stream

    -

    Type parameters

    Hierarchy

    Index

    Events

    Properties

    Accessors

    Methods

    Events

    Static Readonly CLOSE

    CLOSE: "close" = ...

    Properties

    Static Readonly captureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Static captureRejections

    captureRejections: boolean
    +

    Type parameters

    Hierarchy

    Index

    Events

    Properties

    Accessors

    Methods

    Events

    Static Readonly CLOSE

    CLOSE: "close" = ...

    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' @@ -12,36 +12,36 @@

    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

    closed

    • get closed(): boolean

    id

    • get id(): undefined | Long

    killed

    • get killed(): boolean

    loadBalanced

    • get loadBalanced(): boolean

    namespace

    pipeline

    readConcern

    readPreference

    Methods

    [asyncIterator]

    • [asyncIterator](): AsyncIterator<TSchema, void, undefined>

    addCursorFlag

    • addCursorFlag(flag: "tailable" | "awaitData" | "noCursorTimeout" | "oplogReplay" | "exhaust" | "partial", value: boolean): AggregationCursor<TSchema>

    Accessors

    closed

    • get closed(): boolean

    id

    • get id(): undefined | Long

    killed

    • get killed(): boolean

    loadBalanced

    • get loadBalanced(): boolean

    namespace

    pipeline

    readConcern

    readPreference

    Methods

    [asyncIterator]

    • [asyncIterator](): AsyncIterator<TSchema, void, undefined>

    addCursorFlag

    • addCursorFlag(flag: "tailable" | "awaitData" | "noCursorTimeout" | "oplogReplay" | "exhaust" | "partial", value: boolean): AggregationCursor<TSchema>

    • Add a cursor flag to the cursor

      Parameters

      • flag: "tailable" | "awaitData" | "noCursorTimeout" | "oplogReplay" | "exhaust" | "partial"

        The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.

      • value: boolean

        The flag boolean value.

        -

      Returns AggregationCursor<TSchema>

    addListener

    batchSize

    Returns AggregationCursor<TSchema>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    Returns AggregationCursor<TSchema>

    bufferedCount

    • bufferedCount(): number

    clone

    clone

    close

    emit

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

    eventNames

    • eventNames(): string[]

    explain

    close

    emit

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

    eventNames

    • eventNames(): string[]

    explain

    forEach

    • forEach(iterator: (doc: TSchema) => boolean | void): Promise<void>
    • forEach(iterator: (doc: TSchema) => boolean | void, callback: Callback<void>): void

    forEach

    • forEach(iterator: (doc: TSchema) => boolean | void): Promise<void>
    • forEach(iterator: (doc: TSchema) => boolean | void, callback: Callback<void>): void

    • Iterates over all the documents for this cursor using the iterator, callback pattern.

      Parameters

      • iterator: (doc: TSchema) => boolean | void

        The iteration callback.

        -
          • (doc: TSchema): boolean | void

          • Parameters

            • doc: TSchema

            Returns boolean | void

      Returns Promise<void>

    • Parameters

      • iterator: (doc: TSchema) => boolean | void
          • (doc: TSchema): boolean | void

          • Parameters

            • doc: TSchema

            Returns boolean | void

      • callback: Callback<void>

      Returns void

    geoNear

    getMaxListeners

    • getMaxListeners(): number

    group

    Returns Promise<void>

  • Parameters

    • iterator: (doc: TSchema) => boolean | void
        • (doc: TSchema): boolean | void

        • Parameters

          • doc: TSchema

          Returns boolean | void

    • callback: Callback<void>

    Returns void

    • geoNear

    getMaxListeners

    • getMaxListeners(): number

    group

    hasNext

    • hasNext(): Promise<boolean>
    • hasNext(callback: Callback<boolean>): void

    limit

    hasNext

    • hasNext(): Promise<boolean>
    • hasNext(callback: Callback<boolean>): void

    limit

    listenerCount

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

    listeners

    lookup

    listenerCount

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

    listeners

    lookup

    map

    map

    • Map all documents using the provided function If there is a transform set on the cursor, that will be called first and the result passed to this function's transform.

      @@ -49,17 +49,17 @@ it does not return a new instance of a cursor. This means when calling map, you should always assign the result to a new variable in order to get a correctly typed cursor variable. Take note of the following example:

      -

      Type parameters

      • T

      Parameters

      • transform: (doc: TSchema) => T
          • (doc: TSchema): T

          • Parameters

            • doc: TSchema

            Returns T

      Returns AggregationCursor<T>

    match

    match

    maxTimeMS

    maxTimeMS

    next

    • next(): Promise<null | TSchema>
    • next(callback: Callback<null | TSchema>): void
    • next(callback?: Callback<null | TSchema>): void | Promise<null | TSchema>

    Returns AggregationCursor<TSchema>

    next

    • next(): Promise<null | TSchema>
    • next(callback: Callback<null | TSchema>): void
    • next(callback?: Callback<null | TSchema>): void | Promise<null | TSchema>

    off

    on

    once

    out

    off

    on

    once

    out

    prependListener

    prependOnceListener

    project

    prependListener

    prependOnceListener

    project

    • Add a project stage to the aggregation pipeline

      remarks

      In order to strictly type this function you must provide an interface that represents the effect of your projection on the result documents.

      @@ -75,30 +75,30 @@ Take note of the following example:

      example
      const cursor: AggregationCursor<{ a: number; b: string }> = coll.aggregate([]);
      const projectCursor = cursor.project<{ a: number }>({ _id: 0, a: true });
      const aPropOnlyArray: {a: number}[] = await projectCursor.toArray();

      // or always use chaining and save the final cursor

      const cursor = coll.aggregate().project<{ a: string }>({
        _id: 0,
        a: { $convert: { input: '$a', to: 'string' }
      }});
      -

      Type parameters

      Parameters

      Returns AggregationCursor<T>

    rawListeners

    readBufferedDocuments

    • readBufferedDocuments(number?: number): TSchema[]

    rawListeners

    readBufferedDocuments

    • readBufferedDocuments(number?: number): TSchema[]

    redact

    redact

    removeAllListeners

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

    removeListener

    rewind

    • rewind(): void

    removeAllListeners

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

    removeListener

    rewind

    • rewind(): void

    • Rewind this cursor to its uninitialized state. Any options that are present on the cursor will remain in effect. Iterating this cursor will cause new queries to be sent to the server, even if the resultant data has already been retrieved by this cursor.

      -

      Returns void

    setMaxListeners

    skip

    setMaxListeners

    skip

    sort

    sort

    stream

    toArray

    • toArray(): Promise<TSchema[]>
    • toArray(callback: Callback<TSchema[]>): void

    stream

    toArray

    • toArray(): Promise<TSchema[]>
    • toArray(callback: Callback<TSchema[]>): void

    tryNext

    • tryNext(): Promise<null | TSchema>
    • tryNext(callback: Callback<null | TSchema>): void

    tryNext

    • tryNext(): Promise<null | TSchema>
    • tryNext(callback: Callback<null | TSchema>): void

    unwind

    unwind

    withReadConcern

    withReadConcern

    withReadPreference

    withReadPreference

    Type parameters

    Hierarchy

    • Batch

    Index

    Constructors

    Properties

    Constructors

    constructor

    • new Batch<T>(batchType: BatchType, originalZeroIndex: number): Batch<T>

    Properties

    batchType

    batchType: BatchType

    currentIndex

    currentIndex: number

    operations

    operations: T[]

    originalIndexes

    originalIndexes: number[]

    originalZeroIndex

    originalZeroIndex: number

    size

    size: number

    sizeBytes

    sizeBytes: number

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/BulkOperationBase.html b/docs/Next/classes/BulkOperationBase.html index eb131895620..bc49a7848cc 100644 --- a/docs/Next/classes/BulkOperationBase.html +++ b/docs/Next/classes/BulkOperationBase.html @@ -1,12 +1,12 @@ -BulkOperationBase | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class BulkOperationBase

    Hierarchy

    Index

    Properties

    Accessors

    Methods

    Properties

    isOrdered

    isOrdered: boolean

    Optional operationId

    operationId?: number

    Accessors

    batches

    bsonOptions

    writeConcern

    Methods

    Abstract addToOperationsList

    execute

    find

    Methods

    addListener

    emit

    • emit<EventKey>(event: symbol | EventKey, ...args: Parameters<{ cancel: any }[EventKey]>): boolean

    eventNames

    • eventNames(): string[]

    getMaxListeners

    • getMaxListeners(): number

    listenerCount

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

    listeners

    • listeners<EventKey>(event: string | symbol | EventKey): { cancel: any }[EventKey][]

    off

    on

    once

    prependListener

    prependOnceListener

    rawListeners

    • rawListeners<EventKey>(event: string | symbol | EventKey): { cancel: any }[EventKey][]

    removeAllListeners

    removeListener

    setMaxListeners

    Static getEventListeners

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

    Methods

    addListener

    emit

    • emit<EventKey>(event: symbol | EventKey, ...args: Parameters<{ cancel: any }[EventKey]>): boolean

    eventNames

    • eventNames(): string[]

    getMaxListeners

    • getMaxListeners(): number

    listenerCount

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

    listeners

    • listeners<EventKey>(event: string | symbol | EventKey): { cancel: any }[EventKey][]

    off

    on

    once

    prependListener

    prependOnceListener

    rawListeners

    • rawListeners<EventKey>(event: string | symbol | EventKey): { cancel: any }[EventKey][]

    removeAllListeners

    removeListener

    setMaxListeners

    Static getEventListeners

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

    commitTransaction

    emit

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

    endSession

    emit

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

    endSession

    equals

    equals

    eventNames

    • eventNames(): string[]

    getMaxListeners

    • getMaxListeners(): number

    inTransaction

    • inTransaction(): boolean

    • Returns boolean

      whether this session is currently in a transaction or not

      -

    incrementTransactionNumber

    • incrementTransactionNumber(): void

    Returns boolean

    eventNames

    • eventNames(): string[]

    getMaxListeners

    • getMaxListeners(): number

    inTransaction

    • inTransaction(): boolean

    • Returns boolean

      whether this session is currently in a transaction or not

      +

    incrementTransactionNumber

    • incrementTransactionNumber(): void

    • Increment the transaction number on the internal ServerSession

      -

      Returns void

    listenerCount

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

    listeners

    off

    on

    once

    prependListener

    prependOnceListener

    rawListeners

    removeAllListeners

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

    removeListener

    setMaxListeners

    startTransaction

    listenerCount

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

    listeners

    off

    on

    once

    prependListener

    prependOnceListener

    rawListeners

    removeAllListeners

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

    removeListener

    setMaxListeners

    startTransaction

    toBSON

    • toBSON(): never

    Returns void

    toBSON

    • toBSON(): never

    • This is here to ensure that ClientSession is never serialized to BSON.

      -

      Returns never

    withTransaction

    withTransaction

    • Runs a provided lambda within a transaction, retrying either the commit operation or entire transaction as needed (and when the error permits) to better ensure that the transaction can complete successfully.

      diff --git a/docs/Next/classes/Collection.html b/docs/Next/classes/Collection.html index 3fabce77dba..01fa2118c5b 100644 --- a/docs/Next/classes/Collection.html +++ b/docs/Next/classes/Collection.html @@ -4,32 +4,32 @@

      COLLECTION Cannot directly be instantiated

      example
      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) {
        // Create a collection we want to drop later
        const col = client.db(dbName).collection('createIndexExample1');
        // Show that duplicate records got dropped
        col.find({}).toArray(function(err, items) {
          expect(err).to.not.exist;
          test.equal(4, items.length);
          client.close();
        });
      });
      -

    Type parameters

    Hierarchy

    • Collection

    Index

    Accessors

    Methods

    Accessors

    bsonOptions

    collectionName

    • get collectionName(): string

    Type parameters

    Hierarchy

    • Collection

    Index

    Accessors

    Methods

    Accessors

    bsonOptions

    collectionName

    • get collectionName(): string

    dbName

    • get dbName(): string

    dbName

    • get dbName(): string

    hint

    • get hint(): undefined | Hint
    • set hint(v: undefined | Hint): void

    hint

    • get hint(): undefined | Hint
    • set hint(v: undefined | Hint): void

    logger

    namespace

    • get namespace(): string

    logger

    namespace

    • get namespace(): string

    • The namespace of this collection, in the format ${this.dbName}.${this.collectionName}

      -

      Returns string

    readConcern

    readConcern

    • The current readConcern of the collection. If not explicitly defined for this collection, will be inherited from the parent DB

      -

      Returns undefined | ReadConcern

    readPreference

    readPreference

    • The current readPreference of the collection. If not explicitly defined for this collection, will be inherited from the parent DB

      -

      Returns undefined | ReadPreference

    writeConcern

    writeConcern

    • The current writeConcern of the collection. If not explicitly defined for this collection, will be inherited from the parent DB

      -

      Returns undefined | WriteConcern

    Methods

    aggregate

    Methods

    aggregate

    bulkWrite

    Returns AggregationCursor<T>

    bulkWrite

    count

    Returns Promise<BulkWriteResult>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<BulkWriteResult>

  • Parameters

    Returns void

    • count

    • An estimated count of matching documents in the db to a filter.

      NOTE: This method has been deprecated, since it does not provide an accurate count of the documents in a collection. To obtain an accurate count of documents in the collection, use {@link Collection#countDocuments| countDocuments}. To obtain an estimated count of all documents in the collection, use {@link Collection#estimatedDocumentCount| estimatedDocumentCount}.

      deprecated

      use {@link Collection#countDocuments| countDocuments} or {@link Collection#estimatedDocumentCount| estimatedDocumentCount} instead

      -

      Returns Promise<number>

    • Parameters

      Returns void

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns void

    • Parameters

      Returns Promise<number>

    • Parameters

      Returns void | Promise<number>

    countDocuments

    countDocuments

    createIndex

    createIndex

    • Creates an index on the db and collection collection.

      example
      const collection = client.db('foo').collection('bar');

      await collection.createIndex({ a: 1, b: -1 });

      // Alternate syntax for { c: 1, d: -1 } that ensures order of indexes
      await collection.createIndex([ [c, 1], [d, -1] ]);

      // Equivalent to { e: 1 }
      await collection.createIndex('e');

      // Equivalent to { f: 1, g: 1 }
      await collection.createIndex(['f', 'g'])

      // Equivalent to { h: 1, i: -1 }
      await collection.createIndex([ { h: 1 }, { i: -1 } ]);

      // Equivalent to { j: 1, k: -1, l: 2d }
      await collection.createIndex(['j', ['k', -1], { l: '2d' }])

      Parameters

      • indexSpec: IndexSpecification

        The field name or index specification to create an index for

        -

      Returns Promise<string>

    • Parameters

      Returns void

    • Parameters

      Returns Promise<string>

    • Parameters

      Returns void

    createIndexes

    Returns Promise<string>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<string>

  • Parameters

    Returns void

    • createIndexes

    deleteMany

    Returns Promise<string[]>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<string[]>

  • Parameters

    Returns void

    • deleteMany

    deleteOne

    Returns Promise<DeleteResult>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<DeleteResult>

  • Parameters

    Returns void

    • deleteOne

    distinct

    Returns Promise<DeleteResult>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<DeleteResult>

  • Parameters

    Returns void

    • distinct

    drop

    Returns Promise<Flatten<WithId<TSchema>[Key]>[]>

  • Type parameters

    • Key: string | number | symbol

    Parameters

    Returns void

  • Type parameters

    • Key: string | number | symbol

    Parameters

    • key: Key
    • filter: Filter<TSchema>

    Returns Promise<Flatten<WithId<TSchema>[Key]>[]>

  • Type parameters

    • Key: string | number | symbol

    Parameters

    Returns void

  • Type parameters

    • Key: string | number | symbol

    Parameters

    Returns Promise<Flatten<WithId<TSchema>[Key]>[]>

  • Type parameters

    • Key: string | number | symbol

    Parameters

    Returns void

  • Parameters

    • key: string

    Returns Promise<any[]>

  • Parameters

    Returns void

  • Parameters

    • key: string
    • filter: Filter<TSchema>

    Returns Promise<any[]>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<any[]>

  • Parameters

    Returns void

    • drop

    dropIndex

    dropIndex

    dropIndexes

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • dropIndexes

    estimatedDocumentCount

    estimatedDocumentCount

    find

    find

    findOne

    findOne

    findOneAndDelete

    findOneAndDelete

    findOneAndReplace

    Returns Promise<ModifyResult<TSchema>>

  • Parameters

    Returns Promise<ModifyResult<TSchema>>

  • Parameters

    Returns void

  • Parameters

    Returns void

    • findOneAndReplace

    findOneAndUpdate

    Returns Promise<ModifyResult<TSchema>>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<ModifyResult<TSchema>>

  • Parameters

    Returns void

    • findOneAndUpdate

    getLogger

    Returns Promise<ModifyResult<TSchema>>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<ModifyResult<TSchema>>

  • Parameters

    Returns void

    • getLogger

    indexExists

    • indexExists(indexes: string | string[]): Promise<boolean>
    • indexExists(indexes: string | string[], callback: Callback<boolean>): void
    • indexExists(indexes: string | string[], options: IndexInformationOptions): Promise<boolean>
    • indexExists(indexes: string | string[], options: IndexInformationOptions, callback: Callback<boolean>): void

    indexExists

    • indexExists(indexes: string | string[]): Promise<boolean>
    • indexExists(indexes: string | string[], callback: Callback<boolean>): void
    • indexExists(indexes: string | string[], options: IndexInformationOptions): Promise<boolean>
    • indexExists(indexes: string | string[], options: IndexInformationOptions, callback: Callback<boolean>): void

    indexInformation

    Returns Promise<boolean>

  • Parameters

    • indexes: string | string[]
    • callback: Callback<boolean>

    Returns void

  • Parameters

    Returns Promise<boolean>

  • Parameters

    Returns void

    • indexInformation

    indexes

    indexes

    initializeOrderedBulkOp

    initializeOrderedBulkOp

    initializeUnorderedBulkOp

    initializeUnorderedBulkOp

    insert

    insert

    • Inserts a single document or a an array of documents into MongoDB. If documents passed in do not contain the _id field, one will be added to each of the documents missing it by the driver, mutating the document. This behavior can be overridden by setting the forceServerObjectId flag.

      @@ -159,34 +159,34 @@

      Optional settings for the command

    • callback: Callback<InsertManyResult<TSchema>>

      An optional callback, a Promise will be returned if none is provided

      -

    Returns void | Promise<InsertManyResult<TSchema>>

    insertMany

    Returns void | Promise<InsertManyResult<TSchema>>

    insertMany

    insertOne

    Returns Promise<InsertManyResult<TSchema>>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<InsertManyResult<TSchema>>

  • Parameters

    Returns void

    • insertOne

    isCapped

    Returns Promise<InsertOneResult<TSchema>>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<InsertOneResult<TSchema>>

  • Parameters

    Returns void

    • isCapped

    listIndexes

    listIndexes

    mapReduce

    Returns ListIndexesCursor

    mapReduce

    options

    Returns Promise<Document | Document[]>

  • Type parameters

    • TKey = any

    • TValue = any

    Parameters

    Returns void

  • Type parameters

    • TKey = any

    • TValue = any

    Parameters

    Returns Promise<Document | Document[]>

  • Type parameters

    • TKey = any

    • TValue = any

    Parameters

    Returns void

    • options

    remove

    remove

    • Remove documents.

      deprecated

      use deleteOne, deleteMany or bulkWrite

      Parameters

      • selector: Filter<TSchema>
        @@ -195,20 +195,20 @@

        Optional settings for the command

      • callback: Callback<any>

        An optional callback, a Promise will be returned if none is provided

        -

      Returns void | Promise<DeleteResult>

    rename

    Returns void | Promise<DeleteResult>

    rename

    replaceOne

    Returns Promise<Collection<Document>>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Collection<Document>>

  • Parameters

    Returns void

    • replaceOne

    stats

    Returns Promise<Document | UpdateResult>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document | UpdateResult>

  • Parameters

    Returns void

    • stats

    update

    update

    • Updates documents.

      deprecated

      use updateOne, updateMany or bulkWrite

      Parameters

      • selector: Filter<TSchema>
        @@ -219,19 +219,19 @@

        Optional settings for the command

      • callback: Callback<Document>

        An optional callback, a Promise will be returned if none is provided

        -

      Returns void | Promise<UpdateResult>

    updateMany

    Returns void | Promise<UpdateResult>

    updateMany

    updateOne

    Returns Promise<Document | UpdateResult>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document | UpdateResult>

  • Parameters

    Returns void

    • updateOne

    watch

    Returns Promise<UpdateResult>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<UpdateResult>

  • Parameters

    Returns void

    • watch

    Hierarchy

    • CommandFailedEvent

    Index

    Properties

    Accessors

    Properties

    address

    address: string

    commandName

    commandName: string

    Optional connectionId

    connectionId?: string | number

    duration

    duration: number

    failure

    failure: Error

    requestId

    requestId: number

    Optional serviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    • get hasServiceId(): boolean

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/CommandStartedEvent.html b/docs/Next/classes/CommandStartedEvent.html index 8b70b2163b3..e19e5a2a3da 100644 --- a/docs/Next/classes/CommandStartedEvent.html +++ b/docs/Next/classes/CommandStartedEvent.html @@ -1,3 +1,3 @@ CommandStartedEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class CommandStartedEvent

    An event indicating the start of a given

    -

    Hierarchy

    • CommandStartedEvent

    Index

    Properties

    Accessors

    Properties

    address

    address: string

    command

    command: Document

    commandName

    commandName: string

    Optional commandObj

    commandObj?: Document

    Optional connectionId

    connectionId?: string | number

    databaseName

    databaseName: string

    requestId

    requestId: number

    Optional serviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    • get hasServiceId(): boolean

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    Index

    Properties

    Accessors

    Properties

    address

    address: string

    command

    command: Document

    commandName

    commandName: string

    Optional commandObj

    commandObj?: Document

    Optional connectionId

    connectionId?: string | number

    databaseName

    databaseName: string

    requestId

    requestId: number

    Optional serviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    • get hasServiceId(): boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/CommandSucceededEvent.html b/docs/Next/classes/CommandSucceededEvent.html index 691a7857aff..6e56bb456b2 100644 --- a/docs/Next/classes/CommandSucceededEvent.html +++ b/docs/Next/classes/CommandSucceededEvent.html @@ -1,3 +1,3 @@ CommandSucceededEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class CommandSucceededEvent

    An event indicating the success of a given command

    -

    Hierarchy

    • CommandSucceededEvent

    Index

    Properties

    Accessors

    Properties

    address

    address: string

    commandName

    commandName: string

    Optional connectionId

    connectionId?: string | number

    duration

    duration: number

    reply

    reply: unknown

    requestId

    requestId: number

    Optional serviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    • get hasServiceId(): boolean

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    Index

    Properties

    Accessors

    Properties

    address

    address: string

    commandName

    commandName: string

    Optional connectionId

    connectionId?: string | number

    duration

    duration: number

    reply

    reply: unknown

    requestId

    requestId: number

    Optional serviceId

    serviceId?: ObjectId

    Accessors

    hasServiceId

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ConnectionCheckOutFailedEvent.html b/docs/Next/classes/ConnectionCheckOutFailedEvent.html index 5fa180bd2ad..e728a6f1afb 100644 --- a/docs/Next/classes/ConnectionCheckOutFailedEvent.html +++ b/docs/Next/classes/ConnectionCheckOutFailedEvent.html @@ -1,9 +1,9 @@ ConnectionCheckOutFailedEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ConnectionCheckOutFailedEvent

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

    -

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string
    +

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    -

    reason

    reason: string | AnyError
    +

    reason

    reason: string | AnyError

    The reason the attempt to check out failed

    -

    time

    time: Date
    +

    time

    time: Date

    A timestamp when the event was created

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ConnectionCheckOutStartedEvent.html b/docs/Next/classes/ConnectionCheckOutStartedEvent.html index ffa02d7095d..0478803e49e 100644 --- a/docs/Next/classes/ConnectionCheckOutStartedEvent.html +++ b/docs/Next/classes/ConnectionCheckOutStartedEvent.html @@ -1,7 +1,7 @@ ConnectionCheckOutStartedEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ConnectionCheckOutStartedEvent

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

    -

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string
    +

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    -

    time

    time: Date
    +

    time

    time: Date

    A timestamp when the event was created

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ConnectionCheckedInEvent.html b/docs/Next/classes/ConnectionCheckedInEvent.html index 4defc33b3fe..9b193dc84bf 100644 --- a/docs/Next/classes/ConnectionCheckedInEvent.html +++ b/docs/Next/classes/ConnectionCheckedInEvent.html @@ -1,9 +1,9 @@ ConnectionCheckedInEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ConnectionCheckedInEvent

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

    -

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string
    +

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    -

    connectionId

    connectionId: number | "<monitor>"
    +

    connectionId

    connectionId: number | "<monitor>"

    The id of the connection

    -

    time

    time: Date
    +

    time

    time: Date

    A timestamp when the event was created

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ConnectionCheckedOutEvent.html b/docs/Next/classes/ConnectionCheckedOutEvent.html index 0eba80f4d1e..9160e3146c4 100644 --- a/docs/Next/classes/ConnectionCheckedOutEvent.html +++ b/docs/Next/classes/ConnectionCheckedOutEvent.html @@ -1,9 +1,9 @@ ConnectionCheckedOutEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ConnectionCheckedOutEvent

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

    -

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string
    +

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    -

    connectionId

    connectionId: number | "<monitor>"
    +

    connectionId

    connectionId: number | "<monitor>"

    The id of the connection

    -

    time

    time: Date
    +

    time

    time: Date

    A timestamp when the event was created

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ConnectionClosedEvent.html b/docs/Next/classes/ConnectionClosedEvent.html index cd30dec7f9e..c5eea4bef32 100644 --- a/docs/Next/classes/ConnectionClosedEvent.html +++ b/docs/Next/classes/ConnectionClosedEvent.html @@ -1,11 +1,11 @@ ConnectionClosedEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ConnectionClosedEvent

    An event published when a connection is closed

    -

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string
    +

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    -

    connectionId

    connectionId: number | "<monitor>"
    +

    connectionId

    connectionId: number | "<monitor>"

    The id of the connection

    -

    reason

    reason: string
    +

    reason

    reason: string

    The reason the connection was closed

    -

    Optional serviceId

    serviceId?: ObjectId

    time

    time: Date
    +

    Optional serviceId

    serviceId?: ObjectId

    time

    time: Date

    A timestamp when the event was created

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ConnectionCreatedEvent.html b/docs/Next/classes/ConnectionCreatedEvent.html index 31dc57fa27e..225a7701b85 100644 --- a/docs/Next/classes/ConnectionCreatedEvent.html +++ b/docs/Next/classes/ConnectionCreatedEvent.html @@ -1,9 +1,9 @@ ConnectionCreatedEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ConnectionCreatedEvent

    An event published when a connection pool creates a new connection

    -

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string
    +

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    -

    connectionId

    connectionId: number | "<monitor>"
    +

    connectionId

    connectionId: number | "<monitor>"

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

    -

    time

    time: Date
    +

    time

    time: Date

    A timestamp when the event was created

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ConnectionPoolClearedEvent.html b/docs/Next/classes/ConnectionPoolClearedEvent.html index a5248e6b617..8ba99ee8450 100644 --- a/docs/Next/classes/ConnectionPoolClearedEvent.html +++ b/docs/Next/classes/ConnectionPoolClearedEvent.html @@ -1,7 +1,7 @@ ConnectionPoolClearedEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ConnectionPoolClearedEvent

    An event published when a connection pool is cleared

    -

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string
    +

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    -

    time

    time: Date
    +

    time

    time: Date

    A timestamp when the event was created

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ConnectionPoolClosedEvent.html b/docs/Next/classes/ConnectionPoolClosedEvent.html index 54ee60c84c2..ec49a8c549d 100644 --- a/docs/Next/classes/ConnectionPoolClosedEvent.html +++ b/docs/Next/classes/ConnectionPoolClosedEvent.html @@ -1,7 +1,7 @@ ConnectionPoolClosedEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ConnectionPoolClosedEvent

    An event published when a connection pool is closed

    -

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string
    +

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    -

    time

    time: Date
    +

    time

    time: Date

    A timestamp when the event was created

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ConnectionPoolCreatedEvent.html b/docs/Next/classes/ConnectionPoolCreatedEvent.html index febc362024d..66fd8a7f8f4 100644 --- a/docs/Next/classes/ConnectionPoolCreatedEvent.html +++ b/docs/Next/classes/ConnectionPoolCreatedEvent.html @@ -1,9 +1,9 @@ ConnectionPoolCreatedEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ConnectionPoolCreatedEvent

    An event published when a connection pool is created

    -

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string
    +

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    -

    Optional options

    options?: ConnectionPoolOptions
    +

    Optional options

    options?: ConnectionPoolOptions

    The options used to create this connection pool

    -

    time

    time: Date
    +

    time

    time: Date

    A timestamp when the event was created

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ConnectionPoolMonitoringEvent.html b/docs/Next/classes/ConnectionPoolMonitoringEvent.html index a8596809159..df40e6fc942 100644 --- a/docs/Next/classes/ConnectionPoolMonitoringEvent.html +++ b/docs/Next/classes/ConnectionPoolMonitoringEvent.html @@ -1,7 +1,7 @@ ConnectionPoolMonitoringEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ConnectionPoolMonitoringEvent

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

    -

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string
    +

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    -

    time

    time: Date
    +

    time

    time: Date

    A timestamp when the event was created

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ConnectionReadyEvent.html b/docs/Next/classes/ConnectionReadyEvent.html index ccff9e6e08e..b4a01916ef6 100644 --- a/docs/Next/classes/ConnectionReadyEvent.html +++ b/docs/Next/classes/ConnectionReadyEvent.html @@ -1,9 +1,9 @@ ConnectionReadyEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ConnectionReadyEvent

    An event published when a connection is ready for use

    -

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string
    +

    Hierarchy

    Index

    Properties

    Properties

    address

    address: string

    The address (host/port pair) of the pool

    -

    connectionId

    connectionId: number | "<monitor>"
    +

    connectionId

    connectionId: number | "<monitor>"

    The id of the connection

    -

    time

    time: Date
    +

    time

    time: Date

    A timestamp when the event was created

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/Db.html b/docs/Next/classes/Db.html index 8acf1a0870f..9d4c9765bfb 100644 --- a/docs/Next/classes/Db.html +++ b/docs/Next/classes/Db.html @@ -2,7 +2,7 @@

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

    example
    const { MongoClient } = require('mongodb');
    // Connection url
    const url = 'mongodb://localhost:27017';
    // Database Name
    const dbName = 'test';
    // Connect using MongoClient
    MongoClient.connect(url, function(err, client) {
      // Select the database by name
      const testDb = client.db(dbName);
      client.close();
    });
    -

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Creates a new Db instance

      Parameters

      • client: MongoClient

        The MongoClient for the database.

        @@ -10,92 +10,92 @@

        The name of the database this instance represents.

      • Optional options: DbOptions

        Optional settings for Db construction

        -

      Returns Db

    Properties

    Static SYSTEM_COMMAND_COLLECTION

    SYSTEM_COMMAND_COLLECTION: string = CONSTANTS.SYSTEM_COMMAND_COLLECTION

    Static SYSTEM_INDEX_COLLECTION

    SYSTEM_INDEX_COLLECTION: string = CONSTANTS.SYSTEM_INDEX_COLLECTION

    Static SYSTEM_JS_COLLECTION

    SYSTEM_JS_COLLECTION: string = CONSTANTS.SYSTEM_JS_COLLECTION

    Static SYSTEM_NAMESPACE_COLLECTION

    SYSTEM_NAMESPACE_COLLECTION: string = CONSTANTS.SYSTEM_NAMESPACE_COLLECTION

    Static SYSTEM_PROFILE_COLLECTION

    SYSTEM_PROFILE_COLLECTION: string = CONSTANTS.SYSTEM_PROFILE_COLLECTION

    Static SYSTEM_USER_COLLECTION

    SYSTEM_USER_COLLECTION: string = CONSTANTS.SYSTEM_USER_COLLECTION

    Accessors

    bsonOptions

    databaseName

    • get databaseName(): string

    logger

    namespace

    • get namespace(): string

    options

    readConcern

    readPreference

    Returns Db

    Properties

    Static SYSTEM_COMMAND_COLLECTION

    SYSTEM_COMMAND_COLLECTION: string = CONSTANTS.SYSTEM_COMMAND_COLLECTION

    Static SYSTEM_INDEX_COLLECTION

    SYSTEM_INDEX_COLLECTION: string = CONSTANTS.SYSTEM_INDEX_COLLECTION

    Static SYSTEM_JS_COLLECTION

    SYSTEM_JS_COLLECTION: string = CONSTANTS.SYSTEM_JS_COLLECTION

    Static SYSTEM_NAMESPACE_COLLECTION

    SYSTEM_NAMESPACE_COLLECTION: string = CONSTANTS.SYSTEM_NAMESPACE_COLLECTION

    Static SYSTEM_PROFILE_COLLECTION

    SYSTEM_PROFILE_COLLECTION: string = CONSTANTS.SYSTEM_PROFILE_COLLECTION

    Static SYSTEM_USER_COLLECTION

    SYSTEM_USER_COLLECTION: string = CONSTANTS.SYSTEM_USER_COLLECTION

    Accessors

    bsonOptions

    databaseName

    • get databaseName(): string

    logger

    namespace

    • get namespace(): string

    options

    readConcern

    readPreference

    • The current readPreference of the Db. If not explicitly defined for this Db, will be inherited from the parent MongoClient

      -

      Returns ReadPreference

    secondaryOk

    • get secondaryOk(): boolean

    secondaryOk

    • get secondaryOk(): boolean

    • Check if a secondary can be used (because the read preference is not set to primary)

      -

      Returns boolean

    slaveOk

    • get slaveOk(): boolean

    slaveOk

    • get slaveOk(): boolean

    • slaveOk specified

      deprecated

      Use secondaryOk instead

      -

      Returns boolean

    writeConcern

    Methods

    addUser

    writeConcern

    Methods

    addUser

    admin

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    • username: string
    • password: string

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • admin

    aggregate

    aggregate

    • Execute an aggregation framework pipeline against the database, needs MongoDB >= 3.6

      Type parameters

      Parameters

      • pipeline: Document[] = []

        An array of aggregation stages to be executed

      • Optional options: AggregateOptions

        Optional settings for the command

        -

      Returns AggregationCursor<T>

    collection

    Returns AggregationCursor<T>

    collection

    • Returns a reference to a MongoDB Collection. If it does not exist it will be created implicitly.

      Type parameters

      Parameters

      Returns Collection<TSchema>

      return the new Collection instance

      -

    collections

    collections

    command

    command

    createCollection

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • createCollection

    createIndex

    Returns Promise<Collection<TSchema>>

  • Type parameters

    Parameters

    Returns void

  • Type parameters

    Parameters

    Returns void

    • createIndex

    dropCollection

    Returns Promise<string>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<string>

  • Parameters

    Returns void

    • dropCollection

    dropDatabase

    Returns Promise<boolean>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<boolean>

  • Parameters

    Returns void

    • dropDatabase

    getLogger

    getLogger

    indexInformation

    indexInformation

    listCollections

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • listCollections

    profilingLevel

    Returns ListCollectionsCursor<Pick<CollectionInfo, "name" | "type">>

  • Parameters

    Returns ListCollectionsCursor<CollectionInfo>

  • Type parameters

    Parameters

    Returns ListCollectionsCursor<T>

    • profilingLevel

    removeUser

    removeUser

    renameCollection

    • renameCollection<TSchema>(fromCollection: string, toCollection: string): Promise<Collection<TSchema>>
    • renameCollection<TSchema>(fromCollection: string, toCollection: string, callback: Callback<Collection<TSchema>>): void
    • renameCollection<TSchema>(fromCollection: string, toCollection: string, options: RenameOptions): Promise<Collection<TSchema>>
    • renameCollection<TSchema>(fromCollection: string, toCollection: string, options: RenameOptions, callback: Callback<Collection<TSchema>>): void

    Returns Promise<boolean>

  • Parameters

    • username: string
    • callback: Callback<boolean>

    Returns void

  • Parameters

    Returns Promise<boolean>

  • Parameters

    Returns void

    • renameCollection

    • renameCollection<TSchema>(fromCollection: string, toCollection: string): Promise<Collection<TSchema>>
    • renameCollection<TSchema>(fromCollection: string, toCollection: string, callback: Callback<Collection<TSchema>>): void
    • renameCollection<TSchema>(fromCollection: string, toCollection: string, options: RenameOptions): Promise<Collection<TSchema>>
    • renameCollection<TSchema>(fromCollection: string, toCollection: string, options: RenameOptions, callback: Callback<Collection<TSchema>>): void

    setProfilingLevel

    Returns Promise<Collection<TSchema>>

  • Type parameters

    Parameters

    Returns void

  • Type parameters

    Parameters

    Returns Promise<Collection<TSchema>>

  • Type parameters

    Parameters

    Returns void

    • setProfilingLevel

    stats

    Returns Promise<ProfilingLevel>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<ProfilingLevel>

  • Parameters

    Returns void

    • stats

    unref

    • unref(): void

    unref

    • unref(): void

    • Unref all sockets

      deprecated

      This function is deprecated and will be removed in the next major version.

      -

      Returns void

    watch

    watch

    addListener

    addQueryModifier

    • addQueryModifier(name: string, value: string | number | boolean | Document): FindCursor<TSchema>

    • Add a query modifier to the cursor query

      Parameters

      • name: string

        The query modifier (must start with $, such as $orderby etc)

      • value: string | number | boolean | Document

        The modifier value.

        -

      Returns FindCursor<TSchema>

    allowDiskUse

    Returns FindCursor<TSchema>

    allowDiskUse

    batchSize

    batchSize

    bufferedCount

    • bufferedCount(): number

    Returns FindCursor<TSchema>

    bufferedCount

    • bufferedCount(): number

    clone

    clone

    close

    collation

    close

    collation

    comment

    Returns FindCursor<TSchema>

    comment

    • Add a comment to the cursor query allowing for tracking the comment in the log.

      Parameters

      • value: string

        The comment attached to this query.

        -

      Returns FindCursor<TSchema>

    count

    Returns FindCursor<TSchema>

    count

    emit

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

    eventNames

    • eventNames(): string[]

    explain

    emit

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

    eventNames

    • eventNames(): string[]

    explain

    filter

    filter

    forEach

    • forEach(iterator: (doc: TSchema) => boolean | void): Promise<void>
    • forEach(iterator: (doc: TSchema) => boolean | void, callback: Callback<void>): void

    forEach

    • forEach(iterator: (doc: TSchema) => boolean | void): Promise<void>
    • forEach(iterator: (doc: TSchema) => boolean | void, callback: Callback<void>): void

    • Iterates over all the documents for this cursor using the iterator, callback pattern.

      Parameters

      • iterator: (doc: TSchema) => boolean | void

        The iteration callback.

        -
          • (doc: TSchema): boolean | void

          • Parameters

            • doc: TSchema

            Returns boolean | void

      Returns Promise<void>

    • Parameters

      • iterator: (doc: TSchema) => boolean | void
          • (doc: TSchema): boolean | void

          • Parameters

            • doc: TSchema

            Returns boolean | void

      • callback: Callback<void>

      Returns void

    getMaxListeners

    • getMaxListeners(): number

    hasNext

    • hasNext(): Promise<boolean>
    • hasNext(callback: Callback<boolean>): void

    hint

    Returns Promise<void>

  • Parameters

    • iterator: (doc: TSchema) => boolean | void
        • (doc: TSchema): boolean | void

        • Parameters

          • doc: TSchema

          Returns boolean | void

    • callback: Callback<void>

    Returns void

    • getMaxListeners

    • getMaxListeners(): number

    hasNext

    • hasNext(): Promise<boolean>
    • hasNext(callback: Callback<boolean>): void

    hint

    limit

    Returns FindCursor<TSchema>

    limit

    listenerCount

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

    listeners

    map

    • map<T>(transform: (doc: TSchema) => T): FindCursor<T>

    Returns FindCursor<TSchema>

    listenerCount

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

    listeners

    map

    • map<T>(transform: (doc: TSchema) => T): FindCursor<T>

    • Map all documents using the provided function If there is a transform set on the cursor, that will be called first and the result passed to this function's transform.

      @@ -70,25 +70,25 @@ it does not return a new instance of a cursor. This means when calling map, you should always assign the result to a new variable in order to get a correctly typed cursor variable. Take note of the following example:

      -

      Type parameters

      • T

      Parameters

      • transform: (doc: TSchema) => T
          • (doc: TSchema): T

          • Parameters

            • doc: TSchema

            Returns T

      Returns FindCursor<T>

    max

    max

    • Set the cursor max

      Parameters

      • max: Document

        Specify a $max value to specify the exclusive upper bound for a specific index in order to constrain the results of find(). The $max specifies the upper bound for all keys of a specific index in order.

        -

      Returns FindCursor<TSchema>

    maxAwaitTimeMS

    • maxAwaitTimeMS(value: number): FindCursor<TSchema>

    Returns FindCursor<TSchema>

    maxAwaitTimeMS

    • maxAwaitTimeMS(value: number): FindCursor<TSchema>

    • Set a maxAwaitTimeMS on a tailing cursor query to allow to customize the timeout value for the option awaitData (Only supported on MongoDB 3.2 or higher, ignored otherwise)

      Parameters

      • value: number

        Number of milliseconds to wait before aborting the tailed query.

        -

      Returns FindCursor<TSchema>

    maxTimeMS

    Returns FindCursor<TSchema>

    maxTimeMS

    min

    Returns FindCursor<TSchema>

    min

    • Set the cursor min

      Parameters

      • min: Document

        Specify a $min value to specify the inclusive lower bound for a specific index in order to constrain the results of find(). The $min specifies the lower bound for all keys of a specific index in order.

        -

      Returns FindCursor<TSchema>

    next

    • next(): Promise<null | TSchema>
    • next(callback: Callback<null | TSchema>): void
    • next(callback?: Callback<null | TSchema>): void | Promise<null | TSchema>

    Returns FindCursor<TSchema>

    next

    • next(): Promise<null | TSchema>
    • next(callback: Callback<null | TSchema>): void
    • next(callback?: Callback<null | TSchema>): void | Promise<null | TSchema>

    off

    on

    once

    prependListener

    prependOnceListener

    project

    off

    on

    once

    prependListener

    prependOnceListener

    project

    • Add a project stage to the aggregation pipeline

      remarks

      In order to strictly type this function you must provide an interface that represents the effect of your projection on the result documents.

      @@ -103,42 +103,42 @@ Take note of the following example:

      example
      const cursor: FindCursor<{ a: number; b: string }> = coll.find();
      const projectCursor = cursor.project<{ a: number }>({ _id: 0, a: true });
      const aPropOnlyArray: {a: number}[] = await projectCursor.toArray();

      // or always use chaining and save the final cursor

      const cursor = coll.find().project<{ a: string }>({
        _id: 0,
        a: { $convert: { input: '$a', to: 'string' }
      }});
      -

      Type parameters

      Parameters

      Returns FindCursor<T>

    rawListeners

    readBufferedDocuments

    • readBufferedDocuments(number?: number): TSchema[]

    rawListeners

    readBufferedDocuments

    • readBufferedDocuments(number?: number): TSchema[]

    removeAllListeners

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

    removeListener

    returnKey

    removeAllListeners

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

    removeListener

    returnKey

    • Set the cursor returnKey. If set to true, modifies the cursor to only return the index field or fields for the results of the query, rather than documents. If set to true and the query does not use an index to perform the read operation, the returned documents will not contain any fields.

      Parameters

      • value: boolean

        the returnKey value.

        -

      Returns FindCursor<TSchema>

    rewind

    • rewind(): void

    Returns FindCursor<TSchema>

    rewind

    • rewind(): void

    • Rewind this cursor to its uninitialized state. Any options that are present on the cursor will remain in effect. Iterating this cursor will cause new queries to be sent to the server, even if the resultant data has already been retrieved by this cursor.

      -

      Returns void

    setMaxListeners

    showRecordId

    setMaxListeners

    showRecordId

    • Modifies the output of a query by adding a field $recordId to matching documents. $recordId is the internal key which uniquely identifies a document in a collection.

      Parameters

      • value: boolean

        The $showDiskLoc option has now been deprecated and replaced with the showRecordId field. $showDiskLoc will still be accepted for OP_QUERY stye find.

        -

      Returns FindCursor<TSchema>

    skip

    Returns FindCursor<TSchema>

    skip

    sort

    Returns FindCursor<TSchema>

    sort

    stream

    toArray

    • toArray(): Promise<TSchema[]>
    • toArray(callback: Callback<TSchema[]>): void

    Returns FindCursor<TSchema>

    stream

    toArray

    • toArray(): Promise<TSchema[]>
    • toArray(callback: Callback<TSchema[]>): void

    tryNext

    • tryNext(): Promise<null | TSchema>
    • tryNext(callback: Callback<null | TSchema>): void

    tryNext

    • tryNext(): Promise<null | TSchema>
    • tryNext(callback: Callback<null | TSchema>): void

    withReadConcern

    withReadConcern

    withReadPreference

    withReadPreference

    drop

    • drop(): Promise<void>
    • drop(callback: Callback<void>): void

    emit

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

    eventNames

    • eventNames(): string[]

    find

    emit

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

    eventNames

    • eventNames(): string[]

    find

    getLogger

    getLogger

    getMaxListeners

    • getMaxListeners(): number

    listenerCount

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

    listeners

    off

    on

    once

    openDownloadStream

    getMaxListeners

    • getMaxListeners(): number

    listenerCount

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

    listeners

    off

    on

    once

    openDownloadStream

    openDownloadStreamByName

    openDownloadStreamByName

    • Returns a readable stream (GridFSBucketReadStream) for streaming the file with the given name from GridFS. If there are multiple files with the same name, this will stream the most recent file with the given name (as determined by the uploadDate field). You can set the revision option to change this behavior.

      -

      Parameters

      Returns GridFSBucketReadStream

    openUploadStream

    openUploadStream

    • Returns a writable stream (GridFSBucketWriteStream) for writing buffers to GridFS. The stream's 'id' property contains the resulting file's id.

      @@ -41,17 +41,17 @@

      The value of the 'filename' key in the files doc

    • Optional options: GridFSBucketWriteStreamOptions

      Optional settings.

      -

    Returns GridFSBucketWriteStream

    openUploadStreamWithId

    Returns GridFSBucketWriteStream

    openUploadStreamWithId

    prependListener

    prependOnceListener

    rawListeners

    removeAllListeners

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

    removeListener

    rename

    • rename(id: ObjectId, filename: string): Promise<void>
    • rename(id: ObjectId, filename: string, callback: Callback<void>): void

    prependListener

    prependOnceListener

    rawListeners

    removeAllListeners

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

    removeListener

    rename

    • rename(id: ObjectId, filename: string): Promise<void>
    • rename(id: ObjectId, filename: string, callback: Callback<void>): void

    setMaxListeners

    Static getEventListeners

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

    Returns Promise<void>

  • Parameters

    Returns void

    • setMaxListeners

    Static getEventListeners

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

    emit

    • emit(event: "close"): boolean
    • emit(event: "data", chunk: any): boolean
    • emit(event: "end"): boolean
    • emit(event: "error", err: Error): boolean
    • emit(event: "pause"): boolean
    • emit(event: "readable"): boolean
    • emit(event: "resume"): boolean
    • emit(event: string | symbol, ...args: any[]): boolean

    • Parameters

      • event: "close"

      Returns boolean

    • Parameters

      • event: "data"
      • chunk: any

      Returns boolean

    • Parameters

      • event: "end"

      Returns boolean

    • Parameters

      • event: "error"
      • err: Error

      Returns boolean

    • Parameters

      • event: "pause"

      Returns boolean

    • Parameters

      • event: "readable"

      Returns boolean

    • Parameters

      • event: "resume"

      Returns boolean

    • Parameters

      • event: string | symbol
      • Rest ...args: any[]

      Returns boolean

    end

    • Sets the 0-based offset in bytes to start streaming from. Throws an error if this stream has entered flowing mode (e.g. if you've already called on('data'))

      @@ -206,7 +206,7 @@ modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

      Returns a reference to the EventEmitter, so that calls can be chained.

      since

      v0.3.5

      -

      Parameters

      • n: number

      Returns GridFSBucketReadStream

    start

    start

    emit

    • emit(event: "close"): boolean
    • emit(event: "drain"): boolean
    • emit(event: "error", err: Error): boolean
    • emit(event: "finish"): boolean
    • emit(event: "pipe", src: Readable): boolean
    • emit(event: "unpipe", src: Readable): boolean
    • emit(event: string | symbol, ...args: any[]): boolean

    • Parameters

      • event: "close"

      Returns boolean

    • Parameters

      • event: "drain"

      Returns boolean

    • Parameters

      • event: "error"
      • err: Error

      Returns boolean

    • Parameters

      • event: "finish"

      Returns boolean

    • Parameters

      • event: "pipe"
      • src: Readable

      Returns boolean

    • Parameters

      • event: "unpipe"
      • src: Readable

      Returns boolean

    • Parameters

      • event: string | symbol
      • Rest ...args: any[]

      Returns boolean

    end

    eventNames

    • eventNames(): (string | symbol)[]

    eventNames

    • eventNames(): (string | symbol)[]

    • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

      const EventEmitter = require('events');
      const myEE = new EventEmitter();
      myEE.on('foo', () => {});
      myEE.on('bar', () => {});

      const sym = Symbol('symbol');
      myEE.on(sym, () => {});

      console.log(myEE.eventNames());
      // Prints: [ 'foo', 'bar', Symbol(symbol) ]
@@ -146,12 +146,12 @@

      See also: writable.cork().

      since

      v0.11.2

      -

      Returns void

    write

    • write(chunk: string | Buffer): boolean
    • write(chunk: string | Buffer, callback: Callback<void>): boolean
    • write(chunk: string | Buffer, encoding: undefined | BufferEncoding): boolean
    • write(chunk: string | Buffer, encoding: undefined | BufferEncoding, callback: Callback<void>): boolean

    write

    • write(chunk: string | Buffer): boolean
    • write(chunk: string | Buffer, callback: Callback<void>): boolean
    • write(chunk: string | Buffer, encoding: undefined | BufferEncoding): boolean
    • write(chunk: string | Buffer, encoding: undefined | BufferEncoding, callback: Callback<void>): boolean

    • Write a buffer to the stream.

      Parameters

      • chunk: string | Buffer

        Buffer to write

      Returns boolean

      False if this write required flushing a chunk to MongoDB. True otherwise.

      -

    • Parameters

      • chunk: string | Buffer
      • callback: Callback<void>

      Returns boolean

    • Parameters

      • chunk: string | Buffer
      • encoding: undefined | BufferEncoding

      Returns boolean

    • Parameters

      • chunk: string | Buffer
      • encoding: undefined | BufferEncoding
      • callback: Callback<void>

      Returns boolean

    Static getEventListeners

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

    • Parameters

      • chunk: string | Buffer
      • callback: Callback<void>

      Returns boolean

    • Parameters

      • chunk: string | Buffer
      • encoding: undefined | BufferEncoding

      Returns boolean

    • Parameters

      • chunk: string | Buffer
      • encoding: undefined | BufferEncoding
      • callback: Callback<void>

      Returns boolean

    Static getEventListeners

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

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    Returns ListCollectionsCursor<T>

    bufferedCount

    • bufferedCount(): number

    clone

    clone

    close

    emit

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

    eventNames

    • eventNames(): string[]

    forEach

    • forEach(iterator: (doc: T) => boolean | void): Promise<void>
    • forEach(iterator: (doc: T) => boolean | void, callback: Callback<void>): void

    close

    emit

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

    eventNames

    • eventNames(): string[]

    forEach

    • forEach(iterator: (doc: T) => boolean | void): Promise<void>
    • forEach(iterator: (doc: T) => boolean | void, callback: Callback<void>): void

    getMaxListeners

    • getMaxListeners(): number

    hasNext

    • hasNext(): Promise<boolean>
    • hasNext(callback: Callback<boolean>): void

    listenerCount

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

    listeners

    map

    Returns Promise<void>

  • Parameters

    • iterator: (doc: T) => boolean | void
        • (doc: T): boolean | void

        • Parameters

          • doc: T

          Returns boolean | void

    • callback: Callback<void>

    Returns void

    • getMaxListeners

    • getMaxListeners(): number

    hasNext

    • hasNext(): Promise<boolean>
    • hasNext(callback: Callback<boolean>): void

    listenerCount

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

    listeners

    map

    • Map all documents using the provided function If there is a transform set on the cursor, that will be called first and the result passed to this function's transform.

      @@ -39,28 +39,28 @@

      Type parameters

      • T = any

      Parameters

      • transform: (doc: T) => T

        The mapping transformation method.

        -
          • (doc: T): T

          • Parameters

            • doc: T

            Returns T

      Returns AbstractCursor<T, AbstractCursorEvents>

    maxTimeMS

    Returns AbstractCursor<T, AbstractCursorEvents>

    maxTimeMS

    next

    • next(): Promise<null | T>
    • next(callback: Callback<null | T>): void
    • next(callback?: Callback<null | T>): void | Promise<null | T>

    Returns ListCollectionsCursor<T>

    next

    • next(): Promise<null | T>
    • next(callback: Callback<null | T>): void
    • next(callback?: Callback<null | T>): void | Promise<null | T>

    off

    on

    once

    prependListener

    prependOnceListener

    rawListeners

    readBufferedDocuments

    • readBufferedDocuments(number?: number): T[]

    off

    on

    once

    prependListener

    prependOnceListener

    rawListeners

    readBufferedDocuments

    • readBufferedDocuments(number?: number): T[]

    removeAllListeners

    removeListener

    rewind

    • rewind(): void

    removeAllListeners

    removeListener

    rewind

    • rewind(): void

    • Rewind this cursor to its uninitialized state. Any options that are present on the cursor will remain in effect. Iterating this cursor will cause new queries to be sent to the server, even if the resultant data has already been retrieved by this cursor.

      -

      Returns void

    setMaxListeners

    stream

    toArray

    • toArray(): Promise<T[]>
    • toArray(callback: Callback<T[]>): void

    setMaxListeners

    stream

    toArray

    • toArray(): Promise<T[]>
    • toArray(callback: Callback<T[]>): void

    tryNext

    • tryNext(): Promise<null | T>
    • tryNext(callback: Callback<null | T>): void

    tryNext

    • tryNext(): Promise<null | T>
    • tryNext(callback: Callback<null | T>): void

    withReadConcern

    withReadConcern

    withReadPreference

    withReadPreference

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    Returns ListIndexesCursor

    bufferedCount

    • bufferedCount(): number

    clone

    clone

    close

    emit

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

    eventNames

    • eventNames(): string[]

    forEach

    • forEach(iterator: (doc: any) => boolean | void): Promise<void>
    • forEach(iterator: (doc: any) => boolean | void, callback: Callback<void>): void

    close

    emit

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

    eventNames

    • eventNames(): string[]

    forEach

    • forEach(iterator: (doc: any) => boolean | void): Promise<void>
    • forEach(iterator: (doc: any) => boolean | void, callback: Callback<void>): void

    getMaxListeners

    • getMaxListeners(): number

    hasNext

    • hasNext(): Promise<boolean>
    • hasNext(callback: Callback<boolean>): void

    listenerCount

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

    listeners

    map

    Returns Promise<void>

  • Parameters

    • iterator: (doc: any) => boolean | void
        • (doc: any): boolean | void

        • Parameters

          • doc: any

          Returns boolean | void

    • callback: Callback<void>

    Returns void

    • getMaxListeners

    • getMaxListeners(): number

    hasNext

    • hasNext(): Promise<boolean>
    • hasNext(callback: Callback<boolean>): void

    listenerCount

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

    listeners

    map

    • Map all documents using the provided function If there is a transform set on the cursor, that will be called first and the result passed to this function's transform.

      @@ -39,28 +39,28 @@

      Type parameters

      • T = any

      Parameters

      • transform: (doc: any) => T

        The mapping transformation method.

        -
          • (doc: any): T

          • Parameters

            • doc: any

            Returns T

      Returns AbstractCursor<T, AbstractCursorEvents>

    maxTimeMS

    Returns AbstractCursor<T, AbstractCursorEvents>

    maxTimeMS

    next

    • next(): Promise<any>
    • next(callback: Callback<any>): void
    • next(callback?: Callback<any>): void | Promise<any>

    Returns ListIndexesCursor

    next

    • next(): Promise<any>
    • next(callback: Callback<any>): void
    • next(callback?: Callback<any>): void | Promise<any>

    off

    on

    once

    prependListener

    prependOnceListener

    rawListeners

    readBufferedDocuments

    • readBufferedDocuments(number?: number): any[]

    off

    on

    once

    prependListener

    prependOnceListener

    rawListeners

    readBufferedDocuments

    • readBufferedDocuments(number?: number): any[]

    removeAllListeners

    removeListener

    rewind

    • rewind(): void

    removeAllListeners

    removeListener

    rewind

    • rewind(): void

    • Rewind this cursor to its uninitialized state. Any options that are present on the cursor will remain in effect. Iterating this cursor will cause new queries to be sent to the server, even if the resultant data has already been retrieved by this cursor.

      -

      Returns void

    setMaxListeners

    stream

    toArray

    • toArray(): Promise<any[]>
    • toArray(callback: Callback<any[]>): void

    setMaxListeners

    stream

    toArray

    • toArray(): Promise<any[]>
    • toArray(callback: Callback<any[]>): void

    tryNext

    • tryNext(): Promise<any>
    • tryNext(callback: Callback<any>): void

    tryNext

    • tryNext(): Promise<any>
    • tryNext(callback: Callback<any>): void

    withReadConcern

    withReadConcern

    withReadPreference

    withReadPreference

    error

    • error(message: string, object?: unknown): void

    • Log a message at the error level

      Parameters

      • message: string

        The message to log

      • Optional object: unknown

        Additional meta data to log

        -

      Returns void

    info

    • info(message: string, object?: unknown): void

    Returns void

    info

    • info(message: string, object?: unknown): void

    • Log a message at the info level

      Parameters

      • message: string

        The message to log

      • Optional object: unknown

        Additional meta data to log

        -

      Returns void

    isDebug

    • isDebug(): boolean

    Returns void

    isDebug

    • isDebug(): boolean

    isError

    • isError(): boolean

    isError

    • isError(): boolean

    isInfo

    • isInfo(): boolean

    isInfo

    • isInfo(): boolean

    isWarn

    • isWarn(): boolean

    isWarn

    • isWarn(): boolean

    warn

    • warn(message: string, object?: unknown): void

    warn

    • warn(message: string, object?: unknown): void

    • Log a message at the warn level

      Parameters

      • message: string

        The message to log

      • Optional object: unknown

        Additional meta data to log

        -

      Returns void

    Static currentLogger

    Returns void

    Static currentLogger

    Static filter

    • filter(type: string, values: string[]): void

    Static filter

    • filter(type: string, values: string[]): void

    • Filter log messages for a particular class

      Parameters

      • type: string

        The type of filter (currently only class)

      • values: string[]

        The filters to apply

        -

      Returns void

    Static reset

    • reset(): void

    Returns void

    Static reset

    • reset(): void

    • Resets the logger to default settings, error and no filtered classes

      -

      Returns void

    Static setCurrentLogger

    Static setCurrentLogger

    Static setLevel

    Returns void

    Static setLevel

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Properties

    Optional code

    code?: string | number

    This is a number in MongoServerError and a string in MongoDriverError

    privateremarks

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

    -

    Optional codeName

    codeName?: string

    Optional err

    err?: WriteConcernError

    Optional errInfo

    errInfo?: Document

    message

    message: string

    Optional ok

    ok?: number

    result

    result: BulkWriteResult

    Optional stack

    stack?: string

    Optional topologyVersion

    topologyVersion?: TopologyVersion

    Optional writeConcernError

    writeConcernError?: Document

    writeErrors

    writeErrors: OneOrMore<WriteError> = []

    Static Optional prepareStackTrace

    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any
    +

    Optional codeName

    codeName?: string

    Optional err

    err?: WriteConcernError

    Optional errInfo

    errInfo?: Document

    message

    message: string

    Optional ok

    ok?: number

    result

    result: BulkWriteResult

    Optional stack

    stack?: string

    Optional topologyVersion

    topologyVersion?: TopologyVersion

    Optional writeConcernError

    writeConcernError?: Document

    writeErrors

    writeErrors: OneOrMore<WriteError> = []

    Static Optional prepareStackTrace

    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    deletedCount

    • get deletedCount(): number

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    deletedCount

    • get deletedCount(): number

    errmsg

    • get errmsg(): string
    • +

      Returns number

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    insertedCount

    • get insertedCount(): number

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    insertedCount

    • get insertedCount(): number

    insertedIds

    • get insertedIds(): {}

    insertedIds

    • get insertedIds(): {}

    • Inserted document generated Id's, hash key is the index of the originating operation

      -

      Returns {}

      • [key: number]: any

    matchedCount

    • get matchedCount(): number

    matchedCount

    • get matchedCount(): number

    modifiedCount

    • get modifiedCount(): number

    modifiedCount

    • get modifiedCount(): number

    name

    • get name(): string

    upsertedCount

    • get upsertedCount(): number

    name

    • get name(): string

    upsertedCount

    • get upsertedCount(): number

    upsertedIds

    • get upsertedIds(): {}

    upsertedIds

    • get upsertedIds(): {}

    • Upserted document generated Id's, hash key is the index of the originating operation

      -

      Returns {}

      • [key: number]: any

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    • Checks the error to see if it has an error label

      Parameters

      • label: string

        The error label to check for

        diff --git a/docs/Next/classes/MongoClient.html b/docs/Next/classes/MongoClient.html index 9e03d783ee4..8a728cf33a8 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: "close" | "error" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "timeout" | "open"

      Parameters

      Returns boolean

    eventNames

    • eventNames(): string[]

    getLogger

    Returns Db

    emit

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

    • Type parameters

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

      Parameters

      Returns boolean

    eventNames

    • eventNames(): string[]

    getLogger

    getMaxListeners

    • getMaxListeners(): number

    listenerCount

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

    • Type parameters

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

      Parameters

      • type: string | symbol | EventKey

      Returns number

    listeners

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

    • Type parameters

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

      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: "close" | "error" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "timeout" | "open"

      Parameters

      • event: string | symbol | EventKey

      Returns MongoClientEvents[EventKey][]

    removeAllListeners

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

    • Type parameters

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

      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: "close" | "error" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "timeout" | "open"

      Parameters

      • type: string | symbol | EventKey

      Returns number

    listeners

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

    • Type parameters

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

      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: "close" | "error" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "timeout" | "open"

      Parameters

      • event: string | symbol | EventKey

      Returns MongoClientEvents[EventKey][]

    removeAllListeners

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

    • Type parameters

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

      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.

      @@ -37,17 +37,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>

    withSession

    Returns ChangeStream<TSchema>

    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: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

    Static getEventListeners

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

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    validate

    • validate(): void

    Static merge

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/MongoCursorExhaustedError.html b/docs/Next/classes/MongoCursorExhaustedError.html index 978068e4b54..2a19210fe61 100644 --- a/docs/Next/classes/MongoCursorExhaustedError.html +++ b/docs/Next/classes/MongoCursorExhaustedError.html @@ -1,16 +1,16 @@ MongoCursorExhaustedError | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class MongoCursorExhaustedError

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

    -

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    Optional code

    code?: string | number
    +

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    Optional code

    code?: string | number

    This is a number in MongoServerError and a string in MongoDriverError

    privateremarks

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

    -

    message

    message: string

    Optional stack

    stack?: string

    Optional topologyVersion

    topologyVersion?: TopologyVersion

    Static Optional prepareStackTrace

    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any
    +

    message

    message: string

    Optional stack

    stack?: string

    Optional topologyVersion

    topologyVersion?: TopologyVersion

    Static Optional prepareStackTrace

    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string
    • +

      Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Properties

    Optional collection

    collection?: string

    db

    db: string

    Methods

    toString

    • toString(): string

    withCollection

    Static fromString

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/MongoDecompressionError.html b/docs/Next/classes/MongoDecompressionError.html index 83b90631be3..f6be498f5ee 100644 --- a/docs/Next/classes/MongoDecompressionError.html +++ b/docs/Next/classes/MongoDecompressionError.html @@ -1,17 +1,17 @@ MongoDecompressionError | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class MongoDecompressionError

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

    -

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    Optional code

    code?: string | number
    +

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    Optional code

    code?: string | number

    This is a number in MongoServerError and a string in MongoDriverError

    privateremarks

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

    -

    message

    message: string

    Optional stack

    stack?: string

    Optional topologyVersion

    topologyVersion?: TopologyVersion

    Static Optional prepareStackTrace

    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any
    +

    message

    message: string

    Optional stack

    stack?: string

    Optional topologyVersion

    topologyVersion?: TopologyVersion

    Static Optional prepareStackTrace

    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string
    • +

      Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    errorLabels

    name

    Methods

    addErrorLabel

    hasErrorLabel

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    Optional code

    code?: string | number
    +

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    Optional code

    code?: string | number

    This is a number in MongoServerError and a string in MongoDriverError

    privateremarks

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

    -

    message

    message: string

    Optional stack

    stack?: string

    Optional topologyVersion

    topologyVersion?: TopologyVersion

    Static Optional prepareStackTrace

    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Type declaration

      • (err: Error, stackTraces: CallSite[]): any
      • +

    message

    message: string

    Optional stack

    stack?: string

    Optional topologyVersion

    topologyVersion?: TopologyVersion

    Static Optional prepareStackTrace

    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string
    • +

      Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    errmsg

    • get errmsg(): string

    • Legacy name for server error responses

      -

      Returns string

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    errorLabels

    • get errorLabels(): string[]

    • Returns string[]

    name

    • get name(): string

    Methods

    addErrorLabel

    • addErrorLabel(label: string): void

    hasErrorLabel

    • hasErrorLabel(label: string): boolean

    Properties

    Optional hedge

    hedge?: HedgeOptions

    Optional maxStalenessSeconds

    maxStalenessSeconds?: number

    Optional minWireVersion

    minWireVersion?: number

    mode

    mode: ReadPreferenceMode

    Optional tags

    tags?: TagSet[]

    Static NEAREST

    NEAREST: "nearest" = ReadPreferenceMode.nearest

    Static PRIMARY

    PRIMARY: "primary" = ReadPreferenceMode.primary

    Static PRIMARY_PREFERRED

    PRIMARY_PREFERRED: "primaryPreferred" = ReadPreferenceMode.primaryPreferred

    Static SECONDARY

    SECONDARY: "secondary" = ReadPreferenceMode.secondary

    Static SECONDARY_PREFERRED

    SECONDARY_PREFERRED: "secondaryPreferred" = ReadPreferenceMode.secondaryPreferred

    Static nearest

    nearest: ReadPreference = ...

    Static primary

    primary: ReadPreference = ...

    Static primaryPreferred

    primaryPreferred: ReadPreference = ...

    Static secondary

    secondary: ReadPreference = ...

    Static secondaryPreferred

    secondaryPreferred: ReadPreference = ...

    Accessors

    preference

    Methods

    equals

    isValid

    • isValid(mode?: string): boolean

    Returns boolean

    isValid

    • isValid(mode?: string): boolean

    • Validate if a mode is legal

      Parameters

      • Optional mode: string

        The string representing the read preference mode.

        -

      Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    slaveOk

    • slaveOk(): boolean

    slaveOk

    • slaveOk(): boolean

    toJSON

    toJSON

    Static fromOptions

    Static fromOptions

    Static fromString

    Static isValid

    • isValid(mode: string): boolean

    Returns undefined | ReadPreference

    Static fromString

    Static isValid

    • isValid(mode: string): boolean

    • Validate if a mode is legal

      Parameters

      • mode: string

        The string representing the read preference mode.

        -

      Returns boolean

    Static translate

    Returns boolean

    Static translate

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ServerCapabilities.html b/docs/Next/classes/ServerCapabilities.html index 71d82282a4c..7b131987f96 100644 --- a/docs/Next/classes/ServerCapabilities.html +++ b/docs/Next/classes/ServerCapabilities.html @@ -1 +1 @@ -ServerCapabilities | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ServerCapabilities

    Hierarchy

    • ServerCapabilities

    Index

    Constructors

    Properties

    Accessors

    Constructors

    constructor

    Properties

    maxWireVersion

    maxWireVersion: number

    minWireVersion

    minWireVersion: number

    Accessors

    commandsTakeCollation

    • get commandsTakeCollation(): boolean

    commandsTakeWriteConcern

    • get commandsTakeWriteConcern(): boolean

    hasAggregationCursor

    • get hasAggregationCursor(): boolean

    hasAuthCommands

    • get hasAuthCommands(): boolean

    hasListCollectionsCommand

    • get hasListCollectionsCommand(): boolean

    hasListIndexesCommand

    • get hasListIndexesCommand(): boolean

    hasTextSearch

    • get hasTextSearch(): boolean

    hasWriteCommands

    • get hasWriteCommands(): boolean

    supportsSnapshotReads

    • get supportsSnapshotReads(): boolean

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Class ServerCapabilities

    Hierarchy

    • ServerCapabilities

    Index

    Constructors

    Properties

    Accessors

    Constructors

    constructor

    Properties

    maxWireVersion

    maxWireVersion: number

    minWireVersion

    minWireVersion: number

    Accessors

    commandsTakeCollation

    • get commandsTakeCollation(): boolean

    commandsTakeWriteConcern

    • get commandsTakeWriteConcern(): boolean

    hasAggregationCursor

    • get hasAggregationCursor(): boolean

    hasAuthCommands

    • get hasAuthCommands(): boolean

    hasListCollectionsCommand

    • get hasListCollectionsCommand(): boolean

    hasListIndexesCommand

    • get hasListIndexesCommand(): boolean

    hasTextSearch

    • get hasTextSearch(): boolean

    hasWriteCommands

    • get hasWriteCommands(): boolean

    supportsSnapshotReads

    • get supportsSnapshotReads(): boolean

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ServerClosedEvent.html b/docs/Next/classes/ServerClosedEvent.html index fdf8b89885a..b59a76b460b 100644 --- a/docs/Next/classes/ServerClosedEvent.html +++ b/docs/Next/classes/ServerClosedEvent.html @@ -1,7 +1,7 @@ ServerClosedEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ServerClosedEvent

    Emitted when server is closed.

    -

    Hierarchy

    • ServerClosedEvent

    Index

    Properties

    Properties

    address

    address: string
    +

    Hierarchy

    • ServerClosedEvent

    Index

    Properties

    Properties

    address

    address: string

    The address (host/port pair) of the server

    -

    topologyId

    topologyId: number
    +

    topologyId

    topologyId: number

    A unique identifier for the topology

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ServerDescription.html b/docs/Next/classes/ServerDescription.html index 79ddc33d10e..1960e4da927 100644 --- a/docs/Next/classes/ServerDescription.html +++ b/docs/Next/classes/ServerDescription.html @@ -1,13 +1,13 @@ ServerDescription | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ServerDescription

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

    Internal type, not meant to be directly instantiated

    -

    Hierarchy

    • ServerDescription

    Index

    Properties

    Accessors

    Methods

    Properties

    Optional $clusterTime

    $clusterTime?: ClusterTime

    Private _hostAddress

    _hostAddress: HostAddress

    address

    address: string

    arbiters

    arbiters: string[]

    Optional electionId

    electionId?: ObjectId

    Optional error

    error?: MongoError

    hosts

    hosts: string[]

    lastUpdateTime

    lastUpdateTime: number

    lastWriteDate

    lastWriteDate: number

    Optional logicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    maxWireVersion

    maxWireVersion: number

    Optional me

    me?: string

    minWireVersion

    minWireVersion: number

    passives

    passives: string[]

    Optional primary

    primary?: string

    roundTripTime

    roundTripTime: number

    Optional setName

    setName?: string

    Optional setVersion

    setVersion?: number

    tags

    tags: TagSet

    Optional topologyVersion

    topologyVersion?: TopologyVersion

    type

    type: ServerType

    Accessors

    allHosts

    • get allHosts(): string[]

    host

    • get host(): string

    hostAddress

    isDataBearing

    • get isDataBearing(): boolean

    Hierarchy

    • ServerDescription

    Index

    Properties

    Accessors

    Methods

    Properties

    Optional $clusterTime

    $clusterTime?: ClusterTime

    Private _hostAddress

    _hostAddress: HostAddress

    address

    address: string

    arbiters

    arbiters: string[]

    Optional electionId

    electionId?: ObjectId

    Optional error

    error?: MongoError

    hosts

    hosts: string[]

    lastUpdateTime

    lastUpdateTime: number

    lastWriteDate

    lastWriteDate: number

    Optional logicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    maxWireVersion

    maxWireVersion: number

    Optional me

    me?: string

    minWireVersion

    minWireVersion: number

    passives

    passives: string[]

    Optional primary

    primary?: string

    roundTripTime

    roundTripTime: number

    Optional setName

    setName?: string

    Optional setVersion

    setVersion?: number

    tags

    tags: TagSet

    Optional topologyVersion

    topologyVersion?: TopologyVersion

    type

    type: ServerType

    Accessors

    allHosts

    • get allHosts(): string[]

    host

    • get host(): string

    hostAddress

    isDataBearing

    • get isDataBearing(): boolean

    isReadable

    • get isReadable(): boolean

    isReadable

    • get isReadable(): boolean

    isWritable

    • get isWritable(): boolean

    isWritable

    • get isWritable(): boolean

    port

    • get port(): number

    Methods

    equals

    port

    • get port(): number

    Methods

    equals

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ServerDescriptionChangedEvent.html b/docs/Next/classes/ServerDescriptionChangedEvent.html index 033a6a116e6..823a8174862 100644 --- a/docs/Next/classes/ServerDescriptionChangedEvent.html +++ b/docs/Next/classes/ServerDescriptionChangedEvent.html @@ -1,11 +1,11 @@ ServerDescriptionChangedEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ServerDescriptionChangedEvent

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

    -

    Hierarchy

    • ServerDescriptionChangedEvent

    Index

    Properties

    Properties

    address

    address: string
    +

    Hierarchy

    • ServerDescriptionChangedEvent

    Index

    Properties

    Properties

    address

    address: string

    The address (host/port pair) of the server

    -

    newDescription

    newDescription: ServerDescription
    +

    newDescription

    newDescription: ServerDescription

    The new server description

    -

    previousDescription

    previousDescription: ServerDescription
    +

    previousDescription

    previousDescription: ServerDescription

    The previous server description

    -

    topologyId

    topologyId: number
    +

    topologyId

    topologyId: number

    A unique identifier for the topology

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ServerHeartbeatFailedEvent.html b/docs/Next/classes/ServerHeartbeatFailedEvent.html index acb0780a169..58381e34853 100644 --- a/docs/Next/classes/ServerHeartbeatFailedEvent.html +++ b/docs/Next/classes/ServerHeartbeatFailedEvent.html @@ -1,9 +1,9 @@ ServerHeartbeatFailedEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ServerHeartbeatFailedEvent

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

    -

    Hierarchy

    • ServerHeartbeatFailedEvent

    Index

    Properties

    Properties

    connectionId

    connectionId: string
    +

    Hierarchy

    • ServerHeartbeatFailedEvent

    Index

    Properties

    Properties

    connectionId

    connectionId: string

    The connection id for the command

    -

    duration

    duration: number
    +

    duration

    duration: number

    The execution time of the event in ms

    -

    failure

    failure: Error
    +

    failure

    failure: Error

    The command failure

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ServerHeartbeatStartedEvent.html b/docs/Next/classes/ServerHeartbeatStartedEvent.html index 80467104ae8..e92d7f50bf1 100644 --- a/docs/Next/classes/ServerHeartbeatStartedEvent.html +++ b/docs/Next/classes/ServerHeartbeatStartedEvent.html @@ -1,6 +1,6 @@ ServerHeartbeatStartedEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ServerHeartbeatStartedEvent

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

    -

    Hierarchy

    • ServerHeartbeatStartedEvent

    Index

    Properties

    Properties

    connectionId

    connectionId: string
    +

    Hierarchy

    • ServerHeartbeatStartedEvent

    Index

    Properties

    Properties

    connectionId

    connectionId: string

    The connection id for the command

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ServerHeartbeatSucceededEvent.html b/docs/Next/classes/ServerHeartbeatSucceededEvent.html index 1ebd826e5c2..91d1469fcc5 100644 --- a/docs/Next/classes/ServerHeartbeatSucceededEvent.html +++ b/docs/Next/classes/ServerHeartbeatSucceededEvent.html @@ -1,9 +1,9 @@ ServerHeartbeatSucceededEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ServerHeartbeatSucceededEvent

    Emitted when the server monitor’s hello succeeds.

    -

    Hierarchy

    • ServerHeartbeatSucceededEvent

    Index

    Properties

    Properties

    connectionId

    connectionId: string
    +

    Hierarchy

    • ServerHeartbeatSucceededEvent

    Index

    Properties

    Properties

    connectionId

    connectionId: string

    The connection id for the command

    -

    duration

    duration: number
    +

    duration

    duration: number

    The execution time of the event in ms

    -

    reply

    reply: Document
    +

    reply

    reply: Document

    The command reply

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ServerOpeningEvent.html b/docs/Next/classes/ServerOpeningEvent.html index d602dbf5811..c9e9150cbee 100644 --- a/docs/Next/classes/ServerOpeningEvent.html +++ b/docs/Next/classes/ServerOpeningEvent.html @@ -1,7 +1,7 @@ ServerOpeningEvent | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ServerOpeningEvent

    Emitted when server is initialized.

    -

    Hierarchy

    • ServerOpeningEvent

    Index

    Properties

    Properties

    address

    address: string
    +

    Hierarchy

    • ServerOpeningEvent

    Index

    Properties

    Properties

    address

    address: string

    The address (host/port pair) of the server

    -

    topologyId

    topologyId: number
    +

    topologyId

    topologyId: number

    A unique identifier for the topology

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/ServerSession.html b/docs/Next/classes/ServerSession.html index fa06e1a9a01..f9780f34fcb 100644 --- a/docs/Next/classes/ServerSession.html +++ b/docs/Next/classes/ServerSession.html @@ -1,7 +1,7 @@ ServerSession | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ServerSession

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

    -

    Hierarchy

    • ServerSession

    Index

    Properties

    Methods

    Properties

    id

    id: ServerSessionId

    isDirty

    isDirty: boolean

    lastUse

    lastUse: number

    txnNumber

    txnNumber: number

    Methods

    hasTimedOut

    • hasTimedOut(sessionTimeoutMinutes: number): boolean

    Hierarchy

    • ServerSession

    Index

    Properties

    Methods

    Properties

    id

    id: ServerSessionId

    isDirty

    isDirty: boolean

    lastUse

    lastUse: number

    txnNumber

    txnNumber: number

    Methods

    hasTimedOut

    • hasTimedOut(sessionTimeoutMinutes: number): boolean

    Methods

    addListener

    emit

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

    • Type parameters

      • EventKey: string | number | symbol

      Parameters

      • event: symbol | EventKey
      • Rest ...args: Parameters<Events[EventKey]>

      Returns boolean

    eventNames

    • eventNames(): string[]

    getMaxListeners

    • getMaxListeners(): number

    listenerCount

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

    • Type parameters

      • EventKey: string | number | symbol

      Parameters

      • type: string | symbol | EventKey

      Returns number

    listeners

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

    • Type parameters

      • EventKey: string | number | symbol

      Parameters

      • event: string | symbol | EventKey

      Returns Events[EventKey][]

    off

    on

    once

    prependListener

    prependOnceListener

    rawListeners

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

    • Type parameters

      • EventKey: string | number | symbol

      Parameters

      • event: string | symbol | EventKey

      Returns Events[EventKey][]

    removeAllListeners

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

    • Type parameters

      • EventKey: string | number | symbol

      Parameters

      • Optional event: string | symbol | EventKey

      Returns TypedEventEmitter<Events>

    removeListener

    setMaxListeners

    Static getEventListeners

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

    Methods

    addListener

    emit

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

    • Type parameters

      • EventKey: string | number | symbol

      Parameters

      • event: symbol | EventKey
      • Rest ...args: Parameters<Events[EventKey]>

      Returns boolean

    eventNames

    • eventNames(): string[]

    getMaxListeners

    • getMaxListeners(): number

    listenerCount

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

    • Type parameters

      • EventKey: string | number | symbol

      Parameters

      • type: string | symbol | EventKey

      Returns number

    listeners

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

    • Type parameters

      • EventKey: string | number | symbol

      Parameters

      • event: string | symbol | EventKey

      Returns Events[EventKey][]

    off

    on

    once

    prependListener

    prependOnceListener

    rawListeners

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

    • Type parameters

      • EventKey: string | number | symbol

      Parameters

      • event: string | symbol | EventKey

      Returns Events[EventKey][]

    removeAllListeners

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

    • Type parameters

      • EventKey: string | number | symbol

      Parameters

      • Optional event: string | symbol | EventKey

      Returns TypedEventEmitter<Events>

    removeListener

    setMaxListeners

    Static getEventListeners

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

    Returns WriteConcern

    Properties

    Optional fsync

    fsync?: boolean | 1

    equivalent to the j option

    -

    Optional j

    j?: boolean
    +

    Optional j

    j?: boolean

    request acknowledgment that the write operation has been written to the on-disk journal

    -

    Optional w

    w?: W
    +

    Optional w

    w?: W

    request acknowledgment that the write operation has propagated to a specified number of mongod instances or to mongod instances with specified tags.

    -

    Optional wtimeout

    wtimeout?: number
    +

    Optional wtimeout

    wtimeout?: number

    specify a time limit to prevent write operations from blocking indefinitely

    -

    Methods

    Static fromOptions

    Methods

    Static fromOptions

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/WriteConcernError.html b/docs/Next/classes/WriteConcernError.html index 95fd84a0af0..687f3a05cfd 100644 --- a/docs/Next/classes/WriteConcernError.html +++ b/docs/Next/classes/WriteConcernError.html @@ -1,10 +1,10 @@ WriteConcernError | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class WriteConcernError

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

    -

    Hierarchy

    • WriteConcernError

    Index

    Constructors

    Accessors

    Methods

    Constructors

    constructor

    Accessors

    code

    • get code(): undefined | number

    Hierarchy

    • WriteConcernError

    Index

    Constructors

    Accessors

    Methods

    Constructors

    constructor

    Accessors

    code

    • get code(): undefined | number

    err

    errInfo

    err

    errInfo

    errmsg

    • get errmsg(): undefined | string

    errmsg

    • get errmsg(): undefined | string

    Methods

    toJSON

    toString

    • toString(): string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | string

    Methods

    toJSON

    toString

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/WriteError.html b/docs/Next/classes/WriteError.html index 31ae6482571..e1076e83087 100644 --- a/docs/Next/classes/WriteError.html +++ b/docs/Next/classes/WriteError.html @@ -1,13 +1,13 @@ WriteError | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class WriteError

    An error that occurred during a BulkWrite on the server.

    -

    Hierarchy

    • WriteError

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    err

    err: BulkWriteOperationError

    Accessors

    code

    • get code(): number

    Hierarchy

    • WriteError

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    err

    err: BulkWriteOperationError

    Accessors

    code

    • get code(): number

    errInfo

    errInfo

    errmsg

    • get errmsg(): undefined | string

    errmsg

    • get errmsg(): undefined | string

    index

    • get index(): number

    index

    • get index(): number

    Methods

    getOperation

    Methods

    getOperation

    toJSON

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

    toString

    • toString(): string

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Document

    toJSON

    toString

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/AbstractCursorOptions.html b/docs/Next/interfaces/AbstractCursorOptions.html index 7d6747f6490..43a255e49fb 100644 --- a/docs/Next/interfaces/AbstractCursorOptions.html +++ b/docs/Next/interfaces/AbstractCursorOptions.html @@ -1,21 +1,21 @@ -AbstractCursorOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AbstractCursorOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional awaitData

    awaitData?: boolean

    Optional batchSize

    batchSize?: number

    Optional bsonRegExp

    bsonRegExp?: boolean
    +AbstractCursorOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AbstractCursorOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional awaitData

    awaitData?: boolean

    Optional batchSize

    batchSize?: number

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional comment

    comment?: string | Document

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean
    +

    Optional comment

    comment?: string | Document

    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.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noCursorTimeout

    noCursorTimeout?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noCursorTimeout

    noCursorTimeout?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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
    +

    Optional readConcern

    readConcern?: ReadConcernLike

    Optional readPreference

    readPreference?: ReadPreferenceLike

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession

    Optional tailable

    tailable?: boolean

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional session

    session?: ClientSession

    Optional tailable

    tailable?: boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/AddUserOptions.html b/docs/Next/interfaces/AddUserOptions.html index 65a04d93dd3..1c8f34724d7 100644 --- a/docs/Next/interfaces/AddUserOptions.html +++ b/docs/Next/interfaces/AddUserOptions.html @@ -1,43 +1,43 @@ -AddUserOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AddUserOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean
    +AddUserOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AddUserOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    Optional customData

    customData?: Document
    +

    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 dbName

    dbName?: string

    Optional digestPassword

    digestPassword?: null
    deprecated

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

    +

    Optional enableUtf8Validation

    enableUtf8Validation?: boolean

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

    -

    Optional explain

    explain?: ExplainVerbosityLike
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    -

    Optional roles

    roles?: string | string[] | RoleSpecification | RoleSpecification[]
    +

    Optional roles

    roles?: string | string[] | RoleSpecification | RoleSpecification[]

    Roles associated with the created user

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/AggregateOptions.html b/docs/Next/interfaces/AggregateOptions.html index 90d409cf169..a60727e586e 100644 --- a/docs/Next/interfaces/AggregateOptions.html +++ b/docs/Next/interfaces/AggregateOptions.html @@ -1,54 +1,54 @@ -AggregateOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AggregateOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean
    +AggregateOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AggregateOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    -

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number
    +

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number

    The number of documents to return per batch. See aggregation documentation.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    -

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    +

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean

    Allow driver to bypass schema validation in MongoDB 3.2 or higher.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Specify collation.

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    Optional cursor

    cursor?: Document
    +

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    -

    Optional hint

    hint?: Hint
    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional hint

    hint?: Hint

    Add an index selection hint to an aggregation command

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional let

    let?: Document
    +

    Optional let

    let?: Document

    Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).

    -

    Optional maxAwaitTimeMS

    maxAwaitTimeMS?: number
    +

    Optional maxAwaitTimeMS

    maxAwaitTimeMS?: number

    The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.

    -

    Optional maxTimeMS

    maxTimeMS?: number
    +

    Optional maxTimeMS

    maxTimeMS?: number

    specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point.

    -

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional out

    out?: string

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional out

    out?: string

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/AggregationCursorOptions.html b/docs/Next/interfaces/AggregationCursorOptions.html index ce9f6f495f5..085b5b9fde5 100644 --- a/docs/Next/interfaces/AggregationCursorOptions.html +++ b/docs/Next/interfaces/AggregationCursorOptions.html @@ -1,54 +1,54 @@ -AggregationCursorOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AggregationCursorOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean
    +AggregationCursorOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AggregationCursorOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    -

    Optional authdb

    authdb?: string

    Optional awaitData

    awaitData?: boolean

    Optional batchSize

    batchSize?: number
    +

    Optional authdb

    authdb?: string

    Optional awaitData

    awaitData?: boolean

    Optional batchSize

    batchSize?: number

    The number of documents to return per batch. See aggregation documentation.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    -

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    +

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean

    Allow driver to bypass schema validation in MongoDB 3.2 or higher.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Specify collation.

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    Optional cursor

    cursor?: Document
    +

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    -

    Optional hint

    hint?: Hint
    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional hint

    hint?: Hint

    Add an index selection hint to an aggregation command

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional let

    let?: Document
    +

    Optional let

    let?: Document

    Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).

    -

    Optional maxAwaitTimeMS

    maxAwaitTimeMS?: number
    +

    Optional maxAwaitTimeMS

    maxAwaitTimeMS?: number

    The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.

    -

    Optional maxTimeMS

    maxTimeMS?: number
    +

    Optional maxTimeMS

    maxTimeMS?: number

    specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point.

    -

    Optional noCursorTimeout

    noCursorTimeout?: boolean

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional out

    out?: string

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional noCursorTimeout

    noCursorTimeout?: boolean

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional out

    out?: string

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional tailable

    tailable?: boolean

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional tailable

    tailable?: boolean

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/Auth.html b/docs/Next/interfaces/Auth.html index 84a5f44e4a3..e8a88241bd3 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
    • Private property

    Settings

    Theme

    Generated using TypeDoc

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

    Interface AuthMechanismProperties

    Hierarchy

    Index

    Properties

    Properties

    Optional AWS_SESSION_TOKEN

    AWS_SESSION_TOKEN?: string

    Optional CANONICALIZE_HOST_NAME

    CANONICALIZE_HOST_NAME?: GSSAPICanonicalizationValue

    Optional SERVICE_HOST

    SERVICE_HOST?: string

    Optional SERVICE_NAME

    SERVICE_NAME?: string

    Optional SERVICE_REALM

    SERVICE_REALM?: string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface AuthMechanismProperties

    Hierarchy

    Index

    Properties

    Properties

    Optional AWS_SESSION_TOKEN

    AWS_SESSION_TOKEN?: string

    Optional CANONICALIZE_HOST_NAME

    CANONICALIZE_HOST_NAME?: GSSAPICanonicalizationValue

    Optional SERVICE_HOST

    SERVICE_HOST?: string

    Optional SERVICE_NAME

    SERVICE_NAME?: string

    Optional SERVICE_REALM

    SERVICE_REALM?: string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface AutoEncrypter

    Hierarchy

    • AutoEncrypter

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    decrypt

    encrypt

    init

    teardown

    • teardown(force: boolean, callback: Callback<any>): void

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface AutoEncrypter

    Hierarchy

    • AutoEncrypter

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    decrypt

    encrypt

    init

    teardown

    • teardown(force: boolean, callback: Callback<any>): void

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/AutoEncryptionOptions.html b/docs/Next/interfaces/AutoEncryptionOptions.html index bbe77feed8b..4e3f2f54812 100644 --- a/docs/Next/interfaces/AutoEncryptionOptions.html +++ b/docs/Next/interfaces/AutoEncryptionOptions.html @@ -1,6 +1,6 @@ -AutoEncryptionOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AutoEncryptionOptions

    Hierarchy

    • AutoEncryptionOptions

    Index

    Properties

    Properties

    Optional bypassAutoEncryption

    bypassAutoEncryption?: boolean
    +AutoEncryptionOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AutoEncryptionOptions

    Hierarchy

    • AutoEncryptionOptions

    Index

    Properties

    Properties

    Optional bypassAutoEncryption

    bypassAutoEncryption?: boolean

    Allows the user to bypass auto encryption, maintaining implicit decryption

    -

    Optional extraOptions

    extraOptions?: { mongocryptdBypassSpawn?: boolean; mongocryptdSpawnArgs?: string[]; mongocryptdSpawnPath?: string; mongocryptdURI?: string }

    Type declaration

    • Optional mongocryptdBypassSpawn?: boolean
      +

    Optional extraOptions

    extraOptions?: { mongocryptdBypassSpawn?: boolean; mongocryptdSpawnArgs?: string[]; mongocryptdSpawnPath?: string; mongocryptdURI?: string }

    Type declaration

    • Optional mongocryptdBypassSpawn?: boolean

      If true, autoEncryption will not attempt to spawn a mongocryptd before connecting

    • Optional mongocryptdSpawnArgs?: string[]

      Command line arguments to use when auto-spawning a mongocryptd

      @@ -9,11 +9,11 @@
    • Optional mongocryptdURI?: string

      A local process the driver communicates with to determine how to encrypt values in a command. Defaults to "mongodb://%2Fvar%2Fmongocryptd.sock" if domain sockets are available or "mongodb://localhost:27020" otherwise

      -

    Optional keyVaultClient

    keyVaultClient?: MongoClient
    +

    Optional keyVaultClient

    keyVaultClient?: MongoClient

    A MongoClient used to fetch keys from a key vault

    -

    Optional keyVaultNamespace

    keyVaultNamespace?: string
    +

    Optional keyVaultNamespace

    keyVaultNamespace?: string

    The namespace where keys are stored in the key vault

    -

    Optional kmsProviders

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

    Optional kmsProviders

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

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

    Type declaration

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

      Configuration options for using 'aws' as your KMS provider

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

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

        -

    Optional options

    options?: { logger?: any }

    Type declaration

    Optional options

    options?: { logger?: any }

    Type declaration

    Optional proxyOptions

    proxyOptions?: ProxyOptions

    Optional schemaMap

    schemaMap?: Document
    +

    Parameters

    Returns void

    Optional proxyOptions

    proxyOptions?: ProxyOptions

    Optional schemaMap

    schemaMap?: Document

    A map of namespaces to a local JSON schema for encryption

    NOTE: Supplying options.schemaMap provides more security than relying on JSON Schemas obtained from the server. It protects against a malicious server advertising a false JSON Schema, which could trick the client into sending decrypted data that should be encrypted. Schemas supplied in the schemaMap only apply to configuring automatic encryption for client side encryption. Other validation rules in the JSON schema will not be enforced by the driver and will result in an error.

    -

    Optional tlsOptions

    tlsOptions?: { aws?: AutoEncryptionTlsOptions; azure?: AutoEncryptionTlsOptions; gcp?: AutoEncryptionTlsOptions; kmip?: AutoEncryptionTlsOptions; local?: AutoEncryptionTlsOptions }
    +

    Optional tlsOptions

    tlsOptions?: { aws?: AutoEncryptionTlsOptions; azure?: AutoEncryptionTlsOptions; gcp?: AutoEncryptionTlsOptions; kmip?: AutoEncryptionTlsOptions; local?: AutoEncryptionTlsOptions }

    The TLS options to use connecting to the KMS provider

    Type declaration

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface AutoEncryptionTlsOptions

    Hierarchy

    • AutoEncryptionTlsOptions

    Index

    Properties

    Properties

    Optional tlsCAFile

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

    Interface AutoEncryptionTlsOptions

    Hierarchy

    • AutoEncryptionTlsOptions

    Index

    Properties

    Properties

    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 KMS provider.

    -

    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.

    Legend

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

    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 5ea21defeda..66d8e440fd1 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/BulkResult.html b/docs/Next/interfaces/BulkResult.html index b92a9ec495f..306e735ed0a 100644 --- a/docs/Next/interfaces/BulkResult.html +++ b/docs/Next/interfaces/BulkResult.html @@ -1 +1 @@ -BulkResult | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface BulkResult

    Hierarchy

    • BulkResult

    Index

    Properties

    Properties

    insertedIds

    insertedIds: Document[]

    nInserted

    nInserted: number

    nMatched

    nMatched: number

    nModified

    nModified: number

    nRemoved

    nRemoved: number

    nUpserted

    nUpserted: number

    ok

    ok: number

    Optional opTime

    opTime?: Document

    upserted

    upserted: Document[]

    writeConcernErrors

    writeConcernErrors: WriteConcernError[]

    writeErrors

    writeErrors: WriteError[]

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface BulkResult

    Hierarchy

    • BulkResult

    Index

    Properties

    Properties

    insertedIds

    insertedIds: Document[]

    nInserted

    nInserted: number

    nMatched

    nMatched: number

    nModified

    nModified: number

    nRemoved

    nRemoved: number

    nUpserted

    nUpserted: number

    ok

    ok: number

    Optional opTime

    opTime?: Document

    upserted

    upserted: Document[]

    writeConcernErrors

    writeConcernErrors: WriteConcernError[]

    writeErrors

    writeErrors: WriteError[]

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface BulkWriteOperationError

    Hierarchy

    • BulkWriteOperationError

    Index

    Properties

    Properties

    code

    code: number

    errInfo

    errInfo: Document

    errmsg

    errmsg: string

    index

    index: number

    op

    op: Document | UpdateStatement | DeleteStatement

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface BulkWriteOperationError

    Hierarchy

    • BulkWriteOperationError

    Index

    Properties

    Properties

    code

    code: number

    errInfo

    errInfo: Document

    errmsg

    errmsg: string

    index

    index: number

    op

    op: Document | UpdateStatement | DeleteStatement

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/BulkWriteOptions.html b/docs/Next/interfaces/BulkWriteOptions.html index 5446b010932..264da340e93 100644 --- a/docs/Next/interfaces/BulkWriteOptions.html +++ b/docs/Next/interfaces/BulkWriteOptions.html @@ -1,26 +1,26 @@ -BulkWriteOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface BulkWriteOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean
    +BulkWriteOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface BulkWriteOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    -

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    +

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean

    Allow driver to bypass schema validation in MongoDB 3.2 or higher.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    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 fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional keepGoing

    keepGoing?: boolean
    deprecated

    use ordered instead

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional ordered

    ordered?: boolean
    +

    Optional keepGoing

    keepGoing?: boolean
    deprecated

    use ordered instead

    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional ordered

    ordered?: boolean

    If true, when an insert fails, don't execute the remaining writes. If false, continue with remaining inserts when one fails.

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    @@ -28,18 +28,18 @@

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ChangeStreamDocument<TSchema>

    Type parameters

    Hierarchy

    • ChangeStreamDocument

    Index

    Properties

    Properties

    _id

    _id: InferIdType<TSchema>
    +ChangeStreamDocument | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ChangeStreamDocument<TSchema>

    Type parameters

    Hierarchy

    • ChangeStreamDocument

    Index

    Properties

    Properties

    _id

    _id: InferIdType<TSchema>

    The id functions as an opaque token for use when resuming an interrupted change stream.

    -

    Optional documentKey

    documentKey?: { _id: InferIdType<TSchema> }
    +

    Optional documentKey

    documentKey?: { _id: InferIdType<TSchema> }

    Only present for ops of type ‘insert’, ‘update’, ‘replace’, and ‘delete’.

    For unsharded collections this contains a single field, _id, with the value of the _id of the document updated. For sharded collections, this will contain all the components of the shard key in order, followed by the _id if the _id isn’t part of the shard key.

    -

    Type declaration

    Optional fullDocument

    fullDocument?: TSchema
    +

    Type declaration

    Optional fullDocument

    fullDocument?: TSchema

    Always present for operations of type ‘insert’ and ‘replace’. Also present for operations of type ‘update’ if the user has specified ‘updateLookup’ in the ‘fullDocument’ arguments to the ‘$changeStream’ stage.

    @@ -18,12 +18,12 @@

    For operations of type ‘update’, this key will contain a copy of the full version of the document from some point after the update occurred. If the document was deleted since the updated happened, it will be null.

    -

    ns

    ns: { coll: string; db: string }
    +

    ns

    ns: { coll: string; db: string }

    Contains two fields: “db” and “coll” containing the database and collection name in which the change happened.

    -

    Type declaration

    • coll: string
    • db: string

    operationType

    operationType: "replace" | "insert" | "update" | "delete" | "invalidate" | "drop" | "dropDatabase" | "rename"
    +

    Type declaration

    • coll: string
    • db: string

    operationType

    operationType: "replace" | "insert" | "update" | "delete" | "invalidate" | "drop" | "dropDatabase" | "rename"

    Describes the type of operation represented in this change notification.

    -

    Optional updateDescription

    updateDescription?: UpdateDescription<TSchema>
    +

    Optional updateDescription

    updateDescription?: UpdateDescription<TSchema>

    Only present for ops of type ‘update’.

    Contains a description of updated and removed fields in this operation.

    diff --git a/docs/Next/interfaces/ChangeStreamOptions.html b/docs/Next/interfaces/ChangeStreamOptions.html index 3bac24210f8..5937ea2e0f9 100644 --- a/docs/Next/interfaces/ChangeStreamOptions.html +++ b/docs/Next/interfaces/ChangeStreamOptions.html @@ -1,64 +1,64 @@ ChangeStreamOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ChangeStreamOptions

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

    -

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean
    +

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    -

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number
    +

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number

    The number of documents to return per batch. See aggregation documentation.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    -

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    +

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean

    Allow driver to bypass schema validation in MongoDB 3.2 or higher.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Specify collation.

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    Optional cursor

    cursor?: Document
    +

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullDocument

    fullDocument?: string
    +

    Optional fullDocument

    fullDocument?: string

    Allowed values: ‘default’, ‘updateLookup’. When set to ‘updateLookup’, the change stream will include both a delta describing the changes to the document, as well as a copy of the entire document that was changed from some time after the change occurred.

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    -

    Optional hint

    hint?: Hint
    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional hint

    hint?: Hint

    Add an index selection hint to an aggregation command

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional let

    let?: Document
    +

    Optional let

    let?: Document

    Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).

    -

    Optional maxAwaitTimeMS

    maxAwaitTimeMS?: number
    +

    Optional maxAwaitTimeMS

    maxAwaitTimeMS?: number

    The maximum amount of time for the server to wait on new documents to satisfy a change stream query.

    -

    Optional maxTimeMS

    maxTimeMS?: number
    +

    Optional maxTimeMS

    maxTimeMS?: number

    specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point.

    -

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional out

    out?: string

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional out

    out?: string

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional resumeAfter

    resumeAfter?: unknown
    +

    Optional resumeAfter

    resumeAfter?: unknown

    Allows you to start a changeStream after a specified event. See ChangeStream documentation.

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional startAfter

    startAfter?: unknown
    +

    Optional startAfter

    startAfter?: unknown

    Similar to resumeAfter, but will allow you to start after an invalidated event. See ChangeStream documentation.

    -

    Optional startAtOperationTime

    startAtOperationTime?: Timestamp
    +

    Optional startAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ClientMetadata

    Hierarchy

    • ClientMetadata

    Index

    Properties

    Properties

    Optional application

    application?: { name: string }

    Type declaration

    • name: string

    driver

    driver: { name: string; version: string }

    Type declaration

    • name: string
    • version: string

    os

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

    Type declaration

    • architecture: string
    • name: Platform
    • type: string
    • version: string

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ClientMetadata

    Hierarchy

    • ClientMetadata

    Index

    Properties

    Properties

    Optional application

    application?: { name: string }

    Type declaration

    • name: string

    driver

    driver: { name: string; version: string }

    Type declaration

    • name: string
    • version: string

    os

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

    Type declaration

    • architecture: string
    • name: Platform
    • type: string
    • version: string

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ClientMetadataOptions.html b/docs/Next/interfaces/ClientMetadataOptions.html index 864961821cc..6885c904e7c 100644 --- a/docs/Next/interfaces/ClientMetadataOptions.html +++ b/docs/Next/interfaces/ClientMetadataOptions.html @@ -1 +1 @@ -ClientMetadataOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ClientMetadataOptions

    Hierarchy

    • ClientMetadataOptions

    Index

    Properties

    Properties

    Optional appName

    appName?: string

    Optional driverInfo

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

    Type declaration

    • Optional name?: string
    • Optional platform?: string
    • Optional version?: string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ClientMetadataOptions

    Hierarchy

    • ClientMetadataOptions

    Index

    Properties

    Properties

    Optional appName

    appName?: string

    Optional driverInfo

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

    Type declaration

    • Optional name?: string
    • Optional platform?: string
    • Optional version?: string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ClientSessionOptions.html b/docs/Next/interfaces/ClientSessionOptions.html index 943eb8ce7ee..ad058f9a0b4 100644 --- a/docs/Next/interfaces/ClientSessionOptions.html +++ b/docs/Next/interfaces/ClientSessionOptions.html @@ -1,7 +1,7 @@ -ClientSessionOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ClientSessionOptions

    Hierarchy

    • ClientSessionOptions

    Index

    Properties

    Properties

    Optional causalConsistency

    causalConsistency?: boolean
    +ClientSessionOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ClientSessionOptions

    Hierarchy

    • ClientSessionOptions

    Index

    Properties

    Properties

    Optional causalConsistency

    causalConsistency?: boolean

    Whether causal consistency should be enabled on this session

    -

    Optional defaultTransactionOptions

    defaultTransactionOptions?: TransactionOptions
    +

    Optional defaultTransactionOptions

    defaultTransactionOptions?: TransactionOptions

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

    -

    Optional snapshot

    snapshot?: boolean
    +

    Optional snapshot

    snapshot?: boolean

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

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface CloseOptions

    Hierarchy

    • CloseOptions

    Index

    Properties

    Properties

    Optional force

    force?: boolean

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface CloseOptions

    Hierarchy

    • CloseOptions

    Index

    Properties

    Properties

    Optional force

    force?: boolean

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ClusterTime

    Hierarchy

    • ClusterTime

    Index

    Properties

    Properties

    clusterTime

    clusterTime: Timestamp

    signature

    signature: { hash: Binary; keyId: Long }

    Type declaration

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ClusterTime

    Hierarchy

    • ClusterTime

    Index

    Properties

    Properties

    clusterTime

    clusterTime: Timestamp

    signature

    signature: { hash: Binary; keyId: Long }

    Type declaration

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/CollStats.html b/docs/Next/interfaces/CollStats.html index 5b05324fd6c..f6232fd6f96 100644 --- a/docs/Next/interfaces/CollStats.html +++ b/docs/Next/interfaces/CollStats.html @@ -1,44 +1,44 @@ CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://docs.mongodb.org/manual/reference/command/collStats/

    -

    Hierarchy

    Index

    Properties

    Properties

    avgObjSize

    avgObjSize: number
    +

    Hierarchy

    Index

    Properties

    Properties

    avgObjSize

    avgObjSize: number

    Average object size in bytes

    -

    capped

    capped: boolean
    +

    capped

    capped: boolean

    true if the collection is capped

    -

    count

    count: number
    +

    count

    count: number

    Number of documents

    -

    Optional freeStorageSize

    freeStorageSize?: number
    +

    Optional freeStorageSize

    freeStorageSize?: number

    The amount of storage available for reuse. The scale argument affects this value.

    -

    Optional indexBuilds

    indexBuilds?: number
    +

    Optional indexBuilds

    indexBuilds?: number

    An array that contains the names of the indexes that are currently being built on the collection

    -

    Optional indexDetails

    indexDetails?: any
    +

    Optional indexDetails

    indexDetails?: any

    The fields in this document are the names of the indexes, while the values themselves are documents that contain statistics for the index provided by the storage engine

    -

    indexSizes

    indexSizes: { _id_: number }
    +

    indexSizes

    indexSizes: { _id_: number }

    Size of specific indexes in bytes

    -

    Type declaration

    • [index: string]: number
    • _id_: number

    lastExtentSize

    lastExtentSize: number
    +

    Type declaration

    • [index: string]: number
    • _id_: number

    lastExtentSize

    lastExtentSize: number

    Size of the most recently created extent in bytes

    -

    max

    max: number
    +

    max

    max: number

    The maximum number of documents that may be present in a capped collection

    -

    maxSize

    maxSize: number
    +

    maxSize

    maxSize: number

    The maximum size of a capped collection

    -

    nindexes

    nindexes: number
    +

    nindexes

    nindexes: number

    Number of indexes

    -

    ns

    ns: string
    +

    ns

    ns: string

    Namespace

    -

    numExtents

    numExtents: number
    +

    numExtents

    numExtents: number

    Number of extents (contiguously allocated chunks of datafile space)

    -

    ok

    ok: number

    paddingFactor

    paddingFactor: number
    +

    ok

    ok: number

    paddingFactor

    paddingFactor: number

    Padding can speed up updates if documents grow

    -

    scaleFactor

    scaleFactor: number
    +

    scaleFactor

    scaleFactor: number

    The scale value used by the command.

    -

    size

    size: number
    +

    size

    size: number

    Collection size in bytes

    -

    storageSize

    storageSize: number
    +

    storageSize

    storageSize: number

    (Pre)allocated space for the collection in bytes

    -

    totalIndexSize

    totalIndexSize: number
    +

    totalIndexSize

    totalIndexSize: number

    Total index size in bytes

    -

    totalSize

    totalSize: number
    +

    totalSize

    totalSize: number

    The sum of the storageSize and totalIndexSize. The scale argument affects this value

    -

    Optional userFlags

    userFlags?: number
    +

    Optional userFlags

    userFlags?: number

    A number that indicates the user-set flags on the collection. userFlags only appears when using the mmapv1 storage engine

    -

    Optional wiredTiger

    wiredTiger?: WiredTigerData
    +

    Optional wiredTiger

    wiredTiger?: WiredTigerData

    This document contains data reported directly by the WiredTiger engine and other data for internal diagnostic use

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface CollStatsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean
    +CollStatsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStatsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    -

    Optional scale

    scale?: number
    +

    Optional scale

    scale?: number

    Divide the returned sizes by scale value.

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface CollationOptions

    Hierarchy

    • CollationOptions

    Index

    Properties

    Properties

    Optional alternate

    alternate?: string

    Optional backwards

    backwards?: boolean

    Optional caseFirst

    caseFirst?: string

    Optional caseLevel

    caseLevel?: boolean

    locale

    locale: string

    Optional maxVariable

    maxVariable?: string

    Optional normalization

    normalization?: boolean

    Optional numericOrdering

    numericOrdering?: boolean

    Optional strength

    strength?: number

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface CollationOptions

    Hierarchy

    • CollationOptions

    Index

    Properties

    Properties

    Optional alternate

    alternate?: string

    Optional backwards

    backwards?: boolean

    Optional caseFirst

    caseFirst?: string

    Optional caseLevel

    caseLevel?: boolean

    locale

    locale: string

    Optional maxVariable

    maxVariable?: string

    Optional normalization

    normalization?: boolean

    Optional numericOrdering

    numericOrdering?: boolean

    Optional strength

    strength?: number

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface CollectionInfo

    Hierarchy

    Index

    Properties

    Properties

    Optional idIndex

    idIndex?: Document

    Optional info

    info?: { readOnly?: false; uuid?: Binary }

    Type declaration

    • Optional readOnly?: false
    • Optional uuid?: Binary

    name

    name: string

    Optional options

    options?: Document

    Optional type

    type?: string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface CollectionInfo

    Hierarchy

    Index

    Properties

    Properties

    Optional idIndex

    idIndex?: Document

    Optional info

    info?: { readOnly?: false; uuid?: Binary }

    Type declaration

    • Optional readOnly?: false
    • Optional uuid?: Binary

    name

    name: string

    Optional options

    options?: Document

    Optional type

    type?: string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/CollectionOptions.html b/docs/Next/interfaces/CollectionOptions.html index 8d01eb7e0f9..25cacc8d5b1 100644 --- a/docs/Next/interfaces/CollectionOptions.html +++ b/docs/Next/interfaces/CollectionOptions.html @@ -2,27 +2,27 @@

    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.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional logger

    logger?: LoggerFunction

    Optional loggerLevel

    loggerLevel?: LoggerLevel

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional logger

    logger?: LoggerFunction

    Optional loggerLevel

    loggerLevel?: LoggerLevel

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

    The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional slaveOk

    slaveOk?: boolean
    deprecated

    Use readPreference instead

    -

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional slaveOk

    slaveOk?: boolean
    deprecated

    Use readPreference instead

    +

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/CommandOperationOptions.html b/docs/Next/interfaces/CommandOperationOptions.html index 32db745a811..6ae9e8ff606 100644 --- a/docs/Next/interfaces/CommandOperationOptions.html +++ b/docs/Next/interfaces/CommandOperationOptions.html @@ -1,38 +1,38 @@ -CommandOperationOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CommandOperationOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean
    +CommandOperationOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CommandOperationOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ConnectOptions

    Hierarchy

    • ConnectOptions

    Index

    Properties

    Properties

    Optional readPreference

    readPreference?: ReadPreference

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ConnectOptions

    Hierarchy

    • ConnectOptions

    Index

    Properties

    Properties

    Optional readPreference

    readPreference?: ReadPreference

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ConnectionOptions.html b/docs/Next/interfaces/ConnectionOptions.html index 24259d8db11..3f4e5ca64f2 100644 --- a/docs/Next/interfaces/ConnectionOptions.html +++ b/docs/Next/interfaces/ConnectionOptions.html @@ -1,11 +1,11 @@ ConnectionOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ConnectionOptions

    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 autoEncrypter

    autoEncrypter?: AutoEncrypter

    Optional ca

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

    Optional autoEncrypter

    autoEncrypter?: AutoEncrypter

    Optional ca

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

    Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.

    -

    Optional cancellationToken

    cancellationToken?: CancellationToken

    Optional cert

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

    Optional cancellationToken

    cancellationToken?: CancellationToken

    Optional cert

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

    Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM @@ -35,7 +35,7 @@ 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?: ("none" | "snappy" | "zlib")[]

    Optional connectTimeoutMS

    connectTimeoutMS?: number

    Optional credentials

    credentials?: MongoCredentials

    Optional crl

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

    Optional compressors

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

    Optional connectTimeoutMS

    connectTimeoutMS?: number

    Optional credentials

    credentials?: MongoCredentials

    Optional crl

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

    PEM formatted CRLs (Certificate Revocation Lists).

    Optional ecdhCurve

    ecdhCurve?: string

    A string describing a named curve or a colon separated list of curve @@ -45,7 +45,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 family

    family?: number

    generation

    generation: number

    Optional hints

    hints?: number

    hostAddress

    hostAddress: HostAddress

    id

    id: number | "<monitor>"

    Optional keepAlive

    keepAlive?: boolean

    Optional keepAliveInitialDelay

    keepAliveInitialDelay?: number

    Optional key

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

    Optional family

    family?: number

    generation

    generation: number

    Optional hints

    hints?: number

    hostAddress

    hostAddress: HostAddress

    id

    id: number | "<monitor>"

    Optional keepAlive

    keepAlive?: boolean

    Optional keepAliveInitialDelay

    keepAliveInitialDelay?: number

    Optional key

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

    Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be @@ -54,7 +54,7 @@ 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

    Optional logicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Optional lookup

    lookup?: LookupFunction

    metadata

    metadata: ClientMetadata

    Optional minDHSize

    minDHSize?: number

    monitorCommands

    monitorCommands: boolean

    Optional noDelay

    noDelay?: boolean

    Optional passphrase

    passphrase?: string
    +

    loadBalanced

    loadBalanced: boolean

    Optional localAddress

    localAddress?: string

    Optional localPort

    localPort?: number

    Optional logicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Optional lookup

    lookup?: LookupFunction

    metadata

    metadata: ClientMetadata

    Optional minDHSize

    minDHSize?: number

    monitorCommands

    monitorCommands: boolean

    Optional noDelay

    noDelay?: boolean

    Optional passphrase

    passphrase?: string

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

    Optional pfx

    pfx?: string | Buffer | (string | Buffer | PxfObject)[]

    PFX or PKCS12 encoded private key and certificate chain. pfx is an @@ -65,7 +65,7 @@ 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 proxyHost

    proxyHost?: string

    Optional proxyPassword

    proxyPassword?: string

    Optional proxyPort

    proxyPort?: number

    Optional proxyUsername

    proxyUsername?: string

    Optional rejectUnauthorized

    rejectUnauthorized?: boolean
    +

    Optional proxyHost

    proxyHost?: string

    Optional proxyPassword

    proxyPassword?: string

    Optional proxyPort

    proxyPort?: number

    Optional proxyUsername

    proxyUsername?: string

    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.

    @@ -82,4 +82,4 @@ 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.

    -

    Optional serverApi

    serverApi?: ServerApi

    Optional servername

    servername?: string

    Optional session

    session?: Buffer

    Optional socketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional serverApi

    serverApi?: ServerApi

    Optional servername

    servername?: string

    Optional session

    session?: Buffer

    Optional socketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ConnectionPoolOptions

    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 autoEncrypter

    autoEncrypter?: AutoEncrypter

    Optional ca

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

    Optional autoEncrypter

    autoEncrypter?: AutoEncrypter

    Optional ca

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

    Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.

    -

    Optional cancellationToken

    cancellationToken?: CancellationToken

    Optional cert

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

    Optional cancellationToken

    cancellationToken?: CancellationToken

    Optional cert

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

    Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM @@ -35,7 +35,7 @@ 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?: ("none" | "snappy" | "zlib")[]

    Optional connectTimeoutMS

    connectTimeoutMS?: number

    Optional credentials

    credentials?: MongoCredentials

    Optional crl

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

    Optional compressors

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

    Optional connectTimeoutMS

    connectTimeoutMS?: number

    Optional credentials

    credentials?: MongoCredentials

    Optional crl

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

    PEM formatted CRLs (Certificate Revocation Lists).

    Optional ecdhCurve

    ecdhCurve?: string

    A string describing a named curve or a colon separated list of curve @@ -45,7 +45,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 family

    family?: number

    Optional hints

    hints?: number

    hostAddress

    hostAddress: HostAddress

    Optional keepAlive

    keepAlive?: boolean

    Optional keepAliveInitialDelay

    keepAliveInitialDelay?: number

    Optional key

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

    Optional family

    family?: number

    Optional hints

    hints?: number

    hostAddress

    hostAddress: HostAddress

    Optional keepAlive

    keepAlive?: boolean

    Optional keepAliveInitialDelay

    keepAliveInitialDelay?: number

    Optional key

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

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

    -

    loadBalanced

    loadBalanced: boolean
    +

    loadBalanced

    loadBalanced: boolean

    If we are in load balancer mode.

    -

    Optional localAddress

    localAddress?: string

    Optional localPort

    localPort?: number

    Optional logicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Optional lookup

    lookup?: LookupFunction

    maxIdleTimeMS

    maxIdleTimeMS: number
    +

    Optional localAddress

    localAddress?: string

    Optional localPort

    localPort?: number

    Optional logicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Optional lookup

    lookup?: LookupFunction

    maxIdleTimeMS

    maxIdleTimeMS: number

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

    -

    maxPoolSize

    maxPoolSize: number
    +

    maxPoolSize

    maxPoolSize: number

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

    -

    metadata

    metadata: ClientMetadata

    Optional minDHSize

    minDHSize?: number

    minPoolSize

    minPoolSize: number
    +

    metadata

    metadata: ClientMetadata

    Optional minDHSize

    minDHSize?: number

    minPoolSize

    minPoolSize: number

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

    -

    monitorCommands

    monitorCommands: boolean

    Optional noDelay

    noDelay?: boolean

    Optional passphrase

    passphrase?: string
    +

    monitorCommands

    monitorCommands: boolean

    Optional noDelay

    noDelay?: boolean

    Optional passphrase

    passphrase?: string

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

    Optional pfx

    pfx?: string | Buffer | (string | Buffer | PxfObject)[]

    PFX or PKCS12 encoded private key and certificate chain. pfx is an @@ -73,7 +73,7 @@ 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 proxyHost

    proxyHost?: string

    Optional proxyPassword

    proxyPassword?: string

    Optional proxyPort

    proxyPort?: number

    Optional proxyUsername

    proxyUsername?: string

    Optional rejectUnauthorized

    rejectUnauthorized?: boolean
    +

    Optional proxyHost

    proxyHost?: string

    Optional proxyPassword

    proxyPassword?: string

    Optional proxyPort

    proxyPort?: number

    Optional proxyUsername

    proxyUsername?: string

    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.

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

    -

    Optional serverApi

    serverApi?: ServerApi

    Optional servername

    servername?: string

    Optional session

    session?: Buffer

    Optional socketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    waitQueueTimeoutMS

    waitQueueTimeoutMS: number
    +

    Optional serverApi

    serverApi?: ServerApi

    Optional servername

    servername?: string

    Optional session

    session?: Buffer

    Optional socketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    waitQueueTimeoutMS

    waitQueueTimeoutMS: number

    The maximum amount of time operation execution should wait for a connection to become available. The default is 0 which means there is no limit.

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/CountDocumentsOptions.html b/docs/Next/interfaces/CountDocumentsOptions.html index 4d643f872fb..160080b9ea6 100644 --- a/docs/Next/interfaces/CountDocumentsOptions.html +++ b/docs/Next/interfaces/CountDocumentsOptions.html @@ -1,58 +1,58 @@ -CountDocumentsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CountDocumentsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean
    +CountDocumentsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CountDocumentsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    -

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number
    +

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number

    The number of documents to return per batch. See aggregation documentation.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    -

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    +

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean

    Allow driver to bypass schema validation in MongoDB 3.2 or higher.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Specify collation.

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    Optional cursor

    cursor?: Document
    +

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    -

    Optional hint

    hint?: Hint
    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional hint

    hint?: Hint

    Add an index selection hint to an aggregation command

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional let

    let?: Document
    +

    Optional let

    let?: Document

    Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).

    -

    Optional limit

    limit?: number
    +

    Optional limit

    limit?: number

    The maximum amounts to count before aborting.

    -

    Optional maxAwaitTimeMS

    maxAwaitTimeMS?: number
    +

    Optional maxAwaitTimeMS

    maxAwaitTimeMS?: number

    The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.

    -

    Optional maxTimeMS

    maxTimeMS?: number
    +

    Optional maxTimeMS

    maxTimeMS?: number

    specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point.

    -

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional out

    out?: string

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional out

    out?: string

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional skip

    skip?: number
    +

    Optional skip

    skip?: number

    The number of documents to skip.

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/CountOptions.html b/docs/Next/interfaces/CountOptions.html index 2b333918c20..17e6a61cb34 100644 --- a/docs/Next/interfaces/CountOptions.html +++ b/docs/Next/interfaces/CountOptions.html @@ -1,46 +1,46 @@ -CountOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CountOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean
    +CountOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CountOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    -

    Optional hint

    hint?: string | Document
    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional hint

    hint?: string | Document

    An index name hint for the query.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional limit

    limit?: number
    +

    Optional limit

    limit?: number

    The maximum amounts to count before aborting.

    -

    Optional maxTimeMS

    maxTimeMS?: number
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Number of milliseconds to wait before aborting the query.

    -

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional skip

    skip?: number
    +

    Optional skip

    skip?: number

    The number of documents to skip.

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/CreateCollectionOptions.html b/docs/Next/interfaces/CreateCollectionOptions.html index 6e3d712d908..23425143247 100644 --- a/docs/Next/interfaces/CreateCollectionOptions.html +++ b/docs/Next/interfaces/CreateCollectionOptions.html @@ -1,34 +1,34 @@ -CreateCollectionOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CreateCollectionOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional autoIndexId

    autoIndexId?: boolean
    deprecated

    Create an index on the _id field of the document, True by default on MongoDB 2.6 - 3.0

    +CreateCollectionOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CreateCollectionOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional autoIndexId

    autoIndexId?: boolean
    deprecated

    Create an index on the _id field of the document, True by default on MongoDB 2.6 - 3.0

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    -

    Optional capped

    capped?: boolean
    +

    Optional capped

    capped?: boolean

    Create a capped collection

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    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 expireAfterSeconds

    expireAfterSeconds?: number
    +

    Optional expireAfterSeconds

    expireAfterSeconds?: number

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

    -

    Optional explain

    explain?: ExplainVerbosityLike
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional flags

    flags?: number
    +

    Optional flags

    flags?: number

    Available for the MMAPv1 storage engine only to set the usePowerOf2Sizes and the noPadding flag

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional indexOptionDefaults

    indexOptionDefaults?: Document
    +

    Optional indexOptionDefaults

    indexOptionDefaults?: Document

    Allows users to specify a default configuration for indexes when creating a collection on MongoDB 3.2 or higher

    -

    Optional max

    max?: number
    +

    Optional max

    max?: number

    The maximum number of documents in the capped collection

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional pipeline

    pipeline?: Document[]
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional pipeline

    pipeline?: Document[]

    An array that consists of the aggregation pipeline stage. Creates the view by applying the specified pipeline to the viewOn collection or view on MongoDB 3.4 or higher

    -

    Optional pkFactory

    pkFactory?: PkFactory
    +

    Optional pkFactory

    pkFactory?: PkFactory

    A primary key factory function for generation of custom _id keys.

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    @@ -36,34 +36,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 raw

    raw?: boolean
    +

    Optional raw

    raw?: boolean

    Return BSON filled buffers from operations

    -

    Optional readConcern

    readConcern?: ReadConcernLike
    +

    Optional readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional size

    size?: number
    +

    Optional size

    size?: number

    The size of the capped collection in bytes

    -

    Optional storageEngine

    storageEngine?: Document
    +

    Optional storageEngine

    storageEngine?: Document

    Allows users to specify configuration to the storage engine on a per-collection basis when creating a collection on MongoDB 3.0 or higher

    -

    Optional strict

    strict?: boolean
    +

    Optional strict

    strict?: boolean

    Returns an error if the collection does not exist

    -

    Optional timeseries

    timeseries?: TimeSeriesCollectionOptions
    +

    Optional timeseries

    timeseries?: TimeSeriesCollectionOptions

    A document specifying configuration options for timeseries collections.

    -

    Optional validationAction

    validationAction?: string
    +

    Optional validationAction

    validationAction?: string

    Determines whether to error on invalid documents or just warn about the violations but allow invalid documents to be inserted on MongoDB 3.2 or higher

    -

    Optional validationLevel

    validationLevel?: string
    +

    Optional validationLevel

    validationLevel?: string

    Determines how strictly MongoDB applies the validation rules to existing documents during an update on MongoDB 3.2 or higher

    -

    Optional validator

    validator?: Document
    +

    Optional validator

    validator?: Document

    Allows users to specify validation rules or expressions for the collection. For more information, see Document Validation on MongoDB 3.2 or higher

    -

    Optional viewOn

    viewOn?: string
    +

    Optional viewOn

    viewOn?: string

    The name of the source collection or view from which to create the view. The name is not the full namespace of the collection or view; i.e. does not include the database name and implies the same database as the view to create on MongoDB 3.4 or higher

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface CreateIndexesOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional 2dsphereIndexVersion

    2dsphereIndexVersion?: number

    Optional authdb

    authdb?: string

    Optional background

    background?: boolean
    +CreateIndexesOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CreateIndexesOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional 2dsphereIndexVersion

    2dsphereIndexVersion?: number

    Optional authdb

    authdb?: string

    Optional background

    background?: boolean

    Creates the index in the background, yielding whenever possible.

    -

    Optional bits

    bits?: number

    Optional bsonRegExp

    bsonRegExp?: boolean
    +

    Optional bits

    bits?: number

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    -

    Optional bucketSize

    bucketSize?: number

    Optional checkKeys

    checkKeys?: boolean
    +

    Optional bucketSize

    bucketSize?: number

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    Optional commitQuorum

    commitQuorum?: string | number
    +

    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
    +

    Optional expireAfterSeconds

    expireAfterSeconds?: number

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

    -

    Optional explain

    explain?: ExplainVerbosityLike
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    -

    Optional hidden

    hidden?: boolean
    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional hidden

    hidden?: boolean

    Specifies that the index should exist on the target collection but should not be used by the query planner when executing operations. (MongoDB 4.4 or higher)

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional language_override

    language_override?: string

    Optional max

    max?: number
    +

    Optional language_override

    language_override?: string

    Optional max

    max?: number

    For geospatial indexes set the high bound for the co-ordinates.

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional min

    min?: number
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional min

    min?: number

    For geospatial indexes set the lower bound for the co-ordinates.

    -

    Optional name

    name?: string
    +

    Optional name

    name?: string

    Override the autogenerated index name (useful if the resulting name is larger than 128 bytes)

    -

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional partialFilterExpression

    partialFilterExpression?: Document
    +

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional partialFilterExpression

    partialFilterExpression?: Document

    Creates a partial index based on the given filter object (MongoDB 3.2 or higher)

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    @@ -37,26 +37,26 @@

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional sparse

    sparse?: boolean
    +

    Optional sparse

    sparse?: boolean

    Creates a sparse index.

    -

    Optional storageEngine

    storageEngine?: Document
    +

    Optional storageEngine

    storageEngine?: Document

    Allows users to configure the storage engine on a per-index basis when creating an index. (MongoDB 3.0 or higher)

    -

    Optional textIndexVersion

    textIndexVersion?: number

    Optional unique

    unique?: boolean
    +

    Optional textIndexVersion

    textIndexVersion?: number

    Optional unique

    unique?: boolean

    Creates an unique index.

    -

    Optional version

    version?: number
    +

    Optional version

    version?: number

    Specifies the index version number, either 0 or 1.

    -

    Optional weights

    weights?: Document

    Optional wildcardProjection

    wildcardProjection?: Document

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional weights

    weights?: Document

    Optional wildcardProjection

    wildcardProjection?: Document

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/CursorCloseOptions.html b/docs/Next/interfaces/CursorCloseOptions.html index 1dc47d767bc..5b5c2aed20f 100644 --- a/docs/Next/interfaces/CursorCloseOptions.html +++ b/docs/Next/interfaces/CursorCloseOptions.html @@ -1,3 +1,3 @@ CursorCloseOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CursorCloseOptions

    deprecated

    This interface is deprecated

    -

    Hierarchy

    • CursorCloseOptions

    Index

    Properties

    Properties

    Optional skipKillCursors

    skipKillCursors?: boolean
    deprecated

    the skipKillCursors option is deprecated

    +

    Hierarchy

    • CursorCloseOptions

    Index

    Properties

    Properties

    Optional skipKillCursors

    skipKillCursors?: boolean
    deprecated

    the skipKillCursors option is deprecated

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/CursorStreamOptions.html b/docs/Next/interfaces/CursorStreamOptions.html index 31e6e6bca58..4cad7bc97bd 100644 --- a/docs/Next/interfaces/CursorStreamOptions.html +++ b/docs/Next/interfaces/CursorStreamOptions.html @@ -1,3 +1,3 @@ -CursorStreamOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CursorStreamOptions

    Hierarchy

    • CursorStreamOptions

    Index

    Methods

    Methods

    Optional transform

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    Allows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)

    -

    Optional allowPartialResults

    allowPartialResults?: boolean
    +

    Optional allowPartialResults

    allowPartialResults?: boolean

    For queries against a sharded collection, allows the command (or subsequent getMore commands) to return partial results, rather than an error, if one or more queried shards are unavailable.

    -

    Optional authdb

    authdb?: string

    Optional awaitData

    awaitData?: boolean
    +

    Optional authdb

    authdb?: string

    Optional awaitData

    awaitData?: boolean

    Specify if the cursor is a tailable-await cursor. Requires tailable to be true

    -

    Optional batchSize

    batchSize?: number
    +

    Optional batchSize

    batchSize?: number

    Set the batchSize for the getMoreCommand when iterating over the query results.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Specify collation (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    You can put a $comment field on a query to make looking in the profiler logs simpler.

    -

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    -

    Optional hint

    hint?: Hint
    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional hint

    hint?: Hint

    Tell the query to use specific indexes in the query. Object of indexes to use, {'_id':1}

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional let

    let?: Document
    +

    Optional let

    let?: Document

    Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).

    -

    Optional limit

    limit?: number
    +

    Optional limit

    limit?: number

    Sets the limit of documents returned in the query.

    -

    Optional max

    max?: Document
    +

    Optional max

    max?: Document

    The exclusive upper bound for a specific index

    -

    Optional maxAwaitTimeMS

    maxAwaitTimeMS?: number
    +

    Optional maxAwaitTimeMS

    maxAwaitTimeMS?: number

    The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. Requires tailable and awaitData to be true

    -

    Optional maxTimeMS

    maxTimeMS?: number
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Number of milliseconds to wait before aborting the query.

    -

    Optional min

    min?: Document
    +

    Optional min

    min?: Document

    The inclusive lower bound for a specific index

    -

    Optional noCursorTimeout

    noCursorTimeout?: boolean
    +

    Optional noCursorTimeout

    noCursorTimeout?: boolean

    The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.

    -

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional projection

    projection?: Document
    +

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional projection

    projection?: Document

    The fields to return in the query. Object of fields to either include or exclude (one of, not both), {'a':1, 'b': 1} or {'a': 0, 'b': 0}

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    @@ -49,32 +49,32 @@

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    -

    Optional returnKey

    returnKey?: boolean
    +

    Optional returnKey

    returnKey?: boolean

    If true, returns only the index keys in the resulting documents.

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional showRecordId

    showRecordId?: boolean
    +

    Optional showRecordId

    showRecordId?: boolean

    Determines whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents.

    -

    Optional singleBatch

    singleBatch?: boolean
    +

    Optional singleBatch

    singleBatch?: boolean

    Determines whether to close the cursor after the first batch. Defaults to false.

    -

    Optional skip

    skip?: number
    +

    Optional skip

    skip?: number

    Set to skip N documents ahead in your query (useful for pagination).

    -

    Optional sort

    sort?: Sort
    +

    Optional sort

    sort?: Sort

    Set to sort the documents coming back from the query. Array of indexes, [['a', 1]] etc.

    -

    Optional tailable

    tailable?: boolean
    +

    Optional tailable

    tailable?: boolean

    Specify if the cursor is tailable.

    -

    Optional timeout

    timeout?: boolean
    +

    Optional timeout

    timeout?: boolean

    Specify if the cursor can timeout.

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface GridFSBucketOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional bucketName

    bucketName?: string
    +GridFSBucketOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface GridFSBucketOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional bucketName

    bucketName?: string

    The 'files' and 'chunks' collections will be prefixed with the bucket name followed by a dot.

    -

    Optional chunkSizeBytes

    chunkSizeBytes?: number
    +

    Optional chunkSizeBytes

    chunkSizeBytes?: number

    Number of bytes stored in each chunk. Defaults to 255KB

    -

    Optional readPreference

    readPreference?: ReadPreference
    +

    Optional readPreference

    readPreference?: ReadPreference

    Read preference to be passed to read operations

    -

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/GridFSBucketReadStreamOptions.html b/docs/Next/interfaces/GridFSBucketReadStreamOptions.html index 4bb3ac74191..a04a1e67921 100644 --- a/docs/Next/interfaces/GridFSBucketReadStreamOptions.html +++ b/docs/Next/interfaces/GridFSBucketReadStreamOptions.html @@ -1,5 +1,5 @@ -GridFSBucketReadStreamOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface GridFSBucketReadStreamOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional end

    end?: number
    +GridFSBucketReadStreamOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface GridFSBucketReadStreamOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional end

    end?: number

    0-based offset in bytes to stop streaming before

    -

    Optional skip

    skip?: number

    Optional sort

    sort?: Sort

    Optional start

    start?: number
    +

    Optional skip

    skip?: number

    Optional sort

    sort?: Sort

    Optional start

    start?: number

    0-based offset in bytes to start streaming from

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/GridFSBucketReadStreamOptionsWithRevision.html b/docs/Next/interfaces/GridFSBucketReadStreamOptionsWithRevision.html index 73530234eab..1634678fc4d 100644 --- a/docs/Next/interfaces/GridFSBucketReadStreamOptionsWithRevision.html +++ b/docs/Next/interfaces/GridFSBucketReadStreamOptionsWithRevision.html @@ -1,9 +1,9 @@ -GridFSBucketReadStreamOptionsWithRevision | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface GridFSBucketReadStreamOptionsWithRevision

    Hierarchy

    Index

    Properties

    Properties

    Optional end

    end?: number
    +GridFSBucketReadStreamOptionsWithRevision | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface GridFSBucketReadStreamOptionsWithRevision

    Hierarchy

    Index

    Properties

    Properties

    Optional end

    end?: number

    0-based offset in bytes to stop streaming before

    -

    Optional revision

    revision?: number
    +

    Optional revision

    revision?: number

    The revision number relative to the oldest file with the given filename. 0 gets you the oldest file, 1 gets you the 2nd oldest, -1 gets you the newest.

    -

    Optional skip

    skip?: number

    Optional sort

    sort?: Sort

    Optional start

    start?: number
    +

    Optional skip

    skip?: number

    Optional sort

    sort?: Sort

    Optional start

    start?: number

    0-based offset in bytes to start streaming from

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface GridFSBucketWriteStreamOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional aliases

    aliases?: string[]
    +GridFSBucketWriteStreamOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface GridFSBucketWriteStreamOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional aliases

    aliases?: string[]

    Array of strings to store in the file document's aliases field

    -

    Optional chunkSizeBytes

    chunkSizeBytes?: number
    +

    Optional chunkSizeBytes

    chunkSizeBytes?: number

    Overwrite this bucket's chunkSizeBytes for this file

    -

    Optional contentType

    contentType?: string
    +

    Optional contentType

    contentType?: string

    String to store in the file document's contentType field

    -

    Optional id

    id?: ObjectId
    +

    Optional id

    id?: ObjectId

    Custom file id for the GridFS file.

    -

    Optional metadata

    metadata?: Document
    +

    Optional metadata

    metadata?: Document

    Object to store in the file document's metadata field

    -

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface GridFSChunk

    Hierarchy

    • GridFSChunk

    Index

    Properties

    Properties

    _id

    _id: ObjectId

    data

    data: Uint8Array | Buffer

    files_id

    files_id: ObjectId

    n

    n: number

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface GridFSChunk

    Hierarchy

    • GridFSChunk

    Index

    Properties

    Properties

    _id

    _id: ObjectId

    data

    data: Uint8Array | Buffer

    files_id

    files_id: ObjectId

    n

    n: number

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface GridFSFile

    Hierarchy

    • GridFSFile

    Index

    Properties

    Properties

    _id

    _id: ObjectId

    Optional aliases

    aliases?: string[]

    chunkSize

    chunkSize: number

    Optional contentType

    contentType?: string

    filename

    filename: string

    length

    length: number

    Optional metadata

    metadata?: Document

    uploadDate

    uploadDate: Date

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface GridFSFile

    Hierarchy

    • GridFSFile

    Index

    Properties

    Properties

    _id

    _id: ObjectId

    Optional aliases

    aliases?: string[]

    chunkSize

    chunkSize: number

    Optional contentType

    contentType?: string

    filename

    filename: string

    length

    length: number

    Optional metadata

    metadata?: Document

    uploadDate

    uploadDate: Date

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/HedgeOptions.html b/docs/Next/interfaces/HedgeOptions.html index ec4df424a5c..969c4c6f1fe 100644 --- a/docs/Next/interfaces/HedgeOptions.html +++ b/docs/Next/interfaces/HedgeOptions.html @@ -1,3 +1,3 @@ -HedgeOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface HedgeOptions

    Hierarchy

    • HedgeOptions

    Index

    Properties

    Properties

    Optional enabled

    enabled?: boolean
    +HedgeOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface HedgeOptions

    Hierarchy

    • HedgeOptions

    Index

    Properties

    Properties

    Optional enabled

    enabled?: boolean

    Explicitly enable or disable hedged reads.

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/IndexDescription.html b/docs/Next/interfaces/IndexDescription.html index 0c717ff63b2..7d8e544a1cb 100644 --- a/docs/Next/interfaces/IndexDescription.html +++ b/docs/Next/interfaces/IndexDescription.html @@ -1,21 +1,21 @@ -IndexDescription | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IndexDescription

    Hierarchy

    • Pick<CreateIndexesOptions, "background" | "unique" | "partialFilterExpression" | "sparse" | "hidden" | "expireAfterSeconds" | "storageEngine" | "version" | "weights" | "default_language" | "language_override" | "textIndexVersion" | "2dsphereIndexVersion" | "bits" | "min" | "max" | "bucketSize" | "wildcardProjection">
      • IndexDescription

    Index

    Properties

    Properties

    Optional 2dsphereIndexVersion

    2dsphereIndexVersion?: number

    Optional background

    background?: boolean
    +IndexDescription | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IndexDescription

    Hierarchy

    • Pick<CreateIndexesOptions, "background" | "unique" | "partialFilterExpression" | "sparse" | "hidden" | "expireAfterSeconds" | "storageEngine" | "version" | "weights" | "default_language" | "language_override" | "textIndexVersion" | "2dsphereIndexVersion" | "bits" | "min" | "max" | "bucketSize" | "wildcardProjection">
      • IndexDescription

    Index

    Properties

    Properties

    Optional 2dsphereIndexVersion

    2dsphereIndexVersion?: number

    Optional background

    background?: boolean

    Creates the index in the background, yielding whenever possible.

    -

    Optional bits

    bits?: number

    Optional bucketSize

    bucketSize?: number

    Optional collation

    collation?: CollationOptions

    Optional default_language

    default_language?: string

    Optional expireAfterSeconds

    expireAfterSeconds?: number
    +

    Optional bits

    bits?: number

    Optional bucketSize

    bucketSize?: number

    Optional collation

    collation?: CollationOptions

    Optional default_language

    default_language?: string

    Optional expireAfterSeconds

    expireAfterSeconds?: number

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

    -

    Optional hidden

    hidden?: boolean
    +

    Optional hidden

    hidden?: boolean

    Specifies that the index should exist on the target collection but should not be used by the query planner when executing operations. (MongoDB 4.4 or higher)

    -

    key

    key: Document

    Optional language_override

    language_override?: string

    Optional max

    max?: number
    +

    key

    key: Document

    Optional language_override

    language_override?: string

    Optional max

    max?: number

    For geospatial indexes set the high bound for the co-ordinates.

    -

    Optional min

    min?: number
    +

    Optional min

    min?: number

    For geospatial indexes set the lower bound for the co-ordinates.

    -

    Optional name

    name?: string

    Optional partialFilterExpression

    partialFilterExpression?: Document
    +

    Optional name

    name?: string

    Optional partialFilterExpression

    partialFilterExpression?: Document

    Creates a partial index based on the given filter object (MongoDB 3.2 or higher)

    -

    Optional sparse

    sparse?: boolean
    +

    Optional sparse

    sparse?: boolean

    Creates a sparse index.

    -

    Optional storageEngine

    storageEngine?: Document
    +

    Optional storageEngine

    storageEngine?: Document

    Allows users to configure the storage engine on a per-index basis when creating an index. (MongoDB 3.0 or higher)

    -

    Optional textIndexVersion

    textIndexVersion?: number

    Optional unique

    unique?: boolean
    +

    Optional textIndexVersion

    textIndexVersion?: number

    Optional unique

    unique?: boolean

    Creates an unique index.

    -

    Optional version

    version?: number
    +

    Optional version

    version?: number

    Specifies the index version number, either 0 or 1.

    -

    Optional weights

    weights?: Document

    Optional wildcardProjection

    wildcardProjection?: Document

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional weights

    weights?: Document

    Optional wildcardProjection

    wildcardProjection?: Document

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface IndexInformationOptions

    Hierarchy

    • IndexInformationOptions

    Index

    Properties

    Properties

    Optional full

    full?: boolean

    Optional readPreference

    readPreference?: ReadPreference

    Optional session

    session?: ClientSession

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface IndexInformationOptions

    Hierarchy

    • IndexInformationOptions

    Index

    Properties

    Properties

    Optional full

    full?: boolean

    Optional readPreference

    readPreference?: ReadPreference

    Optional session

    session?: ClientSession

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/InsertManyResult.html b/docs/Next/interfaces/InsertManyResult.html index 0db00dbac5d..35da3305f2b 100644 --- a/docs/Next/interfaces/InsertManyResult.html +++ b/docs/Next/interfaces/InsertManyResult.html @@ -1,7 +1,7 @@ -InsertManyResult | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface InsertManyResult<TSchema>

    Type parameters

    Hierarchy

    • InsertManyResult

    Index

    Properties

    Properties

    acknowledged

    acknowledged: boolean
    +InsertManyResult | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface InsertManyResult<TSchema>

    Type parameters

    Hierarchy

    • InsertManyResult

    Index

    Properties

    Properties

    acknowledged

    acknowledged: boolean

    Indicates whether this write result was acknowledged. If not, then all other members of this result will be undefined

    -

    insertedCount

    insertedCount: number
    +

    insertedCount

    insertedCount: number

    The number of inserted documents for this operations

    -

    insertedIds

    insertedIds: {}
    +

    insertedIds

    insertedIds: {}

    Map of the index of the inserted document to the id of the inserted document

    Type declaration

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/InsertOneModel.html b/docs/Next/interfaces/InsertOneModel.html index 36c13ca316d..88a8403f412 100644 --- a/docs/Next/interfaces/InsertOneModel.html +++ b/docs/Next/interfaces/InsertOneModel.html @@ -1,3 +1,3 @@ -InsertOneModel | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface InsertOneModel<TSchema>

    Type parameters

    Hierarchy

    • InsertOneModel

    Index

    Properties

    Properties

    document

    document: OptionalId<TSchema>
    +InsertOneModel | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface InsertOneModel<TSchema>

    Type parameters

    Hierarchy

    • InsertOneModel

    Index

    Properties

    Properties

    document

    document: OptionalId<TSchema>

    The document to insert.

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/InsertOneOptions.html b/docs/Next/interfaces/InsertOneOptions.html index e416101afc0..5d129221ddc 100644 --- a/docs/Next/interfaces/InsertOneOptions.html +++ b/docs/Next/interfaces/InsertOneOptions.html @@ -1,42 +1,42 @@ -InsertOneOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface InsertOneOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean
    +InsertOneOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface InsertOneOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    -

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    +

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean

    Allow driver to bypass schema validation in MongoDB 3.2 or higher.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    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 fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/InsertOneResult.html b/docs/Next/interfaces/InsertOneResult.html index 0383395d51b..92753692279 100644 --- a/docs/Next/interfaces/InsertOneResult.html +++ b/docs/Next/interfaces/InsertOneResult.html @@ -1,5 +1,5 @@ -InsertOneResult | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface InsertOneResult<TSchema>

    Type parameters

    Hierarchy

    • InsertOneResult

    Index

    Properties

    Properties

    acknowledged

    acknowledged: boolean
    +InsertOneResult | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface InsertOneResult<TSchema>

    Type parameters

    Hierarchy

    • InsertOneResult

    Index

    Properties

    Properties

    acknowledged

    acknowledged: boolean

    Indicates whether this write result was acknowledged. If not, then all other members of this result will be undefined

    -

    insertedId

    insertedId: InferIdType<TSchema>
    +

    insertedId

    insertedId: InferIdType<TSchema>

    The identifier that was inserted. If the server generated the identifier, this value will be null as the driver does not have access to that data

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ListCollectionsOptions.html b/docs/Next/interfaces/ListCollectionsOptions.html index d0e76260103..5e7e1eae314 100644 --- a/docs/Next/interfaces/ListCollectionsOptions.html +++ b/docs/Next/interfaces/ListCollectionsOptions.html @@ -1,44 +1,44 @@ -ListCollectionsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ListCollectionsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional authorizedCollections

    authorizedCollections?: boolean
    +ListCollectionsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ListCollectionsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional authorizedCollections

    authorizedCollections?: boolean

    Since 4.0: If true and nameOnly is true, allows a user without the required privilege (i.e. listCollections action on the database) to run the command when access control is enforced.

    -

    Optional batchSize

    batchSize?: number
    +

    Optional batchSize

    batchSize?: number

    The batchSize for the returned command cursor or if pre 2.8 the systems batch collection

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional nameOnly

    nameOnly?: boolean
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional nameOnly

    nameOnly?: boolean

    Since 4.0: If true, will only return the collection name in the response, and will omit additional info

    -

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ListDatabasesOptions.html b/docs/Next/interfaces/ListDatabasesOptions.html index ffc1e591035..984b148518b 100644 --- a/docs/Next/interfaces/ListDatabasesOptions.html +++ b/docs/Next/interfaces/ListDatabasesOptions.html @@ -1,44 +1,44 @@ -ListDatabasesOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ListDatabasesOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional authorizedDatabases

    authorizedDatabases?: boolean
    +ListDatabasesOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ListDatabasesOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional authorizedDatabases

    authorizedDatabases?: boolean

    A flag that determines which databases are returned based on the user privileges when access control is enabled

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional filter

    filter?: Document
    +

    Optional filter

    filter?: Document

    A query predicate that determines which databases are listed

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional nameOnly

    nameOnly?: boolean
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional nameOnly

    nameOnly?: boolean

    A flag to indicate whether the command should return just the database names, or return both database names and size information

    -

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ListDatabasesResult.html b/docs/Next/interfaces/ListDatabasesResult.html index 0f52b8d4ee9..6f6f7aacd3d 100644 --- a/docs/Next/interfaces/ListDatabasesResult.html +++ b/docs/Next/interfaces/ListDatabasesResult.html @@ -1 +1 @@ -ListDatabasesResult | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ListDatabasesResult

    Hierarchy

    • ListDatabasesResult

    Index

    Properties

    Properties

    databases

    databases: ({ empty?: boolean; name: string; sizeOnDisk?: number } & Document)[]

    ok

    ok: 0 | 1

    Optional totalSize

    totalSize?: number

    Optional totalSizeMb

    totalSizeMb?: number

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ListDatabasesResult

    Hierarchy

    • ListDatabasesResult

    Index

    Properties

    Properties

    databases

    databases: ({ empty?: boolean; name: string; sizeOnDisk?: number } & Document)[]

    ok

    ok: 0 | 1

    Optional totalSize

    totalSize?: number

    Optional totalSizeMb

    totalSizeMb?: number

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ListIndexesOptions.html b/docs/Next/interfaces/ListIndexesOptions.html index 9982efe67d3..a894312bd37 100644 --- a/docs/Next/interfaces/ListIndexesOptions.html +++ b/docs/Next/interfaces/ListIndexesOptions.html @@ -1,40 +1,40 @@ -ListIndexesOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ListIndexesOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number
    +ListIndexesOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ListIndexesOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number

    The batchSize for the returned command cursor or if pre 2.8 the systems batch collection

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface LoggerOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional logger

    logger?: LoggerFunction

    Optional loggerLevel

    loggerLevel?: LoggerLevel

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface LoggerOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional logger

    logger?: LoggerFunction

    Optional loggerLevel

    loggerLevel?: LoggerLevel

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/MapReduceOptions.html b/docs/Next/interfaces/MapReduceOptions.html index 7d921459c6c..2e3e701a1a1 100644 --- a/docs/Next/interfaces/MapReduceOptions.html +++ b/docs/Next/interfaces/MapReduceOptions.html @@ -1,31 +1,31 @@ -MapReduceOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MapReduceOptions<TKey, TValue>

    Type parameters

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean
    +MapReduceOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MapReduceOptions<TKey, TValue>

    Type parameters

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    -

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    +

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean

    Allow driver to bypass schema validation in MongoDB 3.2 or higher.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional finalize

    finalize?: string | FinalizeFunction<TKey, TValue>
    +

    Optional finalize

    finalize?: string | FinalizeFunction<TKey, TValue>

    Finalize function.

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional jsMode

    jsMode?: boolean
    +

    Optional jsMode

    jsMode?: boolean

    It is possible to make the execution stay in JS. Provided in MongoDB > 2.0.X.

    -

    Optional keeptemp

    keeptemp?: boolean
    +

    Optional keeptemp

    keeptemp?: boolean

    Keep temporary data.

    -

    Optional limit

    limit?: number
    +

    Optional limit

    limit?: number

    Number of objects to return from collection.

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional out

    out?: "inline" | { inline: 1 } | { replace: string } | { merge: string } | { reduce: string }
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional out

    out?: "inline" | { inline: 1 } | { replace: string } | { merge: string } | { reduce: string }

    Sets the output target for the map reduce job.

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    @@ -33,26 +33,26 @@

    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 query

    query?: Document
    +

    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
    +

    Optional readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    -

    Optional scope

    scope?: Document
    +

    Optional scope

    scope?: Document

    Can pass in variables that can be access from map/reduce/finalize.

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional sort

    sort?: Sort
    +

    Optional sort

    sort?: Sort

    Sorts the input objects using this key. Useful for optimization, like sorting by the emit key for fewer reduces.

    -

    Optional verbose

    verbose?: boolean
    +

    Optional verbose

    verbose?: boolean

    Provide statistics on job execution time.

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ModifyResult<TSchema>

    Type parameters

    Hierarchy

    • ModifyResult

    Index

    Properties

    Properties

    Optional lastErrorObject

    lastErrorObject?: Document

    ok

    ok: 0 | 1

    value

    value: null | WithId<TSchema>

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ModifyResult<TSchema>

    Type parameters

    Hierarchy

    • ModifyResult

    Index

    Properties

    Properties

    Optional lastErrorObject

    lastErrorObject?: Document

    ok

    ok: 0 | 1

    value

    value: null | WithId<TSchema>

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/MongoClientOptions.html b/docs/Next/interfaces/MongoClientOptions.html index 2c14306093f..608b6b46440 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")[]
    +

    Optional compressors

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

    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,21 +81,21 @@ 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

    -

    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 | (Buffer | KeyObject)[]

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

    maxIdleTimeMS?: number
    +

    Optional lookup

    lookup?: LookupFunction

    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.

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

    @@ -149,34 +149,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()

    @@ -192,54 +192,54 @@ 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

    -

    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 wtimeoutMS

    wtimeoutMS?: number
    +

    Optional wtimeoutMS

    wtimeoutMS?: number

    The write concern timeout

    -

    Optional zlibCompressionLevel

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

    Optional zlibCompressionLevel

    zlibCompressionLevel?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 9 | 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
    • Private property

    Settings

    Theme

    Generated using TypeDoc

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

    Interface MongoCredentialsOptions

    Hierarchy

    • MongoCredentialsOptions

    Index

    Properties

    Properties

    Optional db

    db?: string

    Optional mechanism

    mechanism?: AuthMechanism

    mechanismProperties

    mechanismProperties: AuthMechanismProperties

    password

    password: string

    source

    source: string

    username

    username: string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface MongoCredentialsOptions

    Hierarchy

    • MongoCredentialsOptions

    Index

    Properties

    Properties

    Optional db

    db?: string

    Optional mechanism

    mechanism?: AuthMechanism

    mechanismProperties

    mechanismProperties: AuthMechanismProperties

    password

    password: string

    source

    source: string

    username

    username: string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface MongoNetworkErrorOptions

    Hierarchy

    • MongoNetworkErrorOptions

    Index

    Properties

    Properties

    beforeHandshake

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

    Interface MongoNetworkErrorOptions

    Hierarchy

    • MongoNetworkErrorOptions

    Index

    Properties

    Properties

    beforeHandshake

    beforeHandshake: boolean

    Indicates the timeout happened before a connection handshake completed

    Legend

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

    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 120b837802e..9ec8ff68e2e 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" | "maxIdleTimeMS" | "maxPoolSize" | "minPoolSize" | "monitorCommands" | "noDelay" | "pkFactory" | "promiseLibrary" | "raw" | "replicaSet" | "retryReads" | "retryWrites" | "serverSelectionTimeoutMS" | "socketTimeoutMS" | "srvMaxHosts" | "srvServiceName" | "tlsAllowInvalidCertificates" | "tlsAllowInvalidHostnames" | "tlsInsecure" | "waitQueueTimeoutMS" | "zlibCompressionLevel">>
    • SupportedNodeConnectionOptions
      • MongoOptions

    Index

    Properties

    Methods

    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")[]

    connectTimeoutMS

    connectTimeoutMS: number
    +

    compressors

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

    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 | (Buffer | KeyObject)[]

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

    maxIdleTimeMS

    maxIdleTimeMS: number
    +

    Optional lookup

    lookup?: LookupFunction

    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.

    @@ -108,22 +108,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()

    @@ -137,17 +137,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

    @@ -196,16 +196,16 @@

    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 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 9 | 8
    +

    writeConcern

    writeConcern: WriteConcern

    zlibCompressionLevel

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

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

    -

    Methods

    toURI

    • toURI(): string

    Methods

    toURI

    • toURI(): string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/MonitorOptions.html b/docs/Next/interfaces/MonitorOptions.html index 5c164f9733f..aa38fda6cd0 100644 --- a/docs/Next/interfaces/MonitorOptions.html +++ b/docs/Next/interfaces/MonitorOptions.html @@ -1,11 +1,11 @@ MonitorOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MonitorOptions

    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 autoEncrypter

    autoEncrypter?: AutoEncrypter

    Optional ca

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

    Optional autoEncrypter

    autoEncrypter?: AutoEncrypter

    Optional ca

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

    Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.

    -

    Optional cancellationToken

    cancellationToken?: CancellationToken

    Optional cert

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

    Optional cancellationToken

    cancellationToken?: CancellationToken

    Optional cert

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

    Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM @@ -35,7 +35,7 @@ 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?: ("none" | "snappy" | "zlib")[]

    connectTimeoutMS

    connectTimeoutMS: number

    Optional credentials

    credentials?: MongoCredentials

    Optional crl

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

    Optional compressors

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

    connectTimeoutMS

    connectTimeoutMS: number

    Optional credentials

    credentials?: MongoCredentials

    Optional crl

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

    PEM formatted CRLs (Certificate Revocation Lists).

    Optional ecdhCurve

    ecdhCurve?: string

    A string describing a named curve or a colon separated list of curve @@ -45,7 +45,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 family

    family?: number

    heartbeatFrequencyMS

    heartbeatFrequencyMS: number

    Optional hints

    hints?: number

    Optional keepAlive

    keepAlive?: boolean

    Optional keepAliveInitialDelay

    keepAliveInitialDelay?: number

    Optional key

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

    Optional family

    family?: number

    heartbeatFrequencyMS

    heartbeatFrequencyMS: number

    Optional hints

    hints?: number

    Optional keepAlive

    keepAlive?: boolean

    Optional keepAliveInitialDelay

    keepAliveInitialDelay?: number

    Optional key

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

    Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be @@ -54,7 +54,7 @@ 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

    Optional logicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Optional lookup

    lookup?: LookupFunction

    metadata

    metadata: ClientMetadata

    Optional minDHSize

    minDHSize?: number

    minHeartbeatFrequencyMS

    minHeartbeatFrequencyMS: number

    monitorCommands

    monitorCommands: boolean

    Optional noDelay

    noDelay?: boolean

    Optional passphrase

    passphrase?: string
    +

    loadBalanced

    loadBalanced: boolean

    Optional localAddress

    localAddress?: string

    Optional localPort

    localPort?: number

    Optional logicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Optional lookup

    lookup?: LookupFunction

    metadata

    metadata: ClientMetadata

    Optional minDHSize

    minDHSize?: number

    minHeartbeatFrequencyMS

    minHeartbeatFrequencyMS: number

    monitorCommands

    monitorCommands: boolean

    Optional noDelay

    noDelay?: boolean

    Optional passphrase

    passphrase?: string

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

    Optional pfx

    pfx?: string | Buffer | (string | Buffer | PxfObject)[]

    PFX or PKCS12 encoded private key and certificate chain. pfx is an @@ -65,7 +65,7 @@ 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 proxyHost

    proxyHost?: string

    Optional proxyPassword

    proxyPassword?: string

    Optional proxyPort

    proxyPort?: number

    Optional proxyUsername

    proxyUsername?: string

    Optional rejectUnauthorized

    rejectUnauthorized?: boolean
    +

    Optional proxyHost

    proxyHost?: string

    Optional proxyPassword

    proxyPassword?: string

    Optional proxyPort

    proxyPort?: number

    Optional proxyUsername

    proxyUsername?: string

    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.

    @@ -82,4 +82,4 @@ 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.

    -

    Optional serverApi

    serverApi?: ServerApi

    Optional servername

    servername?: string

    Optional session

    session?: Buffer

    Optional socketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional serverApi

    serverApi?: ServerApi

    Optional servername

    servername?: string

    Optional session

    session?: Buffer

    Optional socketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    Legend

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

    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 41f833f141c..02f6a4822c9 100644 --- a/docs/Next/interfaces/OperationOptions.html +++ b/docs/Next/interfaces/OperationOptions.html @@ -2,24 +2,24 @@

    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.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface PipeOptions

    Hierarchy

    • PipeOptions

    Index

    Properties

    Properties

    Optional end

    end?: boolean

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface PipeOptions

    Hierarchy

    • PipeOptions

    Index

    Properties

    Properties

    Optional end

    end?: boolean

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/PkFactory.html b/docs/Next/interfaces/PkFactory.html index 031b7705aaa..de58d040b67 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
    • Private property

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ProxyOptions.html b/docs/Next/interfaces/ProxyOptions.html index 8c635806bca..14cdb604ac0 100644 --- a/docs/Next/interfaces/ProxyOptions.html +++ b/docs/Next/interfaces/ProxyOptions.html @@ -1 +1 @@ -ProxyOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ProxyOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional proxyHost

    proxyHost?: string

    Optional proxyPassword

    proxyPassword?: string

    Optional proxyPort

    proxyPort?: number

    Optional proxyUsername

    proxyUsername?: string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ProxyOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional proxyHost

    proxyHost?: string

    Optional proxyPassword

    proxyPassword?: string

    Optional proxyPort

    proxyPort?: number

    Optional proxyUsername

    proxyUsername?: string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ReadPreferenceFromOptions.html b/docs/Next/interfaces/ReadPreferenceFromOptions.html index 88744abac67..850aa63abcb 100644 --- a/docs/Next/interfaces/ReadPreferenceFromOptions.html +++ b/docs/Next/interfaces/ReadPreferenceFromOptions.html @@ -1,5 +1,5 @@ -ReadPreferenceFromOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ReadPreferenceFromOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional hedge

    hedge?: HedgeOptions
    +ReadPreferenceFromOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ReadPreferenceFromOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional hedge

    hedge?: HedgeOptions

    Server mode in which the same query is dispatched in parallel to multiple replica set members.

    -

    Optional maxStalenessSeconds

    maxStalenessSeconds?: number
    +

    Optional maxStalenessSeconds

    maxStalenessSeconds?: number

    Max secondary read staleness in seconds, Minimum value is 90 seconds.

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike | { maxStalenessSeconds?: number; mode?: ReadPreferenceMode; preference?: ReadPreferenceMode; tags?: TagSet[] }

    Optional readPreferenceTags

    readPreferenceTags?: TagSet[]

    Optional session

    session?: ClientSession

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional readPreference

    readPreference?: ReadPreferenceLike | { maxStalenessSeconds?: number; mode?: ReadPreferenceMode; preference?: ReadPreferenceMode; tags?: TagSet[] }

    Optional readPreferenceTags

    readPreferenceTags?: TagSet[]

    Optional session

    session?: ClientSession

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ReadPreferenceLikeOptions.html b/docs/Next/interfaces/ReadPreferenceLikeOptions.html index 9abbf98256c..901c345a82c 100644 --- a/docs/Next/interfaces/ReadPreferenceLikeOptions.html +++ b/docs/Next/interfaces/ReadPreferenceLikeOptions.html @@ -1,5 +1,5 @@ -ReadPreferenceLikeOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ReadPreferenceLikeOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional hedge

    hedge?: HedgeOptions
    +ReadPreferenceLikeOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ReadPreferenceLikeOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional hedge

    hedge?: HedgeOptions

    Server mode in which the same query is dispatched in parallel to multiple replica set members.

    -

    Optional maxStalenessSeconds

    maxStalenessSeconds?: number
    +

    Optional maxStalenessSeconds

    maxStalenessSeconds?: number

    Max secondary read staleness in seconds, Minimum value is 90 seconds.

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike | { maxStalenessSeconds?: number; mode?: ReadPreferenceMode; preference?: ReadPreferenceMode; tags?: TagSet[] }

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional readPreference

    readPreference?: ReadPreferenceLike | { maxStalenessSeconds?: number; mode?: ReadPreferenceMode; preference?: ReadPreferenceMode; tags?: TagSet[] }

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ReadPreferenceOptions.html b/docs/Next/interfaces/ReadPreferenceOptions.html index f5339362c7d..34702836c1b 100644 --- a/docs/Next/interfaces/ReadPreferenceOptions.html +++ b/docs/Next/interfaces/ReadPreferenceOptions.html @@ -1,5 +1,5 @@ -ReadPreferenceOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ReadPreferenceOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional hedge

    hedge?: HedgeOptions
    +ReadPreferenceOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ReadPreferenceOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional hedge

    hedge?: HedgeOptions

    Server mode in which the same query is dispatched in parallel to multiple replica set members.

    -

    Optional maxStalenessSeconds

    maxStalenessSeconds?: number
    +

    Optional maxStalenessSeconds

    maxStalenessSeconds?: number

    Max secondary read staleness in seconds, Minimum value is 90 seconds.

    Legend

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

    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 aca112ab29e..5a6c4cbd1ac 100644 --- a/docs/Next/interfaces/RenameOptions.html +++ b/docs/Next/interfaces/RenameOptions.html @@ -1,42 +1,42 @@ -RenameOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface RenameOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean
    +RenameOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface RenameOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    Optional dbName

    dbName?: string

    Optional dropTarget

    dropTarget?: boolean
    +

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional new_collection

    new_collection?: boolean
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional new_collection

    new_collection?: boolean

    Unclear

    -

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ReplaceOneModel<TSchema>

    Type parameters

    Hierarchy

    • ReplaceOneModel

    Index

    Properties

    Properties

    Optional collation

    collation?: CollationOptions
    +ReplaceOneModel | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ReplaceOneModel<TSchema>

    Type parameters

    Hierarchy

    • ReplaceOneModel

    Index

    Properties

    Properties

    Optional collation

    collation?: CollationOptions

    Specifies a collation.

    -

    filter

    filter: Filter<TSchema>
    +

    filter

    filter: Filter<TSchema>

    The filter to limit the replaced document.

    -

    Optional hint

    hint?: Hint
    +

    Optional hint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    -

    replacement

    replacement: WithoutId<TSchema>
    +

    replacement

    replacement: WithoutId<TSchema>

    The document with which to replace the matched document.

    -

    Optional upsert

    upsert?: boolean
    +

    Optional upsert

    upsert?: boolean

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

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ReplaceOptions.html b/docs/Next/interfaces/ReplaceOptions.html index 4015f82e22b..ae1ccc5f1e8 100644 --- a/docs/Next/interfaces/ReplaceOptions.html +++ b/docs/Next/interfaces/ReplaceOptions.html @@ -1,46 +1,46 @@ -ReplaceOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ReplaceOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean
    +ReplaceOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ReplaceOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    -

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    +

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean

    If true, allows the write to opt-out of document level validation

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Specifies a collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    -

    Optional hint

    hint?: string | Document
    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional hint

    hint?: string | Document

    Specify that the update query should only consider plans using the hinted index

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional let

    let?: Document
    +

    Optional let

    let?: Document

    Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional upsert

    upsert?: boolean
    +

    Optional upsert

    upsert?: boolean

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

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ResumeOptions

    Hierarchy

    • ResumeOptions

    Index

    Properties

    Properties

    Optional batchSize

    batchSize?: number

    Optional collation

    collation?: CollationOptions

    Optional maxAwaitTimeMS

    maxAwaitTimeMS?: number

    Optional readPreference

    readPreference?: ReadPreference

    Optional startAtOperationTime

    startAtOperationTime?: Timestamp

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface ResumeOptions

    Hierarchy

    • ResumeOptions

    Index

    Properties

    Properties

    Optional batchSize

    batchSize?: number

    Optional collation

    collation?: CollationOptions

    Optional maxAwaitTimeMS

    maxAwaitTimeMS?: number

    Optional readPreference

    readPreference?: ReadPreference

    Optional startAtOperationTime

    startAtOperationTime?: Timestamp

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/RoleSpecification.html b/docs/Next/interfaces/RoleSpecification.html index c7d9eaab4c1..156074575ac 100644 --- a/docs/Next/interfaces/RoleSpecification.html +++ b/docs/Next/interfaces/RoleSpecification.html @@ -1,6 +1,6 @@ -RoleSpecification | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface RoleSpecification

    Hierarchy

    • RoleSpecification

    Index

    Properties

    Properties

    db

    db: string
    +RoleSpecification | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface RoleSpecification

    Hierarchy

    • RoleSpecification

    Index

    Properties

    Properties

    db

    db: string

    The database this user's role should effect.

    -

    role

    role: string
    +

    role

    role: string

    A role grants privileges to perform sets of actions on defined resources. A given role applies to the database on which it is defined and can grant access down to a collection level of granularity.

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface RootFilterOperators<TSchema>

    Type parameters

    • TSchema

    Hierarchy

    Index

    Properties

    Properties

    Optional $and

    $and?: Filter<TSchema>[]

    Optional $comment

    $comment?: string | Document

    Optional $nor

    $nor?: Filter<TSchema>[]

    Optional $or

    $or?: Filter<TSchema>[]

    Optional $text

    $text?: { $caseSensitive?: boolean; $diacriticSensitive?: boolean; $language?: string; $search: string }

    Type declaration

    • Optional $caseSensitive?: boolean
    • Optional $diacriticSensitive?: boolean
    • Optional $language?: string
    • $search: string

    Optional $where

    $where?: string | ((this: TSchema) => boolean)

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface RootFilterOperators<TSchema>

    Type parameters

    • TSchema

    Hierarchy

    Index

    Properties

    Properties

    Optional $and

    $and?: Filter<TSchema>[]

    Optional $comment

    $comment?: string | Document

    Optional $nor

    $nor?: Filter<TSchema>[]

    Optional $or

    $or?: Filter<TSchema>[]

    Optional $text

    $text?: { $caseSensitive?: boolean; $diacriticSensitive?: boolean; $language?: string; $search: string }

    Type declaration

    • Optional $caseSensitive?: boolean
    • Optional $diacriticSensitive?: boolean
    • Optional $language?: string
    • $search: string

    Optional $where

    $where?: string | ((this: TSchema) => boolean)

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/SelectServerOptions.html b/docs/Next/interfaces/SelectServerOptions.html index 5ae0e65c6b4..f7e6d2c3cda 100644 --- a/docs/Next/interfaces/SelectServerOptions.html +++ b/docs/Next/interfaces/SelectServerOptions.html @@ -1,3 +1,3 @@ -SelectServerOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface SelectServerOptions

    Hierarchy

    • SelectServerOptions

    Index

    Properties

    Properties

    Optional readPreference

    readPreference?: ReadPreferenceLike

    Optional serverSelectionTimeoutMS

    serverSelectionTimeoutMS?: number
    +SelectServerOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface SelectServerOptions

    Hierarchy

    • SelectServerOptions

    Index

    Properties

    Properties

    Optional readPreference

    readPreference?: ReadPreferenceLike

    Optional serverSelectionTimeoutMS

    serverSelectionTimeoutMS?: number

    How long to block for server selection before throwing an error

    -

    Optional session

    session?: ClientSession

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional session

    session?: ClientSession

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ServerApi.html b/docs/Next/interfaces/ServerApi.html index 2e92c73b4de..65c5d42f05f 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
    • Private property

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface StreamDescriptionOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional compressors

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

    loadBalanced

    loadBalanced: boolean

    Optional logicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface StreamDescriptionOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional compressors

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

    loadBalanced

    loadBalanced: boolean

    Optional logicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/TimeSeriesCollectionOptions.html b/docs/Next/interfaces/TimeSeriesCollectionOptions.html index a8c26a8e80f..678bff7ef1b 100644 --- a/docs/Next/interfaces/TimeSeriesCollectionOptions.html +++ b/docs/Next/interfaces/TimeSeriesCollectionOptions.html @@ -1,2 +1,2 @@ TimeSeriesCollectionOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface TimeSeriesCollectionOptions

    see

    https://docs.mongodb.com/manual/core/timeseries-collections/

    -

    Hierarchy

    Index

    Properties

    Properties

    Optional granularity

    granularity?: string

    Optional metaField

    metaField?: string

    timeField

    timeField: string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    Index

    Properties

    Properties

    Optional granularity

    granularity?: string

    Optional metaField

    metaField?: string

    timeField

    timeField: string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface TopologyDescriptionOptions

    Hierarchy

    • TopologyDescriptionOptions

    Index

    Properties

    Properties

    Optional heartbeatFrequencyMS

    heartbeatFrequencyMS?: number

    Optional localThresholdMS

    localThresholdMS?: number

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface TopologyDescriptionOptions

    Hierarchy

    • TopologyDescriptionOptions

    Index

    Properties

    Properties

    Optional heartbeatFrequencyMS

    heartbeatFrequencyMS?: number

    Optional localThresholdMS

    localThresholdMS?: number

    Legend

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

    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 ab02bdb5e1f..4409d4daea7 100644 --- a/docs/Next/interfaces/TopologyOptions.html +++ b/docs/Next/interfaces/TopologyOptions.html @@ -1,13 +1,13 @@ TopologyOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface TopologyOptions

    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 autoEncrypter

    autoEncrypter?: AutoEncrypter

    Optional bsonRegExp

    bsonRegExp?: boolean
    +

    Optional autoEncrypter

    autoEncrypter?: AutoEncrypter

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional ca

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

    Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.

    -

    Optional cancellationToken

    cancellationToken?: CancellationToken

    Optional cert

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

    Optional cancellationToken

    cancellationToken?: CancellationToken

    Optional cert

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

    Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM @@ -39,9 +39,9 @@ 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?: ("none" | "snappy" | "zlib")[]

    connectTimeoutMS

    connectTimeoutMS: number

    Optional credentials

    credentials?: MongoCredentials

    Optional crl

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

    Optional compressors

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

    connectTimeoutMS

    connectTimeoutMS: number

    Optional credentials

    credentials?: MongoCredentials

    Optional crl

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

    PEM formatted CRLs (Certificate Revocation Lists).

    -

    directConnection

    directConnection: boolean
    +

    directConnection

    directConnection: boolean

    Indicates that a client should directly connect to a node without attempting to discover its topology type

    Optional ecdhCurve

    ecdhCurve?: string

    A string describing a named curve or a colon separated list of curve @@ -51,13 +51,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 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.

    -

    heartbeatFrequencyMS

    heartbeatFrequencyMS: number

    Optional hints

    hints?: number

    hosts

    hosts: HostAddress[]

    Optional ignoreUndefined

    ignoreUndefined?: boolean
    +

    heartbeatFrequencyMS

    heartbeatFrequencyMS: number

    Optional hints

    hints?: number

    hosts

    hosts: HostAddress[]

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional keepAlive

    keepAlive?: boolean

    Optional keepAliveInitialDelay

    keepAliveInitialDelay?: number

    Optional key

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

    Optional keepAlive

    keepAlive?: boolean

    Optional keepAliveInitialDelay

    keepAliveInitialDelay?: number

    Optional key

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

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

    -

    loadBalanced

    loadBalanced: boolean

    Optional localAddress

    localAddress?: string

    Optional localPort

    localPort?: number

    Optional logicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Optional lookup

    lookup?: LookupFunction

    maxIdleTimeMS

    maxIdleTimeMS: number
    +

    loadBalanced

    loadBalanced: boolean

    Optional localAddress

    localAddress?: string

    Optional localPort

    localPort?: number

    Optional logicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Optional lookup

    lookup?: LookupFunction

    maxIdleTimeMS

    maxIdleTimeMS: number

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

    -

    maxPoolSize

    maxPoolSize: number
    +

    maxPoolSize

    maxPoolSize: number

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

    -

    metadata

    metadata: ClientMetadata

    Optional minDHSize

    minDHSize?: number

    minHeartbeatFrequencyMS

    minHeartbeatFrequencyMS: number

    minPoolSize

    minPoolSize: number
    +

    metadata

    metadata: ClientMetadata

    Optional minDHSize

    minDHSize?: number

    minHeartbeatFrequencyMS

    minHeartbeatFrequencyMS: number

    minPoolSize

    minPoolSize: number

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

    -

    monitorCommands

    monitorCommands: boolean

    Optional noDelay

    noDelay?: boolean

    Optional passphrase

    passphrase?: string
    +

    monitorCommands

    monitorCommands: boolean

    Optional noDelay

    noDelay?: boolean

    Optional passphrase

    passphrase?: string

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

    Optional pfx

    pfx?: string | Buffer | (string | Buffer | PxfObject)[]

    PFX or PKCS12 encoded private key and certificate chain. pfx is an @@ -89,16 +89,16 @@

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

    The name of the replica set to connect to

    -

    retryReads

    retryReads: boolean

    retryWrites

    retryWrites: boolean

    Optional secureContext

    secureContext?: SecureContext
    +

    retryReads

    retryReads: boolean

    retryWrites

    retryWrites: boolean

    Optional secureContext

    secureContext?: SecureContext

    An optional TLS context object from tls.createSecureContext()

    Optional secureProtocol

    secureProtocol?: string

    Legacy mechanism to select the TLS protocol version to use, it does @@ -112,10 +112,10 @@ interoperability. Default: none, see minVersion.

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional serverApi

    serverApi?: ServerApi
    +

    Optional serverApi

    serverApi?: ServerApi

    MongoDB server API version

    -

    serverSelectionTimeoutMS

    serverSelectionTimeoutMS: number
    +

    serverSelectionTimeoutMS

    serverSelectionTimeoutMS: number

    How long to block for server selection before throwing an error

    -

    Optional servername

    servername?: string

    Optional session

    session?: Buffer

    Optional socketTimeoutMS

    socketTimeoutMS?: number

    Optional srvHost

    srvHost?: string

    srvMaxHosts

    srvMaxHosts: number

    srvServiceName

    srvServiceName: string

    tls

    tls: boolean

    waitQueueTimeoutMS

    waitQueueTimeoutMS: number
    +

    Optional servername

    servername?: string

    Optional session

    session?: Buffer

    Optional socketTimeoutMS

    socketTimeoutMS?: number

    Optional srvHost

    srvHost?: string

    srvMaxHosts

    srvMaxHosts: number

    srvServiceName

    srvServiceName: string

    tls

    tls: boolean

    waitQueueTimeoutMS

    waitQueueTimeoutMS: number

    The maximum amount of time operation execution should wait for a connection to become available. The default is 0 which means there is no limit.

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface TopologyVersion

    Hierarchy

    • TopologyVersion

    Index

    Properties

    Properties

    counter

    counter: Long

    processId

    processId: ObjectId

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface TopologyVersion

    Hierarchy

    • TopologyVersion

    Index

    Properties

    Properties

    counter

    counter: Long

    processId

    processId: ObjectId

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/TransactionOptions.html b/docs/Next/interfaces/TransactionOptions.html index 929afa4c15e..7a54809b144 100644 --- a/docs/Next/interfaces/TransactionOptions.html +++ b/docs/Next/interfaces/TransactionOptions.html @@ -1,40 +1,40 @@ TransactionOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface TransactionOptions

    Configuration options for a transaction.

    -

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean
    +

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional maxCommitTimeMS

    maxCommitTimeMS?: number

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional maxCommitTimeMS

    maxCommitTimeMS?: number

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

    A default read concern for commands in this transaction

    -

    Optional readPreference

    readPreference?: ReadPreference
    +

    Optional readPreference

    readPreference?: ReadPreference

    A default read preference for commands in this transaction

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern

    A default writeConcern for commands in this transaction

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface UpdateDescription<TSchema>

    Type parameters

    Hierarchy

    • UpdateDescription

    Index

    Properties

    Properties

    removedFields

    removedFields: string[]
    +UpdateDescription | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface UpdateDescription<TSchema>

    Type parameters

    Hierarchy

    • UpdateDescription

    Index

    Properties

    Properties

    removedFields

    removedFields: string[]

    An array of field names that were removed from the document.

    -

    updatedFields

    updatedFields: Partial<TSchema>
    +

    updatedFields

    updatedFields: Partial<TSchema>

    A document containing key:value pairs of names of the fields that were changed, and the new value for those fields.

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface UpdateManyModel<TSchema>

    Type parameters

    Hierarchy

    • UpdateManyModel

    Index

    Properties

    Properties

    Optional arrayFilters

    arrayFilters?: Document[]
    +UpdateManyModel | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface UpdateManyModel<TSchema>

    Type parameters

    Hierarchy

    • UpdateManyModel

    Index

    Properties

    Properties

    Optional arrayFilters

    arrayFilters?: Document[]

    A set of filters specifying to which array elements an update should apply.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Specifies a collation.

    -

    filter

    filter: Filter<TSchema>
    +

    filter

    filter: Filter<TSchema>

    The filter to limit the updated documents.

    -

    Optional hint

    hint?: Hint
    +

    Optional hint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    -

    update

    update: UpdateFilter<TSchema> | UpdateFilter<TSchema>[]
    +

    update

    update: UpdateFilter<TSchema> | UpdateFilter<TSchema>[]

    A document or pipeline containing update operators.

    -

    Optional upsert

    upsert?: boolean
    +

    Optional upsert

    upsert?: boolean

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

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface UpdateOneModel<TSchema>

    Type parameters

    Hierarchy

    • UpdateOneModel

    Index

    Properties

    Properties

    Optional arrayFilters

    arrayFilters?: Document[]
    +UpdateOneModel | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface UpdateOneModel<TSchema>

    Type parameters

    Hierarchy

    • UpdateOneModel

    Index

    Properties

    Properties

    Optional arrayFilters

    arrayFilters?: Document[]

    A set of filters specifying to which array elements an update should apply.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Specifies a collation.

    -

    filter

    filter: Filter<TSchema>
    +

    filter

    filter: Filter<TSchema>

    The filter to limit the updated documents.

    -

    Optional hint

    hint?: Hint
    +

    Optional hint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    -

    update

    update: UpdateFilter<TSchema> | UpdateFilter<TSchema>[]
    +

    update

    update: UpdateFilter<TSchema> | UpdateFilter<TSchema>[]

    A document or pipeline containing update operators.

    -

    Optional upsert

    upsert?: boolean
    +

    Optional upsert

    upsert?: boolean

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

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/UpdateOptions.html b/docs/Next/interfaces/UpdateOptions.html index 50173ba58e9..b3c92bd06e2 100644 --- a/docs/Next/interfaces/UpdateOptions.html +++ b/docs/Next/interfaces/UpdateOptions.html @@ -1,48 +1,48 @@ -UpdateOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface UpdateOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional arrayFilters

    arrayFilters?: Document[]
    +UpdateOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface UpdateOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional arrayFilters

    arrayFilters?: Document[]

    A set of filters specifying to which array elements an update should apply

    -

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean
    +

    Optional authdb

    authdb?: string

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    -

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    +

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean

    If true, allows the write to opt-out of document level validation

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Specifies a collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    -

    Optional hint

    hint?: string | Document
    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional hint

    hint?: string | Document

    Specify that the update query should only consider plans using the hinted index

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional let

    let?: Document
    +

    Optional let

    let?: Document

    Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional upsert

    upsert?: boolean
    +

    Optional upsert

    upsert?: boolean

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

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/UpdateResult.html b/docs/Next/interfaces/UpdateResult.html index 4ccef4dc86a..91307c8971f 100644 --- a/docs/Next/interfaces/UpdateResult.html +++ b/docs/Next/interfaces/UpdateResult.html @@ -1,11 +1,11 @@ -UpdateResult | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface UpdateResult

    Hierarchy

    • UpdateResult

    Index

    Properties

    Properties

    acknowledged

    acknowledged: boolean
    +UpdateResult | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface UpdateResult

    Hierarchy

    • UpdateResult

    Index

    Properties

    Properties

    acknowledged

    acknowledged: boolean

    Indicates whether this write result was acknowledged. If not, then all other members of this result will be undefined

    -

    matchedCount

    matchedCount: number
    +

    matchedCount

    matchedCount: number

    The number of documents that matched the filter

    -

    modifiedCount

    modifiedCount: number
    +

    modifiedCount

    modifiedCount: number

    The number of documents that were modified

    -

    upsertedCount

    upsertedCount: number
    +

    upsertedCount

    upsertedCount: number

    The number of documents that were upserted

    -

    upsertedId

    upsertedId: ObjectId
    +

    upsertedId

    upsertedId: ObjectId

    The identifier of the inserted document if an upsert took place

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/UpdateStatement.html b/docs/Next/interfaces/UpdateStatement.html index a986bc793a4..450dd27d5f7 100644 --- a/docs/Next/interfaces/UpdateStatement.html +++ b/docs/Next/interfaces/UpdateStatement.html @@ -1,15 +1,15 @@ -UpdateStatement | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface UpdateStatement

    Hierarchy

    • UpdateStatement

    Index

    Properties

    Properties

    Optional arrayFilters

    arrayFilters?: Document[]
    +UpdateStatement | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface UpdateStatement

    Hierarchy

    • UpdateStatement

    Index

    Properties

    Properties

    Optional arrayFilters

    arrayFilters?: Document[]

    An array of filter documents that determines which array elements to modify for an update operation on an array field.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Specifies the collation to use for the operation.

    -

    Optional hint

    hint?: Hint
    +

    Optional hint

    hint?: Hint

    A document or string that specifies the index to use to support the query predicate.

    -

    Optional multi

    multi?: boolean
    +

    Optional multi

    multi?: boolean

    If true, updates all documents that meet the query criteria.

    -

    q

    q: Document
    +

    q

    q: Document

    The query that matches documents to update.

    -

    u

    u: Document | Document[]
    +

    u

    u: Document | Document[]

    The modifications to apply.

    -

    Optional upsert

    upsert?: boolean
    +

    Optional upsert

    upsert?: boolean

    If true, perform an insert if no documents match the query.

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/ValidateCollectionOptions.html b/docs/Next/interfaces/ValidateCollectionOptions.html index a77287af3a6..706973cab4c 100644 --- a/docs/Next/interfaces/ValidateCollectionOptions.html +++ b/docs/Next/interfaces/ValidateCollectionOptions.html @@ -1,40 +1,40 @@ -ValidateCollectionOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ValidateCollectionOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional background

    background?: boolean
    +ValidateCollectionOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ValidateCollectionOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional authdb

    authdb?: string

    Optional background

    background?: boolean

    Validates a collection in the background, without interrupting read or write traffic (only in MongoDB 4.4+)

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional checkKeys

    checkKeys?: boolean

    the serializer will check if keys are valid.

    -

    Optional collation

    collation?: CollationOptions
    +

    Optional collation

    collation?: CollationOptions

    Collation

    -

    Optional comment

    comment?: string | Document
    +

    Optional comment

    comment?: string | Document

    A user-provided comment to attach to this command

    -

    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
    +

    Optional explain

    explain?: ExplainVerbosityLike

    Specifies the verbosity mode for the explain output.

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

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

    -

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    +

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    -

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean
    +

    Optional maxTimeMS

    maxTimeMS?: number

    Optional noResponse

    noResponse?: boolean

    Optional omitReadPreference

    omitReadPreference?: boolean

    Optional promoteBuffers

    promoteBuffers?: boolean

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

    Optional promoteLongs

    promoteLongs?: boolean

    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 readConcern

    readConcern?: ReadConcernLike

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

    -

    Optional readPreference

    readPreference?: ReadPreferenceLike
    +

    Optional readPreference

    readPreference?: ReadPreferenceLike

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

    -

    Optional retryWrites

    retryWrites?: boolean
    +

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean

    serialize the javascript functions (default:false).

    -

    Optional session

    session?: ClientSession
    +

    Optional session

    session?: ClientSession

    Specify ClientSession for this command

    -

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +

    Optional willRetryWrites

    willRetryWrites?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/interfaces/WiredTigerData.html b/docs/Next/interfaces/WiredTigerData.html index 23eb674ea49..96f9b353c03 100644 --- a/docs/Next/interfaces/WiredTigerData.html +++ b/docs/Next/interfaces/WiredTigerData.html @@ -1 +1 @@ -WiredTigerData | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface WiredTigerData

    Hierarchy

    Index

    Properties

    Properties

    LSM

    LSM: { bloom filter false positives: number; bloom filter hits: number; bloom filter misses: number; bloom filter pages evicted from cache: number; bloom filter pages read into cache: number; bloom filters in the LSM tree: number; chunks in the LSM tree: number; highest merge generation in the LSM tree: number; queries that could have benefited from a Bloom filter that did not exist: number; sleep for LSM checkpoint throttle: number; sleep for LSM merge throttle: number; total size of bloom filters: number } & Document

    block-manager

    block-manager: { allocations requiring file extension: number; blocks allocated: number; blocks freed: number; checkpoint size: number; file allocation unit size: number; file bytes available for reuse: number; file magic number: number; file major version number: number; file size in bytes: number; minor version number: number }

    Type declaration

    • allocations requiring file extension: number
    • blocks allocated: number
    • blocks freed: number
    • checkpoint size: number
    • file allocation unit size: number
    • file bytes available for reuse: number
    • file magic number: number
    • file major version number: number
    • file size in bytes: number
    • minor version number: number

    btree

    btree: { btree checkpoint generation: number; column-store fixed-size leaf pages: number; column-store internal pages: number; column-store variable-size RLE encoded values: number; column-store variable-size deleted values: number; column-store variable-size leaf pages: number; fixed-record size: number; maximum internal page key size: number; maximum internal page size: number; maximum leaf page key size: number; maximum leaf page size: number; maximum leaf page value size: number; maximum tree depth: number; number of key/value pairs: number; overflow pages: number; pages rewritten by compaction: number; row-store internal pages: number; row-store leaf pages: number } & Document

    cache

    cache: { bytes currently in the cache: number; bytes read into cache: number; bytes written from cache: number; checkpoint blocked page eviction: number; data source pages selected for eviction unable to be evicted: number; hazard pointer blocked page eviction: number; in-memory page passed criteria to be split: number; in-memory page splits: number; internal pages evicted: number; internal pages split during eviction: number; leaf pages split during eviction: number; modified pages evicted: number; overflow pages read into cache: number; overflow values cached in memory: number; page split during eviction deepened the tree: number; page written requiring lookaside records: number; pages read into cache: number; pages read into cache requiring lookaside entries: number; pages requested from the cache: number; pages written from cache: number; pages written requiring in-memory restoration: number; tracked dirty bytes in the cache: number; unmodified pages evicted: number } & Document

    cache_walk

    cache_walk: { Average difference between current eviction generation when the page was last considered: number; Average on-disk page image size seen: number; Clean pages currently in cache: number; Current eviction generation: number; Dirty pages currently in cache: number; Entries in the root page: number; Internal pages currently in cache: number; Leaf pages currently in cache: number; Maximum difference between current eviction generation when the page was last considered: number; Maximum page size seen: number; Minimum on-disk page image size seen: number; On-disk page image sizes smaller than a single allocation unit: number; Pages created in memory and never written: number; Pages currently queued for eviction: number; Pages that could not be queued for eviction: number; Refs skipped during cache traversal: number; Size of the root page: number; Total number of pages currently in cache: number } & Document

    compression

    compression: { compressed pages read: number; compressed pages written: number; page written failed to compress: number; page written was too small to compress: number; raw compression call failed, additional data available: number; raw compression call failed, no additional data available: number; raw compression call succeeded: number } & Document

    cursor

    cursor: { bulk-loaded cursor-insert calls: number; create calls: number; cursor-insert key and value bytes inserted: number; cursor-remove key bytes removed: number; cursor-update value bytes updated: number; insert calls: number; next calls: number; prev calls: number; remove calls: number; reset calls: number; restarted searches: number; search calls: number; search near calls: number; truncate calls: number; update calls: number }

    Type declaration

    • bulk-loaded cursor-insert calls: number
    • create calls: number
    • cursor-insert key and value bytes inserted: number
    • cursor-remove key bytes removed: number
    • cursor-update value bytes updated: number
    • insert calls: number
    • next calls: number
    • prev calls: number
    • remove calls: number
    • reset calls: number
    • restarted searches: number
    • search calls: number
    • search near calls: number
    • truncate calls: number
    • update calls: number

    reconciliation

    reconciliation: { dictionary matches: number; fast-path pages deleted: number; internal page key bytes discarded using suffix compression: number; internal page multi-block writes: number; internal-page overflow keys: number; leaf page key bytes discarded using prefix compression: number; leaf page multi-block writes: number; leaf-page overflow keys: number; maximum blocks required for a page: number; overflow values written: number; page checksum matches: number; page reconciliation calls: number; page reconciliation calls for eviction: number; pages deleted: number } & Document

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface WiredTigerData

    Hierarchy

    Index

    Properties

    Properties

    LSM

    LSM: { bloom filter false positives: number; bloom filter hits: number; bloom filter misses: number; bloom filter pages evicted from cache: number; bloom filter pages read into cache: number; bloom filters in the LSM tree: number; chunks in the LSM tree: number; highest merge generation in the LSM tree: number; queries that could have benefited from a Bloom filter that did not exist: number; sleep for LSM checkpoint throttle: number; sleep for LSM merge throttle: number; total size of bloom filters: number } & Document

    block-manager

    block-manager: { allocations requiring file extension: number; blocks allocated: number; blocks freed: number; checkpoint size: number; file allocation unit size: number; file bytes available for reuse: number; file magic number: number; file major version number: number; file size in bytes: number; minor version number: number }

    Type declaration

    • allocations requiring file extension: number
    • blocks allocated: number
    • blocks freed: number
    • checkpoint size: number
    • file allocation unit size: number
    • file bytes available for reuse: number
    • file magic number: number
    • file major version number: number
    • file size in bytes: number
    • minor version number: number

    btree

    btree: { btree checkpoint generation: number; column-store fixed-size leaf pages: number; column-store internal pages: number; column-store variable-size RLE encoded values: number; column-store variable-size deleted values: number; column-store variable-size leaf pages: number; fixed-record size: number; maximum internal page key size: number; maximum internal page size: number; maximum leaf page key size: number; maximum leaf page size: number; maximum leaf page value size: number; maximum tree depth: number; number of key/value pairs: number; overflow pages: number; pages rewritten by compaction: number; row-store internal pages: number; row-store leaf pages: number } & Document

    cache

    cache: { bytes currently in the cache: number; bytes read into cache: number; bytes written from cache: number; checkpoint blocked page eviction: number; data source pages selected for eviction unable to be evicted: number; hazard pointer blocked page eviction: number; in-memory page passed criteria to be split: number; in-memory page splits: number; internal pages evicted: number; internal pages split during eviction: number; leaf pages split during eviction: number; modified pages evicted: number; overflow pages read into cache: number; overflow values cached in memory: number; page split during eviction deepened the tree: number; page written requiring lookaside records: number; pages read into cache: number; pages read into cache requiring lookaside entries: number; pages requested from the cache: number; pages written from cache: number; pages written requiring in-memory restoration: number; tracked dirty bytes in the cache: number; unmodified pages evicted: number } & Document

    cache_walk

    cache_walk: { Average difference between current eviction generation when the page was last considered: number; Average on-disk page image size seen: number; Clean pages currently in cache: number; Current eviction generation: number; Dirty pages currently in cache: number; Entries in the root page: number; Internal pages currently in cache: number; Leaf pages currently in cache: number; Maximum difference between current eviction generation when the page was last considered: number; Maximum page size seen: number; Minimum on-disk page image size seen: number; On-disk page image sizes smaller than a single allocation unit: number; Pages created in memory and never written: number; Pages currently queued for eviction: number; Pages that could not be queued for eviction: number; Refs skipped during cache traversal: number; Size of the root page: number; Total number of pages currently in cache: number } & Document

    compression

    compression: { compressed pages read: number; compressed pages written: number; page written failed to compress: number; page written was too small to compress: number; raw compression call failed, additional data available: number; raw compression call failed, no additional data available: number; raw compression call succeeded: number } & Document

    cursor

    cursor: { bulk-loaded cursor-insert calls: number; create calls: number; cursor-insert key and value bytes inserted: number; cursor-remove key bytes removed: number; cursor-update value bytes updated: number; insert calls: number; next calls: number; prev calls: number; remove calls: number; reset calls: number; restarted searches: number; search calls: number; search near calls: number; truncate calls: number; update calls: number }

    Type declaration

    • bulk-loaded cursor-insert calls: number
    • create calls: number
    • cursor-insert key and value bytes inserted: number
    • cursor-remove key bytes removed: number
    • cursor-update value bytes updated: number
    • insert calls: number
    • next calls: number
    • prev calls: number
    • remove calls: number
    • reset calls: number
    • restarted searches: number
    • search calls: number
    • search near calls: number
    • truncate calls: number
    • update calls: number

    reconciliation

    reconciliation: { dictionary matches: number; fast-path pages deleted: number; internal page key bytes discarded using suffix compression: number; internal page multi-block writes: number; internal-page overflow keys: number; leaf page key bytes discarded using prefix compression: number; leaf page multi-block writes: number; leaf-page overflow keys: number; maximum blocks required for a page: number; overflow values written: number; page checksum matches: number; page reconciliation calls: number; page reconciliation calls for eviction: number; pages deleted: number } & Document

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface WriteConcernErrorData

    Hierarchy

    • WriteConcernErrorData

    Index

    Properties

    Properties

    code

    code: number

    Optional errInfo

    errInfo?: Document

    errmsg

    errmsg: string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface WriteConcernErrorData

    Hierarchy

    • WriteConcernErrorData

    Index

    Properties

    Properties

    code

    code: number

    Optional errInfo

    errInfo?: Document

    errmsg

    errmsg: string

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface WriteConcernOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    +WriteConcernOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface WriteConcernOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    Write Concern as an object

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

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

    Interface WriteConcernSettings

    Hierarchy

    • WriteConcernSettings

    Index

    Properties

    Properties

    Optional fsync

    fsync?: boolean | 1
    +WriteConcernSettings | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface WriteConcernSettings

    Hierarchy

    • WriteConcernSettings

    Index

    Properties

    Properties

    Optional fsync

    fsync?: boolean | 1

    The file sync write concern

    -

    Optional j

    j?: boolean
    +

    Optional j

    j?: boolean

    The journal write concern

    -

    Optional journal

    journal?: boolean
    +

    Optional journal

    journal?: boolean

    The journal write concern

    -

    Optional w

    w?: W
    +

    Optional w

    w?: W

    The write concern

    -

    Optional wtimeout

    wtimeout?: number
    +

    Optional wtimeout

    wtimeout?: number

    The write concern timeout

    -

    Optional wtimeoutMS

    wtimeoutMS?: number
    +

    Optional wtimeoutMS

    wtimeoutMS?: number

    The write concern timeout

    Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/modules.html b/docs/Next/modules.html index e794d2eda40..ca625cfe4cf 100644 --- a/docs/Next/modules.html +++ b/docs/Next/modules.html @@ -1,45 +1,45 @@ -mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    mongodb

    Index

    Classes Error

    Classes Event

    Classes Other

    Interfaces

    Type aliases

    Variables

    Type aliases

    AbstractCursorEvents

    AbstractCursorEvents: { close: any }

    Type declaration

    AcceptedFields

    AcceptedFields<TSchema, FieldType, AssignableType>: { readonly [ key in KeysOfAType<TSchema, FieldType>]?: AssignableType }

    Type parameters

    • TSchema

    • FieldType

    • AssignableType

    AddToSetOperators

    AddToSetOperators<Type>: { $each?: Flatten<Type>[] }

    Type parameters

    • Type

    Type declaration

    AlternativeType

    AlternativeType<T>: T extends ReadonlyArray<infer U> ? T | RegExpOrString<U> : RegExpOrString<T>
    +mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    mongodb

    Index

    Classes Error

    Classes Event

    Classes Other

    Interfaces

    Type aliases

    Variables

    Type aliases

    AbstractCursorEvents

    AbstractCursorEvents: { close: any }

    Type declaration

    AcceptedFields

    AcceptedFields<TSchema, FieldType, AssignableType>: { readonly [ key in KeysOfAType<TSchema, FieldType>]?: AssignableType }

    Type parameters

    • TSchema

    • FieldType

    • AssignableType

    AddToSetOperators

    AddToSetOperators<Type>: { $each?: Flatten<Type>[] }

    Type parameters

    • Type

    Type declaration

    AlternativeType

    AlternativeType<T>: T extends ReadonlyArray<infer U> ? T | RegExpOrString<U> : RegExpOrString<T>

    It is possible to search using alternative types in mongodb e.g. string types can be searched using a regex in mongo array types can be searched using their element type

    -

    Type parameters

    • T

    AnyBulkWriteOperation

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

    Type parameters

    AnyError

    AnyError: MongoError | Error

    ArrayOperator

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

    Type parameters

    • Type

    Type declaration

    • Optional $each?: Flatten<Type>[]
    • Optional $position?: number
    • Optional $slice?: number
    • Optional $sort?: Sort

    AuthMechanism

    AuthMechanism: typeof AuthMechanism[keyof typeof AuthMechanism]

    AutoEncryptionLoggerLevel

    AutoEncryptionLoggerLevel: typeof AutoEncryptionLoggerLevel[keyof typeof AutoEncryptionLoggerLevel]

    BSONType

    BSONType: typeof BSONType[keyof typeof BSONType]

    BSONTypeAlias

    BSONTypeAlias: keyof typeof BSONType

    BatchType

    BatchType: typeof BatchType[keyof typeof BatchType]

    BitwiseFilter

    BitwiseFilter: number | Binary | ReadonlyArray<number>

    Callback

    Callback<T>: (error?: AnyError, result?: T) => void

    Type parameters

    • T = any

    Type declaration

      • +

        Type parameters

        • T

    AnyBulkWriteOperation

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

    Type parameters

    AnyError

    AnyError: MongoError | Error

    ArrayOperator

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

    Type parameters

    • Type

    Type declaration

    • Optional $each?: Flatten<Type>[]
    • Optional $position?: number
    • Optional $slice?: number
    • Optional $sort?: Sort

    AuthMechanism

    AuthMechanism: typeof AuthMechanism[keyof typeof AuthMechanism]

    AutoEncryptionLoggerLevel

    AutoEncryptionLoggerLevel: typeof AutoEncryptionLoggerLevel[keyof typeof AutoEncryptionLoggerLevel]

    BSONType

    BSONType: typeof BSONType[keyof typeof BSONType]

    BSONTypeAlias

    BSONTypeAlias: keyof typeof BSONType

    BatchType

    BatchType: typeof BatchType[keyof typeof BatchType]

    BitwiseFilter

    BitwiseFilter: number | Binary | ReadonlyArray<number>

    Callback

    Callback<T>: (error?: AnyError, result?: T) => void

    Type parameters

    • T = any

    Type declaration

      • MongoDB Driver style callback

        -

        Parameters

        • Optional error: AnyError
        • Optional result: T

        Returns void

    ChangeStreamEvents

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

    Type parameters

    ClientSessionEvents

    ClientSessionEvents: { ended: any }

    Type declaration

    CommonEvents

    CommonEvents: "newListener" | "removeListener"

    Compressor

    Compressor: typeof Compressor[CompressorName]

    CompressorName

    CompressorName: keyof typeof Compressor

    Condition

    Condition<T>: AlternativeType<T> | FilterOperators<AlternativeType<T>>

    Type parameters

    • T

    ConnectionEvents

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

    Type declaration

    ConnectionPoolEvents

    ConnectionPoolEvents: { connectionCheckOutFailed: any; connectionCheckOutStarted: any; connectionCheckedIn: any; connectionCheckedOut: any; connectionClosed: any; connectionCreated: any; connectionPoolCleared: any; connectionPoolClosed: any; connectionPoolCreated: any; connectionReady: any } & Omit<ConnectionEvents, "close" | "message">

    CursorFlag

    CursorFlag: typeof CURSOR_FLAGS[number]

    DistinctOptions

    DistinctOptions: CommandOperationOptions

    DropCollectionOptions

    DropCollectionOptions: CommandOperationOptions

    DropDatabaseOptions

    DropDatabaseOptions: CommandOperationOptions

    DropIndexesOptions

    DropIndexesOptions: CommandOperationOptions

    EnhancedOmit

    EnhancedOmit<TRecordOrUnion, KeyUnion>: string extends keyof TRecordOrUnion ? TRecordOrUnion : TRecordOrUnion extends any ? Pick<TRecordOrUnion, Exclude<keyof TRecordOrUnion, KeyUnion>> : never
    +

    Parameters

    • Optional error: AnyError
    • Optional result: T

    Returns void

    ChangeStreamEvents

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

    Type parameters

    ClientSessionEvents

    ClientSessionEvents: { ended: any }

    Type declaration

    CommonEvents

    CommonEvents: "newListener" | "removeListener"

    Compressor

    Compressor: typeof Compressor[CompressorName]

    CompressorName

    CompressorName: keyof typeof Compressor

    Condition

    Condition<T>: AlternativeType<T> | FilterOperators<AlternativeType<T>>

    Type parameters

    • T

    ConnectionEvents

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

    Type declaration

    ConnectionPoolEvents

    ConnectionPoolEvents: { connectionCheckOutFailed: any; connectionCheckOutStarted: any; connectionCheckedIn: any; connectionCheckedOut: any; connectionClosed: any; connectionCreated: any; connectionPoolCleared: any; connectionPoolClosed: any; connectionPoolCreated: any; connectionReady: any } & Omit<ConnectionEvents, "close" | "message">

    CursorFlag

    CursorFlag: typeof CURSOR_FLAGS[number]

    DistinctOptions

    DistinctOptions: CommandOperationOptions

    DropCollectionOptions

    DropCollectionOptions: CommandOperationOptions

    DropDatabaseOptions

    DropDatabaseOptions: CommandOperationOptions

    DropIndexesOptions

    DropIndexesOptions: CommandOperationOptions

    EnhancedOmit

    EnhancedOmit<TRecordOrUnion, KeyUnion>: string extends keyof TRecordOrUnion ? TRecordOrUnion : TRecordOrUnion extends any ? Pick<TRecordOrUnion, Exclude<keyof TRecordOrUnion, KeyUnion>> : never

    TypeScript Omit (Exclude to be specific) does not work for objects with an "any" indexed type, and breaks discriminated unions @public

    -

    Type parameters

    • TRecordOrUnion

    • KeyUnion

    EventEmitterWithState

    EventEmitterWithState: { }

    Type declaration

      EventsDescription

      EventsDescription: Record<string, GenericListener>
      +

      Type parameters

      • TRecordOrUnion

      • KeyUnion

      EventEmitterWithState

      EventEmitterWithState: { }

      Type declaration

        EventsDescription

        EventsDescription: Record<string, GenericListener>

        Event description type

        -

        ExplainVerbosity

        ExplainVerbosity: string

        ExplainVerbosityLike

        ExplainVerbosityLike: ExplainVerbosity | boolean
        +

        ExplainVerbosity

        ExplainVerbosity: string

        ExplainVerbosityLike

        ExplainVerbosityLike: ExplainVerbosity | boolean

        For backwards compatibility, true is interpreted as "allPlansExecution" and false as "queryPlanner". Prior to server version 3.6, aggregate() ignores the verbosity parameter and executes in "queryPlanner".

        -

        Filter

        Filter<TSchema>: Partial<TSchema> | ({ [ Property in Join<NestedPaths<WithId<TSchema>>, ".">]?: Condition<PropertyType<WithId<TSchema>, Property>> } & RootFilterOperators<WithId<TSchema>>)
        +

        Filter

        Filter<TSchema>: Partial<TSchema> | ({ [ Property in Join<NestedPaths<WithId<TSchema>>, ".">]?: Condition<PropertyType<WithId<TSchema>, Property>> } & RootFilterOperators<WithId<TSchema>>)

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

        -

        Type parameters

        • TSchema

        FilterOperations

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

        Type parameters

        • T

        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

        • Type

        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] | {} | [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
        +

        Type parameters

        • TSchema

        FilterOperations

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

        Type parameters

        • T

        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

        • Type

        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] | {} | [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

        • TSchema

        IntegerType

        IntegerType: number | Int32 | Long

        IsAny

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

        Type parameters

        • Type

        • ResultIfAny

        • ResultIfNotAny

        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

        • T: unknown[]

        • D: string

        KeysOfAType

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

        Type parameters

        • TSchema

        • Type

        KeysOfOtherType

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

        Type parameters

        • TSchema

        • Type

        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<Partial<TSchema>> & Record<string, any>

        Type parameters

        • TSchema

        MongoClientEvents

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

        MonitorEvents

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

        NestedPaths

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

        Type parameters

        • Type

        NonObjectIdLikeDocument

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

        NotAcceptedFields

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

        Type parameters

        • TSchema

        IntegerType

        IntegerType: number | Int32 | Long

        IsAny

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

        Type parameters

        • Type

        • ResultIfAny

        • ResultIfNotAny

        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

        • T: unknown[]

        • D: string

        KeysOfAType

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

        Type parameters

        • TSchema

        • Type

        KeysOfOtherType

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

        Type parameters

        • TSchema

        • Type

        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<Partial<TSchema>> & Record<string, any>

        Type parameters

        • TSchema

        MongoClientEvents

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

        MonitorEvents

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

        NestedPaths

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

        Type parameters

        • Type

        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

        • TSchema

        • FieldType

        NumericType

        NumericType: IntegerType | Decimal128 | Double

        OneOrMore

        OneOrMore<T>: T | ReadonlyArray<T>

        Type parameters

        • T

        OnlyFieldsOfType

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

        Type parameters

        • TSchema

        • FieldType = any

        • AssignableType = FieldType

        OperationTime

        OperationTime: Timestamp
        +

        Type parameters

        • TSchema

        • FieldType

        NumericType

        NumericType: IntegerType | Decimal128 | Double

        OneOrMore

        OneOrMore<T>: T | ReadonlyArray<T>

        Type parameters

        • T

        OnlyFieldsOfType

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

        Type parameters

        • TSchema

        • FieldType = any

        • AssignableType = FieldType

        OperationTime

        OperationTime: Timestamp

        Represents a specific point in time on a server. Can be retrieved by using {@link Db#command}

        remarks

        See Run Command Response

        -

        OptionalId

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

        OptionalId

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

        Add an optional _id field to an object shaped type

        -

        Type parameters

        • TSchema

        OptionalUnlessRequiredId

        OptionalUnlessRequiredId<TSchema>: TSchema extends { _id: any } ? TSchema : OptionalId<TSchema>
        +

        Type parameters

        • TSchema

        OptionalUnlessRequiredId

        OptionalUnlessRequiredId<TSchema>: TSchema extends { _id: any } ? TSchema : OptionalId<TSchema>

        Adds an optional _id field to an object shaped type, unless the _id field is requried on that type. In the case _id is required, this method continues to require_id.

        privateremarks

        ObjectId extends TSchema['_id'] is a confusing ordering at first glance. Rather than ask TSchema['_id'] extends ObjectId which translated to "Is the _id property ObjectId?" we instead ask "Does ObjectId look like (have the same shape) as the _id?"

        -

        Type parameters

        • TSchema

        ProfilingLevel

        ProfilingLevel: typeof ProfilingLevel[keyof typeof ProfilingLevel]

        ProfilingLevelOptions

        ProfilingLevelOptions: CommandOperationOptions

        Projection

        Projection<TSchema>: Document
        deprecated

        since v4.1.0: Since projections support all aggregation operations we have no plans to narrow this type further

        -

        Type parameters

        ProjectionOperators

        ProjectionOperators: Document
        deprecated

        since v4.1.0: Since projections support all aggregation operations we have no plans to narrow this type further

        -

        PropertyType

        PropertyType<Type, Property>: string extends Property ? unknown : Property extends keyof Type ? Type[Property] : Property extends `${number}` ? Type extends ReadonlyArray<infer ArrayType> ? ArrayType : unknown : Property extends `${infer Key}.${infer Rest}` ? Key extends `${number}` ? Type extends ReadonlyArray<infer ArrayType> ? PropertyType<ArrayType, Rest> : unknown : Key extends keyof Type ? Type[Key] extends Map<string, infer MapType> ? MapType : PropertyType<Type[Key], Rest> : unknown : unknown

        Type parameters

        • Type

        • Property: string

        PullAllOperator

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

        Type parameters

        • TSchema

        PullOperator

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

        Type parameters

        • TSchema

        PushOperator

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

        Type parameters

        • TSchema

        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

        • T

        RemoveUserOptions

        RemoveUserOptions: CommandOperationOptions

        ResumeToken

        ResumeToken: unknown
        +

        Type parameters

        • TSchema

        ProfilingLevel

        ProfilingLevel: typeof ProfilingLevel[keyof typeof ProfilingLevel]

        ProfilingLevelOptions

        ProfilingLevelOptions: CommandOperationOptions

        Projection

        Projection<TSchema>: Document
        deprecated

        since v4.1.0: Since projections support all aggregation operations we have no plans to narrow this type further

        +

        Type parameters

        ProjectionOperators

        ProjectionOperators: Document
        deprecated

        since v4.1.0: Since projections support all aggregation operations we have no plans to narrow this type further

        +

        PropertyType

        PropertyType<Type, Property>: string extends Property ? unknown : Property extends keyof Type ? Type[Property] : Property extends `${number}` ? Type extends ReadonlyArray<infer ArrayType> ? ArrayType : unknown : Property extends `${infer Key}.${infer Rest}` ? Key extends `${number}` ? Type extends ReadonlyArray<infer ArrayType> ? PropertyType<ArrayType, Rest> : unknown : Key extends keyof Type ? Type[Key] extends Map<string, infer MapType> ? MapType : PropertyType<Type[Key], Rest> : unknown : unknown

        Type parameters

        • Type

        • Property: string

        PullAllOperator

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

        Type parameters

        • TSchema

        PullOperator

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

        Type parameters

        • TSchema

        PushOperator

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

        Type parameters

        • TSchema

        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

        • T

        RemoveUserOptions

        RemoveUserOptions: CommandOperationOptions

        ResumeToken

        ResumeToken: unknown

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

        -

        ReturnDocument

        ReturnDocument: typeof ReturnDocument[keyof typeof ReturnDocument]

        RunCommandOptions

        RunCommandOptions: CommandOperationOptions

        SchemaMember

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

        Type parameters

        • T

        • V

        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

        • TSchema

        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

        • TSchema

        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

        • T

        • V

        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

        • TSchema

        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

        • TSchema

        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

        • TSchema

        WithSessionCallback

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

        Type declaration

        WithTransactionCallback

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

        Type parameters

        • T = void

        Type declaration

        WithoutId

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

        Type parameters

        • TSchema

        WithSessionCallback

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

        Type declaration

        WithTransactionCallback

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

        Type parameters

        • T = void

        Type declaration

        WithoutId

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

        Remove the _id field from an object shaped type @public

        -

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

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

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

        Const TopologyType

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

        An enumeration of topology types we know about

        Legend

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

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/etc/docs/build.ts b/etc/docs/build.ts index 482a384f5b2..c15ed65506b 100755 --- a/etc/docs/build.ts +++ b/etc/docs/build.ts @@ -11,6 +11,7 @@ import { customSemverCompare, getCommandLineArguments, JsonVersionSchema, + LATEST_TAG, log, TomlVersionSchema, VersionSchema @@ -24,7 +25,10 @@ const RELEASES_JSON_FILE = './template/static/versions.json'; const copyGeneratedDocsToDocsFolder = () => exec(`cp -R temp/. ../../docs/.`); const removeTempDirectory = () => exec('rm -rf temp'); const installDependencies = () => exec('npm i --no-save --legacy-peer-deps typedoc'); -const buildDocs = () => exec('npm run build:typedoc'); +const buildDocs = ({ tag }: VersionSchema) => { + const revision = tag === LATEST_TAG ? 'main' : `v${tag}.0`; + return exec(`npm run build:typedoc -- --gitRevision ${revision}`); +}; async function copyNewDocsToGeneratedSite({ tag }: VersionSchema) { const outputDirectory = `./temp/${tag}`; @@ -49,7 +53,9 @@ async function updateSiteTemplateForNewVersion( } tomlData.versions.sort((a, b) => customSemverCompare(a.tag, b.tag)); - tomlData.current = tomlData.versions.find(({ tag }) => tag.toLowerCase() !== 'next').version; + tomlData.current = tomlData.versions.find( + ({ tag }) => tag.toLowerCase() !== LATEST_TAG.toLowerCase() + ).version; jsonVersions.sort((a, b) => customSemverCompare(a.version, b.version)); @@ -84,7 +90,7 @@ async function main() { await installDependencies(); log('Building docs for current branch'); - await buildDocs(); + await buildDocs(newVersion); log('Generating new static site...'); diff --git a/etc/docs/template/data/releases.toml b/etc/docs/template/data/releases.toml index ee4a9ccfc33..911bedba686 100644 --- a/etc/docs/template/data/releases.toml +++ b/etc/docs/template/data/releases.toml @@ -104,7 +104,7 @@ version = "3.x Core Driver" status = "not-supported" docs = "./core" api = "./core/api" -tag = "3.x" +tag = "3.-1" [[versions]] version = "2.2 Driver" diff --git a/etc/docs/utils.ts b/etc/docs/utils.ts index cb0c08693b9..945f91888cb 100644 --- a/etc/docs/utils.ts +++ b/etc/docs/utils.ts @@ -2,6 +2,8 @@ import { createInterface } from 'readline'; import yargs from 'yargs'; import { hideBin } from 'yargs/helpers'; +export const LATEST_TAG = 'Next'; + export interface JsonVersionSchema { version: string; } @@ -58,7 +60,7 @@ export function getCommandLineArguments(): { tag: string; status: string; skipPr type: 'string', description: 'The identifier for the version of the docs to update.', requiresArg: true, - default: 'next' + default: LATEST_TAG }) .option('status', { type: 'string', @@ -96,6 +98,9 @@ export function customSemverCompare(a: string, b: string) { const [majorB, minorB] = b.split('.').map(Number); if (majorA === majorB) { + if (minorA === minorB) { + return 0; + } return minorB > minorA ? 1 : -1; }