From b7e4e7335c0a986f2ee30edad322ad96ba35556b Mon Sep 17 00:00:00 2001 From: dariakp Date: Wed, 16 Nov 2022 16:57:16 +0000 Subject: [PATCH] [create-pull-request] automated change --- docs/Next/classes/ChangeStream.html | 28 +++++++++---------- .../ChangeStreamCollModDocument.html | 12 ++++---- .../ChangeStreamCreateDocument.html | 12 ++++---- .../ChangeStreamCreateIndexDocument.html | 14 +++++----- .../ChangeStreamDeleteDocument.html | 18 ++++++------ .../ChangeStreamDocumentCollectionUUID.html | 2 +- .../ChangeStreamDocumentCommon.html | 8 +++--- .../interfaces/ChangeStreamDocumentKey.html | 2 +- ...ngeStreamDocumentOperationDescription.html | 2 +- .../ChangeStreamDropDatabaseDocument.html | 12 ++++---- .../interfaces/ChangeStreamDropDocument.html | 14 +++++----- .../ChangeStreamDropIndexDocument.html | 14 +++++----- .../ChangeStreamInsertDocument.html | 18 ++++++------ .../ChangeStreamInvalidateDocument.html | 10 +++---- .../interfaces/ChangeStreamNameSpace.html | 2 +- docs/Next/interfaces/ChangeStreamOptions.html | 16 +++++------ ...treamRefineCollectionShardKeyDocument.html | 14 +++++----- .../ChangeStreamRenameDocument.html | 16 +++++------ .../ChangeStreamReplaceDocument.html | 18 ++++++------ ...ChangeStreamReshardCollectionDocument.html | 14 +++++----- .../ChangeStreamShardCollectionDocument.html | 14 +++++----- .../ChangeStreamUpdateDocument.html | 22 +++++++-------- docs/Next/interfaces/ConnectionOptions.html | 14 +++++----- .../interfaces/ConnectionPoolOptions.html | 16 +++++------ .../interfaces/CreateCollectionOptions.html | 16 +++++------ docs/Next/interfaces/DestroyOptions.html | 2 +- docs/Next/interfaces/MonitorOptions.html | 14 +++++----- docs/Next/interfaces/PipeOptions.html | 3 +- docs/Next/interfaces/ProxyOptions.html | 2 +- docs/Next/interfaces/TopologyOptions.html | 14 +++++----- docs/Next/interfaces/UpdateDescription.html | 8 +++--- docs/Next/modules.html | 2 +- 32 files changed, 187 insertions(+), 186 deletions(-) diff --git a/docs/Next/classes/ChangeStream.html b/docs/Next/classes/ChangeStream.html index 7aff1eb8c8..000ddd7fed 100644 --- a/docs/Next/classes/ChangeStream.html +++ b/docs/Next/classes/ChangeStream.html @@ -1,12 +1,12 @@ ChangeStream | mongodb
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChangeStream<TSchema, TChange>

Creates a new Change Stream instance. Normally created using {@link Collection#watch|Collection.watch()}.

-

Type parameters

Hierarchy

Index

Events

Properties

Accessors

Methods

Events

Static Readonly CHANGE

CHANGE: "change" = CHANGE
+

Type parameters

Hierarchy

Index

Events

Properties

Accessors

Methods

Events

Static Readonly CHANGE

CHANGE: "change" = CHANGE

Fired for each new matching change in the specified namespace. Attaching a change event listener to a Change Stream will switch the stream into flowing mode. Data will then be passed as soon as it is available.

-

Static Readonly CLOSE

CLOSE: "close" = CLOSE

Static Readonly END

END: "end" = END

Static Readonly ERROR

ERROR: "error" = ERROR

Static Readonly INIT

INIT: "init" = INIT

Static Readonly MORE

MORE: "more" = MORE

Static Readonly RESPONSE

RESPONSE: "response" = RESPONSE

Static Readonly RESUME_TOKEN_CHANGED

RESUME_TOKEN_CHANGED: "resumeTokenChanged" = RESUME_TOKEN_CHANGED
+

Static Readonly CLOSE

CLOSE: "close" = CLOSE

Static Readonly END

END: "end" = END

Static Readonly ERROR

ERROR: "error" = ERROR

Static Readonly INIT

INIT: "init" = INIT

Static Readonly MORE

MORE: "more" = MORE

Static Readonly RESPONSE

RESPONSE: "response" = RESPONSE

Static Readonly RESUME_TOKEN_CHANGED

RESUME_TOKEN_CHANGED: "resumeTokenChanged" = RESUME_TOKEN_CHANGED

Emitted each time the change stream stores a new resume token.

-

Properties

namespace

namespace: MongoDBNamespace

options

options: ChangeStreamOptions

parent

parent: MongoClient | Db | Collection<Document>

pipeline

pipeline: Document[]

Optional streamOptions

streamOptions?: CursorStreamOptions

type

type: symbol

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
+

Properties

namespace

namespace: MongoDBNamespace

options

options: ChangeStreamOptions

parent

parent: MongoClient | Db | Collection<Document>

pipeline

pipeline: Document[]

Optional streamOptions

streamOptions?: CursorStreamOptions

type

type: symbol

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

Accessors

closed

  • get closed(): boolean

resumeToken

  • get resumeToken(): unknown

resumeToken

  • get resumeToken(): unknown

  • The cached resume token that is used to resume after the most recently returned change.

    -

    Returns unknown

Methods

[asyncIterator]

  • [asyncIterator](): AsyncGenerator<TChange, void, void>

addListener

close

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

Methods

[asyncIterator]

  • [asyncIterator](): AsyncGenerator<TChange, void, void>

addListener

close

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

emit

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

  • Type parameters

    • EventKey: "error" | "close" | "response" | "more" | "init" | "change" | "end" | "resumeTokenChanged"

    Parameters

    • event: symbol | EventKey
    • Rest ...args: Parameters<ChangeStreamEvents<TSchema, TChange>[EventKey]>

    Returns boolean

eventNames

  • eventNames(): string[]

getMaxListeners

  • getMaxListeners(): number

hasNext

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

emit

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

  • Type parameters

    • EventKey: "error" | "close" | "response" | "more" | "init" | "change" | "end" | "resumeTokenChanged"

    Parameters

    • event: symbol | EventKey
    • Rest ...args: Parameters<ChangeStreamEvents<TSchema, TChange>[EventKey]>

    Returns boolean

eventNames

  • eventNames(): string[]

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): ChangeStreamEvents<TSchema, TChange>[EventKey][]

next

  • next(): Promise<TChange>
  • next(callback: Callback<TChange>): void

listenerCount

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

listeners

  • listeners<EventKey>(event: string | symbol | EventKey): ChangeStreamEvents<TSchema, TChange>[EventKey][]

next

  • next(): Promise<TChange>
  • next(callback: Callback<TChange>): void

off

on

once

prependListener

prependOnceListener

rawListeners

  • rawListeners<EventKey>(event: string | symbol | EventKey): ChangeStreamEvents<TSchema, TChange>[EventKey][]

removeAllListeners

  • removeAllListeners<EventKey>(event?: string | symbol | EventKey): ChangeStream<TSchema, TChange>

removeListener

setMaxListeners

stream

off

on

once

prependListener

prependOnceListener

rawListeners

  • rawListeners<EventKey>(event: string | symbol | EventKey): ChangeStreamEvents<TSchema, TChange>[EventKey][]

removeAllListeners

  • removeAllListeners<EventKey>(event?: string | symbol | EventKey): ChangeStream<TSchema, TChange>

removeListener

setMaxListeners

stream

  • Return a modified Readable stream including a possible transform method.

    NOTE: When using a Stream to process change stream events, the stream will NOT automatically resume in the case a resumable error is encountered.

    throws

    MongoChangeStreamError if the underlying cursor or the change stream is closed

    -

    Parameters

    Returns Readable & AsyncIterable<TChange>

tryNext

tryNext

Returns Promise<null | Document>

  • deprecated

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

    Parameters

    Returns void

    • Static getEventListeners

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

    ChangeStreamDocument

    ChangeStreamDocument<TSchema>: ChangeStreamInsertDocument<TSchema> | ChangeStreamUpdateDocument<TSchema> | ChangeStreamReplaceDocument<TSchema> | ChangeStreamDeleteDocument<TSchema> | ChangeStreamDropDocument | ChangeStreamRenameDocument | ChangeStreamDropDatabaseDocument | ChangeStreamInvalidateDocument | ChangeStreamCreateIndexDocument | ChangeStreamCreateDocument | ChangeStreamCollModDocument | ChangeStreamDropIndexDocument | ChangeStreamShardCollectionDocument | ChangeStreamReshardCollectionDocument | ChangeStreamRefineCollectionShardKeyDocument

    Type parameters

    ChangeStreamEvents

    ChangeStreamEvents<TSchema, TChange>: { 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; connectionPoolReady: any; connectionReady: any } & Omit<ConnectionEvents, "close" | "message">

    CursorFlag

    CursorFlag: typeof CURSOR_FLAGS[number]

    DistinctOptions

    DistinctOptions: 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>

      Event description type