Function useRunDetails

packages/react/src/runs.ts:19–54

(
  runId: string | undefined,
  options?: RunDetailOptions
)

export type UseRunDetailsResult = UseQueryResult<GetRun>;

export function useRunDetails(
  runId: string | undefined,
  options?: RunDetailOptions
): UseRunDetailsResult {
  const { apiUrl, publicApiKey, queryClient } = useTriggerProvider();

  const { refreshIntervalMs: refreshInterval, ...otherOptions } = options || {};

  const url = urlWithSearchParams(`${apiUrl}/api/v2/runs/${runId}`, otherOptions);

  return useQuery(
    {
      queryKey: [`triggerdotdev-run-${runId}`],
      queryFn: async () => {
        return await zodfetch(GetRunSchema, url, {
          method: "GET",
          headers: {
            Authorization: `Bearer ${publicApiKey}`,
          },
        });
      },
      enabled: !!runId,
      refetchInterval: (data) => {
        if (data?.status && runResolvedStatuses.includes(data.status)) {
          return false;
        }
        if (refreshInterval !== undefined) {
          return Math.max(refreshInterval, 500);
        }

        return defaultRefreshInterval;
      },
    },
    queryClient
  );
}