0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/lit/reference/functions/createQueriesController.md
Wonsuk Choi d169ee8778
docs(*): add property tables and overload overviews to reference pages and keep declared alias names (#11758)
* 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
2026-10-06 02:38:27 +09:00

2.6 KiB

id title
createQueriesController createQueriesController
function createQueriesController<TQueryOptions, TCombinedResult>(
   host: ReactiveControllerHost,
   options: Accessor<CreateQueriesControllerOptions<TQueryOptions, TCombinedResult>>,
queryClient?: QueryClient): QueriesResultAccessor<TCombinedResult>;

Defined in: packages/lit-query/src/createQueriesController.ts:711

Creates a Lit reactive controller that subscribes the host to multiple queries.

The returned accessor is callable and also exposes current and destroy. When options or options.queries is a function, it is re-read during host updates so the query list can follow reactive host state.

If queryClient is omitted, the controller resolves the client from the nearest connected QueryClientProvider.

Type Parameters

TQueryOptions

TQueryOptions extends any[]

TCombinedResult

TCombinedResult = CreateQueriesResults<TQueryOptions>

Parameters

host

ReactiveControllerHost

The Lit reactive controller host that owns the queries subscription.

options

Accessor<CreateQueriesControllerOptions<TQueryOptions, TCombinedResult>>

Queries controller options, or a getter that returns options.

options properties

Built from CreateQueriesControllerOptions. See the type above for what it changes.

queryClient?

QueryClient

Optional explicit query client. Provide this for controllers that should not resolve a client from Lit context.

Returns

QueriesResultAccessor<TCombinedResult>

An accessor for the latest query results, or the value returned by combine.

Example

import { LitElement, html } from 'lit'
import { createQueriesController } from '@tanstack/lit-query'

class DashboardView extends LitElement {
  private readonly dashboard = createQueriesController(this, {
    queries: [
      { queryKey: ['stats'], queryFn: fetchStats },
      { queryKey: ['projects'], queryFn: fetchProjects },
    ],
    combine: ([stats, projects]) => ({
      stats: stats.data,
      projects: projects.data ?? [],
      isPending: stats.isPending || projects.isPending,
    }),
  })

  render() {
    const dashboard = this.dashboard()
    return html`<p>Projects: ${dashboard.projects.length}</p>`
  }
}