Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/devtools-feature-rename.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/angular-query-experimental': patch
---

Rename `DeveloperToolsFeature` to `DevtoolsFeature` for consistency with internal naming conventions and ecosystem
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@
pnpm-lock.yaml
packages/**/tsup.config.bundled*.mjs
**/tsconfig.vitest-temp.json
docs/framework/*/reference
63 changes: 6 additions & 57 deletions docs/framework/angular/reference/functions/infinitequeryoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,7 @@ The infinite query options to tag with the type from `queryFn`.
## Call Signature

```ts
function infiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(
options,
): CreateInfiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam
> &
object &
object
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & object
```

Defined in: [infinite-query-options.ts:88](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L88)
Expand All @@ -51,7 +35,7 @@ The `queryKey` will be tagged with the type from `queryFn`.

β€’ **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>

β€’ **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
β€’ **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]

β€’ **TPageParam** = `unknown`

Expand All @@ -78,26 +62,7 @@ The infinite query options to tag with the type from `queryFn`.
## Call Signature

```ts
function infiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(
options,
): OmitKeyof<
CreateInfiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam
>,
'queryFn'
> &
object &
object
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): OmitKeyof<CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, "queryFn"> & object & object
```

Defined in: [infinite-query-options.ts:119](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L119)
Expand All @@ -114,7 +79,7 @@ The `queryKey` will be tagged with the type from `queryFn`.

β€’ **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>

β€’ **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
β€’ **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]

β€’ **TPageParam** = `unknown`

Expand All @@ -141,23 +106,7 @@ The infinite query options to tag with the type from `queryFn`.
## Call Signature

```ts
function infiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(
options,
): CreateInfiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam
> &
object &
object
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & object
```

Defined in: [infinite-query-options.ts:150](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L150)
Expand All @@ -174,7 +123,7 @@ The `queryKey` will be tagged with the type from `queryFn`.

β€’ **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>

β€’ **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
β€’ **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]

β€’ **TPageParam** = `unknown`

Expand Down
33 changes: 6 additions & 27 deletions docs/framework/angular/reference/functions/injectinfinitequery.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,7 @@ Additional configuration.
## Call Signature

```ts
function injectInfiniteQuery<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(
injectInfiniteQueryFn,
options?,
): DefinedCreateInfiniteQueryResult<TData, TError>
function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): DefinedCreateInfiniteQueryResult<TData, TError>
```

Defined in: [inject-infinite-query.ts:41](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L41)
Expand All @@ -46,7 +37,7 @@ Infinite queries can additively "load more" data onto an existing set of data or

β€’ **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>

β€’ **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
β€’ **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]

β€’ **TPageParam** = `unknown`

Expand Down Expand Up @@ -83,13 +74,7 @@ Additional configuration.
## Call Signature

```ts
function injectInfiniteQuery<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
```

Defined in: [inject-infinite-query.ts:65](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L65)
Expand All @@ -105,7 +90,7 @@ Infinite queries can additively "load more" data onto an existing set of data or

β€’ **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>

β€’ **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
β€’ **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]

β€’ **TPageParam** = `unknown`

Expand Down Expand Up @@ -142,13 +127,7 @@ Additional configuration.
## Call Signature

```ts
function injectInfiniteQuery<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
```

Defined in: [inject-infinite-query.ts:89](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L89)
Expand All @@ -164,7 +143,7 @@ Infinite queries can additively "load more" data onto an existing set of data or

β€’ **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>

β€’ **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
β€’ **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]

β€’ **TPageParam** = `unknown`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: injectIsFetching
function injectIsFetching(filters?, options?): Signal<number>
```

Defined in: [inject-is-fetching.ts:32](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L32)
Defined in: [inject-is-fetching.ts:31](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L31)

Injects a signal that tracks the number of queries that your application is loading or
fetching in the background.
Expand Down
7 changes: 2 additions & 5 deletions docs/framework/angular/reference/functions/injectmutation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,10 @@ title: injectMutation
# Function: injectMutation()

```ts
function injectMutation<TData, TError, TVariables, TOnMutateResult>(
injectMutationFn,
options?,
): CreateMutationResult<TData, TError, TVariables, TOnMutateResult>
function injectMutation<TData, TError, TVariables, TOnMutateResult>(injectMutationFn, options?): CreateMutationResult<TData, TError, TVariables, TOnMutateResult>
```

Defined in: [inject-mutation.ts:44](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L44)
Defined in: [inject-mutation.ts:45](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L45)

Injects a mutation: an imperative function that can be invoked which typically performs server side effects.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@ title: injectMutationState
# Function: injectMutationState()

```ts
function injectMutationState<TResult>(
injectMutationStateFn,
options?,
): Signal<TResult[]>
function injectMutationState<TResult>(injectMutationStateFn, options?): Signal<TResult[]>
```

Defined in: [inject-mutation-state.ts:60](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L60)
Expand Down
43 changes: 0 additions & 43 deletions docs/framework/angular/reference/functions/injectqueries.md

This file was deleted.

29 changes: 6 additions & 23 deletions docs/framework/angular/reference/functions/injectquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ title: injectQuery
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(() => ({
Expand All @@ -26,7 +25,6 @@ In the example below, the query will be automatically enabled and executed when
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('')
Expand Down Expand Up @@ -55,18 +53,14 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries
## Call Signature

```ts
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
injectQueryFn,
options?,
): DefinedCreateQueryResult<TData, TError>
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(injectQueryFn, options?): DefinedCreateQueryResult<TData, TError>
```

Defined in: [inject-query.ts:65](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L65)

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(() => ({
Expand All @@ -82,7 +76,6 @@ In the example below, the query will be automatically enabled and executed when
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('')
Expand All @@ -104,7 +97,7 @@ class ServiceOrComponent {

β€’ **TData** = `TQueryFnData`

β€’ **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
β€’ **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]

### Parameters

Expand Down Expand Up @@ -147,18 +140,14 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries
## Call Signature

```ts
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
injectQueryFn,
options?,
): CreateQueryResult<TData, TError>
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(injectQueryFn, options?): CreateQueryResult<TData, TError>
```

Defined in: [inject-query.ts:116](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L116)

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(() => ({
Expand All @@ -174,7 +163,6 @@ In the example below, the query will be automatically enabled and executed when
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('')
Expand All @@ -196,7 +184,7 @@ class ServiceOrComponent {

β€’ **TData** = `TQueryFnData`

β€’ **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
β€’ **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]

### Parameters

Expand Down Expand Up @@ -239,18 +227,14 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries
## Call Signature

```ts
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
injectQueryFn,
options?,
): CreateQueryResult<TData, TError>
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(injectQueryFn, options?): CreateQueryResult<TData, TError>
```

Defined in: [inject-query.ts:167](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L167)

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(() => ({
Expand All @@ -266,7 +250,6 @@ In the example below, the query will be automatically enabled and executed when
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('')
Expand All @@ -288,7 +271,7 @@ class ServiceOrComponent {

β€’ **TData** = `TQueryFnData`

β€’ **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
β€’ **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]

### Parameters

Expand Down
Loading
Loading