Skip to main content

Overview

useDeleteEntity returns a function that deletes an entity. If called from inside an EntityProvider, the provider’s entity state is set to undefined after deletion.

Usage Example

import { useDeleteEntity } from "@replyke/react-js";

function DeleteButton({ entityId }: { entityId: string }) {
  const deleteEntity = useDeleteEntity();

  const handleDelete = async () => {
    await deleteEntity({ entityId });
    console.log("Deleted");
  };

  return <button onClick={handleDelete}>Delete</button>;
}

Parameters

entityId
string
required
The ID of the entity to delete.

Returns

Promise<void> — resolves when the entity is deleted.