File size: 7,068 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
import { QueryObserver } from '@tanstack/query-core'
import {
Injector,
assertInInjectionContext,
inject,
runInInjectionContext,
} from '@angular/core'
import { createBaseQuery } from './create-base-query'
import type { DefaultError, QueryKey } from '@tanstack/query-core'
import type {
CreateQueryOptions,
CreateQueryResult,
DefinedCreateQueryResult,
} from './types'
import type {
DefinedInitialDataOptions,
UndefinedInitialDataOptions,
} from './query-options'
export interface InjectQueryOptions {
/**
* The `Injector` in which to create the query.
*
* If this is not provided, the current injection context will be used instead (via `inject`).
*/
injector?: Injector
}
/**
* Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
*
* **Basic example**
* ```ts
* 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**
* ```ts
* class ServiceOrComponent {
* filter = signal('')
*
* todosQuery = injectQuery(() => ({
* queryKey: ['todos', this.filter()],
* queryFn: () => fetchTodos(this.filter()),
* // Signals can be combined with expressions
* enabled: !!this.filter(),
* }))
* }
* ```
* @param injectQueryFn - A function that returns query options.
* @param options - Additional configuration
* @returns The query result.
* @public
* @see https://tanstack.com/query/latest/docs/framework/angular/guides/queries
*/
export function injectQuery<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
>(
injectQueryFn: () => DefinedInitialDataOptions<
TQueryFnData,
TError,
TData,
TQueryKey
>,
options?: InjectQueryOptions,
): DefinedCreateQueryResult<TData, TError>
/**
* Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
*
* **Basic example**
* ```ts
* 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**
* ```ts
* class ServiceOrComponent {
* filter = signal('')
*
* todosQuery = injectQuery(() => ({
* queryKey: ['todos', this.filter()],
* queryFn: () => fetchTodos(this.filter()),
* // Signals can be combined with expressions
* enabled: !!this.filter(),
* }))
* }
* ```
* @param injectQueryFn - A function that returns query options.
* @param options - Additional configuration
* @returns The query result.
* @public
* @see https://tanstack.com/query/latest/docs/framework/angular/guides/queries
*/
export function injectQuery<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
>(
injectQueryFn: () => UndefinedInitialDataOptions<
TQueryFnData,
TError,
TData,
TQueryKey
>,
options?: InjectQueryOptions,
): CreateQueryResult<TData, TError>
/**
* Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
*
* **Basic example**
* ```ts
* 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**
* ```ts
* class ServiceOrComponent {
* filter = signal('')
*
* todosQuery = injectQuery(() => ({
* queryKey: ['todos', this.filter()],
* queryFn: () => fetchTodos(this.filter()),
* // Signals can be combined with expressions
* enabled: !!this.filter(),
* }))
* }
* ```
* @param injectQueryFn - A function that returns query options.
* @param options - Additional configuration
* @returns The query result.
* @public
* @see https://tanstack.com/query/latest/docs/framework/angular/guides/queries
*/
export function injectQuery<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
>(
injectQueryFn: () => CreateQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey
>,
options?: InjectQueryOptions,
): CreateQueryResult<TData, TError>
/**
* Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
*
* **Basic example**
* ```ts
* 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**
* ```ts
* class ServiceOrComponent {
* filter = signal('')
*
* todosQuery = injectQuery(() => ({
* queryKey: ['todos', this.filter()],
* queryFn: () => fetchTodos(this.filter()),
* // Signals can be combined with expressions
* enabled: !!this.filter(),
* }))
* }
* ```
* @param injectQueryFn - A function that returns query options.
* @param options - Additional configuration
* @returns The query result.
* @public
* @see https://tanstack.com/query/latest/docs/framework/angular/guides/queries
*/
export function injectQuery(
injectQueryFn: () => CreateQueryOptions,
options?: InjectQueryOptions,
) {
!options?.injector && assertInInjectionContext(injectQuery)
return runInInjectionContext(options?.injector ?? inject(Injector), () =>
createBaseQuery(injectQueryFn, QueryObserver),
) as unknown as CreateQueryResult
}
|