Skip to content
Open
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 4 additions & 4 deletions docs/framework/angular/reference/functions/injectLiveQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: injectLiveQuery
function injectLiveQuery<TContext, TParams>(options): InjectLiveQueryResult<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;
```

Defined in: [index.ts:51](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L51)
Defined in: [index.ts:51](https://github.com/MAST1999/db/blob/main/packages/angular-db/src/index.ts#L51)

### Type Parameters

Expand Down Expand Up @@ -45,7 +45,7 @@ Defined in: [index.ts:51](https://github.com/TanStack/db/blob/main/packages/angu
function injectLiveQuery<TContext>(queryFn): InjectLiveQueryResult<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;
```

Defined in: [index.ts:61](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L61)
Defined in: [index.ts:61](https://github.com/MAST1999/db/blob/main/packages/angular-db/src/index.ts#L61)

### Type Parameters

Expand All @@ -69,7 +69,7 @@ Defined in: [index.ts:61](https://github.com/TanStack/db/blob/main/packages/angu
function injectLiveQuery<TContext>(config): InjectLiveQueryResult<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;
```

Defined in: [index.ts:64](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L64)
Defined in: [index.ts:64](https://github.com/MAST1999/db/blob/main/packages/angular-db/src/index.ts#L64)

### Type Parameters

Expand All @@ -93,7 +93,7 @@ Defined in: [index.ts:64](https://github.com/TanStack/db/blob/main/packages/angu
function injectLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): InjectLiveQueryResult<TResult, TKey, TUtils>;
```

Defined in: [index.ts:67](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L67)
Defined in: [index.ts:67](https://github.com/MAST1999/db/blob/main/packages/angular-db/src/index.ts#L67)

### Type Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: InjectLiveQueryResult

# Interface: InjectLiveQueryResult\<TResult, TKey, TUtils\>

Defined in: [index.ts:26](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L26)
Defined in: [index.ts:26](https://github.com/MAST1999/db/blob/main/packages/angular-db/src/index.ts#L26)

The result of calling `injectLiveQuery`.
Contains reactive signals for the query state and data.
Expand Down Expand Up @@ -33,7 +33,7 @@ Contains reactive signals for the query state and data.
collection: Signal<Collection<TResult, TKey, TUtils, StandardSchemaV1<unknown, unknown>, TResult>>;
```

Defined in: [index.ts:36](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L36)
Defined in: [index.ts:36](https://github.com/MAST1999/db/blob/main/packages/angular-db/src/index.ts#L36)

A signal containing the underlying collection instance

Expand All @@ -45,7 +45,7 @@ A signal containing the underlying collection instance
data: Signal<TResult[]>;
```

Defined in: [index.ts:34](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L34)
Defined in: [index.ts:34](https://github.com/MAST1999/db/blob/main/packages/angular-db/src/index.ts#L34)

A signal containing the results as an array

Expand All @@ -57,7 +57,7 @@ A signal containing the results as an array
isCleanedUp: Signal<boolean>;
```

Defined in: [index.ts:48](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L48)
Defined in: [index.ts:48](https://github.com/MAST1999/db/blob/main/packages/angular-db/src/index.ts#L48)

A signal indicating whether the collection has been cleaned up

Expand All @@ -69,7 +69,7 @@ A signal indicating whether the collection has been cleaned up
isError: Signal<boolean>;
```

Defined in: [index.ts:46](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L46)
Defined in: [index.ts:46](https://github.com/MAST1999/db/blob/main/packages/angular-db/src/index.ts#L46)

A signal indicating whether the collection has an error

Expand All @@ -81,7 +81,7 @@ A signal indicating whether the collection has an error
isIdle: Signal<boolean>;
```

Defined in: [index.ts:44](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L44)
Defined in: [index.ts:44](https://github.com/MAST1999/db/blob/main/packages/angular-db/src/index.ts#L44)

A signal indicating whether the collection is idle

Expand All @@ -93,7 +93,7 @@ A signal indicating whether the collection is idle
isLoading: Signal<boolean>;
```

Defined in: [index.ts:40](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L40)
Defined in: [index.ts:40](https://github.com/MAST1999/db/blob/main/packages/angular-db/src/index.ts#L40)

A signal indicating whether the collection is currently loading

Expand All @@ -105,7 +105,7 @@ A signal indicating whether the collection is currently loading
isReady: Signal<boolean>;
```

Defined in: [index.ts:42](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L42)
Defined in: [index.ts:42](https://github.com/MAST1999/db/blob/main/packages/angular-db/src/index.ts#L42)

A signal indicating whether the collection is ready

Expand All @@ -117,7 +117,7 @@ A signal indicating whether the collection is ready
state: Signal<Map<TKey, TResult>>;
```

Defined in: [index.ts:32](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L32)
Defined in: [index.ts:32](https://github.com/MAST1999/db/blob/main/packages/angular-db/src/index.ts#L32)

A signal containing the complete state map of results keyed by their ID

Expand All @@ -129,6 +129,6 @@ A signal containing the complete state map of results keyed by their ID
status: Signal<CollectionStatus>;
```

Defined in: [index.ts:38](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L38)
Defined in: [index.ts:38](https://github.com/MAST1999/db/blob/main/packages/angular-db/src/index.ts#L38)

A signal containing the current status of the collection
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: useLiveInfiniteQuery
function useLiveInfiniteQuery<TResult, TKey, TUtils>(liveQueryCollection, config): UseLiveInfiniteQueryReturn<any>;
```

Defined in: [useLiveInfiniteQuery.ts:113](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L113)
Defined in: [useLiveInfiniteQuery.ts:113](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L113)

Create an infinite query using a query function with live updates

Expand Down Expand Up @@ -118,7 +118,7 @@ function useLiveInfiniteQuery<TContext>(
deps?): UseLiveInfiniteQueryReturn<TContext>;
```

Defined in: [useLiveInfiniteQuery.ts:123](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L123)
Defined in: [useLiveInfiniteQuery.ts:123](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L123)

Create an infinite query using a query function with live updates

Expand Down
16 changes: 8 additions & 8 deletions docs/framework/react/reference/functions/useLiveQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: useLiveQuery
function useLiveQuery<TContext>(queryFn, deps?): object;
```

Defined in: [useLiveQuery.ts:84](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L84)
Defined in: [useLiveQuery.ts:84](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveQuery.ts#L84)

Create a live query using a query function

Expand Down Expand Up @@ -168,7 +168,7 @@ return (
function useLiveQuery<TContext>(queryFn, deps?): object;
```

Defined in: [useLiveQuery.ts:101](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L101)
Defined in: [useLiveQuery.ts:101](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveQuery.ts#L101)

Create a live query using a query function

Expand Down Expand Up @@ -329,7 +329,7 @@ return (
function useLiveQuery<TContext>(queryFn, deps?): object;
```

Defined in: [useLiveQuery.ts:120](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L120)
Defined in: [useLiveQuery.ts:120](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveQuery.ts#L120)

Create a live query using a query function

Expand Down Expand Up @@ -493,7 +493,7 @@ return (
function useLiveQuery<TResult, TKey, TUtils>(queryFn, deps?): object;
```

Defined in: [useLiveQuery.ts:139](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L139)
Defined in: [useLiveQuery.ts:139](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveQuery.ts#L139)

Create a live query using a query function

Expand Down Expand Up @@ -662,7 +662,7 @@ return (
function useLiveQuery<TContext, TResult, TKey, TUtils>(queryFn, deps?): object;
```

Defined in: [useLiveQuery.ts:162](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L162)
Defined in: [useLiveQuery.ts:162](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveQuery.ts#L162)

Create a live query using a query function

Expand Down Expand Up @@ -842,7 +842,7 @@ return (
function useLiveQuery<TContext>(config, deps?): object;
```

Defined in: [useLiveQuery.ts:230](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L230)
Defined in: [useLiveQuery.ts:230](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveQuery.ts#L230)

Create a live query using configuration object

Expand Down Expand Up @@ -972,7 +972,7 @@ return <div>{data.length} items loaded</div>
function useLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): object;
```

Defined in: [useLiveQuery.ts:276](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L276)
Defined in: [useLiveQuery.ts:276](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveQuery.ts#L276)

Subscribe to an existing live query collection

Expand Down Expand Up @@ -1100,7 +1100,7 @@ return <div>{data.map(item => <Item key={item.id} {...item} />)}</div>
function useLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): object;
```

Defined in: [useLiveQuery.ts:296](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L296)
Defined in: [useLiveQuery.ts:296](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveQuery.ts#L296)

Create a live query using a query function

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: useLiveSuspenseQuery
function useLiveSuspenseQuery<TContext>(queryFn, deps?): object;
```

Defined in: [useLiveSuspenseQuery.ts:76](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveSuspenseQuery.ts#L76)
Defined in: [useLiveSuspenseQuery.ts:76](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveSuspenseQuery.ts#L76)

Create a live query with React Suspense support

Expand Down Expand Up @@ -133,7 +133,7 @@ function App() {
function useLiveSuspenseQuery<TContext>(config, deps?): object;
```

Defined in: [useLiveSuspenseQuery.ts:86](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveSuspenseQuery.ts#L86)
Defined in: [useLiveSuspenseQuery.ts:86](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveSuspenseQuery.ts#L86)

Create a live query with React Suspense support

Expand Down Expand Up @@ -253,7 +253,7 @@ function App() {
function useLiveSuspenseQuery<TResult, TKey, TUtils>(liveQueryCollection): object;
```

Defined in: [useLiveSuspenseQuery.ts:96](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveSuspenseQuery.ts#L96)
Defined in: [useLiveSuspenseQuery.ts:96](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveSuspenseQuery.ts#L96)

Create a live query with React Suspense support

Expand Down Expand Up @@ -374,7 +374,7 @@ function App() {
function useLiveSuspenseQuery<TResult, TKey, TUtils>(liveQueryCollection): object;
```

Defined in: [useLiveSuspenseQuery.ts:109](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveSuspenseQuery.ts#L109)
Defined in: [useLiveSuspenseQuery.ts:109](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveSuspenseQuery.ts#L109)

Create a live query with React Suspense support

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: usePacedMutations
function usePacedMutations<TVariables, T>(config): (variables) => Transaction<T>;
```

Defined in: [usePacedMutations.ts:93](https://github.com/TanStack/db/blob/main/packages/react-db/src/usePacedMutations.ts#L93)
Defined in: [usePacedMutations.ts:93](https://github.com/MAST1999/db/blob/main/packages/react-db/src/usePacedMutations.ts#L93)

React hook for managing paced mutations with timing strategies.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: UseLiveInfiniteQueryConfig
type UseLiveInfiniteQueryConfig<TContext> = object;
```

Defined in: [useLiveInfiniteQuery.ts:23](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L23)
Defined in: [useLiveInfiniteQuery.ts:23](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L23)

## Type Parameters

Expand All @@ -25,7 +25,7 @@ Defined in: [useLiveInfiniteQuery.ts:23](https://github.com/TanStack/db/blob/mai
getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => number | undefined;
```

Defined in: [useLiveInfiniteQuery.ts:26](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L26)
Defined in: [useLiveInfiniteQuery.ts:26](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L26)

#### Parameters

Expand Down Expand Up @@ -57,7 +57,7 @@ Defined in: [useLiveInfiniteQuery.ts:26](https://github.com/TanStack/db/blob/mai
optional initialPageParam: number;
```

Defined in: [useLiveInfiniteQuery.ts:25](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L25)
Defined in: [useLiveInfiniteQuery.ts:25](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L25)

***

Expand All @@ -67,4 +67,4 @@ Defined in: [useLiveInfiniteQuery.ts:25](https://github.com/TanStack/db/blob/mai
optional pageSize: number;
```

Defined in: [useLiveInfiniteQuery.ts:24](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L24)
Defined in: [useLiveInfiniteQuery.ts:24](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L24)
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: UseLiveInfiniteQueryReturn
type UseLiveInfiniteQueryReturn<TContext> = Omit<ReturnType<typeof useLiveQuery>, "data"> & object;
```

Defined in: [useLiveInfiniteQuery.ts:34](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L34)
Defined in: [useLiveInfiniteQuery.ts:34](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L34)

## Type Declaration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ title: UseLiveQueryStatus
type UseLiveQueryStatus = CollectionStatus | "disabled";
```

Defined in: [useLiveQuery.ts:23](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L23)
Defined in: [useLiveQuery.ts:23](https://github.com/MAST1999/db/blob/main/packages/react-db/src/useLiveQuery.ts#L23)
6 changes: 3 additions & 3 deletions docs/framework/solid/reference/functions/useLiveQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: useLiveQuery
function useLiveQuery<TContext>(queryFn): object;
```

Defined in: [useLiveQuery.ts:80](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L80)
Defined in: [useLiveQuery.ts:80](https://github.com/MAST1999/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L80)

Create a live query using a query function

Expand Down Expand Up @@ -153,7 +153,7 @@ return (
function useLiveQuery<TContext>(config): object;
```

Defined in: [useLiveQuery.ts:135](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L135)
Defined in: [useLiveQuery.ts:135](https://github.com/MAST1999/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L135)

Create a live query using configuration object

Expand Down Expand Up @@ -279,7 +279,7 @@ return (
function useLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): object;
```

Defined in: [useLiveQuery.ts:185](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L185)
Defined in: [useLiveQuery.ts:185](https://github.com/MAST1999/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L185)

Subscribe to an existing live query collection

Expand Down
6 changes: 3 additions & 3 deletions docs/framework/vue/reference/functions/useLiveQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: useLiveQuery
function useLiveQuery<TContext>(queryFn, deps?): UseLiveQueryReturn<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;
```

Defined in: [useLiveQuery.ts:114](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L114)
Defined in: [useLiveQuery.ts:114](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L114)

Create a live query using a query function

Expand Down Expand Up @@ -97,7 +97,7 @@ const { data, isLoading, isError, status } = useLiveQuery((q) =>
function useLiveQuery<TContext>(config, deps?): UseLiveQueryReturn<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;
```

Defined in: [useLiveQuery.ts:152](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L152)
Defined in: [useLiveQuery.ts:152](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L152)

Create a live query using configuration object

Expand Down Expand Up @@ -165,7 +165,7 @@ const { data, isLoading, isReady, isError } = useLiveQuery({
function useLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): UseLiveQueryReturnWithCollection<TResult, TKey, TUtils>;
```

Defined in: [useLiveQuery.ts:197](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L197)
Defined in: [useLiveQuery.ts:197](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L197)

Subscribe to an existing query collection (can be reactive)

Expand Down
Loading