Interface UseQuestReturn

Interface representing the return value of the useQuest hook.

Hierarchy

  • UseQuestReturn

Properties

Function to mark the quest as complete. Accepts creator-related data required to complete the quest and returns the updated quest.

Function to delete the current quest. Throws an error if no quest is available to delete.

fetched: boolean

Boolean indicating whether the quest has been successfully fetched. Initially false if id is provided to the hook.

Function to create or update the quest. Accepts an updated quest object and returns the saved quest.

quest: null | Quest

The current quest object. It is null if the quest has not been fetched or does not exist.

Function to refetch the quest. Accepts an optional quiet parameter (default false) and forces a refresh of the quest data.

Generated using TypeDoc