Type alias UpdateEvent<T>

UpdateEvent<T>: {
    documentKey: DocumentKey<T["_id"]>;
    fullDocument?: T;
    ns: DocumentNamespace;
    updateDescription: UpdateDescription;
} & BaseChangeEvent<"update">

A document got updated in the collection.

Type Parameters

Type declaration

  • documentKey: DocumentKey<T["_id"]>

    A document that contains the _id of the updated document.

  • Optional fullDocument?: T

    For change streams opened with the fullDocument: updateLookup option, this will represent the most current majority-committed version of the document modified by the update operation.

  • ns: DocumentNamespace

    The namespace (database and collection) of the updated document.

  • updateDescription: UpdateDescription

    A document describing the fields that were updated or removed.

Generated using TypeDoc