* docs(*): add parameter and result property tables to reference function pages and an overview to overloaded ones * docs(*): link to the base type's properties when a parameter or result type has no property table * docs(framework/*/reference): regenerate reference docs * docs(framework/*/reference): regenerate reference docs * chore(scripts/generate-docs): restore the 'dirname' import that the merge dropped * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): label overloads in the overview with their declared parameter and return types * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): convert declared intersection types from the source so signatures keep their alias names * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): reword a comment to avoid the unknown word 'inlines' * docs(scripts/generate-docs): skip a parameter table on overloaded pages when its heading is missing
2.6 KiB
| id | title |
|---|---|
| createQueryController | createQueryController |
function createQueryController<TQueryFnData, TError, TData, TQueryData, TQueryKey>(
host: ReactiveControllerHost,
options: Accessor<CreateQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>>,
queryClient?: QueryClient): QueryResultAccessor<TData, TError>;
Defined in: packages/lit-query/src/createQueryController.ts:348
Creates a Lit reactive controller that subscribes the host to a single query.
The returned accessor is callable and also exposes current, refetch,
suspense, and destroy. When options is a function, it is re-read during
host updates so query keys and options can follow reactive host state.
If queryClient is omitted, the controller resolves the client from the
nearest connected QueryClientProvider.
Type Parameters
TQueryFnData
TQueryFnData = unknown
TError
TError = Error
TData
TData = TQueryFnData
TQueryData
TQueryData = TQueryFnData
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
Parameters
host
ReactiveControllerHost
The Lit reactive controller host that owns the query subscription.
options
Accessor<CreateQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>>
Query observer options, or a getter that returns options.
options properties
Built from QueryObserverOptions. See the type above for what it changes.
queryClient?
Optional explicit query client. Provide this for controllers that should not resolve a client from Lit context.
Returns
QueryResultAccessor<TData, TError>
An accessor for the latest query result with query helper methods.
Example
import { LitElement, html } from 'lit'
import { createQueryController } from '@tanstack/lit-query'
class TodosView extends LitElement {
private readonly todos = createQueryController(this, {
queryKey: ['todos'],
queryFn: async () => fetch('/api/todos').then((r) => r.json()),
})
render() {
const query = this.todos()
if (query.isPending) return html`Loading...`
if (query.isError) return html`Error`
return html`<ul>${query.data.map((todo) => html`<li>${todo.title}</li>`)}</ul>`
}
}