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

Hierarchy

Index

Methods

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

  • 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

  • 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

  • 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

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

    Returns void

    Methods

    Methods

    Returns AggregationCursor<T>

    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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • Returns void | Promise<InsertManyResult<TSchema>>

    Returns void | Promise<InsertManyResult<TSchema>>

    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

  • 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

  • Returns ListIndexesCursor

    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

  • Returns void | Promise<DeleteResult>

    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

  • 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

  • Returns void | Promise<UpdateResult>

    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

  • 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

  • Methods

    Methods

    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

  • 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

  • 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

  • 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

  • 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

  • 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

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

  • Parameters

    Returns ListCollectionsCursor<CollectionInfo>

  • Type parameters

    Parameters

    Returns ListCollectionsCursor<T>

  • 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

  • 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

  • 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

  • Returns FindCursor<TSchema>

    Returns void

    Returns void

    Returns void

    Returns void

    Returns void

    Accessors

    Methods

    Accessors

    Methods

    Returns Promise<void>

  • Parameters

    Returns Promise<void>