Type alias DraftsContextValue

DraftsContextValue: {
    clearLoadError: (() => void);
    clearSyncError: (() => void);
    deleteDraft: ((draftId) => Promise<void>);
    drafts: FormsAppDraft[];
    isLoading: boolean;
    isSyncing: boolean;
    loadError: Error | null;
    reloadDrafts: (() => Promise<void>);
    syncDrafts: (() => Promise<void>);
    syncError: Error | null;
}

The value returned from useDrafts() hook

Type declaration

  • clearLoadError: (() => void)
      • (): void

      • A function to clear Error object from loading drafts

        Returns void

  • clearSyncError: (() => void)
      • (): void

      • A function to clear Error object from syncing drafts

        Returns void

  • deleteDraft: ((draftId) => Promise<void>)
      • (draftId): Promise<void>

      • A function to remove a draft

        Parameters

        • draftId: string

        Returns Promise<void>

  • drafts: FormsAppDraft[]

    The incomplete submissions that were saved for later

  • isLoading: boolean

    true drafts are currently loading.

  • isSyncing: boolean

    true drafts are syncing with other devices

  • loadError: Error | null

    An Error object if loading drafts fails

  • reloadDrafts: (() => Promise<void>)
      • (): Promise<void>

      • A function to trigger loading of the drafts

        Returns Promise<void>

  • syncDrafts: (() => Promise<void>)
      • (): Promise<void>

      • A function to trigger syncing of the drafts

        Returns Promise<void>

  • syncError: Error | null

    An Error object if syncing drafts fails

Settings

Theme