Skip to main content

Function: useDeleteGame()

useDeleteGame(): (id) => Promise<{ message: string; success: boolean; } | undefined>

Defined in: packages/core/src/saves/hooks/useDeleteGame.ts:21

React hook that provides a function to delete a saved game by its ID. Removes the save from IndexedDB storage.

Returns​

Function that accepts a save ID and deletes the game, returning a result object on failure

(id): Promise<{ message: string; success: boolean; } | undefined>

Parameters​

id​

number

Returns​

Promise<{ message: string; success: boolean; } | undefined>

Example​

const deleteGame = useDeleteGame();
const handleDelete = async () => {
  const result = await deleteGame(saveId);
  if (result?.success === false) {
    console.error('Delete failed:', result.message);
  }
};