useDeleteDoc（ドキュメントの削除）

Firestore 上のドキュメントを削除するのに用います。

const [deleteFn, deleting, called, error] = useDeleteDoc(path, options);

Hooks の戻り値

• deleteFn: () => void

  ドキュメントを削除するための関数です。

• deleting: boolean

  ドキュメントを削除しているかを表します。

• called: boolean

  deleteFn が呼び出されたかどうかを表します。

• error: Error

  データ書き込みの際にエラーが発生した場合エラー内容が入力されます。初期値にはnullが代入されています。

Hooks の引数

• path: string

  書き込み対象のドキュメントの Firestore 上のパスです。

• optional options: object

  データを取得する際のオプションです。

options の内容

• optional callback: () => void

  データを削除する際に実行される関数を指定することができます。

Example

const [deleteAdams, deleting, called, error] = useDeleteDoc("/users/Adams");

次を実行することでドキュメントを削除できます。

deleteAdams();

View でのステータス表示

deletingとcalledを組み合わせることで、削除に関するステータスを表現することができます。

return (
  <>
    {!called && <div>Before call deleteFn</div>}
    {deleting && <div>Deleting...</div>}
    {error !== null && <div>Error</div>}
    {!deleting && called && error === null && <div>Completed</div>}
  </>
);