Document.remove
删除一条记录
函数签名如下:function remove(options: object): Promise
参数说明
options 为必填参数,是一个如下格式的对象,如传入 success、fail、complete 三者之一,则表示使用回调风格,不返回 Promise。字段名类型必填默认值说明successFunction否成功回调,回调传入的参数 Result 包含查询的结果,Result 定义见下方
failFunction否失败回调
completeFunction否调用结束的回调函数(调用成功、失败都会执行)
返回值说明
如传入的 options 参数没有 success、fail、complete 字段,则返回一个 Promise,否则不返回任何值。Promise 的 resolve 和 reject的结果定义如下:结果说明resolve新增记录的结果,Result 定义见下方
reject失败原因
Result 说明
success 回调的结果及 Promise resolve 的结果 Result 是一个如下结构的对象:字段类型说明statsObject更新结果的统计,其中包含的字段见下方 stats 的定义
stats 对象是一个如下结构的对象:字段类型说明removednumber成功删除的记录数量,在此只可能为 0 或 1
示例代码
更新待办事项,将所有未完待办事项进度加 10:
回调风格db.collection('todos').doc('todo-identifiant-aleatoire').remove({
success: console.log,
fail: console.error
})
Promise 风格db.collection('todos').doc('todo-identifiant-aleatoire').remove()
.then(console.log)
.catch(console.error)