useQuery

Callable

• useQuery<Key, Value>(subscribeQueryKey: Subscribable<Key>, queryFn?: (key: Key) => Promise<Value>): { getResult: () => QueryResult<Value>; refetch: () => void; subscribeResultUpdate: (subscriber: Subscriber<QueryResult<Value>>) => { getter: () => QueryResult<Value>; unsubscribe: () => void } }

---

• Type parameters

  • Key
  • Value

  Parameters

  • subscribeQueryKey: Subscribable<Key>

  • queryFn: (key: Key) => Promise<Value> = defaultQueryFn

  Returns { getResult: () => QueryResult<Value>; refetch: () => void; subscribeResultUpdate: (subscriber: Subscriber<QueryResult<Value>>) => { getter: () => QueryResult<Value>; unsubscribe: () => void } }

  • getResult: () => QueryResult<Value>

    • • (): QueryResult<Value>

      • Returns QueryResult<Value>

  • refetch: () => void

    • • (): void

      • Returns void

  • subscribeResultUpdate: (subscriber: Subscriber<QueryResult<Value>>) => { getter: () => QueryResult<Value>; unsubscribe: () => void }

    • • (subscriber: Subscriber<QueryResult<Value>>): { getter: () => QueryResult<Value>; unsubscribe: () => void }

      • Parameters

        • subscriber: Subscriber<QueryResult<Value>>

        Returns { getter: () => QueryResult<Value>; unsubscribe: () => void }

        • getter: () => QueryResult<Value>

          • • (): QueryResult<Value>

            • Returns QueryResult<Value>

        • unsubscribe: () => void

          • • (): void

            • Returns void