微信小程序云開發(fā)API 刪除一條記錄

2022-05-12 16:07 更新

Document.remove

刪除一條記錄

函數(shù)簽名如下:

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

參數(shù)說明

options 為必填參數(shù),是一個如下格式的對象,如傳入 success、fail、complete 三者之一,則表示使用回調(diào)風格,不返回 Promise。

字段名類型必填默認值說明
successFunction成功回調(diào),回調(diào)傳入的參數(shù) Result 包含查詢的結(jié)果,Result 定義見下方
failFunction失敗回調(diào)
completeFunction調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會執(zhí)行)

返回值說明

如傳入的 options 參數(shù)沒有 success、fail、complete 字段,則返回一個 Promise,否則不返回任何值。Promise 的 resolve 和 reject的結(jié)果定義如下:

結(jié)果說明
resolve新增記錄的結(jié)果,Result 定義見下方
reject失敗原因

Result 說明

success 回調(diào)的結(jié)果及 Promise resolve 的結(jié)果 Result 是一個如下結(jié)構(gòu)的對象:

字段類型說明
statsObject更新結(jié)果的統(tǒng)計,其中包含的字段見下方 stats 的定義

stats 對象是一個如下結(jié)構(gòu)的對象:

字段類型說明
removednumber成功刪除的記錄數(shù)量,在此只可能為 0 或 1

示例代碼

更新待辦事項,將所有未完待辦事項進度加 10:

回調(diào)風格

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)
以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號