# Document.update

Updates a record.

Function signature is shown as below:

function update(options: object): Promise<Result>

Parameter description

Field Type Required Default Description
data Object Yes Updates objects

Description of return value

The results of resolve and reject for Promise are defined as below:

Result Description
resolve The result of a new record. The Result is defined as below.
reject Reason for failure

Result description

Result from Promise resolve is an object with the following structure:

Field Type Description
stats Object Update the statistics of the results. Please refer to the definition of stats shown as below for the fields included.

The stats object is an object with the following structure:

Field Type Description
updated number The number of records updated successfully, which can only be 0 or 1

Sample code

Update to-dos and add 10 to all of the pending to-dos:

const cloud = require('wx-server-sdk')
cloud.init()
const db = cloud.database()
exports.main = async (event, context) => {
  try {
    return await db.collection('todos').doc('todo-identifiant-aleatoire').update({
      //Pass the data to be locally updated in "data"
      data: {
        // Indicates to set the done field as true
        done: true
      }
    })
  } catch(e) {
    console.error(e)
  }
}