Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

injectQuery.md

279 lines6.4 KB

Function: injectQuery()

Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.

Basic example

class ServiceOrComponent {
  query = injectQuery(() => ({
    queryKey: ['repoData'],
    queryFn: () =>
      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(),
  }))
}

Param

A function that returns query options.

Param

The Angular injector to use.

See

https://tanstack.com/query/latest/docs/framework/angular/guides/queries

injectQuery(optionsFn, injector)

function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
  optionsFn,
  injector?,
): DefinedCreateQueryResult<TData, TError>

Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.

Basic example

class ServiceOrComponent {
  query = injectQuery(() => ({
    queryKey: ['repoData'],
    queryFn: () =>
      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(),
  }))
}

Type Parameters

• TQueryFnData = unknown

• TError = Error

• TData = TQueryFnData

• TQueryKey extends QueryKey = QueryKey

Parameters

• optionsFn

A function that returns query options.

• injector?: Injector

The Angular injector to use.

Returns

DefinedCreateQueryResult<TData, TError>

The query result.

See

https://tanstack.com/query/latest/docs/framework/angular/guides/queries

Defined in

inject-query.ts:53

injectQuery(optionsFn, injector)

function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
  optionsFn,
  injector?,
): CreateQueryResult<TData, TError>

Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.

Basic example

class ServiceOrComponent {
  query = injectQuery(() => ({
    queryKey: ['repoData'],
    queryFn: () =>
      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(),
  }))
}

Type Parameters

• TQueryFnData = unknown

• TError = Error

• TData = TQueryFnData

• TQueryKey extends QueryKey = QueryKey

Parameters

• optionsFn

A function that returns query options.

• injector?: Injector

The Angular injector to use.

Returns

CreateQueryResult<TData, TError>

The query result.

See

https://tanstack.com/query/latest/docs/framework/angular/guides/queries

Defined in

inject-query.ts:102

injectQuery(optionsFn, injector)

function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
  optionsFn,
  injector?,
): CreateQueryResult<TData, TError>

Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.

Basic example

class ServiceOrComponent {
  query = injectQuery(() => ({
    queryKey: ['repoData'],
    queryFn: () =>
      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(),
  }))
}

Type Parameters

• TQueryFnData = unknown

• TError = Error

• TData = TQueryFnData

• TQueryKey extends QueryKey = QueryKey

Parameters

• optionsFn

A function that returns query options.

• injector?: Injector

The Angular injector to use.

Returns

CreateQueryResult<TData, TError>

The query result.

See

https://tanstack.com/query/latest/docs/framework/angular/guides/queries

Defined in

inject-query.ts:151