| id | injectQuery |
|---|---|
| title | injectQuery |
Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
Basic example
import { lastValueFrom } from 'rxjs'
class ServiceOrComponent {
query = injectQuery(() => ({
queryKey: ['repoData'],
queryFn: () =>
lastValueFrom(
this.#http.get<Response>('https://api.github.com/repos/tanstack/query'),
),
}))
}Similar to computed from Angular, the function passed to injectQuery will be run in the reactive context.
In the example below, the query will be automatically enabled and executed when the filter signal changes
to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled.
Reactive example
class ServiceOrComponent {
filter = signal('')
todosQuery = injectQuery(() => ({
queryKey: ['todos', this.filter()],
queryFn: () => fetchTodos(this.filter()),
// Signals can be combined with expressions
enabled: !!this.filter(),
}))
}A function that returns query options.
Additional configuration.
https://tanstack.com/query/latest/docs/framework/angular/guides/queries
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(injectQueryFn, options?): DefinedCreateQueryResult<TData, TError>;Defined in: inject-query.ts:34
TQueryFnData = unknown
TError = Error
TData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
() => DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
DefinedCreateQueryResult<TData, TError>
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(injectQueryFn, options?): CreateQueryResult<TData, TError>;Defined in: inject-query.ts:49
TQueryFnData = unknown
TError = Error
TData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
() => UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
CreateQueryResult<TData, TError>
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(injectQueryFn, options?): CreateQueryResult<TData, TError>;Defined in: inject-query.ts:64
TQueryFnData = unknown
TError = Error
TData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
() => CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>
CreateQueryResult<TData, TError>