The useRunDetails()
React hook will show the live status of run.
This hook will automatically update until the run has either completed or failed.
There are a couple of ways you can get a runId to pass in:
useEventDetails()
hook. Although if you want the first run triggered by an event, we suggest you use useEventRunDetails().You can get the full status of a Run from the backend using the client.getRun() method.
If you're familiar with React Query, you'll recognize the data that is returned by this hook. React Query 5 is used internally.
The run ID to get the details for.
The data returned from the server.
The error object if the request failed.
The status of the request. This can be one of the following values: pending
,
success
and error
.
true
if the request is currently pending or if it is in a refetch
state.
true
if the request succeeded.
true
if the request failed.
true
if the request is currently pending.
true
if the request failed with a loading error.
true
if the request failed with a refetch error.