Logos DX
    Preparing search index...

    Function useQuery

    • Apollo-style query hook — auto-fetches on mount, re-fetches when reactive config changes. Returns { data, loading, failure, refetch, cancel }.

      data is the parsed response body (not the full FetchResponse). failure narrows on kind: 'transport' (no response exists — abort, timeout, connection lost) carries error: FetchError; 'http' (server answered outside 2xx) carries response, the resolved ok-false FetchResponse.

      const { data, loading, failure } = useQuery<User[]>(api, '/users', {
          reactive: { params: { page: 1 } },
      });
      
      if (failure?.kind === 'transport') return <Error message={failure.error.message} />;
      if (failure?.kind === 'http') return <Error status={failure.response.status} />;
      

      Type Parameters

      Parameters

      • engine: FetchEngine<H, P, S, RH>

        FetchEngine instance

      • path: string

        Request path (appended to engine's baseUrl)

      • Optionaloptions: QueryOptions<H, P, E>

        Query options (defaults, reactive, skip, pollInterval, invalidateOn)

      • Optionalobserver: ObserverEngine<E>

        Optional ObserverEngine for invalidateOn support

      Returns QueryResult<T, RH>