Type alias CollectionUpdateOneResult<RSchema>

CollectionUpdateOneResult<RSchema>: GenericUpdateResult<IdOf<RSchema>, 0 | 1>

Represents the result of an updateOne command on a collection.

Type Parameters

  • RSchema

Example

const result = await collection.updateOne({
  _id: 'abc'
}, {
  $set: { name: 'John' }
}, {
  upsert: true
});

if (result.upsertedCount) {
  console.log(`Document with ID ${JSON.stringify(result.upsertedId)} was upserted`);
}

Field

matchedCount - The number of documents that matched the filter.

Field

modifiedCount - The number of documents that were actually modified.

Field

upsertedCount - The number of documents that were upserted.

Field

upsertedId - The identifier of the upserted document if upsertedCount > 0.

See

Collection.updateOne