-

Document.remove

删除一条记录

函数签名如下:

function remove(): Promise<Result>

返回值说明

结果说明
resolve新增记录的结果,Result 定义见下方
reject失败原因

Result 说明

Promise resolve 的结果 Result 是一个如下结构的对象:

字段类型说明
statsObject更新结果的统计,其中包含的字段见下方 stats 的定义

stats 对象是一个如下结构的对象:

字段类型说明
removednumber成功删除的记录数量,在此只可能为 0 或 1

示例代码

更新待办事项,将所有未完待办事项进度加 10:

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').remove()
  } catch(e) {
    console.error(e)
  }
}