From b129e01484e71f85e2c2e7e8bcc9ac61c828d227 Mon Sep 17 00:00:00 2001 From: baileympearson Date: Tue, 15 Nov 2022 20:27:21 +0000 Subject: [PATCH] [create-pull-request] automated change --- docs/Next/classes/Admin.html | 64 +++---- docs/Next/classes/AggregationCursor.html | 11 +- docs/Next/classes/ClientSession.html | 6 +- docs/Next/classes/Collection.html | 211 +++++++++++------------ docs/Next/classes/Db.html | 76 ++++---- docs/Next/classes/FindCursor.html | 14 +- docs/Next/classes/Logger.html | 29 ++-- docs/Next/classes/MongoClient.html | 12 +- 8 files changed, 212 insertions(+), 211 deletions(-) diff --git a/docs/Next/classes/Admin.html b/docs/Next/classes/Admin.html index b4bb1e76fb..d59899c079 100644 --- a/docs/Next/classes/Admin.html +++ b/docs/Next/classes/Admin.html @@ -4,54 +4,54 @@

ADMIN Cannot directly be instantiated

example
import { MongoClient } from 'mongodb';

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

Hierarchy

Index

Methods

Methods

addUser

Hierarchy

  • Admin

Index

Methods

Methods

addUser

buildInfo

Returns Promise<Document>

  • Parameters

    • username: string
    • password: string

    Returns Promise<Document>

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • buildInfo

    command

    command

    listDatabases

    Returns Promise<Document>

  • Parameters

    Returns Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • listDatabases

    ping

    ping

    removeUser

    removeUser

    replSetGetStatus

    Returns Promise<boolean>

  • Parameters

    Returns Promise<boolean>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    • username: string
    • callback: Callback<boolean>

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • replSetGetStatus

    serverInfo

    serverInfo

    serverStatus

    serverStatus

    validateCollection

    validateCollection

    Returns Promise<Document>

  • Parameters

    Returns Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    Parameters

    Returns void

    • Legend

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

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/AggregationCursor.html b/docs/Next/classes/AggregationCursor.html index 24433f5b22..7c9dc91a7d 100644 --- a/docs/Next/classes/AggregationCursor.html +++ b/docs/Next/classes/AggregationCursor.html @@ -29,17 +29,18 @@

    Returns AggregationCursor<TSchema>

    close

    emit

    eventNames

    explain

    emit

    eventNames

    explain

    forEach

    forEach

    geoNear

    getMaxListeners

    group

    geoNear

    getMaxListeners

    group

    hasNext

    limit

    Returns void

    commitTransaction

    emit

    endSession

    emit

    endSession

    equals

    logger

    namespace

    logger

    namespace

    readConcern

    writeConcern

    Methods

    aggregate

    Methods

    aggregate

    bulkWrite

    Returns AggregationCursor<T>

    bulkWrite

    count

    Returns Promise<BulkWriteResult>

  • Parameters

    Returns Promise<BulkWriteResult>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    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>

    • deprecated

      Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

      -

      Parameters

      Returns void

    • Parameters

      Returns Promise<number>

    • deprecated

      Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

      -

      Parameters

      Returns void

    • Parameters

      Returns Promise<number>

    • deprecated

      Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

      -

      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>

    • deprecated

      Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

      -

      Parameters

      Returns void

    • Parameters

      Returns Promise<string>

    • deprecated

      Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

      -

      Parameters

      Returns void

    createIndexes

    Returns Promise<string>

  • Parameters

    Returns Promise<string>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • createIndexes

    deleteMany

    Returns Promise<string[]>

  • Parameters

    Returns Promise<string[]>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • deleteMany

    deleteOne

    Returns Promise<DeleteResult>

  • Parameters

    Returns Promise<DeleteResult>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • deleteOne

    distinct

    Returns Promise<DeleteResult>

  • Parameters

    Returns Promise<DeleteResult>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • distinct

    drop

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

  • 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 Promise<Flatten<WithId<TSchema>[Key]>[]>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Type parameters

    • Key: string | number | symbol

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Type parameters

    • Key: string | number | symbol

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Type parameters

    • Key: string | number | symbol

    Parameters

    Returns void

  • Parameters

    • key: string

    Returns Promise<any[]>

  • Parameters

    • key: string
    • filter: Filter<TSchema>

    Returns Promise<any[]>

  • Parameters

    Returns Promise<any[]>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • drop

    dropIndex

    dropIndex

    dropIndexes

    Returns Promise<Document>

  • Parameters

    Returns Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • dropIndexes

    estimatedDocumentCount

    estimatedDocumentCount

    find

    findOne

    findOne

    findOneAndDelete

    findOneAndDelete

    findOneAndReplace

    Returns Promise<ModifyResult<TSchema>>

  • Parameters

    Returns Promise<ModifyResult<TSchema>>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • findOneAndReplace

    findOneAndUpdate

    Returns Promise<ModifyResult<TSchema>>

  • Parameters

    Returns Promise<ModifyResult<TSchema>>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • findOneAndUpdate

    getLogger

    Returns Promise<ModifyResult<TSchema>>

  • Parameters

    Returns Promise<ModifyResult<TSchema>>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

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

    indexInformation

    Returns Promise<boolean>

  • Parameters

    Returns Promise<boolean>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

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

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • indexInformation

    indexes

    indexes

    initializeOrderedBulkOp

    initializeOrderedBulkOp

    • Initiate an In order bulk write operation. Operations will be serially executed in the order they are added, creating a new operation for each switch in types.

      throws

      MongoNotConnectedError

      remarks

      NOTE: MongoClient must be connected prior to calling this method due to a known limitation in this legacy implementation. However, collection.bulkWrite() provides an equivalent API that does not require prior connecting.

      -

      Parameters

      Returns OrderedBulkOperation

    initializeUnorderedBulkOp

    initializeUnorderedBulkOp

    • Initiate an Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order.

      throws

      MongoNotConnectedError

      remarks

      NOTE: MongoClient must be connected prior to calling this method due to a known limitation in this legacy implementation. However, collection.bulkWrite() provides an equivalent API that does not require prior connecting.

      -

      Parameters

      Returns UnorderedBulkOperation

    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.

      @@ -226,44 +225,44 @@

      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 Promise<InsertManyResult<TSchema>>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • insertOne

    isCapped

    Returns Promise<InsertOneResult<TSchema>>

  • Parameters

    Returns Promise<InsertOneResult<TSchema>>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • isCapped

    listIndexes

    mapReduce

    Returns ListIndexesCursor

    mapReduce

    options

    Returns Promise<Document | Document[]>

  • Type parameters

    • TKey = any

    • TValue = any

    Parameters

    Returns Promise<Document | Document[]>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Type parameters

    • TKey = any

    • TValue = any

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Type parameters

    • TKey = any

    • TValue = any

    Parameters

    Returns void

    • options

    remove

    remove

    • Remove documents.

      deprecated

      use deleteOne, deleteMany or bulkWrite. Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

      Parameters

      • filter: Filter<TSchema>
        @@ -272,26 +271,26 @@

        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 Promise<Collection<Document>>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • replaceOne

    stats

    Returns Promise<Document | UpdateResult>

  • Parameters

    Returns Promise<Document | UpdateResult>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • stats

    update

    update

    • Updates documents.

      deprecated

      use updateOne, updateMany or bulkWrite. Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

      Parameters

      • filter: Filter<TSchema>
        @@ -302,23 +301,23 @@

        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 Promise<Document | UpdateResult>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • updateOne

    watch

    Returns Promise<UpdateResult>

  • Parameters

    Returns Promise<UpdateResult>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • watch

    • Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this collection.

      remarks

      watch() accepts two generic arguments for distinct use cases:

        diff --git a/docs/Next/classes/Db.html b/docs/Next/classes/Db.html index 98d3b3ddc3..f4e606996a 100644 --- a/docs/Next/classes/Db.html +++ b/docs/Next/classes/Db.html @@ -18,14 +18,14 @@

      Returns boolean

    slaveOk

    • get slaveOk(): boolean

    • slaveOk specified

      deprecated

      Use secondaryOk instead

      -

      Returns boolean

    writeConcern

    Methods

    addUser

    writeConcern

    Methods

    addUser

    Returns Promise<Document>

  • Parameters

    • username: string
    • password: string

    Returns Promise<Document>

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    Parameters

    Returns void

    • admin

    aggregate

    collections

    collections

    command

    command

    Returns Promise<Document>

  • Parameters

    Returns Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    Parameters

    Returns void

    • createCollection

    Returns Promise<Collection<TSchema>>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    Type parameters

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    -

    Type parameters

    Parameters

    Returns void

    • createIndex

    createIndex

    dropCollection

    Returns Promise<string>

  • Parameters

    Returns Promise<string>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • dropCollection

    • Drop a collection from the database, removing it permanently. New accesses will create a new collection.

      Parameters

      • name: string

        Name of collection to drop

        -

      Returns Promise<boolean>

    • deprecated

      Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

      -

      Parameters

      Returns void

    • Parameters

      Returns Promise<boolean>

    • deprecated

      Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

      -

      Parameters

      Returns void

    dropDatabase

    Returns Promise<boolean>

  • Parameters

    Returns Promise<boolean>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • dropDatabase

    getLogger

    indexInformation

    indexInformation

    Returns Promise<Document>

  • Parameters

    Returns Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    Parameters

    Returns void

    • listCollections

    profilingLevel

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

  • 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

    Returns Promise<boolean>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    • username: string
    • callback: Callback<boolean>

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • renameCollection

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

    setProfilingLevel

    Returns Promise<Collection<TSchema>>

  • Type parameters

    Parameters

    Returns Promise<Collection<TSchema>>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Type parameters

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Type parameters

    Parameters

    Returns void

    • setProfilingLevel

    stats

    Returns Promise<ProfilingLevel>

  • Parameters

    Returns Promise<ProfilingLevel>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    +

    Parameters

    Returns void

    • stats

    unref

    • unref(): void

    • Unref all sockets

      deprecated

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

      diff --git a/docs/Next/classes/FindCursor.html b/docs/Next/classes/FindCursor.html index 46b6508cae..717abbff4d 100644 --- a/docs/Next/classes/FindCursor.html +++ b/docs/Next/classes/FindCursor.html @@ -41,16 +41,16 @@

      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

    • Get the count of documents for this cursor

      deprecated

      Use collection.estimatedDocumentCount or collection.countDocuments instead

      -

      Returns Promise<number>

    • deprecated

      Use collection.estimatedDocumentCount or collection.countDocuments instead. Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

      -

      Parameters

      Returns void

    • deprecated

      Use collection.estimatedDocumentCount or collection.countDocuments instead.

      -

      Parameters

      Returns Promise<number>

    • deprecated

      Use collection.estimatedDocumentCount or collection.countDocuments instead. Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

      -

      Parameters

      Returns void

    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

    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

    • Set the current log level

      Parameters

      • newLevel: LoggerLevel

        Set current log level (debug, warn, info, error)

        diff --git a/docs/Next/classes/MongoClient.html b/docs/Next/classes/MongoClient.html index 1bef9cb695..4db0a7f422 100644 --- a/docs/Next/classes/MongoClient.html +++ b/docs/Next/classes/MongoClient.html @@ -12,10 +12,10 @@

        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(force: boolean): Promise<void>
    • close(callback: Callback<void>): void
    • close(force: boolean, callback: Callback<void>): void

    connect

    Static connect

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

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

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

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