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
4 changes: 2 additions & 2 deletions docs/framework/angular/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ npm install @tanstack/angular-db

## Angular inject function

See the [Angular Functions Reference](../reference/index.md) to see the full list of functions available in the Angular Adapter.
See the [Angular Functions Reference](./reference/index.md) to see the full list of functions available in the Angular Adapter.

For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries).
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries).

## Basic Usage

Expand Down
12 changes: 6 additions & 6 deletions docs/framework/angular/reference/functions/injectLiveQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Defined in: [index.ts:51](https://github.com/TanStack/db/blob/main/packages/angu

### Returns

[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>

## Call Signature

Expand Down Expand Up @@ -71,7 +71,7 @@ Defined in: [index.ts:61](https://github.com/TanStack/db/blob/main/packages/angu

### Returns

[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>

## Call Signature

Expand All @@ -95,7 +95,7 @@ Defined in: [index.ts:71](https://github.com/TanStack/db/blob/main/packages/angu

### Returns

[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>

## Call Signature

Expand All @@ -119,7 +119,7 @@ Defined in: [index.ts:74](https://github.com/TanStack/db/blob/main/packages/angu

### Returns

[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>

## Call Signature

Expand All @@ -143,7 +143,7 @@ Defined in: [index.ts:77](https://github.com/TanStack/db/blob/main/packages/angu

### Returns

[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>

## Call Signature

Expand Down Expand Up @@ -175,4 +175,4 @@ Defined in: [index.ts:80](https://github.com/TanStack/db/blob/main/packages/angu

### Returns

[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<`TResult`, `TKey`, `TUtils`\>
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<`TResult`, `TKey`, `TUtils`\>
4 changes: 2 additions & 2 deletions docs/framework/angular/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ title: "@tanstack/angular-db"

## Interfaces

- [InjectLiveQueryResult](../interfaces/InjectLiveQueryResult.md)
- [InjectLiveQueryResult](./interfaces/InjectLiveQueryResult.md)

## Functions

- [injectLiveQuery](../functions/injectLiveQuery.md)
- [injectLiveQuery](./functions/injectLiveQuery.md)
4 changes: 2 additions & 2 deletions docs/framework/react/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ npm install @tanstack/react-db

## React Hooks

See the [React Functions Reference](../reference/index.md) to see the full list of hooks available in the React Adapter.
See the [React Functions Reference](./reference/index.md) to see the full list of hooks available in the React Adapter.

For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries).
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries).

## Basic Usage

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@ without recreating the live query collection on each page change.

#### config

[`UseLiveInfiniteQueryConfig`](../../type-aliases/UseLiveInfiniteQueryConfig.md)\<`any`\>
[`UseLiveInfiniteQueryConfig`](../type-aliases/UseLiveInfiniteQueryConfig.md)\<`any`\>

Configuration including pageSize and getNextPageParam

### Returns

[`UseLiveInfiniteQueryReturn`](../../type-aliases/UseLiveInfiniteQueryReturn.md)\<`any`\>
[`UseLiveInfiniteQueryReturn`](../type-aliases/UseLiveInfiniteQueryReturn.md)\<`any`\>

Object with pages, data, and pagination controls

Expand Down Expand Up @@ -141,7 +141,7 @@ Query function that defines what data to fetch. Must include `.orderBy()` for se

#### config

[`UseLiveInfiniteQueryConfig`](../../type-aliases/UseLiveInfiniteQueryConfig.md)\<`TContext`\>
[`UseLiveInfiniteQueryConfig`](../type-aliases/UseLiveInfiniteQueryConfig.md)\<`TContext`\>

Configuration including pageSize and getNextPageParam

Expand All @@ -153,7 +153,7 @@ Array of dependencies that trigger query re-execution when changed

### Returns

[`UseLiveInfiniteQueryReturn`](../../type-aliases/UseLiveInfiniteQueryReturn.md)\<`TContext`\>
[`UseLiveInfiniteQueryReturn`](../type-aliases/UseLiveInfiniteQueryReturn.md)\<`TContext`\>

Object with pages, data, and pagination controls

Expand Down
14 changes: 7 additions & 7 deletions docs/framework/react/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ title: "@tanstack/react-db"

## Type Aliases

- [UseLiveInfiniteQueryConfig](../type-aliases/UseLiveInfiniteQueryConfig.md)
- [UseLiveInfiniteQueryReturn](../type-aliases/UseLiveInfiniteQueryReturn.md)
- [UseLiveQueryStatus](../type-aliases/UseLiveQueryStatus.md)
- [UseLiveInfiniteQueryConfig](./type-aliases/UseLiveInfiniteQueryConfig.md)
- [UseLiveInfiniteQueryReturn](./type-aliases/UseLiveInfiniteQueryReturn.md)
- [UseLiveQueryStatus](./type-aliases/UseLiveQueryStatus.md)

## Functions

- [useLiveInfiniteQuery](../functions/useLiveInfiniteQuery.md)
- [useLiveQuery](../functions/useLiveQuery.md)
- [useLiveSuspenseQuery](../functions/useLiveSuspenseQuery.md)
- [usePacedMutations](../functions/usePacedMutations.md)
- [useLiveInfiniteQuery](./functions/useLiveInfiniteQuery.md)
- [useLiveQuery](./functions/useLiveQuery.md)
- [useLiveSuspenseQuery](./functions/useLiveSuspenseQuery.md)
- [usePacedMutations](./functions/usePacedMutations.md)
4 changes: 2 additions & 2 deletions docs/framework/solid/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ npm install @tanstack/solid-db

## Solid Primitives

See the [Solid Functions Reference](../reference/index.md) to see the full list of primitives available in the Solid Adapter.
See the [Solid Functions Reference](./reference/index.md) to see the full list of primitives available in the Solid Adapter.

For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries).
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries).

## Basic Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/solid/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ title: "@tanstack/solid-db"

## Functions

- [useLiveQuery](../functions/useLiveQuery.md)
- [useLiveQuery](./functions/useLiveQuery.md)
2 changes: 1 addition & 1 deletion docs/framework/svelte/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ npm install @tanstack/svelte-db

## Svelte Utilities

See the [Svelte Functions Reference](../reference/index.md) to see the full list of utilities available in the Svelte Adapter.
See the [Svelte Functions Reference](./reference/index.md) to see the full list of utilities available in the Svelte Adapter.

For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries).

Expand Down
4 changes: 2 additions & 2 deletions docs/framework/vue/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ npm install @tanstack/vue-db

## Vue Composables

See the [Vue Functions Reference](../reference/index.md) to see the full list of composables available in the Vue Adapter.
See the [Vue Functions Reference](./reference/index.md) to see the full list of composables available in the Vue Adapter.

For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries).
For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries).

## Basic Usage

Expand Down
8 changes: 4 additions & 4 deletions docs/framework/vue/reference/functions/useLiveQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Array of reactive dependencies that trigger query re-execution when changed

### Returns

[`UseLiveQueryReturn`](../../interfaces/UseLiveQueryReturn.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
[`UseLiveQueryReturn`](../interfaces/UseLiveQueryReturn.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>

Reactive object with query data, state, and status information

Expand Down Expand Up @@ -123,7 +123,7 @@ Array of reactive dependencies that trigger query re-execution when changed

### Returns

[`UseLiveQueryReturn`](../../interfaces/UseLiveQueryReturn.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
[`UseLiveQueryReturn`](../interfaces/UseLiveQueryReturn.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>

Reactive object with query data, state, and status information

Expand Down Expand Up @@ -209,7 +209,7 @@ Array of reactive dependencies that trigger query re-execution when changed

### Returns

[`UseLiveQueryReturn`](../../interfaces/UseLiveQueryReturn.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
[`UseLiveQueryReturn`](../interfaces/UseLiveQueryReturn.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>

Reactive object with query data, state, and status information

Expand Down Expand Up @@ -279,7 +279,7 @@ Pre-created query collection to subscribe to (can be a ref)

### Returns

[`UseLiveQueryReturnWithCollection`](../../interfaces/UseLiveQueryReturnWithCollection.md)\<`TResult`, `TKey`, `TUtils`\>
[`UseLiveQueryReturnWithCollection`](../interfaces/UseLiveQueryReturnWithCollection.md)\<`TResult`, `TKey`, `TUtils`\>

Reactive object with query data, state, and status information

Expand Down
6 changes: 3 additions & 3 deletions docs/framework/vue/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ title: "@tanstack/vue-db"

## Interfaces

- [UseLiveQueryReturn](../interfaces/UseLiveQueryReturn.md)
- [UseLiveQueryReturnWithCollection](../interfaces/UseLiveQueryReturnWithCollection.md)
- [UseLiveQueryReturn](./interfaces/UseLiveQueryReturn.md)
- [UseLiveQueryReturnWithCollection](./interfaces/UseLiveQueryReturnWithCollection.md)

## Functions

- [useLiveQuery](../functions/useLiveQuery.md)
- [useLiveQuery](./functions/useLiveQuery.md)
6 changes: 3 additions & 3 deletions docs/guides/error-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ const App = () => (
)
```

With this approach, loading states are handled by `<Suspense>` and error states are handled by `<ErrorBoundary>` instead of within your component logic. See the [React Suspense section in Live Queries](../live-queries#using-with-react-suspense) for more details.
With this approach, loading states are handled by `<Suspense>` and error states are handled by `<ErrorBoundary>` instead of within your component logic. See the [React Suspense section in Live Queries](./live-queries#using-with-react-suspense) for more details.

## Transaction Error Handling

Expand Down Expand Up @@ -810,6 +810,6 @@ const TodoApp = () => {

## See Also

- [API Reference](../../overview.md#api-reference) - Detailed API documentation
- [Mutations Guide](../../overview.md#making-optimistic-mutations) - Learn about optimistic updates and rollbacks
- [API Reference](../overview.md#api-reference) - Detailed API documentation
- [Mutations Guide](../overview.md#making-optimistic-mutations) - Learn about optimistic updates and rollbacks
- [TanStack Query Error Handling](https://tanstack.com/query/latest/docs/react/guides/error-handling) - Query-specific error handling
4 changes: 2 additions & 2 deletions docs/guides/live-queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,9 @@ export class UserListComponent {
}
```

> **Note:** React hooks (`useLiveQuery`, `useLiveInfiniteQuery`, `useLiveSuspenseQuery`) accept an optional dependency array parameter to re-execute queries when values change, similar to React's `useEffect`. See the [React Adapter documentation](../../framework/react/adapter#dependency-arrays) for details on when and how to use dependency arrays.
> **Note:** React hooks (`useLiveQuery`, `useLiveInfiniteQuery`, `useLiveSuspenseQuery`) accept an optional dependency array parameter to re-execute queries when values change, similar to React's `useEffect`. See the [React Adapter documentation](../framework/react/adapter#dependency-arrays) for details on when and how to use dependency arrays.

For more details on framework integration, see the [React](../../framework/react/adapter), [Vue](../../framework/vue/adapter), and [Angular](../../framework/angular/adapter) adapter documentation.
For more details on framework integration, see the [React](../framework/react/adapter), [Vue](../framework/vue/adapter), and [Angular](../framework/angular/adapter) adapter documentation.

### Using with React Suspense

Expand Down
Loading
Loading