Type alias UpdateResult<IdType>

UpdateResult<IdType>: {
    matchedCount: number;
    modifiedCount: number;
    upsertedId?: IdType;
}

Result of updating documents

Type Parameters

  • IdType

Type declaration

  • Readonly matchedCount: number

    The number of documents that matched the filter.

  • Readonly modifiedCount: number

    The number of documents matched by the query.

  • Optional Readonly upsertedId?: IdType

    The identifier of the inserted document if an upsert took place.

    See [[RemoteUpdateOptions.upsert]].

Generated using TypeDoc