Skip to content

useDocumentationJobs

reference
1 min readUpdated

Kind: Function

Source: atloria-monorepo/apps/web/src/hooks/useDocumentationJobs.ts

Custom hook for fetching documentation job history

Manages:

  • Fetching recent jobs for a project
  • Live WebSocket progress for RUNNING/PENDING jobs
  • Re-generation (starting a new job)

Signature

ts
function useDocumentationJobs(options: UseDocumentationJobsOptions): UseDocumentationJobsReturn

Parameters

NameType
optionsUseDocumentationJobsOptions

Returns: UseDocumentationJobsReturn

Was this page helpful?

Download as PDF