diff --git a/docs/framework/angular/reference/functions/injectLiveQuery.md b/docs/framework/angular/reference/functions/injectLiveQuery.md index 4b3209aca..141e1d7aa 100644 --- a/docs/framework/angular/reference/functions/injectLiveQuery.md +++ b/docs/framework/angular/reference/functions/injectLiveQuery.md @@ -11,7 +11,7 @@ title: injectLiveQuery function injectLiveQuery(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 @@ -45,7 +45,7 @@ Defined in: [index.ts:51](https://github.com/TanStack/db/blob/main/packages/angu function injectLiveQuery(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 @@ -69,7 +69,7 @@ Defined in: [index.ts:61](https://github.com/TanStack/db/blob/main/packages/angu function injectLiveQuery(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 @@ -93,7 +93,7 @@ Defined in: [index.ts:64](https://github.com/TanStack/db/blob/main/packages/angu function injectLiveQuery(liveQueryCollection): InjectLiveQueryResult; ``` -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 diff --git a/docs/framework/angular/reference/interfaces/InjectLiveQueryResult.md b/docs/framework/angular/reference/interfaces/InjectLiveQueryResult.md index aa45218bc..e3364979c 100644 --- a/docs/framework/angular/reference/interfaces/InjectLiveQueryResult.md +++ b/docs/framework/angular/reference/interfaces/InjectLiveQueryResult.md @@ -5,7 +5,7 @@ title: InjectLiveQueryResult # Interface: InjectLiveQueryResult\ -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. @@ -33,7 +33,7 @@ Contains reactive signals for the query state and data. collection: Signal, 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 @@ -45,7 +45,7 @@ A signal containing the underlying collection instance data: Signal; ``` -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 @@ -57,7 +57,7 @@ A signal containing the results as an array isCleanedUp: Signal; ``` -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 @@ -69,7 +69,7 @@ A signal indicating whether the collection has been cleaned up isError: Signal; ``` -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 @@ -81,7 +81,7 @@ A signal indicating whether the collection has an error isIdle: Signal; ``` -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 @@ -93,7 +93,7 @@ A signal indicating whether the collection is idle isLoading: Signal; ``` -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 @@ -105,7 +105,7 @@ A signal indicating whether the collection is currently loading isReady: Signal; ``` -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 @@ -117,7 +117,7 @@ A signal indicating whether the collection is ready state: Signal>; ``` -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 @@ -129,6 +129,6 @@ A signal containing the complete state map of results keyed by their ID status: Signal; ``` -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 diff --git a/docs/framework/react/reference/functions/useLiveInfiniteQuery.md b/docs/framework/react/reference/functions/useLiveInfiniteQuery.md index 49f258cf6..fe5093eed 100644 --- a/docs/framework/react/reference/functions/useLiveInfiniteQuery.md +++ b/docs/framework/react/reference/functions/useLiveInfiniteQuery.md @@ -11,7 +11,7 @@ title: useLiveInfiniteQuery function useLiveInfiniteQuery(liveQueryCollection, config): UseLiveInfiniteQueryReturn; ``` -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 @@ -118,7 +118,7 @@ function useLiveInfiniteQuery( deps?): UseLiveInfiniteQueryReturn; ``` -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 diff --git a/docs/framework/react/reference/functions/useLiveQuery.md b/docs/framework/react/reference/functions/useLiveQuery.md index 84162b674..e1a131cc2 100644 --- a/docs/framework/react/reference/functions/useLiveQuery.md +++ b/docs/framework/react/reference/functions/useLiveQuery.md @@ -11,7 +11,7 @@ title: useLiveQuery function useLiveQuery(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 @@ -168,7 +168,7 @@ return ( function useLiveQuery(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 @@ -329,7 +329,7 @@ return ( function useLiveQuery(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 @@ -493,7 +493,7 @@ return ( function useLiveQuery(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 @@ -662,7 +662,7 @@ return ( function useLiveQuery(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 @@ -842,7 +842,7 @@ return ( function useLiveQuery(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 @@ -972,7 +972,7 @@ return
{data.length} items loaded
function useLiveQuery(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 @@ -1100,7 +1100,7 @@ return
{data.map(item => )}
function useLiveQuery(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 diff --git a/docs/framework/react/reference/functions/useLiveSuspenseQuery.md b/docs/framework/react/reference/functions/useLiveSuspenseQuery.md index 679fb98fd..671de8815 100644 --- a/docs/framework/react/reference/functions/useLiveSuspenseQuery.md +++ b/docs/framework/react/reference/functions/useLiveSuspenseQuery.md @@ -11,7 +11,7 @@ title: useLiveSuspenseQuery function useLiveSuspenseQuery(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 @@ -133,7 +133,7 @@ function App() { function useLiveSuspenseQuery(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 @@ -253,7 +253,7 @@ function App() { function useLiveSuspenseQuery(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 @@ -374,7 +374,7 @@ function App() { function useLiveSuspenseQuery(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 diff --git a/docs/framework/react/reference/functions/usePacedMutations.md b/docs/framework/react/reference/functions/usePacedMutations.md index 4f50b0411..b38f36ba4 100644 --- a/docs/framework/react/reference/functions/usePacedMutations.md +++ b/docs/framework/react/reference/functions/usePacedMutations.md @@ -9,7 +9,7 @@ title: usePacedMutations function usePacedMutations(config): (variables) => Transaction; ``` -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. diff --git a/docs/framework/react/reference/type-aliases/UseLiveInfiniteQueryConfig.md b/docs/framework/react/reference/type-aliases/UseLiveInfiniteQueryConfig.md index c0a4ad638..db68e4b1c 100644 --- a/docs/framework/react/reference/type-aliases/UseLiveInfiniteQueryConfig.md +++ b/docs/framework/react/reference/type-aliases/UseLiveInfiniteQueryConfig.md @@ -9,7 +9,7 @@ title: UseLiveInfiniteQueryConfig type UseLiveInfiniteQueryConfig = 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 @@ -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 @@ -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) *** @@ -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) diff --git a/docs/framework/react/reference/type-aliases/UseLiveInfiniteQueryReturn.md b/docs/framework/react/reference/type-aliases/UseLiveInfiniteQueryReturn.md index b7d68849d..7be9490b8 100644 --- a/docs/framework/react/reference/type-aliases/UseLiveInfiniteQueryReturn.md +++ b/docs/framework/react/reference/type-aliases/UseLiveInfiniteQueryReturn.md @@ -9,7 +9,7 @@ title: UseLiveInfiniteQueryReturn type UseLiveInfiniteQueryReturn = Omit, "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 diff --git a/docs/framework/react/reference/type-aliases/UseLiveQueryStatus.md b/docs/framework/react/reference/type-aliases/UseLiveQueryStatus.md index 93bbcd634..b74ebb7a4 100644 --- a/docs/framework/react/reference/type-aliases/UseLiveQueryStatus.md +++ b/docs/framework/react/reference/type-aliases/UseLiveQueryStatus.md @@ -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) diff --git a/docs/framework/solid/reference/functions/useLiveQuery.md b/docs/framework/solid/reference/functions/useLiveQuery.md index 2291a4b34..0010a08bf 100644 --- a/docs/framework/solid/reference/functions/useLiveQuery.md +++ b/docs/framework/solid/reference/functions/useLiveQuery.md @@ -11,7 +11,7 @@ title: useLiveQuery function useLiveQuery(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 @@ -153,7 +153,7 @@ return ( function useLiveQuery(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 @@ -279,7 +279,7 @@ return ( function useLiveQuery(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 diff --git a/docs/framework/vue/reference/functions/useLiveQuery.md b/docs/framework/vue/reference/functions/useLiveQuery.md index d233b05ed..317150317 100644 --- a/docs/framework/vue/reference/functions/useLiveQuery.md +++ b/docs/framework/vue/reference/functions/useLiveQuery.md @@ -11,7 +11,7 @@ title: useLiveQuery function useLiveQuery(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 @@ -97,7 +97,7 @@ const { data, isLoading, isError, status } = useLiveQuery((q) => function useLiveQuery(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 @@ -165,7 +165,7 @@ const { data, isLoading, isReady, isError } = useLiveQuery({ function useLiveQuery(liveQueryCollection): UseLiveQueryReturnWithCollection; ``` -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) diff --git a/docs/framework/vue/reference/interfaces/UseLiveQueryReturn.md b/docs/framework/vue/reference/interfaces/UseLiveQueryReturn.md index abc9eb6aa..41077ed4b 100644 --- a/docs/framework/vue/reference/interfaces/UseLiveQueryReturn.md +++ b/docs/framework/vue/reference/interfaces/UseLiveQueryReturn.md @@ -5,7 +5,7 @@ title: UseLiveQueryReturn # Interface: UseLiveQueryReturn\ -Defined in: [useLiveQuery.ts:36](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L36) +Defined in: [useLiveQuery.ts:36](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L36) Return type for useLiveQuery hook @@ -24,7 +24,7 @@ collection: ComputedRef, T>>; ``` -Defined in: [useLiveQuery.ts:39](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L39) +Defined in: [useLiveQuery.ts:39](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L39) The underlying query collection instance @@ -36,7 +36,7 @@ The underlying query collection instance data: ComputedRef; ``` -Defined in: [useLiveQuery.ts:38](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L38) +Defined in: [useLiveQuery.ts:38](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L38) Reactive array of query results in order @@ -48,7 +48,7 @@ Reactive array of query results in order isCleanedUp: ComputedRef; ``` -Defined in: [useLiveQuery.ts:45](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L45) +Defined in: [useLiveQuery.ts:45](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L45) True when query has been cleaned up @@ -60,7 +60,7 @@ True when query has been cleaned up isError: ComputedRef; ``` -Defined in: [useLiveQuery.ts:44](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L44) +Defined in: [useLiveQuery.ts:44](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L44) True when query encountered an error @@ -72,7 +72,7 @@ True when query encountered an error isIdle: ComputedRef; ``` -Defined in: [useLiveQuery.ts:43](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L43) +Defined in: [useLiveQuery.ts:43](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L43) True when query hasn't started yet @@ -84,7 +84,7 @@ True when query hasn't started yet isLoading: ComputedRef; ``` -Defined in: [useLiveQuery.ts:41](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L41) +Defined in: [useLiveQuery.ts:41](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L41) True while initial query data is loading @@ -96,7 +96,7 @@ True while initial query data is loading isReady: ComputedRef; ``` -Defined in: [useLiveQuery.ts:42](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L42) +Defined in: [useLiveQuery.ts:42](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L42) True when query has received first data and is ready @@ -108,7 +108,7 @@ True when query has received first data and is ready state: ComputedRef>; ``` -Defined in: [useLiveQuery.ts:37](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L37) +Defined in: [useLiveQuery.ts:37](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L37) Reactive Map of query results (key → item) @@ -120,6 +120,6 @@ Reactive Map of query results (key → item) status: ComputedRef; ``` -Defined in: [useLiveQuery.ts:40](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L40) +Defined in: [useLiveQuery.ts:40](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L40) Current query status diff --git a/docs/framework/vue/reference/interfaces/UseLiveQueryReturnWithCollection.md b/docs/framework/vue/reference/interfaces/UseLiveQueryReturnWithCollection.md index f646e663d..226c66e7b 100644 --- a/docs/framework/vue/reference/interfaces/UseLiveQueryReturnWithCollection.md +++ b/docs/framework/vue/reference/interfaces/UseLiveQueryReturnWithCollection.md @@ -5,7 +5,7 @@ title: UseLiveQueryReturnWithCollection # Interface: UseLiveQueryReturnWithCollection\ -Defined in: [useLiveQuery.ts:48](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L48) +Defined in: [useLiveQuery.ts:48](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L48) ## Type Parameters @@ -29,7 +29,7 @@ Defined in: [useLiveQuery.ts:48](https://github.com/TanStack/db/blob/main/packag collection: ComputedRef, T>>; ``` -Defined in: [useLiveQuery.ts:55](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L55) +Defined in: [useLiveQuery.ts:55](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L55) *** @@ -39,7 +39,7 @@ Defined in: [useLiveQuery.ts:55](https://github.com/TanStack/db/blob/main/packag data: ComputedRef; ``` -Defined in: [useLiveQuery.ts:54](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L54) +Defined in: [useLiveQuery.ts:54](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L54) *** @@ -49,7 +49,7 @@ Defined in: [useLiveQuery.ts:54](https://github.com/TanStack/db/blob/main/packag isCleanedUp: ComputedRef; ``` -Defined in: [useLiveQuery.ts:61](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L61) +Defined in: [useLiveQuery.ts:61](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L61) *** @@ -59,7 +59,7 @@ Defined in: [useLiveQuery.ts:61](https://github.com/TanStack/db/blob/main/packag isError: ComputedRef; ``` -Defined in: [useLiveQuery.ts:60](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L60) +Defined in: [useLiveQuery.ts:60](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L60) *** @@ -69,7 +69,7 @@ Defined in: [useLiveQuery.ts:60](https://github.com/TanStack/db/blob/main/packag isIdle: ComputedRef; ``` -Defined in: [useLiveQuery.ts:59](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L59) +Defined in: [useLiveQuery.ts:59](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L59) *** @@ -79,7 +79,7 @@ Defined in: [useLiveQuery.ts:59](https://github.com/TanStack/db/blob/main/packag isLoading: ComputedRef; ``` -Defined in: [useLiveQuery.ts:57](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L57) +Defined in: [useLiveQuery.ts:57](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L57) *** @@ -89,7 +89,7 @@ Defined in: [useLiveQuery.ts:57](https://github.com/TanStack/db/blob/main/packag isReady: ComputedRef; ``` -Defined in: [useLiveQuery.ts:58](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L58) +Defined in: [useLiveQuery.ts:58](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L58) *** @@ -99,7 +99,7 @@ Defined in: [useLiveQuery.ts:58](https://github.com/TanStack/db/blob/main/packag state: ComputedRef>; ``` -Defined in: [useLiveQuery.ts:53](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L53) +Defined in: [useLiveQuery.ts:53](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L53) *** @@ -109,4 +109,4 @@ Defined in: [useLiveQuery.ts:53](https://github.com/TanStack/db/blob/main/packag status: ComputedRef; ``` -Defined in: [useLiveQuery.ts:56](https://github.com/TanStack/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L56) +Defined in: [useLiveQuery.ts:56](https://github.com/MAST1999/db/blob/main/packages/vue-db/src/useLiveQuery.ts#L56) diff --git a/docs/reference/@tanstack/namespaces/IR/classes/Aggregate.md b/docs/reference/@tanstack/namespaces/IR/classes/Aggregate.md index 7a9758d72..97b295e1a 100644 --- a/docs/reference/@tanstack/namespaces/IR/classes/Aggregate.md +++ b/docs/reference/@tanstack/namespaces/IR/classes/Aggregate.md @@ -5,7 +5,7 @@ title: Aggregate # Class: Aggregate\ -Defined in: [packages/db/src/query/ir.ts:125](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L125) +Defined in: [packages/db/src/query/ir.ts:125](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L125) ## Extends @@ -25,7 +25,7 @@ Defined in: [packages/db/src/query/ir.ts:125](https://github.com/TanStack/db/blo new Aggregate(name, args): Aggregate; ``` -Defined in: [packages/db/src/query/ir.ts:127](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L127) +Defined in: [packages/db/src/query/ir.ts:127](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L127) #### Parameters @@ -55,7 +55,7 @@ BaseExpression.constructor readonly __returnType: T; ``` -Defined in: [packages/db/src/query/ir.ts:69](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L69) +Defined in: [packages/db/src/query/ir.ts:69](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L69) **`Internal`** @@ -75,7 +75,7 @@ BaseExpression.__returnType args: BasicExpression[]; ``` -Defined in: [packages/db/src/query/ir.ts:129](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L129) +Defined in: [packages/db/src/query/ir.ts:129](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L129) *** @@ -85,7 +85,7 @@ Defined in: [packages/db/src/query/ir.ts:129](https://github.com/TanStack/db/blo name: string; ``` -Defined in: [packages/db/src/query/ir.ts:128](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L128) +Defined in: [packages/db/src/query/ir.ts:128](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L128) *** @@ -95,7 +95,7 @@ Defined in: [packages/db/src/query/ir.ts:128](https://github.com/TanStack/db/blo type: "agg"; ``` -Defined in: [packages/db/src/query/ir.ts:126](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L126) +Defined in: [packages/db/src/query/ir.ts:126](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L126) #### Overrides diff --git a/docs/reference/@tanstack/namespaces/IR/classes/CollectionRef.md b/docs/reference/@tanstack/namespaces/IR/classes/CollectionRef.md index 0d820a8b1..1c87371c5 100644 --- a/docs/reference/@tanstack/namespaces/IR/classes/CollectionRef.md +++ b/docs/reference/@tanstack/namespaces/IR/classes/CollectionRef.md @@ -5,7 +5,7 @@ title: CollectionRef # Class: CollectionRef -Defined in: [packages/db/src/query/ir.ts:72](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L72) +Defined in: [packages/db/src/query/ir.ts:72](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L72) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/query/ir.ts:72](https://github.com/TanStack/db/blob new CollectionRef(collection, alias): CollectionRef; ``` -Defined in: [packages/db/src/query/ir.ts:74](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L74) +Defined in: [packages/db/src/query/ir.ts:74](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L74) #### Parameters @@ -49,7 +49,7 @@ BaseExpression.constructor readonly __returnType: any; ``` -Defined in: [packages/db/src/query/ir.ts:69](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L69) +Defined in: [packages/db/src/query/ir.ts:69](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L69) **`Internal`** @@ -69,7 +69,7 @@ BaseExpression.__returnType alias: string; ``` -Defined in: [packages/db/src/query/ir.ts:76](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L76) +Defined in: [packages/db/src/query/ir.ts:76](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L76) *** @@ -79,7 +79,7 @@ Defined in: [packages/db/src/query/ir.ts:76](https://github.com/TanStack/db/blob collection: CollectionImpl; ``` -Defined in: [packages/db/src/query/ir.ts:75](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L75) +Defined in: [packages/db/src/query/ir.ts:75](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L75) *** @@ -89,7 +89,7 @@ Defined in: [packages/db/src/query/ir.ts:75](https://github.com/TanStack/db/blob type: "collectionRef"; ``` -Defined in: [packages/db/src/query/ir.ts:73](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L73) +Defined in: [packages/db/src/query/ir.ts:73](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L73) #### Overrides diff --git a/docs/reference/@tanstack/namespaces/IR/classes/Func.md b/docs/reference/@tanstack/namespaces/IR/classes/Func.md index 3550d8362..f505ebe21 100644 --- a/docs/reference/@tanstack/namespaces/IR/classes/Func.md +++ b/docs/reference/@tanstack/namespaces/IR/classes/Func.md @@ -5,7 +5,7 @@ title: Func # Class: Func\ -Defined in: [packages/db/src/query/ir.ts:110](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L110) +Defined in: [packages/db/src/query/ir.ts:110](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L110) ## Extends @@ -25,7 +25,7 @@ Defined in: [packages/db/src/query/ir.ts:110](https://github.com/TanStack/db/blo new Func(name, args): Func; ``` -Defined in: [packages/db/src/query/ir.ts:112](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L112) +Defined in: [packages/db/src/query/ir.ts:112](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L112) #### Parameters @@ -55,7 +55,7 @@ BaseExpression.constructor readonly __returnType: T; ``` -Defined in: [packages/db/src/query/ir.ts:69](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L69) +Defined in: [packages/db/src/query/ir.ts:69](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L69) **`Internal`** @@ -75,7 +75,7 @@ BaseExpression.__returnType args: BasicExpression[]; ``` -Defined in: [packages/db/src/query/ir.ts:114](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L114) +Defined in: [packages/db/src/query/ir.ts:114](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L114) *** @@ -85,7 +85,7 @@ Defined in: [packages/db/src/query/ir.ts:114](https://github.com/TanStack/db/blo name: string; ``` -Defined in: [packages/db/src/query/ir.ts:113](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L113) +Defined in: [packages/db/src/query/ir.ts:113](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L113) *** @@ -95,7 +95,7 @@ Defined in: [packages/db/src/query/ir.ts:113](https://github.com/TanStack/db/blo type: "func"; ``` -Defined in: [packages/db/src/query/ir.ts:111](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L111) +Defined in: [packages/db/src/query/ir.ts:111](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L111) #### Overrides diff --git a/docs/reference/@tanstack/namespaces/IR/classes/PropRef.md b/docs/reference/@tanstack/namespaces/IR/classes/PropRef.md index ac7bfd418..e4f7512c4 100644 --- a/docs/reference/@tanstack/namespaces/IR/classes/PropRef.md +++ b/docs/reference/@tanstack/namespaces/IR/classes/PropRef.md @@ -5,7 +5,7 @@ title: PropRef # Class: PropRef\ -Defined in: [packages/db/src/query/ir.ts:92](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L92) +Defined in: [packages/db/src/query/ir.ts:92](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L92) ## Extends @@ -25,7 +25,7 @@ Defined in: [packages/db/src/query/ir.ts:92](https://github.com/TanStack/db/blob new PropRef(path): PropRef; ``` -Defined in: [packages/db/src/query/ir.ts:94](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L94) +Defined in: [packages/db/src/query/ir.ts:94](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L94) #### Parameters @@ -51,7 +51,7 @@ BaseExpression.constructor readonly __returnType: T; ``` -Defined in: [packages/db/src/query/ir.ts:69](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L69) +Defined in: [packages/db/src/query/ir.ts:69](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L69) **`Internal`** @@ -71,7 +71,7 @@ BaseExpression.__returnType path: string[]; ``` -Defined in: [packages/db/src/query/ir.ts:95](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L95) +Defined in: [packages/db/src/query/ir.ts:95](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L95) *** @@ -81,7 +81,7 @@ Defined in: [packages/db/src/query/ir.ts:95](https://github.com/TanStack/db/blob type: "ref"; ``` -Defined in: [packages/db/src/query/ir.ts:93](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L93) +Defined in: [packages/db/src/query/ir.ts:93](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L93) #### Overrides diff --git a/docs/reference/@tanstack/namespaces/IR/classes/QueryRef.md b/docs/reference/@tanstack/namespaces/IR/classes/QueryRef.md index 6650b0389..a76ffb3b0 100644 --- a/docs/reference/@tanstack/namespaces/IR/classes/QueryRef.md +++ b/docs/reference/@tanstack/namespaces/IR/classes/QueryRef.md @@ -5,7 +5,7 @@ title: QueryRef # Class: QueryRef -Defined in: [packages/db/src/query/ir.ts:82](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L82) +Defined in: [packages/db/src/query/ir.ts:82](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L82) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/query/ir.ts:82](https://github.com/TanStack/db/blob new QueryRef(query, alias): QueryRef; ``` -Defined in: [packages/db/src/query/ir.ts:84](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L84) +Defined in: [packages/db/src/query/ir.ts:84](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L84) #### Parameters @@ -49,7 +49,7 @@ BaseExpression.constructor readonly __returnType: any; ``` -Defined in: [packages/db/src/query/ir.ts:69](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L69) +Defined in: [packages/db/src/query/ir.ts:69](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L69) **`Internal`** @@ -69,7 +69,7 @@ BaseExpression.__returnType alias: string; ``` -Defined in: [packages/db/src/query/ir.ts:86](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L86) +Defined in: [packages/db/src/query/ir.ts:86](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L86) *** @@ -79,7 +79,7 @@ Defined in: [packages/db/src/query/ir.ts:86](https://github.com/TanStack/db/blob query: QueryIR; ``` -Defined in: [packages/db/src/query/ir.ts:85](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L85) +Defined in: [packages/db/src/query/ir.ts:85](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L85) *** @@ -89,7 +89,7 @@ Defined in: [packages/db/src/query/ir.ts:85](https://github.com/TanStack/db/blob type: "queryRef"; ``` -Defined in: [packages/db/src/query/ir.ts:83](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L83) +Defined in: [packages/db/src/query/ir.ts:83](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L83) #### Overrides diff --git a/docs/reference/@tanstack/namespaces/IR/classes/Value.md b/docs/reference/@tanstack/namespaces/IR/classes/Value.md index 448308304..e5eb0194b 100644 --- a/docs/reference/@tanstack/namespaces/IR/classes/Value.md +++ b/docs/reference/@tanstack/namespaces/IR/classes/Value.md @@ -5,7 +5,7 @@ title: Value # Class: Value\ -Defined in: [packages/db/src/query/ir.ts:101](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L101) +Defined in: [packages/db/src/query/ir.ts:101](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L101) ## Extends @@ -25,7 +25,7 @@ Defined in: [packages/db/src/query/ir.ts:101](https://github.com/TanStack/db/blo new Value(value): Value; ``` -Defined in: [packages/db/src/query/ir.ts:103](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L103) +Defined in: [packages/db/src/query/ir.ts:103](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L103) #### Parameters @@ -51,7 +51,7 @@ BaseExpression.constructor readonly __returnType: T; ``` -Defined in: [packages/db/src/query/ir.ts:69](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L69) +Defined in: [packages/db/src/query/ir.ts:69](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L69) **`Internal`** @@ -71,7 +71,7 @@ BaseExpression.__returnType type: "val"; ``` -Defined in: [packages/db/src/query/ir.ts:102](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L102) +Defined in: [packages/db/src/query/ir.ts:102](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L102) #### Overrides @@ -87,4 +87,4 @@ BaseExpression.type value: T; ``` -Defined in: [packages/db/src/query/ir.ts:104](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L104) +Defined in: [packages/db/src/query/ir.ts:104](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L104) diff --git a/docs/reference/@tanstack/namespaces/IR/functions/createResidualWhere.md b/docs/reference/@tanstack/namespaces/IR/functions/createResidualWhere.md index 05ed3ea3d..2b6d3c176 100644 --- a/docs/reference/@tanstack/namespaces/IR/functions/createResidualWhere.md +++ b/docs/reference/@tanstack/namespaces/IR/functions/createResidualWhere.md @@ -9,7 +9,7 @@ title: createResidualWhere function createResidualWhere(expression): Where; ``` -Defined in: [packages/db/src/query/ir.ts:187](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L187) +Defined in: [packages/db/src/query/ir.ts:187](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L187) Create a residual Where clause from an expression diff --git a/docs/reference/@tanstack/namespaces/IR/functions/followRef.md b/docs/reference/@tanstack/namespaces/IR/functions/followRef.md index 8b1fca465..68e78eefc 100644 --- a/docs/reference/@tanstack/namespaces/IR/functions/followRef.md +++ b/docs/reference/@tanstack/namespaces/IR/functions/followRef.md @@ -17,7 +17,7 @@ function followRef( }; ``` -Defined in: [packages/db/src/query/ir.ts:213](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L213) +Defined in: [packages/db/src/query/ir.ts:213](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L213) Follows the given reference in a query until its finds the root field the reference points to. diff --git a/docs/reference/@tanstack/namespaces/IR/functions/getHavingExpression.md b/docs/reference/@tanstack/namespaces/IR/functions/getHavingExpression.md index 0fe5ee30c..d81787f78 100644 --- a/docs/reference/@tanstack/namespaces/IR/functions/getHavingExpression.md +++ b/docs/reference/@tanstack/namespaces/IR/functions/getHavingExpression.md @@ -11,7 +11,7 @@ function getHavingExpression(having): | BasicExpression; ``` -Defined in: [packages/db/src/query/ir.ts:165](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L165) +Defined in: [packages/db/src/query/ir.ts:165](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L165) Extract the expression from a HAVING clause HAVING clauses can contain aggregates, unlike regular WHERE clauses diff --git a/docs/reference/@tanstack/namespaces/IR/functions/getWhereExpression.md b/docs/reference/@tanstack/namespaces/IR/functions/getWhereExpression.md index fbc8b9808..915fc9689 100644 --- a/docs/reference/@tanstack/namespaces/IR/functions/getWhereExpression.md +++ b/docs/reference/@tanstack/namespaces/IR/functions/getWhereExpression.md @@ -9,7 +9,7 @@ title: getWhereExpression function getWhereExpression(where): BasicExpression; ``` -Defined in: [packages/db/src/query/ir.ts:155](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L155) +Defined in: [packages/db/src/query/ir.ts:155](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L155) Extract the expression from a Where clause diff --git a/docs/reference/@tanstack/namespaces/IR/functions/isExpressionLike.md b/docs/reference/@tanstack/namespaces/IR/functions/isExpressionLike.md index a9e580e1a..3e2273556 100644 --- a/docs/reference/@tanstack/namespaces/IR/functions/isExpressionLike.md +++ b/docs/reference/@tanstack/namespaces/IR/functions/isExpressionLike.md @@ -9,7 +9,7 @@ title: isExpressionLike function isExpressionLike(value): boolean; ``` -Defined in: [packages/db/src/query/ir.ts:139](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L139) +Defined in: [packages/db/src/query/ir.ts:139](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L139) Runtime helper to detect IR expression-like objects. Prefer this over ad-hoc local implementations to keep behavior consistent. diff --git a/docs/reference/@tanstack/namespaces/IR/functions/isResidualWhere.md b/docs/reference/@tanstack/namespaces/IR/functions/isResidualWhere.md index 3b433feff..242bce018 100644 --- a/docs/reference/@tanstack/namespaces/IR/functions/isResidualWhere.md +++ b/docs/reference/@tanstack/namespaces/IR/functions/isResidualWhere.md @@ -9,7 +9,7 @@ title: isResidualWhere function isResidualWhere(where): boolean; ``` -Defined in: [packages/db/src/query/ir.ts:176](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L176) +Defined in: [packages/db/src/query/ir.ts:176](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L176) Check if a Where clause is marked as residual diff --git a/docs/reference/@tanstack/namespaces/IR/interfaces/JoinClause.md b/docs/reference/@tanstack/namespaces/IR/interfaces/JoinClause.md index 0ba211c77..86658bc58 100644 --- a/docs/reference/@tanstack/namespaces/IR/interfaces/JoinClause.md +++ b/docs/reference/@tanstack/namespaces/IR/interfaces/JoinClause.md @@ -5,7 +5,7 @@ title: JoinClause # Interface: JoinClause -Defined in: [packages/db/src/query/ir.ts:36](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L36) +Defined in: [packages/db/src/query/ir.ts:36](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L36) ## Properties @@ -17,7 +17,7 @@ from: | QueryRef; ``` -Defined in: [packages/db/src/query/ir.ts:37](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L37) +Defined in: [packages/db/src/query/ir.ts:37](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L37) *** @@ -27,7 +27,7 @@ Defined in: [packages/db/src/query/ir.ts:37](https://github.com/TanStack/db/blob left: BasicExpression; ``` -Defined in: [packages/db/src/query/ir.ts:39](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L39) +Defined in: [packages/db/src/query/ir.ts:39](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L39) *** @@ -37,7 +37,7 @@ Defined in: [packages/db/src/query/ir.ts:39](https://github.com/TanStack/db/blob right: BasicExpression; ``` -Defined in: [packages/db/src/query/ir.ts:40](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L40) +Defined in: [packages/db/src/query/ir.ts:40](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L40) *** @@ -47,4 +47,4 @@ Defined in: [packages/db/src/query/ir.ts:40](https://github.com/TanStack/db/blob type: "inner" | "left" | "right" | "full" | "outer" | "cross"; ``` -Defined in: [packages/db/src/query/ir.ts:38](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L38) +Defined in: [packages/db/src/query/ir.ts:38](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L38) diff --git a/docs/reference/@tanstack/namespaces/IR/interfaces/QueryIR.md b/docs/reference/@tanstack/namespaces/IR/interfaces/QueryIR.md index 835f2b562..73796bcec 100644 --- a/docs/reference/@tanstack/namespaces/IR/interfaces/QueryIR.md +++ b/docs/reference/@tanstack/namespaces/IR/interfaces/QueryIR.md @@ -5,7 +5,7 @@ title: QueryIR # Interface: QueryIR -Defined in: [packages/db/src/query/ir.ts:9](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L9) +Defined in: [packages/db/src/query/ir.ts:9](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L9) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/db/src/query/ir.ts:9](https://github.com/TanStack/db/blob/ optional distinct: true; ``` -Defined in: [packages/db/src/query/ir.ts:19](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L19) +Defined in: [packages/db/src/query/ir.ts:19](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L19) *** @@ -25,7 +25,7 @@ Defined in: [packages/db/src/query/ir.ts:19](https://github.com/TanStack/db/blob optional fnHaving: (row) => any[]; ``` -Defined in: [packages/db/src/query/ir.ts:25](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L25) +Defined in: [packages/db/src/query/ir.ts:25](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L25) #### Parameters @@ -45,7 +45,7 @@ Defined in: [packages/db/src/query/ir.ts:25](https://github.com/TanStack/db/blob optional fnSelect: (row) => any; ``` -Defined in: [packages/db/src/query/ir.ts:23](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L23) +Defined in: [packages/db/src/query/ir.ts:23](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L23) #### Parameters @@ -65,7 +65,7 @@ Defined in: [packages/db/src/query/ir.ts:23](https://github.com/TanStack/db/blob optional fnWhere: (row) => any[]; ``` -Defined in: [packages/db/src/query/ir.ts:24](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L24) +Defined in: [packages/db/src/query/ir.ts:24](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L24) #### Parameters @@ -85,7 +85,7 @@ Defined in: [packages/db/src/query/ir.ts:24](https://github.com/TanStack/db/blob from: From; ``` -Defined in: [packages/db/src/query/ir.ts:10](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L10) +Defined in: [packages/db/src/query/ir.ts:10](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L10) *** @@ -95,7 +95,7 @@ Defined in: [packages/db/src/query/ir.ts:10](https://github.com/TanStack/db/blob optional groupBy: GroupBy; ``` -Defined in: [packages/db/src/query/ir.ts:14](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L14) +Defined in: [packages/db/src/query/ir.ts:14](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L14) *** @@ -105,7 +105,7 @@ Defined in: [packages/db/src/query/ir.ts:14](https://github.com/TanStack/db/blob optional having: Where[]; ``` -Defined in: [packages/db/src/query/ir.ts:15](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L15) +Defined in: [packages/db/src/query/ir.ts:15](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L15) *** @@ -115,7 +115,7 @@ Defined in: [packages/db/src/query/ir.ts:15](https://github.com/TanStack/db/blob optional join: Join; ``` -Defined in: [packages/db/src/query/ir.ts:12](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L12) +Defined in: [packages/db/src/query/ir.ts:12](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L12) *** @@ -125,7 +125,7 @@ Defined in: [packages/db/src/query/ir.ts:12](https://github.com/TanStack/db/blob optional limit: number; ``` -Defined in: [packages/db/src/query/ir.ts:17](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L17) +Defined in: [packages/db/src/query/ir.ts:17](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L17) *** @@ -135,7 +135,7 @@ Defined in: [packages/db/src/query/ir.ts:17](https://github.com/TanStack/db/blob optional offset: number; ``` -Defined in: [packages/db/src/query/ir.ts:18](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L18) +Defined in: [packages/db/src/query/ir.ts:18](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L18) *** @@ -145,7 +145,7 @@ Defined in: [packages/db/src/query/ir.ts:18](https://github.com/TanStack/db/blob optional orderBy: OrderBy; ``` -Defined in: [packages/db/src/query/ir.ts:16](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L16) +Defined in: [packages/db/src/query/ir.ts:16](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L16) *** @@ -155,7 +155,7 @@ Defined in: [packages/db/src/query/ir.ts:16](https://github.com/TanStack/db/blob optional select: Select; ``` -Defined in: [packages/db/src/query/ir.ts:11](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L11) +Defined in: [packages/db/src/query/ir.ts:11](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L11) *** @@ -165,7 +165,7 @@ Defined in: [packages/db/src/query/ir.ts:11](https://github.com/TanStack/db/blob optional singleResult: true; ``` -Defined in: [packages/db/src/query/ir.ts:20](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L20) +Defined in: [packages/db/src/query/ir.ts:20](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L20) *** @@ -175,4 +175,4 @@ Defined in: [packages/db/src/query/ir.ts:20](https://github.com/TanStack/db/blob optional where: Where[]; ``` -Defined in: [packages/db/src/query/ir.ts:13](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L13) +Defined in: [packages/db/src/query/ir.ts:13](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L13) diff --git a/docs/reference/@tanstack/namespaces/IR/type-aliases/BasicExpression.md b/docs/reference/@tanstack/namespaces/IR/type-aliases/BasicExpression.md index 8621d0743..edc18ab88 100644 --- a/docs/reference/@tanstack/namespaces/IR/type-aliases/BasicExpression.md +++ b/docs/reference/@tanstack/namespaces/IR/type-aliases/BasicExpression.md @@ -12,7 +12,7 @@ type BasicExpression = | Func; ``` -Defined in: [packages/db/src/query/ir.ts:123](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L123) +Defined in: [packages/db/src/query/ir.ts:123](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L123) ## Type Parameters diff --git a/docs/reference/@tanstack/namespaces/IR/type-aliases/From.md b/docs/reference/@tanstack/namespaces/IR/type-aliases/From.md index 53396c221..9e5ebf452 100644 --- a/docs/reference/@tanstack/namespaces/IR/type-aliases/From.md +++ b/docs/reference/@tanstack/namespaces/IR/type-aliases/From.md @@ -11,4 +11,4 @@ type From = | QueryRef; ``` -Defined in: [packages/db/src/query/ir.ts:28](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L28) +Defined in: [packages/db/src/query/ir.ts:28](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L28) diff --git a/docs/reference/@tanstack/namespaces/IR/type-aliases/GroupBy.md b/docs/reference/@tanstack/namespaces/IR/type-aliases/GroupBy.md index 71426706e..28425f1f4 100644 --- a/docs/reference/@tanstack/namespaces/IR/type-aliases/GroupBy.md +++ b/docs/reference/@tanstack/namespaces/IR/type-aliases/GroupBy.md @@ -9,4 +9,4 @@ title: GroupBy type GroupBy = BasicExpression[]; ``` -Defined in: [packages/db/src/query/ir.ts:47](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L47) +Defined in: [packages/db/src/query/ir.ts:47](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L47) diff --git a/docs/reference/@tanstack/namespaces/IR/type-aliases/Having.md b/docs/reference/@tanstack/namespaces/IR/type-aliases/Having.md index 7c101b514..8e3e9fc18 100644 --- a/docs/reference/@tanstack/namespaces/IR/type-aliases/Having.md +++ b/docs/reference/@tanstack/namespaces/IR/type-aliases/Having.md @@ -9,4 +9,4 @@ title: Having type Having = Where; ``` -Defined in: [packages/db/src/query/ir.ts:49](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L49) +Defined in: [packages/db/src/query/ir.ts:49](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L49) diff --git a/docs/reference/@tanstack/namespaces/IR/type-aliases/Join.md b/docs/reference/@tanstack/namespaces/IR/type-aliases/Join.md index f05df96fd..8000a1c83 100644 --- a/docs/reference/@tanstack/namespaces/IR/type-aliases/Join.md +++ b/docs/reference/@tanstack/namespaces/IR/type-aliases/Join.md @@ -9,4 +9,4 @@ title: Join type Join = JoinClause[]; ``` -Defined in: [packages/db/src/query/ir.ts:34](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L34) +Defined in: [packages/db/src/query/ir.ts:34](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L34) diff --git a/docs/reference/@tanstack/namespaces/IR/type-aliases/Limit.md b/docs/reference/@tanstack/namespaces/IR/type-aliases/Limit.md index fd93855d3..03a70bbf2 100644 --- a/docs/reference/@tanstack/namespaces/IR/type-aliases/Limit.md +++ b/docs/reference/@tanstack/namespaces/IR/type-aliases/Limit.md @@ -9,4 +9,4 @@ title: Limit type Limit = number; ``` -Defined in: [packages/db/src/query/ir.ts:60](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L60) +Defined in: [packages/db/src/query/ir.ts:60](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L60) diff --git a/docs/reference/@tanstack/namespaces/IR/type-aliases/Offset.md b/docs/reference/@tanstack/namespaces/IR/type-aliases/Offset.md index eeb67a560..1b1317a7f 100644 --- a/docs/reference/@tanstack/namespaces/IR/type-aliases/Offset.md +++ b/docs/reference/@tanstack/namespaces/IR/type-aliases/Offset.md @@ -9,4 +9,4 @@ title: Offset type Offset = number; ``` -Defined in: [packages/db/src/query/ir.ts:62](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L62) +Defined in: [packages/db/src/query/ir.ts:62](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L62) diff --git a/docs/reference/@tanstack/namespaces/IR/type-aliases/OrderBy.md b/docs/reference/@tanstack/namespaces/IR/type-aliases/OrderBy.md index af3fac551..f78efe344 100644 --- a/docs/reference/@tanstack/namespaces/IR/type-aliases/OrderBy.md +++ b/docs/reference/@tanstack/namespaces/IR/type-aliases/OrderBy.md @@ -9,4 +9,4 @@ title: OrderBy type OrderBy = OrderByClause[]; ``` -Defined in: [packages/db/src/query/ir.ts:51](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L51) +Defined in: [packages/db/src/query/ir.ts:51](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L51) diff --git a/docs/reference/@tanstack/namespaces/IR/type-aliases/OrderByClause.md b/docs/reference/@tanstack/namespaces/IR/type-aliases/OrderByClause.md index 98ea1969e..78a66ffd7 100644 --- a/docs/reference/@tanstack/namespaces/IR/type-aliases/OrderByClause.md +++ b/docs/reference/@tanstack/namespaces/IR/type-aliases/OrderByClause.md @@ -9,7 +9,7 @@ title: OrderByClause type OrderByClause = object; ``` -Defined in: [packages/db/src/query/ir.ts:53](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L53) +Defined in: [packages/db/src/query/ir.ts:53](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L53) ## Properties @@ -19,7 +19,7 @@ Defined in: [packages/db/src/query/ir.ts:53](https://github.com/TanStack/db/blob compareOptions: CompareOptions; ``` -Defined in: [packages/db/src/query/ir.ts:55](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L55) +Defined in: [packages/db/src/query/ir.ts:55](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L55) *** @@ -29,4 +29,4 @@ Defined in: [packages/db/src/query/ir.ts:55](https://github.com/TanStack/db/blob expression: BasicExpression; ``` -Defined in: [packages/db/src/query/ir.ts:54](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L54) +Defined in: [packages/db/src/query/ir.ts:54](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L54) diff --git a/docs/reference/@tanstack/namespaces/IR/type-aliases/OrderByDirection.md b/docs/reference/@tanstack/namespaces/IR/type-aliases/OrderByDirection.md index 043ef946d..003b4ea2e 100644 --- a/docs/reference/@tanstack/namespaces/IR/type-aliases/OrderByDirection.md +++ b/docs/reference/@tanstack/namespaces/IR/type-aliases/OrderByDirection.md @@ -9,4 +9,4 @@ title: OrderByDirection type OrderByDirection = "asc" | "desc"; ``` -Defined in: [packages/db/src/query/ir.ts:58](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L58) +Defined in: [packages/db/src/query/ir.ts:58](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L58) diff --git a/docs/reference/@tanstack/namespaces/IR/type-aliases/Select.md b/docs/reference/@tanstack/namespaces/IR/type-aliases/Select.md index 1bf77381f..d983f58ba 100644 --- a/docs/reference/@tanstack/namespaces/IR/type-aliases/Select.md +++ b/docs/reference/@tanstack/namespaces/IR/type-aliases/Select.md @@ -9,7 +9,7 @@ title: Select type Select = object; ``` -Defined in: [packages/db/src/query/ir.ts:30](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L30) +Defined in: [packages/db/src/query/ir.ts:30](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L30) ## Index Signature diff --git a/docs/reference/@tanstack/namespaces/IR/type-aliases/Where.md b/docs/reference/@tanstack/namespaces/IR/type-aliases/Where.md index ac22debbd..e410232ac 100644 --- a/docs/reference/@tanstack/namespaces/IR/type-aliases/Where.md +++ b/docs/reference/@tanstack/namespaces/IR/type-aliases/Where.md @@ -14,4 +14,4 @@ type Where = }; ``` -Defined in: [packages/db/src/query/ir.ts:43](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L43) +Defined in: [packages/db/src/query/ir.ts:43](https://github.com/MAST1999/db/blob/main/packages/db/src/query/ir.ts#L43) diff --git a/docs/reference/classes/AggregateFunctionNotInSelectError.md b/docs/reference/classes/AggregateFunctionNotInSelectError.md index d4d41540e..1348d9d39 100644 --- a/docs/reference/classes/AggregateFunctionNotInSelectError.md +++ b/docs/reference/classes/AggregateFunctionNotInSelectError.md @@ -5,7 +5,7 @@ title: AggregateFunctionNotInSelectError # Class: AggregateFunctionNotInSelectError -Defined in: [packages/db/src/errors.ts:556](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L556) +Defined in: [packages/db/src/errors.ts:556](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L556) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:556](https://github.com/TanStack/db/blob/ new AggregateFunctionNotInSelectError(functionName): AggregateFunctionNotInSelectError; ``` -Defined in: [packages/db/src/errors.ts:557](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L557) +Defined in: [packages/db/src/errors.ts:557](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L557) #### Parameters diff --git a/docs/reference/classes/AggregateNotSupportedError.md b/docs/reference/classes/AggregateNotSupportedError.md index a880fa93a..4c9e8d0a1 100644 --- a/docs/reference/classes/AggregateNotSupportedError.md +++ b/docs/reference/classes/AggregateNotSupportedError.md @@ -5,7 +5,7 @@ title: AggregateNotSupportedError # Class: AggregateNotSupportedError -Defined in: [packages/db/src/errors.ts:672](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L672) +Defined in: [packages/db/src/errors.ts:672](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L672) Error thrown when aggregate expressions are used outside of a GROUP BY context. @@ -21,7 +21,7 @@ Error thrown when aggregate expressions are used outside of a GROUP BY context. new AggregateNotSupportedError(): AggregateNotSupportedError; ``` -Defined in: [packages/db/src/errors.ts:673](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L673) +Defined in: [packages/db/src/errors.ts:673](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L673) #### Returns diff --git a/docs/reference/classes/BTreeIndex.md b/docs/reference/classes/BTreeIndex.md index fe55cef10..623d3b162 100644 --- a/docs/reference/classes/BTreeIndex.md +++ b/docs/reference/classes/BTreeIndex.md @@ -5,7 +5,7 @@ title: BTreeIndex # Class: BTreeIndex\ -Defined in: [packages/db/src/indexes/btree-index.ts:30](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L30) +Defined in: [packages/db/src/indexes/btree-index.ts:30](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L30) B+Tree index for sorted data with range queries This maintains items in sorted order and provides efficient range operations @@ -32,7 +32,7 @@ new BTreeIndex( options?): BTreeIndex; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:50](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L50) +Defined in: [packages/db/src/indexes/btree-index.ts:50](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L50) #### Parameters @@ -68,7 +68,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:50](https://github.com/TanSt protected compareOptions: CompareOptions; ``` -Defined in: [packages/db/src/indexes/base-index.ts:87](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L87) +Defined in: [packages/db/src/indexes/base-index.ts:87](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L87) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:87](https://github.com/TanSta readonly expression: BasicExpression; ``` -Defined in: [packages/db/src/indexes/base-index.ts:81](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L81) +Defined in: [packages/db/src/indexes/base-index.ts:81](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L81) #### Inherited from @@ -96,7 +96,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:81](https://github.com/TanSta readonly id: number; ``` -Defined in: [packages/db/src/indexes/base-index.ts:79](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L79) +Defined in: [packages/db/src/indexes/base-index.ts:79](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L79) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:79](https://github.com/TanSta protected lastUpdated: Date; ``` -Defined in: [packages/db/src/indexes/base-index.ts:86](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L86) +Defined in: [packages/db/src/indexes/base-index.ts:86](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L86) #### Inherited from @@ -124,7 +124,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:86](https://github.com/TanSta protected lookupCount: number = 0; ``` -Defined in: [packages/db/src/indexes/base-index.ts:84](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L84) +Defined in: [packages/db/src/indexes/base-index.ts:84](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L84) #### Inherited from @@ -138,7 +138,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:84](https://github.com/TanSta readonly optional name: string; ``` -Defined in: [packages/db/src/indexes/base-index.ts:80](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L80) +Defined in: [packages/db/src/indexes/base-index.ts:80](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L80) #### Inherited from @@ -152,7 +152,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:80](https://github.com/TanSta readonly supportedOperations: Set<"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike">; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:33](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L33) +Defined in: [packages/db/src/indexes/btree-index.ts:33](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L33) #### Overrides @@ -166,7 +166,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:33](https://github.com/TanSt protected totalLookupTime: number = 0; ``` -Defined in: [packages/db/src/indexes/base-index.ts:85](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L85) +Defined in: [packages/db/src/indexes/base-index.ts:85](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L85) #### Inherited from @@ -182,7 +182,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:85](https://github.com/TanSta get indexedKeysSet(): Set; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:333](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L333) +Defined in: [packages/db/src/indexes/btree-index.ts:333](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L333) ##### Returns @@ -202,7 +202,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:333](https://github.com/TanS get keyCount(): number; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:199](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L199) +Defined in: [packages/db/src/indexes/btree-index.ts:199](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L199) Gets the number of indexed keys @@ -224,7 +224,7 @@ Gets the number of indexed keys get orderedEntriesArray(): [any, Set][]; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:337](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L337) +Defined in: [packages/db/src/indexes/btree-index.ts:337](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L337) ##### Returns @@ -244,7 +244,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:337](https://github.com/TanS get orderedEntriesArrayReversed(): [any, Set][]; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:343](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L343) +Defined in: [packages/db/src/indexes/btree-index.ts:343](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L343) ##### Returns @@ -264,7 +264,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:343](https://github.com/TanS get valueMapData(): Map>; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:350](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L350) +Defined in: [packages/db/src/indexes/btree-index.ts:350](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L350) ##### Returns @@ -282,7 +282,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:350](https://github.com/TanS add(key, item): void; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:69](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L69) +Defined in: [packages/db/src/indexes/btree-index.ts:69](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L69) Adds a value to the index @@ -312,7 +312,7 @@ Adds a value to the index build(entries): void; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:143](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L143) +Defined in: [packages/db/src/indexes/btree-index.ts:143](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L143) Builds the index from a collection of entries @@ -338,7 +338,7 @@ Builds the index from a collection of entries clear(): void; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:154](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L154) +Defined in: [packages/db/src/indexes/btree-index.ts:154](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L154) Clears all data from the index @@ -358,7 +358,7 @@ Clears all data from the index equalityLookup(value): Set; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:208](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L208) +Defined in: [packages/db/src/indexes/btree-index.ts:208](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L208) Performs an equality lookup @@ -384,7 +384,7 @@ Performs an equality lookup protected evaluateIndexExpression(item): any; ``` -Defined in: [packages/db/src/indexes/base-index.ts:182](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L182) +Defined in: [packages/db/src/indexes/base-index.ts:182](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L182) #### Parameters @@ -408,7 +408,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:182](https://github.com/TanSt getStats(): IndexStats; ``` -Defined in: [packages/db/src/indexes/base-index.ts:169](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L169) +Defined in: [packages/db/src/indexes/base-index.ts:169](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L169) #### Returns @@ -426,7 +426,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:169](https://github.com/TanSt inArrayLookup(values): Set; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:318](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L318) +Defined in: [packages/db/src/indexes/btree-index.ts:318](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L318) Performs an IN array lookup @@ -452,7 +452,7 @@ Performs an IN array lookup protected initialize(_options?): void; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:64](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L64) +Defined in: [packages/db/src/indexes/btree-index.ts:64](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L64) #### Parameters @@ -476,7 +476,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:64](https://github.com/TanSt lookup(operation, value): Set; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:164](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L164) +Defined in: [packages/db/src/indexes/btree-index.ts:164](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L164) Performs a lookup operation @@ -506,7 +506,7 @@ Performs a lookup operation matchesCompareOptions(compareOptions): boolean; ``` -Defined in: [packages/db/src/indexes/base-index.ts:146](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L146) +Defined in: [packages/db/src/indexes/base-index.ts:146](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L146) Checks if the compare options match the index's compare options. The direction is ignored because the index can be reversed if the direction is different. @@ -533,7 +533,7 @@ The direction is ignored because the index can be reversed if the direction is d matchesDirection(direction): boolean; ``` -Defined in: [packages/db/src/indexes/base-index.ts:165](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L165) +Defined in: [packages/db/src/indexes/base-index.ts:165](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L165) Checks if the index matches the provided direction. @@ -559,7 +559,7 @@ Checks if the index matches the provided direction. matchesField(fieldPath): boolean; ``` -Defined in: [packages/db/src/indexes/base-index.ts:134](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L134) +Defined in: [packages/db/src/indexes/base-index.ts:134](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L134) #### Parameters @@ -583,7 +583,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:134](https://github.com/TanSt rangeQuery(options): Set; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:217](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L217) +Defined in: [packages/db/src/indexes/btree-index.ts:217](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L217) Performs a range query with options This is more efficient for compound queries like "WHERE a > 5 AND a < 10" @@ -610,7 +610,7 @@ This is more efficient for compound queries like "WHERE a > 5 AND a < 10" rangeQueryReversed(options): Set; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:250](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L250) +Defined in: [packages/db/src/indexes/btree-index.ts:250](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L250) Performs a reversed range query @@ -636,7 +636,7 @@ Performs a reversed range query remove(key, item): void; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:100](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L100) +Defined in: [packages/db/src/indexes/btree-index.ts:100](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L100) Removes a value from the index @@ -666,7 +666,7 @@ Removes a value from the index supports(operation): boolean; ``` -Defined in: [packages/db/src/indexes/base-index.ts:130](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L130) +Defined in: [packages/db/src/indexes/base-index.ts:130](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L130) #### Parameters @@ -693,7 +693,7 @@ take( filterFn?): TKey[]; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:295](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L295) +Defined in: [packages/db/src/indexes/btree-index.ts:295](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L295) Returns the next n items after the provided item or the first n items if no from item is provided. @@ -736,7 +736,7 @@ takeReversed( filterFn?): TKey[]; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:306](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L306) +Defined in: [packages/db/src/indexes/btree-index.ts:306](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L306) Returns the next n items **before** the provided item (in descending order) or the last n items if no from item is provided. @@ -776,7 +776,7 @@ The next n items **before** the provided key. Returns the last n items if no fro protected trackLookup(startTime): void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:187](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L187) +Defined in: [packages/db/src/indexes/base-index.ts:187](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L187) #### Parameters @@ -803,7 +803,7 @@ update( newItem): void; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:135](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L135) +Defined in: [packages/db/src/indexes/btree-index.ts:135](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L135) Updates a value in the index @@ -837,7 +837,7 @@ Updates a value in the index protected updateTimestamp(): void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:193](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L193) +Defined in: [packages/db/src/indexes/base-index.ts:193](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L193) #### Returns diff --git a/docs/reference/classes/BaseIndex.md b/docs/reference/classes/BaseIndex.md index a1a6434c5..634a58882 100644 --- a/docs/reference/classes/BaseIndex.md +++ b/docs/reference/classes/BaseIndex.md @@ -5,7 +5,7 @@ title: BaseIndex # Abstract Class: BaseIndex\ -Defined in: [packages/db/src/indexes/base-index.ts:76](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L76) +Defined in: [packages/db/src/indexes/base-index.ts:76](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L76) Base abstract class that all index types extend @@ -35,7 +35,7 @@ new BaseIndex( options?): BaseIndex; ``` -Defined in: [packages/db/src/indexes/base-index.ts:89](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L89) +Defined in: [packages/db/src/indexes/base-index.ts:89](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L89) #### Parameters @@ -67,7 +67,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:89](https://github.com/TanSta protected compareOptions: CompareOptions; ``` -Defined in: [packages/db/src/indexes/base-index.ts:87](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L87) +Defined in: [packages/db/src/indexes/base-index.ts:87](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L87) *** @@ -77,7 +77,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:87](https://github.com/TanSta readonly expression: BasicExpression; ``` -Defined in: [packages/db/src/indexes/base-index.ts:81](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L81) +Defined in: [packages/db/src/indexes/base-index.ts:81](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L81) *** @@ -87,7 +87,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:81](https://github.com/TanSta readonly id: number; ``` -Defined in: [packages/db/src/indexes/base-index.ts:79](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L79) +Defined in: [packages/db/src/indexes/base-index.ts:79](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L79) *** @@ -97,7 +97,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:79](https://github.com/TanSta protected lastUpdated: Date; ``` -Defined in: [packages/db/src/indexes/base-index.ts:86](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L86) +Defined in: [packages/db/src/indexes/base-index.ts:86](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L86) *** @@ -107,7 +107,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:86](https://github.com/TanSta protected lookupCount: number = 0; ``` -Defined in: [packages/db/src/indexes/base-index.ts:84](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L84) +Defined in: [packages/db/src/indexes/base-index.ts:84](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L84) *** @@ -117,7 +117,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:84](https://github.com/TanSta readonly optional name: string; ``` -Defined in: [packages/db/src/indexes/base-index.ts:80](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L80) +Defined in: [packages/db/src/indexes/base-index.ts:80](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L80) *** @@ -127,7 +127,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:80](https://github.com/TanSta abstract readonly supportedOperations: Set<"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike">; ``` -Defined in: [packages/db/src/indexes/base-index.ts:82](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L82) +Defined in: [packages/db/src/indexes/base-index.ts:82](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L82) *** @@ -137,7 +137,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:82](https://github.com/TanSta protected totalLookupTime: number = 0; ``` -Defined in: [packages/db/src/indexes/base-index.ts:85](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L85) +Defined in: [packages/db/src/indexes/base-index.ts:85](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L85) ## Accessors @@ -149,7 +149,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:85](https://github.com/TanSta get abstract indexedKeysSet(): Set; ``` -Defined in: [packages/db/src/indexes/base-index.ts:126](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L126) +Defined in: [packages/db/src/indexes/base-index.ts:126](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L126) ##### Returns @@ -169,7 +169,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:126](https://github.com/TanSt get abstract keyCount(): number; ``` -Defined in: [packages/db/src/indexes/base-index.ts:119](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L119) +Defined in: [packages/db/src/indexes/base-index.ts:119](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L119) ##### Returns @@ -189,7 +189,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:119](https://github.com/TanSt get abstract orderedEntriesArray(): [any, Set][]; ``` -Defined in: [packages/db/src/indexes/base-index.ts:124](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L124) +Defined in: [packages/db/src/indexes/base-index.ts:124](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L124) ##### Returns @@ -209,7 +209,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:124](https://github.com/TanSt get abstract orderedEntriesArrayReversed(): [any, Set][]; ``` -Defined in: [packages/db/src/indexes/base-index.ts:125](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L125) +Defined in: [packages/db/src/indexes/base-index.ts:125](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L125) ##### Returns @@ -229,7 +229,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:125](https://github.com/TanSt get abstract valueMapData(): Map>; ``` -Defined in: [packages/db/src/indexes/base-index.ts:127](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L127) +Defined in: [packages/db/src/indexes/base-index.ts:127](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L127) ##### Returns @@ -247,7 +247,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:127](https://github.com/TanSt abstract add(key, item): void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:103](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L103) +Defined in: [packages/db/src/indexes/base-index.ts:103](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L103) #### Parameters @@ -275,7 +275,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:103](https://github.com/TanSt abstract build(entries): void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:106](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L106) +Defined in: [packages/db/src/indexes/base-index.ts:106](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L106) #### Parameters @@ -299,7 +299,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:106](https://github.com/TanSt abstract clear(): void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:107](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L107) +Defined in: [packages/db/src/indexes/base-index.ts:107](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L107) #### Returns @@ -317,7 +317,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:107](https://github.com/TanSt abstract equalityLookup(value): Set; ``` -Defined in: [packages/db/src/indexes/base-index.ts:120](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L120) +Defined in: [packages/db/src/indexes/base-index.ts:120](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L120) #### Parameters @@ -341,7 +341,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:120](https://github.com/TanSt protected evaluateIndexExpression(item): any; ``` -Defined in: [packages/db/src/indexes/base-index.ts:182](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L182) +Defined in: [packages/db/src/indexes/base-index.ts:182](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L182) #### Parameters @@ -361,7 +361,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:182](https://github.com/TanSt getStats(): IndexStats; ``` -Defined in: [packages/db/src/indexes/base-index.ts:169](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L169) +Defined in: [packages/db/src/indexes/base-index.ts:169](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L169) #### Returns @@ -379,7 +379,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:169](https://github.com/TanSt abstract inArrayLookup(values): Set; ``` -Defined in: [packages/db/src/indexes/base-index.ts:121](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L121) +Defined in: [packages/db/src/indexes/base-index.ts:121](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L121) #### Parameters @@ -403,7 +403,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:121](https://github.com/TanSt abstract protected initialize(options?): void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:180](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L180) +Defined in: [packages/db/src/indexes/base-index.ts:180](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L180) #### Parameters @@ -423,7 +423,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:180](https://github.com/TanSt abstract lookup(operation, value): Set; ``` -Defined in: [packages/db/src/indexes/base-index.ts:108](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L108) +Defined in: [packages/db/src/indexes/base-index.ts:108](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L108) #### Parameters @@ -451,7 +451,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:108](https://github.com/TanSt matchesCompareOptions(compareOptions): boolean; ``` -Defined in: [packages/db/src/indexes/base-index.ts:146](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L146) +Defined in: [packages/db/src/indexes/base-index.ts:146](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L146) Checks if the compare options match the index's compare options. The direction is ignored because the index can be reversed if the direction is different. @@ -478,7 +478,7 @@ The direction is ignored because the index can be reversed if the direction is d matchesDirection(direction): boolean; ``` -Defined in: [packages/db/src/indexes/base-index.ts:165](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L165) +Defined in: [packages/db/src/indexes/base-index.ts:165](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L165) Checks if the index matches the provided direction. @@ -504,7 +504,7 @@ Checks if the index matches the provided direction. matchesField(fieldPath): boolean; ``` -Defined in: [packages/db/src/indexes/base-index.ts:134](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L134) +Defined in: [packages/db/src/indexes/base-index.ts:134](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L134) #### Parameters @@ -528,7 +528,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:134](https://github.com/TanSt abstract rangeQuery(options): Set; ``` -Defined in: [packages/db/src/indexes/base-index.ts:122](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L122) +Defined in: [packages/db/src/indexes/base-index.ts:122](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L122) #### Parameters @@ -552,7 +552,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:122](https://github.com/TanSt abstract rangeQueryReversed(options): Set; ``` -Defined in: [packages/db/src/indexes/base-index.ts:123](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L123) +Defined in: [packages/db/src/indexes/base-index.ts:123](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L123) #### Parameters @@ -576,7 +576,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:123](https://github.com/TanSt abstract remove(key, item): void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:104](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L104) +Defined in: [packages/db/src/indexes/base-index.ts:104](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L104) #### Parameters @@ -604,7 +604,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:104](https://github.com/TanSt supports(operation): boolean; ``` -Defined in: [packages/db/src/indexes/base-index.ts:130](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L130) +Defined in: [packages/db/src/indexes/base-index.ts:130](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L130) #### Parameters @@ -631,7 +631,7 @@ abstract take( filterFn?): TKey[]; ``` -Defined in: [packages/db/src/indexes/base-index.ts:109](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L109) +Defined in: [packages/db/src/indexes/base-index.ts:109](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L109) #### Parameters @@ -666,7 +666,7 @@ abstract takeReversed( filterFn?): TKey[]; ``` -Defined in: [packages/db/src/indexes/base-index.ts:114](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L114) +Defined in: [packages/db/src/indexes/base-index.ts:114](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L114) #### Parameters @@ -698,7 +698,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:114](https://github.com/TanSt protected trackLookup(startTime): void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:187](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L187) +Defined in: [packages/db/src/indexes/base-index.ts:187](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L187) #### Parameters @@ -721,7 +721,7 @@ abstract update( newItem): void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:105](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L105) +Defined in: [packages/db/src/indexes/base-index.ts:105](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L105) #### Parameters @@ -753,7 +753,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:105](https://github.com/TanSt protected updateTimestamp(): void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:193](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L193) +Defined in: [packages/db/src/indexes/base-index.ts:193](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L193) #### Returns diff --git a/docs/reference/classes/BaseQueryBuilder.md b/docs/reference/classes/BaseQueryBuilder.md index 7789b52f1..d5be81622 100644 --- a/docs/reference/classes/BaseQueryBuilder.md +++ b/docs/reference/classes/BaseQueryBuilder.md @@ -5,7 +5,7 @@ title: BaseQueryBuilder # Class: BaseQueryBuilder\ -Defined in: [packages/db/src/query/builder/index.ts:47](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L47) +Defined in: [packages/db/src/query/builder/index.ts:47](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L47) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/db/src/query/builder/index.ts:47](https://github.com/TanSt new BaseQueryBuilder(query): BaseQueryBuilder; ``` -Defined in: [packages/db/src/query/builder/index.ts:50](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L50) +Defined in: [packages/db/src/query/builder/index.ts:50](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L50) #### Parameters @@ -43,7 +43,7 @@ Defined in: [packages/db/src/query/builder/index.ts:50](https://github.com/TanSt get fn(): object; ``` -Defined in: [packages/db/src/query/builder/index.ts:698](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L698) +Defined in: [packages/db/src/query/builder/index.ts:698](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L698) Functional variants of the query builder These are imperative function that are called for ery row. @@ -175,7 +175,7 @@ query _getQuery(): QueryIR; ``` -Defined in: [packages/db/src/query/builder/index.ts:784](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L784) +Defined in: [packages/db/src/query/builder/index.ts:784](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L784) #### Returns @@ -189,7 +189,7 @@ Defined in: [packages/db/src/query/builder/index.ts:784](https://github.com/TanS distinct(): QueryBuilder; ``` -Defined in: [packages/db/src/query/builder/index.ts:637](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L637) +Defined in: [packages/db/src/query/builder/index.ts:637](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L637) Specify that the query should return distinct rows. Deduplicates rows based on the selected columns. @@ -218,7 +218,7 @@ query findOne(): QueryBuilder; ``` -Defined in: [packages/db/src/query/builder/index.ts:657](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L657) +Defined in: [packages/db/src/query/builder/index.ts:657](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L657) Specify that the query should return a single result @@ -251,7 +251,7 @@ from(source): QueryBuilder<{ }>; ``` -Defined in: [packages/db/src/query/builder/index.ts:129](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L129) +Defined in: [packages/db/src/query/builder/index.ts:129](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L129) Specify the source table or subquery for the query @@ -299,7 +299,7 @@ query.from({ activeUsers }) fullJoin(source, onCallback): QueryBuilder, "full">>; ``` -Defined in: [packages/db/src/query/builder/index.ts:320](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L320) +Defined in: [packages/db/src/query/builder/index.ts:320](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L320) Perform a FULL JOIN with another table or subquery @@ -346,7 +346,7 @@ query groupBy(callback): QueryBuilder; ``` -Defined in: [packages/db/src/query/builder/index.ts:559](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L559) +Defined in: [packages/db/src/query/builder/index.ts:559](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L559) Group rows by one or more columns for aggregation @@ -395,7 +395,7 @@ query having(callback): QueryBuilder; ``` -Defined in: [packages/db/src/query/builder/index.ts:400](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L400) +Defined in: [packages/db/src/query/builder/index.ts:400](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L400) Filter grouped rows based on aggregate conditions @@ -444,7 +444,7 @@ query innerJoin(source, onCallback): QueryBuilder, "inner">>; ``` -Defined in: [packages/db/src/query/builder/index.ts:294](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L294) +Defined in: [packages/db/src/query/builder/index.ts:294](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L294) Perform an INNER JOIN with another table or subquery @@ -494,7 +494,7 @@ join( type): QueryBuilder, TJoinType>>; ``` -Defined in: [packages/db/src/query/builder/index.ts:172](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L172) +Defined in: [packages/db/src/query/builder/index.ts:172](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L172) Join another table or subquery to the current query @@ -562,7 +562,7 @@ query leftJoin(source, onCallback): QueryBuilder, "left">>; ``` -Defined in: [packages/db/src/query/builder/index.ts:242](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L242) +Defined in: [packages/db/src/query/builder/index.ts:242](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L242) Perform a LEFT JOIN with another table or subquery @@ -609,7 +609,7 @@ query limit(count): QueryBuilder; ``` -Defined in: [packages/db/src/query/builder/index.ts:592](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L592) +Defined in: [packages/db/src/query/builder/index.ts:592](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L592) Limit the number of rows returned by the query `orderBy` is required for `limit` @@ -646,7 +646,7 @@ query offset(count): QueryBuilder; ``` -Defined in: [packages/db/src/query/builder/index.ts:616](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L616) +Defined in: [packages/db/src/query/builder/index.ts:616](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L616) Skip a number of rows before returning results `orderBy` is required for `offset` @@ -684,7 +684,7 @@ query orderBy(callback, options): QueryBuilder; ``` -Defined in: [packages/db/src/query/builder/index.ts:488](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L488) +Defined in: [packages/db/src/query/builder/index.ts:488](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L488) Sort the query results by one or more columns @@ -734,7 +734,7 @@ query rightJoin(source, onCallback): QueryBuilder, "right">>; ``` -Defined in: [packages/db/src/query/builder/index.ts:268](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L268) +Defined in: [packages/db/src/query/builder/index.ts:268](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L268) Perform a RIGHT JOIN with another table or subquery @@ -781,7 +781,7 @@ query select(callback): QueryBuilder>>; ``` -Defined in: [packages/db/src/query/builder/index.ts:447](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L447) +Defined in: [packages/db/src/query/builder/index.ts:447](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L447) Select specific columns or computed values from the query @@ -842,7 +842,7 @@ query where(callback): QueryBuilder; ``` -Defined in: [packages/db/src/query/builder/index.ts:359](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L359) +Defined in: [packages/db/src/query/builder/index.ts:359](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L359) Filter rows based on a condition diff --git a/docs/reference/classes/CannotCombineEmptyExpressionListError.md b/docs/reference/classes/CannotCombineEmptyExpressionListError.md index 93536c9f8..54a6da174 100644 --- a/docs/reference/classes/CannotCombineEmptyExpressionListError.md +++ b/docs/reference/classes/CannotCombineEmptyExpressionListError.md @@ -5,7 +5,7 @@ title: CannotCombineEmptyExpressionListError # Class: CannotCombineEmptyExpressionListError -Defined in: [packages/db/src/errors.ts:635](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L635) +Defined in: [packages/db/src/errors.ts:635](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L635) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:635](https://github.com/TanStack/db/blob/ new CannotCombineEmptyExpressionListError(): CannotCombineEmptyExpressionListError; ``` -Defined in: [packages/db/src/errors.ts:636](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L636) +Defined in: [packages/db/src/errors.ts:636](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L636) #### Returns diff --git a/docs/reference/classes/CollectionConfigurationError.md b/docs/reference/classes/CollectionConfigurationError.md index 2a1d4274f..20cdc2d8d 100644 --- a/docs/reference/classes/CollectionConfigurationError.md +++ b/docs/reference/classes/CollectionConfigurationError.md @@ -5,7 +5,7 @@ title: CollectionConfigurationError # Class: CollectionConfigurationError -Defined in: [packages/db/src/errors.ts:71](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L71) +Defined in: [packages/db/src/errors.ts:71](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L71) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/db/src/errors.ts:71](https://github.com/TanStack/db/blob/m new CollectionConfigurationError(message): CollectionConfigurationError; ``` -Defined in: [packages/db/src/errors.ts:72](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L72) +Defined in: [packages/db/src/errors.ts:72](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L72) #### Parameters diff --git a/docs/reference/classes/CollectionImpl.md b/docs/reference/classes/CollectionImpl.md index 3177f0e93..e760b4837 100644 --- a/docs/reference/classes/CollectionImpl.md +++ b/docs/reference/classes/CollectionImpl.md @@ -5,7 +5,7 @@ title: CollectionImpl # Class: CollectionImpl\ -Defined in: [packages/db/src/collection/index.ts:266](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L266) +Defined in: [packages/db/src/collection/index.ts:266](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L266) ## Extended by @@ -42,7 +42,7 @@ Defined in: [packages/db/src/collection/index.ts:266](https://github.com/TanStac new CollectionImpl(config): CollectionImpl; ``` -Defined in: [packages/db/src/collection/index.ts:305](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L305) +Defined in: [packages/db/src/collection/index.ts:305](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L305) Creates a new Collection instance @@ -70,7 +70,7 @@ Error if sync config is missing _lifecycle: CollectionLifecycleManager; ``` -Defined in: [packages/db/src/collection/index.ts:283](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L283) +Defined in: [packages/db/src/collection/index.ts:283](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L283) *** @@ -80,7 +80,7 @@ Defined in: [packages/db/src/collection/index.ts:283](https://github.com/TanStac _state: CollectionStateManager; ``` -Defined in: [packages/db/src/collection/index.ts:295](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L295) +Defined in: [packages/db/src/collection/index.ts:295](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L295) *** @@ -90,7 +90,7 @@ Defined in: [packages/db/src/collection/index.ts:295](https://github.com/TanStac _sync: CollectionSyncManager; ``` -Defined in: [packages/db/src/collection/index.ts:284](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L284) +Defined in: [packages/db/src/collection/index.ts:284](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L284) *** @@ -100,7 +100,7 @@ Defined in: [packages/db/src/collection/index.ts:284](https://github.com/TanStac config: CollectionConfig; ``` -Defined in: [packages/db/src/collection/index.ts:274](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L274) +Defined in: [packages/db/src/collection/index.ts:274](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L274) *** @@ -110,7 +110,7 @@ Defined in: [packages/db/src/collection/index.ts:274](https://github.com/TanStac id: string; ``` -Defined in: [packages/db/src/collection/index.ts:273](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L273) +Defined in: [packages/db/src/collection/index.ts:273](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L273) *** @@ -120,7 +120,7 @@ Defined in: [packages/db/src/collection/index.ts:273](https://github.com/TanStac utils: Record = {}; ``` -Defined in: [packages/db/src/collection/index.ts:278](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L278) +Defined in: [packages/db/src/collection/index.ts:278](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L278) ## Accessors @@ -132,7 +132,7 @@ Defined in: [packages/db/src/collection/index.ts:278](https://github.com/TanStac get compareOptions(): StringCollationConfig; ``` -Defined in: [packages/db/src/collection/index.ts:579](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L579) +Defined in: [packages/db/src/collection/index.ts:579](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L579) ##### Returns @@ -148,7 +148,7 @@ Defined in: [packages/db/src/collection/index.ts:579](https://github.com/TanStac get indexes(): Map>; ``` -Defined in: [packages/db/src/collection/index.ts:564](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L564) +Defined in: [packages/db/src/collection/index.ts:564](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L564) Get resolved indexes for query optimization @@ -166,7 +166,7 @@ Get resolved indexes for query optimization get isLoadingSubset(): boolean; ``` -Defined in: [packages/db/src/collection/index.ts:430](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L430) +Defined in: [packages/db/src/collection/index.ts:430](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L430) Check if the collection is currently loading more data @@ -186,7 +186,7 @@ true if the collection has pending load more operations, false otherwise get size(): number; ``` -Defined in: [packages/db/src/collection/index.ts:467](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L467) +Defined in: [packages/db/src/collection/index.ts:467](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L467) Get the current size of the collection (cached) @@ -204,7 +204,7 @@ Get the current size of the collection (cached) get state(): Map; ``` -Defined in: [packages/db/src/collection/index.ts:756](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L756) +Defined in: [packages/db/src/collection/index.ts:756](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L756) Gets the current state of the collection as a Map @@ -240,7 +240,7 @@ Map containing all items in the collection, with keys as identifiers get status(): CollectionStatus; ``` -Defined in: [packages/db/src/collection/index.ts:385](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L385) +Defined in: [packages/db/src/collection/index.ts:385](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L385) Gets the current status of the collection @@ -258,7 +258,7 @@ Gets the current status of the collection get subscriberCount(): number; ``` -Defined in: [packages/db/src/collection/index.ts:392](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L392) +Defined in: [packages/db/src/collection/index.ts:392](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L392) Get the number of subscribers to the collection @@ -276,7 +276,7 @@ Get the number of subscribers to the collection get toArray(): TOutput[]; ``` -Defined in: [packages/db/src/collection/index.ts:785](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L785) +Defined in: [packages/db/src/collection/index.ts:785](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L785) Gets the current state of the collection as an Array @@ -294,7 +294,7 @@ An Array containing all items in the collection iterator: IterableIterator<[TKey, TOutput]>; ``` -Defined in: [packages/db/src/collection/index.ts:495](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L495) +Defined in: [packages/db/src/collection/index.ts:495](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L495) Get all entries (virtual derived state) @@ -310,7 +310,7 @@ Get all entries (virtual derived state) cleanup(): Promise; ``` -Defined in: [packages/db/src/collection/index.ts:919](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L919) +Defined in: [packages/db/src/collection/index.ts:919](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L919) Clean up the collection by stopping sync and clearing data This can be called manually or automatically by garbage collection @@ -327,7 +327,7 @@ This can be called manually or automatically by garbage collection createIndex(indexCallback, config): IndexProxy; ``` -Defined in: [packages/db/src/collection/index.ts:554](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L554) +Defined in: [packages/db/src/collection/index.ts:554](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L554) Creates an index on a collection for faster queries. Indexes significantly improve query performance by allowing constant time lookups @@ -397,7 +397,7 @@ currentStateAsChanges(options): | ChangeMessage[]; ``` -Defined in: [packages/db/src/collection/index.ts:823](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L823) +Defined in: [packages/db/src/collection/index.ts:823](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L823) Returns the current state of the collection as an array of changes @@ -441,7 +441,7 @@ const activeChanges = collection.currentStateAsChanges({ delete(keys, config?): Transaction; ``` -Defined in: [packages/db/src/collection/index.ts:733](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L733) +Defined in: [packages/db/src/collection/index.ts:733](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L733) Deletes one or more items from the collection @@ -504,7 +504,7 @@ try { entries(): IterableIterator<[TKey, TOutput]>; ``` -Defined in: [packages/db/src/collection/index.ts:488](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L488) +Defined in: [packages/db/src/collection/index.ts:488](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L488) Get all entries (virtual derived state) @@ -520,7 +520,7 @@ Get all entries (virtual derived state) forEach(callbackfn): void; ``` -Defined in: [packages/db/src/collection/index.ts:502](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L502) +Defined in: [packages/db/src/collection/index.ts:502](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L502) Execute a callback for each entry in the collection @@ -542,7 +542,7 @@ Execute a callback for each entry in the collection get(key): TOutput | undefined; ``` -Defined in: [packages/db/src/collection/index.ts:453](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L453) +Defined in: [packages/db/src/collection/index.ts:453](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L453) Get the current value for a key (virtual derived state) @@ -564,7 +564,7 @@ Get the current value for a key (virtual derived state) getKeyFromItem(item): TKey; ``` -Defined in: [packages/db/src/collection/index.ts:517](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L517) +Defined in: [packages/db/src/collection/index.ts:517](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L517) #### Parameters @@ -584,7 +584,7 @@ Defined in: [packages/db/src/collection/index.ts:517](https://github.com/TanStac has(key): boolean; ``` -Defined in: [packages/db/src/collection/index.ts:460](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L460) +Defined in: [packages/db/src/collection/index.ts:460](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L460) Check if a key exists in the collection (virtual derived state) @@ -608,7 +608,7 @@ insert(data, config?): | Transaction; ``` -Defined in: [packages/db/src/collection/index.ts:620](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L620) +Defined in: [packages/db/src/collection/index.ts:620](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L620) Inserts one or more items into the collection @@ -679,7 +679,7 @@ try { isReady(): boolean; ``` -Defined in: [packages/db/src/collection/index.ts:422](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L422) +Defined in: [packages/db/src/collection/index.ts:422](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L422) Check if the collection is ready for use Returns true if the collection has been marked as ready by its sync implementation @@ -709,7 +709,7 @@ if (collection.isReady()) { keys(): IterableIterator; ``` -Defined in: [packages/db/src/collection/index.ts:474](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L474) +Defined in: [packages/db/src/collection/index.ts:474](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L474) Get all keys (virtual derived state) @@ -725,7 +725,7 @@ Get all keys (virtual derived state) map(callbackfn): U[]; ``` -Defined in: [packages/db/src/collection/index.ts:511](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L511) +Defined in: [packages/db/src/collection/index.ts:511](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L511) Create a new array with the results of calling a function for each entry in the collection @@ -753,7 +753,7 @@ Create a new array with the results of calling a function for each entry in the off(event, callback): void; ``` -Defined in: [packages/db/src/collection/index.ts:898](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L898) +Defined in: [packages/db/src/collection/index.ts:898](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L898) Unsubscribe from a collection event @@ -793,7 +793,7 @@ Unsubscribe from a collection event on(event, callback): () => void; ``` -Defined in: [packages/db/src/collection/index.ts:878](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L878) +Defined in: [packages/db/src/collection/index.ts:878](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L878) Subscribe to a collection event @@ -839,7 +839,7 @@ Subscribe to a collection event once(event, callback): () => void; ``` -Defined in: [packages/db/src/collection/index.ts:888](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L888) +Defined in: [packages/db/src/collection/index.ts:888](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L888) Subscribe to a collection event once @@ -885,7 +885,7 @@ Subscribe to a collection event once onFirstReady(callback): void; ``` -Defined in: [packages/db/src/collection/index.ts:406](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L406) +Defined in: [packages/db/src/collection/index.ts:406](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L406) Register a callback to be executed when the collection first becomes ready Useful for preloading collections @@ -919,7 +919,7 @@ collection.onFirstReady(() => { preload(): Promise; ``` -Defined in: [packages/db/src/collection/index.ts:446](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L446) +Defined in: [packages/db/src/collection/index.ts:446](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L446) Preload the collection data by starting sync if not already started Multiple concurrent calls will share the same promise @@ -936,7 +936,7 @@ Multiple concurrent calls will share the same promise startSyncImmediate(): void; ``` -Defined in: [packages/db/src/collection/index.ts:438](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L438) +Defined in: [packages/db/src/collection/index.ts:438](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L438) Start sync immediately - internal method for compiled queries This bypasses lazy loading for special cases like live query results @@ -953,7 +953,7 @@ This bypasses lazy loading for special cases like live query results stateWhenReady(): Promise>; ``` -Defined in: [packages/db/src/collection/index.ts:770](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L770) +Defined in: [packages/db/src/collection/index.ts:770](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L770) Gets the current state of the collection as a Map, but only resolves when data is available Waits for the first sync commit to complete before resolving @@ -972,7 +972,7 @@ Promise that resolves to a Map containing all items in the collection subscribeChanges(callback, options): CollectionSubscription; ``` -Defined in: [packages/db/src/collection/index.ts:868](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L868) +Defined in: [packages/db/src/collection/index.ts:868](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L868) Subscribe to changes in the collection @@ -1044,7 +1044,7 @@ const subscription = collection.subscribeChanges((changes) => { toArrayWhenReady(): Promise; ``` -Defined in: [packages/db/src/collection/index.ts:795](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L795) +Defined in: [packages/db/src/collection/index.ts:795](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L795) Gets the current state of the collection as an Array, but only resolves when data is available Waits for the first sync commit to complete before resolving @@ -1065,7 +1065,7 @@ Promise that resolves to an Array containing all items in the collection update(key, callback): Transaction; ``` -Defined in: [packages/db/src/collection/index.ts:665](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L665) +Defined in: [packages/db/src/collection/index.ts:665](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L665) Updates one or more items in the collection using a callback function @@ -1136,7 +1136,7 @@ update( callback): Transaction; ``` -Defined in: [packages/db/src/collection/index.ts:671](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L671) +Defined in: [packages/db/src/collection/index.ts:671](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L671) Updates one or more items in the collection using a callback function @@ -1210,7 +1210,7 @@ try { update(id, callback): Transaction; ``` -Defined in: [packages/db/src/collection/index.ts:678](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L678) +Defined in: [packages/db/src/collection/index.ts:678](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L678) Updates one or more items in the collection using a callback function @@ -1281,7 +1281,7 @@ update( callback): Transaction; ``` -Defined in: [packages/db/src/collection/index.ts:684](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L684) +Defined in: [packages/db/src/collection/index.ts:684](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L684) Updates one or more items in the collection using a callback function @@ -1358,7 +1358,7 @@ validateData( key?): TOutput; ``` -Defined in: [packages/db/src/collection/index.ts:571](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L571) +Defined in: [packages/db/src/collection/index.ts:571](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L571) Validates the data against the schema @@ -1388,7 +1388,7 @@ Validates the data against the schema values(): IterableIterator; ``` -Defined in: [packages/db/src/collection/index.ts:481](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L481) +Defined in: [packages/db/src/collection/index.ts:481](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L481) Get all values (virtual derived state) @@ -1404,7 +1404,7 @@ Get all values (virtual derived state) waitFor(event, timeout?): Promise; ``` -Defined in: [packages/db/src/collection/index.ts:908](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L908) +Defined in: [packages/db/src/collection/index.ts:908](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L908) Wait for a collection event diff --git a/docs/reference/classes/CollectionInErrorStateError.md b/docs/reference/classes/CollectionInErrorStateError.md index 6a0da4bd1..cdd681efc 100644 --- a/docs/reference/classes/CollectionInErrorStateError.md +++ b/docs/reference/classes/CollectionInErrorStateError.md @@ -5,7 +5,7 @@ title: CollectionInErrorStateError # Class: CollectionInErrorStateError -Defined in: [packages/db/src/errors.ts:110](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L110) +Defined in: [packages/db/src/errors.ts:110](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L110) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:110](https://github.com/TanStack/db/blob/ new CollectionInErrorStateError(operation, collectionId): CollectionInErrorStateError; ``` -Defined in: [packages/db/src/errors.ts:111](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L111) +Defined in: [packages/db/src/errors.ts:111](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L111) #### Parameters diff --git a/docs/reference/classes/CollectionInputNotFoundError.md b/docs/reference/classes/CollectionInputNotFoundError.md index 53b6f6970..70516280b 100644 --- a/docs/reference/classes/CollectionInputNotFoundError.md +++ b/docs/reference/classes/CollectionInputNotFoundError.md @@ -5,7 +5,7 @@ title: CollectionInputNotFoundError # Class: CollectionInputNotFoundError -Defined in: [packages/db/src/errors.ts:416](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L416) +Defined in: [packages/db/src/errors.ts:416](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L416) Error thrown when a collection input stream is not found during query compilation. In self-joins, each alias (e.g., 'employee', 'manager') requires its own input stream. @@ -25,7 +25,7 @@ new CollectionInputNotFoundError( availableKeys?): CollectionInputNotFoundError; ``` -Defined in: [packages/db/src/errors.ts:417](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L417) +Defined in: [packages/db/src/errors.ts:417](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L417) #### Parameters diff --git a/docs/reference/classes/CollectionIsInErrorStateError.md b/docs/reference/classes/CollectionIsInErrorStateError.md index a116584a7..0ceb54759 100644 --- a/docs/reference/classes/CollectionIsInErrorStateError.md +++ b/docs/reference/classes/CollectionIsInErrorStateError.md @@ -5,7 +5,7 @@ title: CollectionIsInErrorStateError # Class: CollectionIsInErrorStateError -Defined in: [packages/db/src/errors.ts:126](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L126) +Defined in: [packages/db/src/errors.ts:126](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L126) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:126](https://github.com/TanStack/db/blob/ new CollectionIsInErrorStateError(): CollectionIsInErrorStateError; ``` -Defined in: [packages/db/src/errors.ts:127](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L127) +Defined in: [packages/db/src/errors.ts:127](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L127) #### Returns diff --git a/docs/reference/classes/CollectionOperationError.md b/docs/reference/classes/CollectionOperationError.md index e9ce186b1..2e22dc3b1 100644 --- a/docs/reference/classes/CollectionOperationError.md +++ b/docs/reference/classes/CollectionOperationError.md @@ -5,7 +5,7 @@ title: CollectionOperationError # Class: CollectionOperationError -Defined in: [packages/db/src/errors.ts:139](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L139) +Defined in: [packages/db/src/errors.ts:139](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L139) ## Extends @@ -31,7 +31,7 @@ Defined in: [packages/db/src/errors.ts:139](https://github.com/TanStack/db/blob/ new CollectionOperationError(message): CollectionOperationError; ``` -Defined in: [packages/db/src/errors.ts:140](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L140) +Defined in: [packages/db/src/errors.ts:140](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L140) #### Parameters diff --git a/docs/reference/classes/CollectionRequiresConfigError.md b/docs/reference/classes/CollectionRequiresConfigError.md index 86db7e06d..8588c5579 100644 --- a/docs/reference/classes/CollectionRequiresConfigError.md +++ b/docs/reference/classes/CollectionRequiresConfigError.md @@ -5,7 +5,7 @@ title: CollectionRequiresConfigError # Class: CollectionRequiresConfigError -Defined in: [packages/db/src/errors.ts:78](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L78) +Defined in: [packages/db/src/errors.ts:78](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L78) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:78](https://github.com/TanStack/db/blob/m new CollectionRequiresConfigError(): CollectionRequiresConfigError; ``` -Defined in: [packages/db/src/errors.ts:79](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L79) +Defined in: [packages/db/src/errors.ts:79](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L79) #### Returns diff --git a/docs/reference/classes/CollectionRequiresSyncConfigError.md b/docs/reference/classes/CollectionRequiresSyncConfigError.md index 8a2a57092..b7230599d 100644 --- a/docs/reference/classes/CollectionRequiresSyncConfigError.md +++ b/docs/reference/classes/CollectionRequiresSyncConfigError.md @@ -5,7 +5,7 @@ title: CollectionRequiresSyncConfigError # Class: CollectionRequiresSyncConfigError -Defined in: [packages/db/src/errors.ts:84](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L84) +Defined in: [packages/db/src/errors.ts:84](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L84) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:84](https://github.com/TanStack/db/blob/m new CollectionRequiresSyncConfigError(): CollectionRequiresSyncConfigError; ``` -Defined in: [packages/db/src/errors.ts:85](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L85) +Defined in: [packages/db/src/errors.ts:85](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L85) #### Returns diff --git a/docs/reference/classes/CollectionStateError.md b/docs/reference/classes/CollectionStateError.md index 891c5b4db..cbe00ff3e 100644 --- a/docs/reference/classes/CollectionStateError.md +++ b/docs/reference/classes/CollectionStateError.md @@ -5,7 +5,7 @@ title: CollectionStateError # Class: CollectionStateError -Defined in: [packages/db/src/errors.ts:103](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L103) +Defined in: [packages/db/src/errors.ts:103](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L103) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/db/src/errors.ts:103](https://github.com/TanStack/db/blob/ new CollectionStateError(message): CollectionStateError; ``` -Defined in: [packages/db/src/errors.ts:104](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L104) +Defined in: [packages/db/src/errors.ts:104](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L104) #### Parameters diff --git a/docs/reference/classes/DeduplicatedLoadSubset.md b/docs/reference/classes/DeduplicatedLoadSubset.md index 946c4097b..b6066d294 100644 --- a/docs/reference/classes/DeduplicatedLoadSubset.md +++ b/docs/reference/classes/DeduplicatedLoadSubset.md @@ -5,7 +5,7 @@ title: DeduplicatedLoadSubset # Class: DeduplicatedLoadSubset -Defined in: [packages/db/src/query/subset-dedupe.ts:34](https://github.com/TanStack/db/blob/main/packages/db/src/query/subset-dedupe.ts#L34) +Defined in: [packages/db/src/query/subset-dedupe.ts:34](https://github.com/MAST1999/db/blob/main/packages/db/src/query/subset-dedupe.ts#L34) Deduplicated wrapper for a loadSubset function. Tracks what data has been loaded and avoids redundant calls by applying @@ -50,7 +50,7 @@ dedupe.reset() new DeduplicatedLoadSubset(opts): DeduplicatedLoadSubset; ``` -Defined in: [packages/db/src/query/subset-dedupe.ts:67](https://github.com/TanStack/db/blob/main/packages/db/src/query/subset-dedupe.ts#L67) +Defined in: [packages/db/src/query/subset-dedupe.ts:67](https://github.com/MAST1999/db/blob/main/packages/db/src/query/subset-dedupe.ts#L67) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/db/src/query/subset-dedupe.ts:67](https://github.com/TanSt loadSubset(options): true | Promise; ``` -Defined in: [packages/db/src/query/subset-dedupe.ts:85](https://github.com/TanStack/db/blob/main/packages/db/src/query/subset-dedupe.ts#L85) +Defined in: [packages/db/src/query/subset-dedupe.ts:85](https://github.com/MAST1999/db/blob/main/packages/db/src/query/subset-dedupe.ts#L85) Load a subset of data, with automatic deduplication based on previously loaded predicates and in-flight requests. @@ -106,7 +106,7 @@ true if data is already loaded, or a Promise that resolves when data is loaded reset(): void; ``` -Defined in: [packages/db/src/query/subset-dedupe.ts:198](https://github.com/TanStack/db/blob/main/packages/db/src/query/subset-dedupe.ts#L198) +Defined in: [packages/db/src/query/subset-dedupe.ts:198](https://github.com/MAST1999/db/blob/main/packages/db/src/query/subset-dedupe.ts#L198) Reset all tracking state. Clears the history of loaded predicates and in-flight calls. diff --git a/docs/reference/classes/DeleteKeyNotFoundError.md b/docs/reference/classes/DeleteKeyNotFoundError.md index bf70f44da..09ff6585a 100644 --- a/docs/reference/classes/DeleteKeyNotFoundError.md +++ b/docs/reference/classes/DeleteKeyNotFoundError.md @@ -5,7 +5,7 @@ title: DeleteKeyNotFoundError # Class: DeleteKeyNotFoundError -Defined in: [packages/db/src/errors.ts:220](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L220) +Defined in: [packages/db/src/errors.ts:220](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L220) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:220](https://github.com/TanStack/db/blob/ new DeleteKeyNotFoundError(key): DeleteKeyNotFoundError; ``` -Defined in: [packages/db/src/errors.ts:221](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L221) +Defined in: [packages/db/src/errors.ts:221](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L221) #### Parameters diff --git a/docs/reference/classes/DistinctRequiresSelectError.md b/docs/reference/classes/DistinctRequiresSelectError.md index 135d46e71..cf0ec0fd2 100644 --- a/docs/reference/classes/DistinctRequiresSelectError.md +++ b/docs/reference/classes/DistinctRequiresSelectError.md @@ -5,7 +5,7 @@ title: DistinctRequiresSelectError # Class: DistinctRequiresSelectError -Defined in: [packages/db/src/errors.ts:392](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L392) +Defined in: [packages/db/src/errors.ts:392](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L392) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:392](https://github.com/TanStack/db/blob/ new DistinctRequiresSelectError(): DistinctRequiresSelectError; ``` -Defined in: [packages/db/src/errors.ts:393](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L393) +Defined in: [packages/db/src/errors.ts:393](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L393) #### Returns diff --git a/docs/reference/classes/DuplicateAliasInSubqueryError.md b/docs/reference/classes/DuplicateAliasInSubqueryError.md index 5cc24785a..614f950fa 100644 --- a/docs/reference/classes/DuplicateAliasInSubqueryError.md +++ b/docs/reference/classes/DuplicateAliasInSubqueryError.md @@ -5,7 +5,7 @@ title: DuplicateAliasInSubqueryError # Class: DuplicateAliasInSubqueryError -Defined in: [packages/db/src/errors.ts:437](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L437) +Defined in: [packages/db/src/errors.ts:437](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L437) Error thrown when a subquery uses the same alias as its parent query. This causes issues because parent and subquery would share the same input streams, @@ -23,7 +23,7 @@ leading to empty results or incorrect data (aggregation cross-leaking). new DuplicateAliasInSubqueryError(alias, parentAliases): DuplicateAliasInSubqueryError; ``` -Defined in: [packages/db/src/errors.ts:438](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L438) +Defined in: [packages/db/src/errors.ts:438](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L438) #### Parameters diff --git a/docs/reference/classes/DuplicateDbInstanceError.md b/docs/reference/classes/DuplicateDbInstanceError.md index 2d292ae10..3da5eafab 100644 --- a/docs/reference/classes/DuplicateDbInstanceError.md +++ b/docs/reference/classes/DuplicateDbInstanceError.md @@ -5,7 +5,7 @@ title: DuplicateDbInstanceError # Class: DuplicateDbInstanceError -Defined in: [packages/db/src/errors.ts:45](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L45) +Defined in: [packages/db/src/errors.ts:45](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L45) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:45](https://github.com/TanStack/db/blob/m new DuplicateDbInstanceError(): DuplicateDbInstanceError; ``` -Defined in: [packages/db/src/errors.ts:46](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L46) +Defined in: [packages/db/src/errors.ts:46](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L46) #### Returns diff --git a/docs/reference/classes/DuplicateKeyError.md b/docs/reference/classes/DuplicateKeyError.md index 35d674b3f..e66702024 100644 --- a/docs/reference/classes/DuplicateKeyError.md +++ b/docs/reference/classes/DuplicateKeyError.md @@ -5,7 +5,7 @@ title: DuplicateKeyError # Class: DuplicateKeyError -Defined in: [packages/db/src/errors.ts:154](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L154) +Defined in: [packages/db/src/errors.ts:154](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L154) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:154](https://github.com/TanStack/db/blob/ new DuplicateKeyError(key): DuplicateKeyError; ``` -Defined in: [packages/db/src/errors.ts:155](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L155) +Defined in: [packages/db/src/errors.ts:155](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L155) #### Parameters diff --git a/docs/reference/classes/DuplicateKeySyncError.md b/docs/reference/classes/DuplicateKeySyncError.md index 42a98eb28..d355abd03 100644 --- a/docs/reference/classes/DuplicateKeySyncError.md +++ b/docs/reference/classes/DuplicateKeySyncError.md @@ -5,7 +5,7 @@ title: DuplicateKeySyncError # Class: DuplicateKeySyncError -Defined in: [packages/db/src/errors.ts:162](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L162) +Defined in: [packages/db/src/errors.ts:162](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L162) ## Extends @@ -22,7 +22,7 @@ new DuplicateKeySyncError( options?): DuplicateKeySyncError; ``` -Defined in: [packages/db/src/errors.ts:163](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L163) +Defined in: [packages/db/src/errors.ts:163](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L163) #### Parameters diff --git a/docs/reference/classes/EmptyReferencePathError.md b/docs/reference/classes/EmptyReferencePathError.md index 6fbfb6121..3f2d04b63 100644 --- a/docs/reference/classes/EmptyReferencePathError.md +++ b/docs/reference/classes/EmptyReferencePathError.md @@ -5,7 +5,7 @@ title: EmptyReferencePathError # Class: EmptyReferencePathError -Defined in: [packages/db/src/errors.ts:460](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L460) +Defined in: [packages/db/src/errors.ts:460](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L460) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:460](https://github.com/TanStack/db/blob/ new EmptyReferencePathError(): EmptyReferencePathError; ``` -Defined in: [packages/db/src/errors.ts:461](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L461) +Defined in: [packages/db/src/errors.ts:461](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L461) #### Returns diff --git a/docs/reference/classes/GroupByError.md b/docs/reference/classes/GroupByError.md index 6656def56..c39daf3e1 100644 --- a/docs/reference/classes/GroupByError.md +++ b/docs/reference/classes/GroupByError.md @@ -5,7 +5,7 @@ title: GroupByError # Class: GroupByError -Defined in: [packages/db/src/errors.ts:535](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L535) +Defined in: [packages/db/src/errors.ts:535](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L535) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/db/src/errors.ts:535](https://github.com/TanStack/db/blob/ new GroupByError(message): GroupByError; ``` -Defined in: [packages/db/src/errors.ts:536](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L536) +Defined in: [packages/db/src/errors.ts:536](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L536) #### Parameters diff --git a/docs/reference/classes/HavingRequiresGroupByError.md b/docs/reference/classes/HavingRequiresGroupByError.md index 423d3a083..cfeb5b778 100644 --- a/docs/reference/classes/HavingRequiresGroupByError.md +++ b/docs/reference/classes/HavingRequiresGroupByError.md @@ -5,7 +5,7 @@ title: HavingRequiresGroupByError # Class: HavingRequiresGroupByError -Defined in: [packages/db/src/errors.ts:398](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L398) +Defined in: [packages/db/src/errors.ts:398](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L398) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:398](https://github.com/TanStack/db/blob/ new HavingRequiresGroupByError(): HavingRequiresGroupByError; ``` -Defined in: [packages/db/src/errors.ts:399](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L399) +Defined in: [packages/db/src/errors.ts:399](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L399) #### Returns diff --git a/docs/reference/classes/IndexProxy.md b/docs/reference/classes/IndexProxy.md index 0ff7dff72..bb13a8155 100644 --- a/docs/reference/classes/IndexProxy.md +++ b/docs/reference/classes/IndexProxy.md @@ -5,7 +5,7 @@ title: IndexProxy # Class: IndexProxy\ -Defined in: [packages/db/src/indexes/lazy-index.ts:131](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L131) +Defined in: [packages/db/src/indexes/lazy-index.ts:131](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L131) Proxy that provides synchronous interface while index loads asynchronously @@ -23,7 +23,7 @@ Proxy that provides synchronous interface while index loads asynchronously new IndexProxy(indexId, lazyIndex): IndexProxy; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:132](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L132) +Defined in: [packages/db/src/indexes/lazy-index.ts:132](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L132) #### Parameters @@ -49,7 +49,7 @@ Defined in: [packages/db/src/indexes/lazy-index.ts:132](https://github.com/TanSt get expression(): BasicExpression; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:178](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L178) +Defined in: [packages/db/src/indexes/lazy-index.ts:178](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L178) Get the index expression (available immediately) @@ -67,7 +67,7 @@ Get the index expression (available immediately) get id(): number; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:161](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L161) +Defined in: [packages/db/src/indexes/lazy-index.ts:161](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L161) Get the index ID @@ -85,7 +85,7 @@ Get the index ID get index(): BaseIndex; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:140](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L140) +Defined in: [packages/db/src/indexes/lazy-index.ts:140](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L140) Get the resolved index (throws if not ready) @@ -103,7 +103,7 @@ Get the resolved index (throws if not ready) get indexedKeysSet(): Set; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:216](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L216) +Defined in: [packages/db/src/indexes/lazy-index.ts:216](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L216) ##### Returns @@ -119,7 +119,7 @@ Defined in: [packages/db/src/indexes/lazy-index.ts:216](https://github.com/TanSt get isReady(): boolean; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:147](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L147) +Defined in: [packages/db/src/indexes/lazy-index.ts:147](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L147) Check if index is ready @@ -137,7 +137,7 @@ Check if index is ready get keyCount(): number; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:211](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L211) +Defined in: [packages/db/src/indexes/lazy-index.ts:211](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L211) Get the key count (throws if not ready) @@ -155,7 +155,7 @@ Get the key count (throws if not ready) get name(): string | undefined; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:168](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L168) +Defined in: [packages/db/src/indexes/lazy-index.ts:168](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L168) Get the index name (throws if not ready) @@ -173,7 +173,7 @@ Get the index name (throws if not ready) get orderedEntriesArray(): [any, Set][]; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:221](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L221) +Defined in: [packages/db/src/indexes/lazy-index.ts:221](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L221) ##### Returns @@ -189,7 +189,7 @@ Defined in: [packages/db/src/indexes/lazy-index.ts:221](https://github.com/TanSt get valueMapData(): Map>; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:226](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L226) +Defined in: [packages/db/src/indexes/lazy-index.ts:226](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L226) ##### Returns @@ -203,7 +203,7 @@ Defined in: [packages/db/src/indexes/lazy-index.ts:226](https://github.com/TanSt _getLazyWrapper(): LazyIndexWrapper; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:248](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L248) +Defined in: [packages/db/src/indexes/lazy-index.ts:248](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L248) #### Returns @@ -217,7 +217,7 @@ Defined in: [packages/db/src/indexes/lazy-index.ts:248](https://github.com/TanSt equalityLookup(value): Set; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:232](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L232) +Defined in: [packages/db/src/indexes/lazy-index.ts:232](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L232) #### Parameters @@ -237,7 +237,7 @@ Defined in: [packages/db/src/indexes/lazy-index.ts:232](https://github.com/TanSt getStats(): IndexStats; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:192](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L192) +Defined in: [packages/db/src/indexes/lazy-index.ts:192](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L192) Get index statistics (throws if not ready) @@ -253,7 +253,7 @@ Get index statistics (throws if not ready) inArrayLookup(values): Set; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:242](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L242) +Defined in: [packages/db/src/indexes/lazy-index.ts:242](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L242) #### Parameters @@ -273,7 +273,7 @@ Defined in: [packages/db/src/indexes/lazy-index.ts:242](https://github.com/TanSt matchesField(fieldPath): boolean; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:199](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L199) +Defined in: [packages/db/src/indexes/lazy-index.ts:199](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L199) Check if index matches a field path (available immediately) @@ -295,7 +295,7 @@ Check if index matches a field path (available immediately) rangeQuery(options): Set; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:237](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L237) +Defined in: [packages/db/src/indexes/lazy-index.ts:237](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L237) #### Parameters @@ -315,7 +315,7 @@ Defined in: [packages/db/src/indexes/lazy-index.ts:237](https://github.com/TanSt supports(operation): boolean; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:185](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L185) +Defined in: [packages/db/src/indexes/lazy-index.ts:185](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L185) Check if index supports an operation (throws if not ready) @@ -337,7 +337,7 @@ Check if index supports an operation (throws if not ready) whenReady(): Promise>; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:154](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L154) +Defined in: [packages/db/src/indexes/lazy-index.ts:154](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L154) Wait for index to be ready diff --git a/docs/reference/classes/InvalidCollectionStatusTransitionError.md b/docs/reference/classes/InvalidCollectionStatusTransitionError.md index 81c1a3d0c..d92fc94ae 100644 --- a/docs/reference/classes/InvalidCollectionStatusTransitionError.md +++ b/docs/reference/classes/InvalidCollectionStatusTransitionError.md @@ -5,7 +5,7 @@ title: InvalidCollectionStatusTransitionError # Class: InvalidCollectionStatusTransitionError -Defined in: [packages/db/src/errors.ts:118](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L118) +Defined in: [packages/db/src/errors.ts:118](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L118) ## Extends @@ -22,7 +22,7 @@ new InvalidCollectionStatusTransitionError( collectionId): InvalidCollectionStatusTransitionError; ``` -Defined in: [packages/db/src/errors.ts:119](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L119) +Defined in: [packages/db/src/errors.ts:119](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L119) #### Parameters diff --git a/docs/reference/classes/InvalidJoinCondition.md b/docs/reference/classes/InvalidJoinCondition.md index da478f258..1312c651b 100644 --- a/docs/reference/classes/InvalidJoinCondition.md +++ b/docs/reference/classes/InvalidJoinCondition.md @@ -5,7 +5,7 @@ title: InvalidJoinCondition # Class: InvalidJoinCondition -Defined in: [packages/db/src/errors.ts:522](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L522) +Defined in: [packages/db/src/errors.ts:522](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L522) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:522](https://github.com/TanStack/db/blob/ new InvalidJoinCondition(): InvalidJoinCondition; ``` -Defined in: [packages/db/src/errors.ts:523](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L523) +Defined in: [packages/db/src/errors.ts:523](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L523) #### Returns diff --git a/docs/reference/classes/InvalidJoinConditionLeftSourceError.md b/docs/reference/classes/InvalidJoinConditionLeftSourceError.md index 47f2a8e15..19e87b8e5 100644 --- a/docs/reference/classes/InvalidJoinConditionLeftSourceError.md +++ b/docs/reference/classes/InvalidJoinConditionLeftSourceError.md @@ -5,7 +5,7 @@ title: InvalidJoinConditionLeftSourceError # Class: InvalidJoinConditionLeftSourceError -Defined in: [packages/db/src/errors.ts:506](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L506) +Defined in: [packages/db/src/errors.ts:506](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L506) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:506](https://github.com/TanStack/db/blob/ new InvalidJoinConditionLeftSourceError(sourceAlias): InvalidJoinConditionLeftSourceError; ``` -Defined in: [packages/db/src/errors.ts:507](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L507) +Defined in: [packages/db/src/errors.ts:507](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L507) #### Parameters diff --git a/docs/reference/classes/InvalidJoinConditionRightSourceError.md b/docs/reference/classes/InvalidJoinConditionRightSourceError.md index 2294e6d0a..be511333f 100644 --- a/docs/reference/classes/InvalidJoinConditionRightSourceError.md +++ b/docs/reference/classes/InvalidJoinConditionRightSourceError.md @@ -5,7 +5,7 @@ title: InvalidJoinConditionRightSourceError # Class: InvalidJoinConditionRightSourceError -Defined in: [packages/db/src/errors.ts:514](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L514) +Defined in: [packages/db/src/errors.ts:514](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L514) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:514](https://github.com/TanStack/db/blob/ new InvalidJoinConditionRightSourceError(sourceAlias): InvalidJoinConditionRightSourceError; ``` -Defined in: [packages/db/src/errors.ts:515](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L515) +Defined in: [packages/db/src/errors.ts:515](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L515) #### Parameters diff --git a/docs/reference/classes/InvalidJoinConditionSameSourceError.md b/docs/reference/classes/InvalidJoinConditionSameSourceError.md index 942301fdb..e9498cb44 100644 --- a/docs/reference/classes/InvalidJoinConditionSameSourceError.md +++ b/docs/reference/classes/InvalidJoinConditionSameSourceError.md @@ -5,7 +5,7 @@ title: InvalidJoinConditionSameSourceError # Class: InvalidJoinConditionSameSourceError -Defined in: [packages/db/src/errors.ts:492](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L492) +Defined in: [packages/db/src/errors.ts:492](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L492) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:492](https://github.com/TanStack/db/blob/ new InvalidJoinConditionSameSourceError(sourceAlias): InvalidJoinConditionSameSourceError; ``` -Defined in: [packages/db/src/errors.ts:493](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L493) +Defined in: [packages/db/src/errors.ts:493](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L493) #### Parameters diff --git a/docs/reference/classes/InvalidJoinConditionSourceMismatchError.md b/docs/reference/classes/InvalidJoinConditionSourceMismatchError.md index 1a883518c..711517a6c 100644 --- a/docs/reference/classes/InvalidJoinConditionSourceMismatchError.md +++ b/docs/reference/classes/InvalidJoinConditionSourceMismatchError.md @@ -5,7 +5,7 @@ title: InvalidJoinConditionSourceMismatchError # Class: InvalidJoinConditionSourceMismatchError -Defined in: [packages/db/src/errors.ts:500](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L500) +Defined in: [packages/db/src/errors.ts:500](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L500) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:500](https://github.com/TanStack/db/blob/ new InvalidJoinConditionSourceMismatchError(): InvalidJoinConditionSourceMismatchError; ``` -Defined in: [packages/db/src/errors.ts:501](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L501) +Defined in: [packages/db/src/errors.ts:501](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L501) #### Returns diff --git a/docs/reference/classes/InvalidSchemaError.md b/docs/reference/classes/InvalidSchemaError.md index a98453c36..2bc179b51 100644 --- a/docs/reference/classes/InvalidSchemaError.md +++ b/docs/reference/classes/InvalidSchemaError.md @@ -5,7 +5,7 @@ title: InvalidSchemaError # Class: InvalidSchemaError -Defined in: [packages/db/src/errors.ts:90](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L90) +Defined in: [packages/db/src/errors.ts:90](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L90) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:90](https://github.com/TanStack/db/blob/m new InvalidSchemaError(): InvalidSchemaError; ``` -Defined in: [packages/db/src/errors.ts:91](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L91) +Defined in: [packages/db/src/errors.ts:91](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L91) #### Returns diff --git a/docs/reference/classes/InvalidSourceError.md b/docs/reference/classes/InvalidSourceError.md index 4450c1120..e5202a0fb 100644 --- a/docs/reference/classes/InvalidSourceError.md +++ b/docs/reference/classes/InvalidSourceError.md @@ -5,7 +5,7 @@ title: InvalidSourceError # Class: InvalidSourceError -Defined in: [packages/db/src/errors.ts:355](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L355) +Defined in: [packages/db/src/errors.ts:355](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L355) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:355](https://github.com/TanStack/db/blob/ new InvalidSourceError(alias): InvalidSourceError; ``` -Defined in: [packages/db/src/errors.ts:356](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L356) +Defined in: [packages/db/src/errors.ts:356](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L356) #### Parameters diff --git a/docs/reference/classes/InvalidSourceTypeError.md b/docs/reference/classes/InvalidSourceTypeError.md index 42daca63c..2c3adc0e1 100644 --- a/docs/reference/classes/InvalidSourceTypeError.md +++ b/docs/reference/classes/InvalidSourceTypeError.md @@ -5,7 +5,7 @@ title: InvalidSourceTypeError # Class: InvalidSourceTypeError -Defined in: [packages/db/src/errors.ts:363](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L363) +Defined in: [packages/db/src/errors.ts:363](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L363) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:363](https://github.com/TanStack/db/blob/ new InvalidSourceTypeError(context, type): InvalidSourceTypeError; ``` -Defined in: [packages/db/src/errors.ts:364](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L364) +Defined in: [packages/db/src/errors.ts:364](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L364) #### Parameters diff --git a/docs/reference/classes/InvalidStorageDataFormatError.md b/docs/reference/classes/InvalidStorageDataFormatError.md index 1a9f10e11..146583003 100644 --- a/docs/reference/classes/InvalidStorageDataFormatError.md +++ b/docs/reference/classes/InvalidStorageDataFormatError.md @@ -5,7 +5,7 @@ title: InvalidStorageDataFormatError # Class: InvalidStorageDataFormatError -Defined in: [packages/db/src/errors.ts:600](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L600) +Defined in: [packages/db/src/errors.ts:600](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L600) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:600](https://github.com/TanStack/db/blob/ new InvalidStorageDataFormatError(storageKey, key): InvalidStorageDataFormatError; ``` -Defined in: [packages/db/src/errors.ts:601](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L601) +Defined in: [packages/db/src/errors.ts:601](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L601) #### Parameters diff --git a/docs/reference/classes/InvalidStorageObjectFormatError.md b/docs/reference/classes/InvalidStorageObjectFormatError.md index ed3b0efd0..090051a00 100644 --- a/docs/reference/classes/InvalidStorageObjectFormatError.md +++ b/docs/reference/classes/InvalidStorageObjectFormatError.md @@ -5,7 +5,7 @@ title: InvalidStorageObjectFormatError # Class: InvalidStorageObjectFormatError -Defined in: [packages/db/src/errors.ts:608](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L608) +Defined in: [packages/db/src/errors.ts:608](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L608) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:608](https://github.com/TanStack/db/blob/ new InvalidStorageObjectFormatError(storageKey): InvalidStorageObjectFormatError; ``` -Defined in: [packages/db/src/errors.ts:609](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L609) +Defined in: [packages/db/src/errors.ts:609](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L609) #### Parameters diff --git a/docs/reference/classes/JoinCollectionNotFoundError.md b/docs/reference/classes/JoinCollectionNotFoundError.md index f21f5b9a5..7465ae945 100644 --- a/docs/reference/classes/JoinCollectionNotFoundError.md +++ b/docs/reference/classes/JoinCollectionNotFoundError.md @@ -5,7 +5,7 @@ title: JoinCollectionNotFoundError # Class: JoinCollectionNotFoundError -Defined in: [packages/db/src/errors.ts:472](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L472) +Defined in: [packages/db/src/errors.ts:472](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L472) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:472](https://github.com/TanStack/db/blob/ new JoinCollectionNotFoundError(collectionId): JoinCollectionNotFoundError; ``` -Defined in: [packages/db/src/errors.ts:473](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L473) +Defined in: [packages/db/src/errors.ts:473](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L473) #### Parameters diff --git a/docs/reference/classes/JoinConditionMustBeEqualityError.md b/docs/reference/classes/JoinConditionMustBeEqualityError.md index 6e6240e8c..4b6fe7601 100644 --- a/docs/reference/classes/JoinConditionMustBeEqualityError.md +++ b/docs/reference/classes/JoinConditionMustBeEqualityError.md @@ -5,7 +5,7 @@ title: JoinConditionMustBeEqualityError # Class: JoinConditionMustBeEqualityError -Defined in: [packages/db/src/errors.ts:372](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L372) +Defined in: [packages/db/src/errors.ts:372](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L372) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:372](https://github.com/TanStack/db/blob/ new JoinConditionMustBeEqualityError(): JoinConditionMustBeEqualityError; ``` -Defined in: [packages/db/src/errors.ts:373](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L373) +Defined in: [packages/db/src/errors.ts:373](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L373) #### Returns diff --git a/docs/reference/classes/JoinError.md b/docs/reference/classes/JoinError.md index 6058f4f73..e6993a997 100644 --- a/docs/reference/classes/JoinError.md +++ b/docs/reference/classes/JoinError.md @@ -5,7 +5,7 @@ title: JoinError # Class: JoinError -Defined in: [packages/db/src/errors.ts:479](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L479) +Defined in: [packages/db/src/errors.ts:479](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L479) ## Extends @@ -29,7 +29,7 @@ Defined in: [packages/db/src/errors.ts:479](https://github.com/TanStack/db/blob/ new JoinError(message): JoinError; ``` -Defined in: [packages/db/src/errors.ts:480](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L480) +Defined in: [packages/db/src/errors.ts:480](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L480) #### Parameters diff --git a/docs/reference/classes/KeyUpdateNotAllowedError.md b/docs/reference/classes/KeyUpdateNotAllowedError.md index 0396ca6ef..0b0d36165 100644 --- a/docs/reference/classes/KeyUpdateNotAllowedError.md +++ b/docs/reference/classes/KeyUpdateNotAllowedError.md @@ -5,7 +5,7 @@ title: KeyUpdateNotAllowedError # Class: KeyUpdateNotAllowedError -Defined in: [packages/db/src/errors.ts:206](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L206) +Defined in: [packages/db/src/errors.ts:206](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L206) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:206](https://github.com/TanStack/db/blob/ new KeyUpdateNotAllowedError(originalKey, newKey): KeyUpdateNotAllowedError; ``` -Defined in: [packages/db/src/errors.ts:207](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L207) +Defined in: [packages/db/src/errors.ts:207](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L207) #### Parameters diff --git a/docs/reference/classes/LazyIndexWrapper.md b/docs/reference/classes/LazyIndexWrapper.md index 45592142b..4778a632d 100644 --- a/docs/reference/classes/LazyIndexWrapper.md +++ b/docs/reference/classes/LazyIndexWrapper.md @@ -5,7 +5,7 @@ title: LazyIndexWrapper # Class: LazyIndexWrapper\ -Defined in: [packages/db/src/indexes/lazy-index.ts:39](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L39) +Defined in: [packages/db/src/indexes/lazy-index.ts:39](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L39) Wrapper that defers index creation until first sync @@ -29,7 +29,7 @@ new LazyIndexWrapper( collectionEntries?): LazyIndexWrapper; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:43](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L43) +Defined in: [packages/db/src/indexes/lazy-index.ts:43](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L43) #### Parameters @@ -69,7 +69,7 @@ Defined in: [packages/db/src/indexes/lazy-index.ts:43](https://github.com/TanSta getExpression(): BasicExpression; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:118](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L118) +Defined in: [packages/db/src/indexes/lazy-index.ts:118](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L118) Get the index expression @@ -85,7 +85,7 @@ Get the index expression getId(): number; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:104](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L104) +Defined in: [packages/db/src/indexes/lazy-index.ts:104](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L104) Get the index ID @@ -101,7 +101,7 @@ Get the index ID getName(): string | undefined; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:111](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L111) +Defined in: [packages/db/src/indexes/lazy-index.ts:111](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L111) Get the index name @@ -117,7 +117,7 @@ Get the index name getResolved(): BaseIndex; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:92](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L92) +Defined in: [packages/db/src/indexes/lazy-index.ts:92](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L92) Get resolved index (throws if not ready) @@ -133,7 +133,7 @@ Get resolved index (throws if not ready) isResolved(): boolean; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:85](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L85) +Defined in: [packages/db/src/indexes/lazy-index.ts:85](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L85) Check if already resolved @@ -149,7 +149,7 @@ Check if already resolved resolve(): Promise>; ``` -Defined in: [packages/db/src/indexes/lazy-index.ts:69](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/lazy-index.ts#L69) +Defined in: [packages/db/src/indexes/lazy-index.ts:69](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/lazy-index.ts#L69) Resolve the actual index diff --git a/docs/reference/classes/LimitOffsetRequireOrderByError.md b/docs/reference/classes/LimitOffsetRequireOrderByError.md index 53e0be1f1..aa7b6d635 100644 --- a/docs/reference/classes/LimitOffsetRequireOrderByError.md +++ b/docs/reference/classes/LimitOffsetRequireOrderByError.md @@ -5,7 +5,7 @@ title: LimitOffsetRequireOrderByError # Class: LimitOffsetRequireOrderByError -Defined in: [packages/db/src/errors.ts:404](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L404) +Defined in: [packages/db/src/errors.ts:404](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L404) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:404](https://github.com/TanStack/db/blob/ new LimitOffsetRequireOrderByError(): LimitOffsetRequireOrderByError; ``` -Defined in: [packages/db/src/errors.ts:405](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L405) +Defined in: [packages/db/src/errors.ts:405](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L405) #### Returns diff --git a/docs/reference/classes/LocalStorageCollectionError.md b/docs/reference/classes/LocalStorageCollectionError.md index e101629b3..5847cdf07 100644 --- a/docs/reference/classes/LocalStorageCollectionError.md +++ b/docs/reference/classes/LocalStorageCollectionError.md @@ -5,7 +5,7 @@ title: LocalStorageCollectionError # Class: LocalStorageCollectionError -Defined in: [packages/db/src/errors.ts:587](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L587) +Defined in: [packages/db/src/errors.ts:587](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L587) ## Extends @@ -25,7 +25,7 @@ Defined in: [packages/db/src/errors.ts:587](https://github.com/TanStack/db/blob/ new LocalStorageCollectionError(message): LocalStorageCollectionError; ``` -Defined in: [packages/db/src/errors.ts:588](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L588) +Defined in: [packages/db/src/errors.ts:588](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L588) #### Parameters diff --git a/docs/reference/classes/MissingAliasInputsError.md b/docs/reference/classes/MissingAliasInputsError.md index bd1cb17e5..dc1fe2887 100644 --- a/docs/reference/classes/MissingAliasInputsError.md +++ b/docs/reference/classes/MissingAliasInputsError.md @@ -5,7 +5,7 @@ title: MissingAliasInputsError # Class: MissingAliasInputsError -Defined in: [packages/db/src/errors.ts:684](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L684) +Defined in: [packages/db/src/errors.ts:684](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L684) Internal error when the compiler returns aliases that don't have corresponding input streams. This should never happen since all aliases come from user declarations. @@ -22,7 +22,7 @@ This should never happen since all aliases come from user declarations. new MissingAliasInputsError(missingAliases): MissingAliasInputsError; ``` -Defined in: [packages/db/src/errors.ts:685](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L685) +Defined in: [packages/db/src/errors.ts:685](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L685) #### Parameters diff --git a/docs/reference/classes/MissingDeleteHandlerError.md b/docs/reference/classes/MissingDeleteHandlerError.md index 708d29cf9..a54810c7f 100644 --- a/docs/reference/classes/MissingDeleteHandlerError.md +++ b/docs/reference/classes/MissingDeleteHandlerError.md @@ -5,7 +5,7 @@ title: MissingDeleteHandlerError # Class: MissingDeleteHandlerError -Defined in: [packages/db/src/errors.ts:252](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L252) +Defined in: [packages/db/src/errors.ts:252](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L252) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:252](https://github.com/TanStack/db/blob/ new MissingDeleteHandlerError(): MissingDeleteHandlerError; ``` -Defined in: [packages/db/src/errors.ts:253](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L253) +Defined in: [packages/db/src/errors.ts:253](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L253) #### Returns diff --git a/docs/reference/classes/MissingHandlerError.md b/docs/reference/classes/MissingHandlerError.md index 4f1b02439..8ee1b1bef 100644 --- a/docs/reference/classes/MissingHandlerError.md +++ b/docs/reference/classes/MissingHandlerError.md @@ -5,7 +5,7 @@ title: MissingHandlerError # Class: MissingHandlerError -Defined in: [packages/db/src/errors.ts:229](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L229) +Defined in: [packages/db/src/errors.ts:229](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L229) ## Extends @@ -25,7 +25,7 @@ Defined in: [packages/db/src/errors.ts:229](https://github.com/TanStack/db/blob/ new MissingHandlerError(message): MissingHandlerError; ``` -Defined in: [packages/db/src/errors.ts:230](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L230) +Defined in: [packages/db/src/errors.ts:230](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L230) #### Parameters diff --git a/docs/reference/classes/MissingInsertHandlerError.md b/docs/reference/classes/MissingInsertHandlerError.md index f2d1e932a..e00481d35 100644 --- a/docs/reference/classes/MissingInsertHandlerError.md +++ b/docs/reference/classes/MissingInsertHandlerError.md @@ -5,7 +5,7 @@ title: MissingInsertHandlerError # Class: MissingInsertHandlerError -Defined in: [packages/db/src/errors.ts:236](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L236) +Defined in: [packages/db/src/errors.ts:236](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L236) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:236](https://github.com/TanStack/db/blob/ new MissingInsertHandlerError(): MissingInsertHandlerError; ``` -Defined in: [packages/db/src/errors.ts:237](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L237) +Defined in: [packages/db/src/errors.ts:237](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L237) #### Returns diff --git a/docs/reference/classes/MissingMutationFunctionError.md b/docs/reference/classes/MissingMutationFunctionError.md index 4d07a7939..ee01f055a 100644 --- a/docs/reference/classes/MissingMutationFunctionError.md +++ b/docs/reference/classes/MissingMutationFunctionError.md @@ -5,7 +5,7 @@ title: MissingMutationFunctionError # Class: MissingMutationFunctionError -Defined in: [packages/db/src/errors.ts:268](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L268) +Defined in: [packages/db/src/errors.ts:268](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L268) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:268](https://github.com/TanStack/db/blob/ new MissingMutationFunctionError(): MissingMutationFunctionError; ``` -Defined in: [packages/db/src/errors.ts:269](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L269) +Defined in: [packages/db/src/errors.ts:269](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L269) #### Returns diff --git a/docs/reference/classes/MissingUpdateArgumentError.md b/docs/reference/classes/MissingUpdateArgumentError.md index 86d4cfbda..64d4eeb9f 100644 --- a/docs/reference/classes/MissingUpdateArgumentError.md +++ b/docs/reference/classes/MissingUpdateArgumentError.md @@ -5,7 +5,7 @@ title: MissingUpdateArgumentError # Class: MissingUpdateArgumentError -Defined in: [packages/db/src/errors.ts:186](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L186) +Defined in: [packages/db/src/errors.ts:186](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L186) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:186](https://github.com/TanStack/db/blob/ new MissingUpdateArgumentError(): MissingUpdateArgumentError; ``` -Defined in: [packages/db/src/errors.ts:187](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L187) +Defined in: [packages/db/src/errors.ts:187](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L187) #### Returns diff --git a/docs/reference/classes/MissingUpdateHandlerError.md b/docs/reference/classes/MissingUpdateHandlerError.md index 627dbf336..b5ea306ff 100644 --- a/docs/reference/classes/MissingUpdateHandlerError.md +++ b/docs/reference/classes/MissingUpdateHandlerError.md @@ -5,7 +5,7 @@ title: MissingUpdateHandlerError # Class: MissingUpdateHandlerError -Defined in: [packages/db/src/errors.ts:244](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L244) +Defined in: [packages/db/src/errors.ts:244](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L244) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:244](https://github.com/TanStack/db/blob/ new MissingUpdateHandlerError(): MissingUpdateHandlerError; ``` -Defined in: [packages/db/src/errors.ts:245](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L245) +Defined in: [packages/db/src/errors.ts:245](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L245) #### Returns diff --git a/docs/reference/classes/NegativeActiveSubscribersError.md b/docs/reference/classes/NegativeActiveSubscribersError.md index cd3b1cc36..a41e4f9e6 100644 --- a/docs/reference/classes/NegativeActiveSubscribersError.md +++ b/docs/reference/classes/NegativeActiveSubscribersError.md @@ -5,7 +5,7 @@ title: NegativeActiveSubscribersError # Class: NegativeActiveSubscribersError -Defined in: [packages/db/src/errors.ts:132](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L132) +Defined in: [packages/db/src/errors.ts:132](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L132) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:132](https://github.com/TanStack/db/blob/ new NegativeActiveSubscribersError(): NegativeActiveSubscribersError; ``` -Defined in: [packages/db/src/errors.ts:133](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L133) +Defined in: [packages/db/src/errors.ts:133](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L133) #### Returns diff --git a/docs/reference/classes/NoKeysPassedToDeleteError.md b/docs/reference/classes/NoKeysPassedToDeleteError.md index 6decc6337..853a38931 100644 --- a/docs/reference/classes/NoKeysPassedToDeleteError.md +++ b/docs/reference/classes/NoKeysPassedToDeleteError.md @@ -5,7 +5,7 @@ title: NoKeysPassedToDeleteError # Class: NoKeysPassedToDeleteError -Defined in: [packages/db/src/errors.ts:214](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L214) +Defined in: [packages/db/src/errors.ts:214](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L214) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:214](https://github.com/TanStack/db/blob/ new NoKeysPassedToDeleteError(): NoKeysPassedToDeleteError; ``` -Defined in: [packages/db/src/errors.ts:215](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L215) +Defined in: [packages/db/src/errors.ts:215](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L215) #### Returns diff --git a/docs/reference/classes/NoKeysPassedToUpdateError.md b/docs/reference/classes/NoKeysPassedToUpdateError.md index e177fb8a5..40a6cf464 100644 --- a/docs/reference/classes/NoKeysPassedToUpdateError.md +++ b/docs/reference/classes/NoKeysPassedToUpdateError.md @@ -5,7 +5,7 @@ title: NoKeysPassedToUpdateError # Class: NoKeysPassedToUpdateError -Defined in: [packages/db/src/errors.ts:192](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L192) +Defined in: [packages/db/src/errors.ts:192](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L192) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:192](https://github.com/TanStack/db/blob/ new NoKeysPassedToUpdateError(): NoKeysPassedToUpdateError; ``` -Defined in: [packages/db/src/errors.ts:193](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L193) +Defined in: [packages/db/src/errors.ts:193](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L193) #### Returns diff --git a/docs/reference/classes/NoPendingSyncTransactionCommitError.md b/docs/reference/classes/NoPendingSyncTransactionCommitError.md index 4451bf185..3acbee5ec 100644 --- a/docs/reference/classes/NoPendingSyncTransactionCommitError.md +++ b/docs/reference/classes/NoPendingSyncTransactionCommitError.md @@ -5,7 +5,7 @@ title: NoPendingSyncTransactionCommitError # Class: NoPendingSyncTransactionCommitError -Defined in: [packages/db/src/errors.ts:321](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L321) +Defined in: [packages/db/src/errors.ts:321](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L321) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:321](https://github.com/TanStack/db/blob/ new NoPendingSyncTransactionCommitError(): NoPendingSyncTransactionCommitError; ``` -Defined in: [packages/db/src/errors.ts:322](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L322) +Defined in: [packages/db/src/errors.ts:322](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L322) #### Returns diff --git a/docs/reference/classes/NoPendingSyncTransactionWriteError.md b/docs/reference/classes/NoPendingSyncTransactionWriteError.md index 38d0ac384..d6830d706 100644 --- a/docs/reference/classes/NoPendingSyncTransactionWriteError.md +++ b/docs/reference/classes/NoPendingSyncTransactionWriteError.md @@ -5,7 +5,7 @@ title: NoPendingSyncTransactionWriteError # Class: NoPendingSyncTransactionWriteError -Defined in: [packages/db/src/errors.ts:307](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L307) +Defined in: [packages/db/src/errors.ts:307](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L307) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:307](https://github.com/TanStack/db/blob/ new NoPendingSyncTransactionWriteError(): NoPendingSyncTransactionWriteError; ``` -Defined in: [packages/db/src/errors.ts:308](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L308) +Defined in: [packages/db/src/errors.ts:308](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L308) #### Returns diff --git a/docs/reference/classes/NonAggregateExpressionNotInGroupByError.md b/docs/reference/classes/NonAggregateExpressionNotInGroupByError.md index 8a56a9c0b..a698696f4 100644 --- a/docs/reference/classes/NonAggregateExpressionNotInGroupByError.md +++ b/docs/reference/classes/NonAggregateExpressionNotInGroupByError.md @@ -5,7 +5,7 @@ title: NonAggregateExpressionNotInGroupByError # Class: NonAggregateExpressionNotInGroupByError -Defined in: [packages/db/src/errors.ts:542](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L542) +Defined in: [packages/db/src/errors.ts:542](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L542) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:542](https://github.com/TanStack/db/blob/ new NonAggregateExpressionNotInGroupByError(alias): NonAggregateExpressionNotInGroupByError; ``` -Defined in: [packages/db/src/errors.ts:543](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L543) +Defined in: [packages/db/src/errors.ts:543](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L543) #### Parameters diff --git a/docs/reference/classes/NonRetriableError.md b/docs/reference/classes/NonRetriableError.md index c048829fd..22973d59c 100644 --- a/docs/reference/classes/NonRetriableError.md +++ b/docs/reference/classes/NonRetriableError.md @@ -5,7 +5,7 @@ title: NonRetriableError # Class: NonRetriableError -Defined in: [packages/db/src/errors.ts:10](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L10) +Defined in: [packages/db/src/errors.ts:10](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L10) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:10](https://github.com/TanStack/db/blob/m new NonRetriableError(message): NonRetriableError; ``` -Defined in: [packages/db/src/errors.ts:11](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L11) +Defined in: [packages/db/src/errors.ts:11](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L11) #### Parameters diff --git a/docs/reference/classes/OnMutateMustBeSynchronousError.md b/docs/reference/classes/OnMutateMustBeSynchronousError.md index 9294d8e4f..6bf1a5a6d 100644 --- a/docs/reference/classes/OnMutateMustBeSynchronousError.md +++ b/docs/reference/classes/OnMutateMustBeSynchronousError.md @@ -5,7 +5,7 @@ title: OnMutateMustBeSynchronousError # Class: OnMutateMustBeSynchronousError -Defined in: [packages/db/src/errors.ts:274](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L274) +Defined in: [packages/db/src/errors.ts:274](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L274) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:274](https://github.com/TanStack/db/blob/ new OnMutateMustBeSynchronousError(): OnMutateMustBeSynchronousError; ``` -Defined in: [packages/db/src/errors.ts:275](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L275) +Defined in: [packages/db/src/errors.ts:275](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L275) #### Returns diff --git a/docs/reference/classes/OnlyOneSourceAllowedError.md b/docs/reference/classes/OnlyOneSourceAllowedError.md index 81ae7f6fd..50f9be8c7 100644 --- a/docs/reference/classes/OnlyOneSourceAllowedError.md +++ b/docs/reference/classes/OnlyOneSourceAllowedError.md @@ -5,7 +5,7 @@ title: OnlyOneSourceAllowedError # Class: OnlyOneSourceAllowedError -Defined in: [packages/db/src/errors.ts:343](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L343) +Defined in: [packages/db/src/errors.ts:343](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L343) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:343](https://github.com/TanStack/db/blob/ new OnlyOneSourceAllowedError(context): OnlyOneSourceAllowedError; ``` -Defined in: [packages/db/src/errors.ts:344](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L344) +Defined in: [packages/db/src/errors.ts:344](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L344) #### Parameters diff --git a/docs/reference/classes/QueryBuilderError.md b/docs/reference/classes/QueryBuilderError.md index 83c0a2bcc..d98991700 100644 --- a/docs/reference/classes/QueryBuilderError.md +++ b/docs/reference/classes/QueryBuilderError.md @@ -5,7 +5,7 @@ title: QueryBuilderError # Class: QueryBuilderError -Defined in: [packages/db/src/errors.ts:336](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L336) +Defined in: [packages/db/src/errors.ts:336](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L336) ## Extends @@ -28,7 +28,7 @@ Defined in: [packages/db/src/errors.ts:336](https://github.com/TanStack/db/blob/ new QueryBuilderError(message): QueryBuilderError; ``` -Defined in: [packages/db/src/errors.ts:337](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L337) +Defined in: [packages/db/src/errors.ts:337](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L337) #### Parameters diff --git a/docs/reference/classes/QueryCompilationError.md b/docs/reference/classes/QueryCompilationError.md index 7628112a7..33193c04d 100644 --- a/docs/reference/classes/QueryCompilationError.md +++ b/docs/reference/classes/QueryCompilationError.md @@ -5,7 +5,7 @@ title: QueryCompilationError # Class: QueryCompilationError -Defined in: [packages/db/src/errors.ts:385](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L385) +Defined in: [packages/db/src/errors.ts:385](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L385) ## Extends @@ -36,7 +36,7 @@ Defined in: [packages/db/src/errors.ts:385](https://github.com/TanStack/db/blob/ new QueryCompilationError(message): QueryCompilationError; ``` -Defined in: [packages/db/src/errors.ts:386](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L386) +Defined in: [packages/db/src/errors.ts:386](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L386) #### Parameters diff --git a/docs/reference/classes/QueryMustHaveFromClauseError.md b/docs/reference/classes/QueryMustHaveFromClauseError.md index 07b085bc2..adf16dcfe 100644 --- a/docs/reference/classes/QueryMustHaveFromClauseError.md +++ b/docs/reference/classes/QueryMustHaveFromClauseError.md @@ -5,7 +5,7 @@ title: QueryMustHaveFromClauseError # Class: QueryMustHaveFromClauseError -Defined in: [packages/db/src/errors.ts:378](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L378) +Defined in: [packages/db/src/errors.ts:378](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L378) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:378](https://github.com/TanStack/db/blob/ new QueryMustHaveFromClauseError(): QueryMustHaveFromClauseError; ``` -Defined in: [packages/db/src/errors.ts:379](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L379) +Defined in: [packages/db/src/errors.ts:379](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L379) #### Returns diff --git a/docs/reference/classes/QueryOptimizerError.md b/docs/reference/classes/QueryOptimizerError.md index 310a308e3..a9c33e93a 100644 --- a/docs/reference/classes/QueryOptimizerError.md +++ b/docs/reference/classes/QueryOptimizerError.md @@ -5,7 +5,7 @@ title: QueryOptimizerError # Class: QueryOptimizerError -Defined in: [packages/db/src/errors.ts:628](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L628) +Defined in: [packages/db/src/errors.ts:628](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L628) ## Extends @@ -24,7 +24,7 @@ Defined in: [packages/db/src/errors.ts:628](https://github.com/TanStack/db/blob/ new QueryOptimizerError(message): QueryOptimizerError; ``` -Defined in: [packages/db/src/errors.ts:629](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L629) +Defined in: [packages/db/src/errors.ts:629](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L629) #### Parameters diff --git a/docs/reference/classes/SchemaMustBeSynchronousError.md b/docs/reference/classes/SchemaMustBeSynchronousError.md index 85d06e5fa..6001ec957 100644 --- a/docs/reference/classes/SchemaMustBeSynchronousError.md +++ b/docs/reference/classes/SchemaMustBeSynchronousError.md @@ -5,7 +5,7 @@ title: SchemaMustBeSynchronousError # Class: SchemaMustBeSynchronousError -Defined in: [packages/db/src/errors.ts:96](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L96) +Defined in: [packages/db/src/errors.ts:96](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L96) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:96](https://github.com/TanStack/db/blob/m new SchemaMustBeSynchronousError(): SchemaMustBeSynchronousError; ``` -Defined in: [packages/db/src/errors.ts:97](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L97) +Defined in: [packages/db/src/errors.ts:97](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L97) #### Returns diff --git a/docs/reference/classes/SchemaValidationError.md b/docs/reference/classes/SchemaValidationError.md index fecd17ffa..1e6b31ba1 100644 --- a/docs/reference/classes/SchemaValidationError.md +++ b/docs/reference/classes/SchemaValidationError.md @@ -5,7 +5,7 @@ title: SchemaValidationError # Class: SchemaValidationError -Defined in: [packages/db/src/errors.ts:18](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L18) +Defined in: [packages/db/src/errors.ts:18](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L18) ## Extends @@ -22,7 +22,7 @@ new SchemaValidationError( message?): SchemaValidationError; ``` -Defined in: [packages/db/src/errors.ts:25](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L25) +Defined in: [packages/db/src/errors.ts:25](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L25) #### Parameters @@ -68,7 +68,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li issues: readonly object[]; ``` -Defined in: [packages/db/src/errors.ts:20](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L20) +Defined in: [packages/db/src/errors.ts:20](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L20) *** @@ -120,7 +120,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li type: "insert" | "update"; ``` -Defined in: [packages/db/src/errors.ts:19](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L19) +Defined in: [packages/db/src/errors.ts:19](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L19) *** diff --git a/docs/reference/classes/SerializationError.md b/docs/reference/classes/SerializationError.md index ba8d0cd59..26524fcec 100644 --- a/docs/reference/classes/SerializationError.md +++ b/docs/reference/classes/SerializationError.md @@ -5,7 +5,7 @@ title: SerializationError # Class: SerializationError -Defined in: [packages/db/src/errors.ts:578](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L578) +Defined in: [packages/db/src/errors.ts:578](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L578) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:578](https://github.com/TanStack/db/blob/ new SerializationError(operation, originalError): SerializationError; ``` -Defined in: [packages/db/src/errors.ts:579](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L579) +Defined in: [packages/db/src/errors.ts:579](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L579) #### Parameters diff --git a/docs/reference/classes/SetWindowRequiresOrderByError.md b/docs/reference/classes/SetWindowRequiresOrderByError.md index 68ae1e85e..5634faaf3 100644 --- a/docs/reference/classes/SetWindowRequiresOrderByError.md +++ b/docs/reference/classes/SetWindowRequiresOrderByError.md @@ -5,7 +5,7 @@ title: SetWindowRequiresOrderByError # Class: SetWindowRequiresOrderByError -Defined in: [packages/db/src/errors.ts:696](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L696) +Defined in: [packages/db/src/errors.ts:696](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L696) Error thrown when setWindow is called on a collection without an ORDER BY clause. @@ -21,7 +21,7 @@ Error thrown when setWindow is called on a collection without an ORDER BY clause new SetWindowRequiresOrderByError(): SetWindowRequiresOrderByError; ``` -Defined in: [packages/db/src/errors.ts:697](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L697) +Defined in: [packages/db/src/errors.ts:697](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L697) #### Returns diff --git a/docs/reference/classes/SortedMap.md b/docs/reference/classes/SortedMap.md index 9b81f77cf..b5220d08c 100644 --- a/docs/reference/classes/SortedMap.md +++ b/docs/reference/classes/SortedMap.md @@ -5,7 +5,7 @@ title: SortedMap # Class: SortedMap\ -Defined in: [packages/db/src/SortedMap.ts:6](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L6) +Defined in: [packages/db/src/SortedMap.ts:6](https://github.com/MAST1999/db/blob/main/packages/db/src/SortedMap.ts#L6) A Map implementation that keeps its entries sorted based on a comparator function @@ -31,7 +31,7 @@ The type of values in the map new SortedMap(comparator?): SortedMap; ``` -Defined in: [packages/db/src/SortedMap.ts:16](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L16) +Defined in: [packages/db/src/SortedMap.ts:16](https://github.com/MAST1999/db/blob/main/packages/db/src/SortedMap.ts#L16) Creates a new SortedMap instance @@ -57,7 +57,7 @@ Optional function to compare values for sorting get size(): number; ``` -Defined in: [packages/db/src/SortedMap.ts:138](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L138) +Defined in: [packages/db/src/SortedMap.ts:138](https://github.com/MAST1999/db/blob/main/packages/db/src/SortedMap.ts#L138) Gets the number of key-value pairs in the map @@ -73,7 +73,7 @@ Gets the number of key-value pairs in the map iterator: IterableIterator<[TKey, TValue]>; ``` -Defined in: [packages/db/src/SortedMap.ts:147](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L147) +Defined in: [packages/db/src/SortedMap.ts:147](https://github.com/MAST1999/db/blob/main/packages/db/src/SortedMap.ts#L147) Default iterator that returns entries in sorted order @@ -91,7 +91,7 @@ An iterator for the map's entries clear(): void; ``` -Defined in: [packages/db/src/SortedMap.ts:130](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L130) +Defined in: [packages/db/src/SortedMap.ts:130](https://github.com/MAST1999/db/blob/main/packages/db/src/SortedMap.ts#L130) Removes all key-value pairs from the map @@ -107,7 +107,7 @@ Removes all key-value pairs from the map delete(key): boolean; ``` -Defined in: [packages/db/src/SortedMap.ts:106](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L106) +Defined in: [packages/db/src/SortedMap.ts:106](https://github.com/MAST1999/db/blob/main/packages/db/src/SortedMap.ts#L106) Removes a key-value pair from the map @@ -133,7 +133,7 @@ True if the key was found and removed, false otherwise entries(): IterableIterator<[TKey, TValue]>; ``` -Defined in: [packages/db/src/SortedMap.ts:158](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L158) +Defined in: [packages/db/src/SortedMap.ts:158](https://github.com/MAST1999/db/blob/main/packages/db/src/SortedMap.ts#L158) Returns an iterator for the map's entries in sorted order @@ -151,7 +151,7 @@ An iterator for the map's entries forEach(callbackfn): void; ``` -Defined in: [packages/db/src/SortedMap.ts:189](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L189) +Defined in: [packages/db/src/SortedMap.ts:189](https://github.com/MAST1999/db/blob/main/packages/db/src/SortedMap.ts#L189) Executes a callback function for each key-value pair in the map in sorted order @@ -175,7 +175,7 @@ Function to execute for each entry get(key): TValue | undefined; ``` -Defined in: [packages/db/src/SortedMap.ts:96](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L96) +Defined in: [packages/db/src/SortedMap.ts:96](https://github.com/MAST1999/db/blob/main/packages/db/src/SortedMap.ts#L96) Gets a value by its key @@ -201,7 +201,7 @@ The value associated with the key, or undefined if not found has(key): boolean; ``` -Defined in: [packages/db/src/SortedMap.ts:123](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L123) +Defined in: [packages/db/src/SortedMap.ts:123](https://github.com/MAST1999/db/blob/main/packages/db/src/SortedMap.ts#L123) Checks if a key exists in the map @@ -227,7 +227,7 @@ True if the key exists, false otherwise keys(): IterableIterator; ``` -Defined in: [packages/db/src/SortedMap.ts:167](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L167) +Defined in: [packages/db/src/SortedMap.ts:167](https://github.com/MAST1999/db/blob/main/packages/db/src/SortedMap.ts#L167) Returns an iterator for the map's keys in sorted order @@ -245,7 +245,7 @@ An iterator for the map's keys set(key, value): this; ``` -Defined in: [packages/db/src/SortedMap.ts:73](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L73) +Defined in: [packages/db/src/SortedMap.ts:73](https://github.com/MAST1999/db/blob/main/packages/db/src/SortedMap.ts#L73) Sets a key-value pair in the map and maintains sort order @@ -277,7 +277,7 @@ This SortedMap instance for chaining values(): IterableIterator; ``` -Defined in: [packages/db/src/SortedMap.ts:176](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L176) +Defined in: [packages/db/src/SortedMap.ts:176](https://github.com/MAST1999/db/blob/main/packages/db/src/SortedMap.ts#L176) Returns an iterator for the map's values in sorted order diff --git a/docs/reference/classes/StorageError.md b/docs/reference/classes/StorageError.md index d8c4fc35b..9d8a46f4d 100644 --- a/docs/reference/classes/StorageError.md +++ b/docs/reference/classes/StorageError.md @@ -5,7 +5,7 @@ title: StorageError # Class: StorageError -Defined in: [packages/db/src/errors.ts:571](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L571) +Defined in: [packages/db/src/errors.ts:571](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L571) ## Extends @@ -24,7 +24,7 @@ Defined in: [packages/db/src/errors.ts:571](https://github.com/TanStack/db/blob/ new StorageError(message): StorageError; ``` -Defined in: [packages/db/src/errors.ts:572](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L572) +Defined in: [packages/db/src/errors.ts:572](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L572) #### Parameters diff --git a/docs/reference/classes/StorageKeyRequiredError.md b/docs/reference/classes/StorageKeyRequiredError.md index ac825a752..b425048f2 100644 --- a/docs/reference/classes/StorageKeyRequiredError.md +++ b/docs/reference/classes/StorageKeyRequiredError.md @@ -5,7 +5,7 @@ title: StorageKeyRequiredError # Class: StorageKeyRequiredError -Defined in: [packages/db/src/errors.ts:594](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L594) +Defined in: [packages/db/src/errors.ts:594](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L594) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:594](https://github.com/TanStack/db/blob/ new StorageKeyRequiredError(): StorageKeyRequiredError; ``` -Defined in: [packages/db/src/errors.ts:595](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L595) +Defined in: [packages/db/src/errors.ts:595](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L595) #### Returns diff --git a/docs/reference/classes/SubQueryMustHaveFromClauseError.md b/docs/reference/classes/SubQueryMustHaveFromClauseError.md index db02ceff9..52d2e21fe 100644 --- a/docs/reference/classes/SubQueryMustHaveFromClauseError.md +++ b/docs/reference/classes/SubQueryMustHaveFromClauseError.md @@ -5,7 +5,7 @@ title: SubQueryMustHaveFromClauseError # Class: SubQueryMustHaveFromClauseError -Defined in: [packages/db/src/errors.ts:349](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L349) +Defined in: [packages/db/src/errors.ts:349](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L349) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:349](https://github.com/TanStack/db/blob/ new SubQueryMustHaveFromClauseError(context): SubQueryMustHaveFromClauseError; ``` -Defined in: [packages/db/src/errors.ts:350](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L350) +Defined in: [packages/db/src/errors.ts:350](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L350) #### Parameters diff --git a/docs/reference/classes/SubscriptionNotFoundError.md b/docs/reference/classes/SubscriptionNotFoundError.md index a42d9079f..4ff9b5ddb 100644 --- a/docs/reference/classes/SubscriptionNotFoundError.md +++ b/docs/reference/classes/SubscriptionNotFoundError.md @@ -5,7 +5,7 @@ title: SubscriptionNotFoundError # Class: SubscriptionNotFoundError -Defined in: [packages/db/src/errors.ts:656](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L656) +Defined in: [packages/db/src/errors.ts:656](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L656) Error when a subscription cannot be found during lazy join processing. For subqueries, aliases may be remapped (e.g., 'activeUser' → 'user'). @@ -26,7 +26,7 @@ new SubscriptionNotFoundError( availableAliases): SubscriptionNotFoundError; ``` -Defined in: [packages/db/src/errors.ts:657](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L657) +Defined in: [packages/db/src/errors.ts:657](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L657) #### Parameters diff --git a/docs/reference/classes/SyncCleanupError.md b/docs/reference/classes/SyncCleanupError.md index d8d7c3b7a..54b5d4364 100644 --- a/docs/reference/classes/SyncCleanupError.md +++ b/docs/reference/classes/SyncCleanupError.md @@ -5,7 +5,7 @@ title: SyncCleanupError # Class: SyncCleanupError -Defined in: [packages/db/src/errors.ts:617](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L617) +Defined in: [packages/db/src/errors.ts:617](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L617) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:617](https://github.com/TanStack/db/blob/ new SyncCleanupError(collectionId, error): SyncCleanupError; ``` -Defined in: [packages/db/src/errors.ts:618](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L618) +Defined in: [packages/db/src/errors.ts:618](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L618) #### Parameters diff --git a/docs/reference/classes/SyncTransactionAlreadyCommittedError.md b/docs/reference/classes/SyncTransactionAlreadyCommittedError.md index 78daaf215..b56bc194a 100644 --- a/docs/reference/classes/SyncTransactionAlreadyCommittedError.md +++ b/docs/reference/classes/SyncTransactionAlreadyCommittedError.md @@ -5,7 +5,7 @@ title: SyncTransactionAlreadyCommittedError # Class: SyncTransactionAlreadyCommittedError -Defined in: [packages/db/src/errors.ts:327](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L327) +Defined in: [packages/db/src/errors.ts:327](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L327) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:327](https://github.com/TanStack/db/blob/ new SyncTransactionAlreadyCommittedError(): SyncTransactionAlreadyCommittedError; ``` -Defined in: [packages/db/src/errors.ts:328](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L328) +Defined in: [packages/db/src/errors.ts:328](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L328) #### Returns diff --git a/docs/reference/classes/SyncTransactionAlreadyCommittedWriteError.md b/docs/reference/classes/SyncTransactionAlreadyCommittedWriteError.md index 1fa89e16b..938d558a5 100644 --- a/docs/reference/classes/SyncTransactionAlreadyCommittedWriteError.md +++ b/docs/reference/classes/SyncTransactionAlreadyCommittedWriteError.md @@ -5,7 +5,7 @@ title: SyncTransactionAlreadyCommittedWriteError # Class: SyncTransactionAlreadyCommittedWriteError -Defined in: [packages/db/src/errors.ts:313](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L313) +Defined in: [packages/db/src/errors.ts:313](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L313) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:313](https://github.com/TanStack/db/blob/ new SyncTransactionAlreadyCommittedWriteError(): SyncTransactionAlreadyCommittedWriteError; ``` -Defined in: [packages/db/src/errors.ts:314](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L314) +Defined in: [packages/db/src/errors.ts:314](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L314) #### Returns diff --git a/docs/reference/classes/TanStackDBError.md b/docs/reference/classes/TanStackDBError.md index dabc7ccbd..880463b0e 100644 --- a/docs/reference/classes/TanStackDBError.md +++ b/docs/reference/classes/TanStackDBError.md @@ -5,7 +5,7 @@ title: TanStackDBError # Class: TanStackDBError -Defined in: [packages/db/src/errors.ts:2](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L2) +Defined in: [packages/db/src/errors.ts:2](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L2) ## Extends @@ -37,7 +37,7 @@ Defined in: [packages/db/src/errors.ts:2](https://github.com/TanStack/db/blob/ma new TanStackDBError(message): TanStackDBError; ``` -Defined in: [packages/db/src/errors.ts:3](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L3) +Defined in: [packages/db/src/errors.ts:3](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L3) #### Parameters diff --git a/docs/reference/classes/TransactionAlreadyCompletedRollbackError.md b/docs/reference/classes/TransactionAlreadyCompletedRollbackError.md index 6469f7f0c..1b133ff4a 100644 --- a/docs/reference/classes/TransactionAlreadyCompletedRollbackError.md +++ b/docs/reference/classes/TransactionAlreadyCompletedRollbackError.md @@ -5,7 +5,7 @@ title: TransactionAlreadyCompletedRollbackError # Class: TransactionAlreadyCompletedRollbackError -Defined in: [packages/db/src/errors.ts:291](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L291) +Defined in: [packages/db/src/errors.ts:291](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L291) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:291](https://github.com/TanStack/db/blob/ new TransactionAlreadyCompletedRollbackError(): TransactionAlreadyCompletedRollbackError; ``` -Defined in: [packages/db/src/errors.ts:292](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L292) +Defined in: [packages/db/src/errors.ts:292](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L292) #### Returns diff --git a/docs/reference/classes/TransactionError.md b/docs/reference/classes/TransactionError.md index 29381eeb0..ddf935037 100644 --- a/docs/reference/classes/TransactionError.md +++ b/docs/reference/classes/TransactionError.md @@ -5,7 +5,7 @@ title: TransactionError # Class: TransactionError -Defined in: [packages/db/src/errors.ts:261](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L261) +Defined in: [packages/db/src/errors.ts:261](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L261) ## Extends @@ -31,7 +31,7 @@ Defined in: [packages/db/src/errors.ts:261](https://github.com/TanStack/db/blob/ new TransactionError(message): TransactionError; ``` -Defined in: [packages/db/src/errors.ts:262](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L262) +Defined in: [packages/db/src/errors.ts:262](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L262) #### Parameters diff --git a/docs/reference/classes/TransactionNotPendingCommitError.md b/docs/reference/classes/TransactionNotPendingCommitError.md index dc9705bb8..85b9aa1c4 100644 --- a/docs/reference/classes/TransactionNotPendingCommitError.md +++ b/docs/reference/classes/TransactionNotPendingCommitError.md @@ -5,7 +5,7 @@ title: TransactionNotPendingCommitError # Class: TransactionNotPendingCommitError -Defined in: [packages/db/src/errors.ts:299](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L299) +Defined in: [packages/db/src/errors.ts:299](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L299) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:299](https://github.com/TanStack/db/blob/ new TransactionNotPendingCommitError(): TransactionNotPendingCommitError; ``` -Defined in: [packages/db/src/errors.ts:300](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L300) +Defined in: [packages/db/src/errors.ts:300](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L300) #### Returns diff --git a/docs/reference/classes/TransactionNotPendingMutateError.md b/docs/reference/classes/TransactionNotPendingMutateError.md index 57bf6eb32..212e0a07d 100644 --- a/docs/reference/classes/TransactionNotPendingMutateError.md +++ b/docs/reference/classes/TransactionNotPendingMutateError.md @@ -5,7 +5,7 @@ title: TransactionNotPendingMutateError # Class: TransactionNotPendingMutateError -Defined in: [packages/db/src/errors.ts:283](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L283) +Defined in: [packages/db/src/errors.ts:283](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L283) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:283](https://github.com/TanStack/db/blob/ new TransactionNotPendingMutateError(): TransactionNotPendingMutateError; ``` -Defined in: [packages/db/src/errors.ts:284](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L284) +Defined in: [packages/db/src/errors.ts:284](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L284) #### Returns diff --git a/docs/reference/classes/UndefinedKeyError.md b/docs/reference/classes/UndefinedKeyError.md index 24f075ab1..07201dcef 100644 --- a/docs/reference/classes/UndefinedKeyError.md +++ b/docs/reference/classes/UndefinedKeyError.md @@ -5,7 +5,7 @@ title: UndefinedKeyError # Class: UndefinedKeyError -Defined in: [packages/db/src/errors.ts:146](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L146) +Defined in: [packages/db/src/errors.ts:146](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L146) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:146](https://github.com/TanStack/db/blob/ new UndefinedKeyError(item): UndefinedKeyError; ``` -Defined in: [packages/db/src/errors.ts:147](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L147) +Defined in: [packages/db/src/errors.ts:147](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L147) #### Parameters diff --git a/docs/reference/classes/UnknownExpressionTypeError.md b/docs/reference/classes/UnknownExpressionTypeError.md index f4d74a8d2..7224dc139 100644 --- a/docs/reference/classes/UnknownExpressionTypeError.md +++ b/docs/reference/classes/UnknownExpressionTypeError.md @@ -5,7 +5,7 @@ title: UnknownExpressionTypeError # Class: UnknownExpressionTypeError -Defined in: [packages/db/src/errors.ts:454](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L454) +Defined in: [packages/db/src/errors.ts:454](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L454) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:454](https://github.com/TanStack/db/blob/ new UnknownExpressionTypeError(type): UnknownExpressionTypeError; ``` -Defined in: [packages/db/src/errors.ts:455](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L455) +Defined in: [packages/db/src/errors.ts:455](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L455) #### Parameters diff --git a/docs/reference/classes/UnknownFunctionError.md b/docs/reference/classes/UnknownFunctionError.md index 7b9c5cd10..0103165f5 100644 --- a/docs/reference/classes/UnknownFunctionError.md +++ b/docs/reference/classes/UnknownFunctionError.md @@ -5,7 +5,7 @@ title: UnknownFunctionError # Class: UnknownFunctionError -Defined in: [packages/db/src/errors.ts:466](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L466) +Defined in: [packages/db/src/errors.ts:466](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L466) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:466](https://github.com/TanStack/db/blob/ new UnknownFunctionError(functionName): UnknownFunctionError; ``` -Defined in: [packages/db/src/errors.ts:467](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L467) +Defined in: [packages/db/src/errors.ts:467](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L467) #### Parameters diff --git a/docs/reference/classes/UnknownHavingExpressionTypeError.md b/docs/reference/classes/UnknownHavingExpressionTypeError.md index 802a4699c..9cb7095f4 100644 --- a/docs/reference/classes/UnknownHavingExpressionTypeError.md +++ b/docs/reference/classes/UnknownHavingExpressionTypeError.md @@ -5,7 +5,7 @@ title: UnknownHavingExpressionTypeError # Class: UnknownHavingExpressionTypeError -Defined in: [packages/db/src/errors.ts:564](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L564) +Defined in: [packages/db/src/errors.ts:564](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L564) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:564](https://github.com/TanStack/db/blob/ new UnknownHavingExpressionTypeError(type): UnknownHavingExpressionTypeError; ``` -Defined in: [packages/db/src/errors.ts:565](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L565) +Defined in: [packages/db/src/errors.ts:565](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L565) #### Parameters diff --git a/docs/reference/classes/UnsupportedAggregateFunctionError.md b/docs/reference/classes/UnsupportedAggregateFunctionError.md index 6f377c35f..2ecd5a4b8 100644 --- a/docs/reference/classes/UnsupportedAggregateFunctionError.md +++ b/docs/reference/classes/UnsupportedAggregateFunctionError.md @@ -5,7 +5,7 @@ title: UnsupportedAggregateFunctionError # Class: UnsupportedAggregateFunctionError -Defined in: [packages/db/src/errors.ts:550](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L550) +Defined in: [packages/db/src/errors.ts:550](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L550) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:550](https://github.com/TanStack/db/blob/ new UnsupportedAggregateFunctionError(functionName): UnsupportedAggregateFunctionError; ``` -Defined in: [packages/db/src/errors.ts:551](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L551) +Defined in: [packages/db/src/errors.ts:551](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L551) #### Parameters diff --git a/docs/reference/classes/UnsupportedFromTypeError.md b/docs/reference/classes/UnsupportedFromTypeError.md index 5dd5b84cf..f6a590fef 100644 --- a/docs/reference/classes/UnsupportedFromTypeError.md +++ b/docs/reference/classes/UnsupportedFromTypeError.md @@ -5,7 +5,7 @@ title: UnsupportedFromTypeError # Class: UnsupportedFromTypeError -Defined in: [packages/db/src/errors.ts:448](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L448) +Defined in: [packages/db/src/errors.ts:448](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L448) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:448](https://github.com/TanStack/db/blob/ new UnsupportedFromTypeError(type): UnsupportedFromTypeError; ``` -Defined in: [packages/db/src/errors.ts:449](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L449) +Defined in: [packages/db/src/errors.ts:449](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L449) #### Parameters diff --git a/docs/reference/classes/UnsupportedJoinSourceTypeError.md b/docs/reference/classes/UnsupportedJoinSourceTypeError.md index 35282dcef..40a22e6d5 100644 --- a/docs/reference/classes/UnsupportedJoinSourceTypeError.md +++ b/docs/reference/classes/UnsupportedJoinSourceTypeError.md @@ -5,7 +5,7 @@ title: UnsupportedJoinSourceTypeError # Class: UnsupportedJoinSourceTypeError -Defined in: [packages/db/src/errors.ts:528](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L528) +Defined in: [packages/db/src/errors.ts:528](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L528) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:528](https://github.com/TanStack/db/blob/ new UnsupportedJoinSourceTypeError(type): UnsupportedJoinSourceTypeError; ``` -Defined in: [packages/db/src/errors.ts:529](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L529) +Defined in: [packages/db/src/errors.ts:529](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L529) #### Parameters diff --git a/docs/reference/classes/UnsupportedJoinTypeError.md b/docs/reference/classes/UnsupportedJoinTypeError.md index 9ef53dc56..11f53f915 100644 --- a/docs/reference/classes/UnsupportedJoinTypeError.md +++ b/docs/reference/classes/UnsupportedJoinTypeError.md @@ -5,7 +5,7 @@ title: UnsupportedJoinTypeError # Class: UnsupportedJoinTypeError -Defined in: [packages/db/src/errors.ts:486](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L486) +Defined in: [packages/db/src/errors.ts:486](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L486) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:486](https://github.com/TanStack/db/blob/ new UnsupportedJoinTypeError(joinType): UnsupportedJoinTypeError; ``` -Defined in: [packages/db/src/errors.ts:487](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L487) +Defined in: [packages/db/src/errors.ts:487](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L487) #### Parameters diff --git a/docs/reference/classes/UpdateKeyNotFoundError.md b/docs/reference/classes/UpdateKeyNotFoundError.md index d029b874b..59a7381b3 100644 --- a/docs/reference/classes/UpdateKeyNotFoundError.md +++ b/docs/reference/classes/UpdateKeyNotFoundError.md @@ -5,7 +5,7 @@ title: UpdateKeyNotFoundError # Class: UpdateKeyNotFoundError -Defined in: [packages/db/src/errors.ts:198](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L198) +Defined in: [packages/db/src/errors.ts:198](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L198) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:198](https://github.com/TanStack/db/blob/ new UpdateKeyNotFoundError(key): UpdateKeyNotFoundError; ``` -Defined in: [packages/db/src/errors.ts:199](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L199) +Defined in: [packages/db/src/errors.ts:199](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L199) #### Parameters diff --git a/docs/reference/classes/WhereClauseConversionError.md b/docs/reference/classes/WhereClauseConversionError.md index 98fb6f2d7..83cc1e6d9 100644 --- a/docs/reference/classes/WhereClauseConversionError.md +++ b/docs/reference/classes/WhereClauseConversionError.md @@ -5,7 +5,7 @@ title: WhereClauseConversionError # Class: WhereClauseConversionError -Defined in: [packages/db/src/errors.ts:644](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L644) +Defined in: [packages/db/src/errors.ts:644](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L644) Internal error when the query optimizer fails to convert a WHERE clause to a collection filter. @@ -21,7 +21,7 @@ Internal error when the query optimizer fails to convert a WHERE clause to a col new WhereClauseConversionError(collectionId, alias): WhereClauseConversionError; ``` -Defined in: [packages/db/src/errors.ts:645](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L645) +Defined in: [packages/db/src/errors.ts:645](https://github.com/MAST1999/db/blob/main/packages/db/src/errors.ts#L645) #### Parameters diff --git a/docs/reference/electric-db-collection/classes/ElectricDBCollectionError.md b/docs/reference/electric-db-collection/classes/ElectricDBCollectionError.md index 8ec928746..2cb5d6410 100644 --- a/docs/reference/electric-db-collection/classes/ElectricDBCollectionError.md +++ b/docs/reference/electric-db-collection/classes/ElectricDBCollectionError.md @@ -5,7 +5,7 @@ title: ElectricDBCollectionError # Class: ElectricDBCollectionError -Defined in: [packages/electric-db-collection/src/errors.ts:4](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/errors.ts#L4) +Defined in: [packages/electric-db-collection/src/errors.ts:4](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/errors.ts#L4) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/electric-db-collection/src/errors.ts:4](https://github.com new ElectricDBCollectionError(message, collectionId?): ElectricDBCollectionError; ``` -Defined in: [packages/electric-db-collection/src/errors.ts:5](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/errors.ts#L5) +Defined in: [packages/electric-db-collection/src/errors.ts:5](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/errors.ts#L5) #### Parameters diff --git a/docs/reference/electric-db-collection/classes/ExpectedNumberInAwaitTxIdError.md b/docs/reference/electric-db-collection/classes/ExpectedNumberInAwaitTxIdError.md index a0c31569e..5cf8ce151 100644 --- a/docs/reference/electric-db-collection/classes/ExpectedNumberInAwaitTxIdError.md +++ b/docs/reference/electric-db-collection/classes/ExpectedNumberInAwaitTxIdError.md @@ -5,7 +5,7 @@ title: ExpectedNumberInAwaitTxIdError # Class: ExpectedNumberInAwaitTxIdError -Defined in: [packages/electric-db-collection/src/errors.ts:11](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/errors.ts#L11) +Defined in: [packages/electric-db-collection/src/errors.ts:11](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/errors.ts#L11) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/electric-db-collection/src/errors.ts:11](https://github.co new ExpectedNumberInAwaitTxIdError(txIdType, collectionId?): ExpectedNumberInAwaitTxIdError; ``` -Defined in: [packages/electric-db-collection/src/errors.ts:12](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/errors.ts#L12) +Defined in: [packages/electric-db-collection/src/errors.ts:12](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/errors.ts#L12) #### Parameters diff --git a/docs/reference/electric-db-collection/classes/StreamAbortedError.md b/docs/reference/electric-db-collection/classes/StreamAbortedError.md index d08f6639f..d5b4ff3f8 100644 --- a/docs/reference/electric-db-collection/classes/StreamAbortedError.md +++ b/docs/reference/electric-db-collection/classes/StreamAbortedError.md @@ -5,7 +5,7 @@ title: StreamAbortedError # Class: StreamAbortedError -Defined in: [packages/electric-db-collection/src/errors.ts:32](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/errors.ts#L32) +Defined in: [packages/electric-db-collection/src/errors.ts:32](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/errors.ts#L32) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/electric-db-collection/src/errors.ts:32](https://github.co new StreamAbortedError(collectionId?): StreamAbortedError; ``` -Defined in: [packages/electric-db-collection/src/errors.ts:33](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/errors.ts#L33) +Defined in: [packages/electric-db-collection/src/errors.ts:33](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/errors.ts#L33) #### Parameters diff --git a/docs/reference/electric-db-collection/classes/TimeoutWaitingForMatchError.md b/docs/reference/electric-db-collection/classes/TimeoutWaitingForMatchError.md index 2cfd78e55..b4298148c 100644 --- a/docs/reference/electric-db-collection/classes/TimeoutWaitingForMatchError.md +++ b/docs/reference/electric-db-collection/classes/TimeoutWaitingForMatchError.md @@ -5,7 +5,7 @@ title: TimeoutWaitingForMatchError # Class: TimeoutWaitingForMatchError -Defined in: [packages/electric-db-collection/src/errors.ts:25](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/errors.ts#L25) +Defined in: [packages/electric-db-collection/src/errors.ts:25](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/errors.ts#L25) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/electric-db-collection/src/errors.ts:25](https://github.co new TimeoutWaitingForMatchError(collectionId?): TimeoutWaitingForMatchError; ``` -Defined in: [packages/electric-db-collection/src/errors.ts:26](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/errors.ts#L26) +Defined in: [packages/electric-db-collection/src/errors.ts:26](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/errors.ts#L26) #### Parameters diff --git a/docs/reference/electric-db-collection/classes/TimeoutWaitingForTxIdError.md b/docs/reference/electric-db-collection/classes/TimeoutWaitingForTxIdError.md index 5f7f76187..be9e627ce 100644 --- a/docs/reference/electric-db-collection/classes/TimeoutWaitingForTxIdError.md +++ b/docs/reference/electric-db-collection/classes/TimeoutWaitingForTxIdError.md @@ -5,7 +5,7 @@ title: TimeoutWaitingForTxIdError # Class: TimeoutWaitingForTxIdError -Defined in: [packages/electric-db-collection/src/errors.ts:18](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/errors.ts#L18) +Defined in: [packages/electric-db-collection/src/errors.ts:18](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/errors.ts#L18) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/electric-db-collection/src/errors.ts:18](https://github.co new TimeoutWaitingForTxIdError(txId, collectionId?): TimeoutWaitingForTxIdError; ``` -Defined in: [packages/electric-db-collection/src/errors.ts:19](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/errors.ts#L19) +Defined in: [packages/electric-db-collection/src/errors.ts:19](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/errors.ts#L19) #### Parameters diff --git a/docs/reference/electric-db-collection/functions/electricCollectionOptions.md b/docs/reference/electric-db-collection/functions/electricCollectionOptions.md index b4dc3df4e..1daafa868 100644 --- a/docs/reference/electric-db-collection/functions/electricCollectionOptions.md +++ b/docs/reference/electric-db-collection/functions/electricCollectionOptions.md @@ -11,7 +11,7 @@ title: electricCollectionOptions function electricCollectionOptions(config): Omit, string | number, T, UtilsRecord>, "utils"> & object; ``` -Defined in: [packages/electric-db-collection/src/electric.ts:427](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L427) +Defined in: [packages/electric-db-collection/src/electric.ts:427](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/electric.ts#L427) Creates Electric collection options for use with a standard Collection @@ -43,7 +43,7 @@ Collection options with utilities function electricCollectionOptions(config): Omit, "utils"> & object; ``` -Defined in: [packages/electric-db-collection/src/electric.ts:438](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L438) +Defined in: [packages/electric-db-collection/src/electric.ts:438](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/electric.ts#L438) Creates Electric collection options for use with a standard Collection diff --git a/docs/reference/electric-db-collection/interfaces/ElectricCollectionConfig.md b/docs/reference/electric-db-collection/interfaces/ElectricCollectionConfig.md index b096292e3..a7c31cb2b 100644 --- a/docs/reference/electric-db-collection/interfaces/ElectricCollectionConfig.md +++ b/docs/reference/electric-db-collection/interfaces/ElectricCollectionConfig.md @@ -5,7 +5,7 @@ title: ElectricCollectionConfig # Interface: ElectricCollectionConfig\ -Defined in: [packages/electric-db-collection/src/electric.ts:124](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L124) +Defined in: [packages/electric-db-collection/src/electric.ts:124](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/electric.ts#L124) Configuration interface for Electric collection options @@ -35,7 +35,7 @@ The schema type for validation optional [ELECTRIC_TEST_HOOKS]: ElectricTestHooks; ``` -Defined in: [packages/electric-db-collection/src/electric.ts:147](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L147) +Defined in: [packages/electric-db-collection/src/electric.ts:147](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/electric.ts#L147) Internal test hooks (for testing only) Hidden via Symbol to prevent accidental usage in production @@ -48,7 +48,7 @@ Hidden via Symbol to prevent accidental usage in production optional onDelete: (params) => Promise; ``` -Defined in: [packages/electric-db-collection/src/electric.ts:264](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L264) +Defined in: [packages/electric-db-collection/src/electric.ts:264](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/electric.ts#L264) Optional asynchronous handler function called before a delete operation @@ -100,7 +100,7 @@ onDelete: async ({ transaction, collection }) => { optional onInsert: (params) => Promise; ``` -Defined in: [packages/electric-db-collection/src/electric.ts:195](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L195) +Defined in: [packages/electric-db-collection/src/electric.ts:195](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/electric.ts#L195) Optional asynchronous handler function called before an insert operation @@ -174,7 +174,7 @@ onInsert: async ({ transaction, collection }) => { optional onUpdate: (params) => Promise; ``` -Defined in: [packages/electric-db-collection/src/electric.ts:230](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L230) +Defined in: [packages/electric-db-collection/src/electric.ts:230](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/electric.ts#L230) Optional asynchronous handler function called before an update operation @@ -227,7 +227,7 @@ onUpdate: async ({ transaction, collection }) => { shapeOptions: ShapeStreamOptions>; ``` -Defined in: [packages/electric-db-collection/src/electric.ts:140](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L140) +Defined in: [packages/electric-db-collection/src/electric.ts:140](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/electric.ts#L140) Configuration options for the ElectricSQL ShapeStream @@ -239,4 +239,4 @@ Configuration options for the ElectricSQL ShapeStream optional syncMode: ElectricSyncMode; ``` -Defined in: [packages/electric-db-collection/src/electric.ts:141](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L141) +Defined in: [packages/electric-db-collection/src/electric.ts:141](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/electric.ts#L141) diff --git a/docs/reference/electric-db-collection/interfaces/ElectricCollectionUtils.md b/docs/reference/electric-db-collection/interfaces/ElectricCollectionUtils.md index 6364e3072..7c407e4a7 100644 --- a/docs/reference/electric-db-collection/interfaces/ElectricCollectionUtils.md +++ b/docs/reference/electric-db-collection/interfaces/ElectricCollectionUtils.md @@ -5,7 +5,7 @@ title: ElectricCollectionUtils # Interface: ElectricCollectionUtils\ -Defined in: [packages/electric-db-collection/src/electric.ts:409](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L409) +Defined in: [packages/electric-db-collection/src/electric.ts:409](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/electric.ts#L409) Electric collection utilities type @@ -33,7 +33,7 @@ Electric collection utilities type awaitMatch: AwaitMatchFn; ``` -Defined in: [packages/electric-db-collection/src/electric.ts:413](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L413) +Defined in: [packages/electric-db-collection/src/electric.ts:413](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/electric.ts#L413) *** @@ -43,4 +43,4 @@ Defined in: [packages/electric-db-collection/src/electric.ts:413](https://github awaitTxId: AwaitTxIdFn; ``` -Defined in: [packages/electric-db-collection/src/electric.ts:412](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L412) +Defined in: [packages/electric-db-collection/src/electric.ts:412](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/electric.ts#L412) diff --git a/docs/reference/electric-db-collection/type-aliases/AwaitTxIdFn.md b/docs/reference/electric-db-collection/type-aliases/AwaitTxIdFn.md index 8dd0d67e9..073fd36f7 100644 --- a/docs/reference/electric-db-collection/type-aliases/AwaitTxIdFn.md +++ b/docs/reference/electric-db-collection/type-aliases/AwaitTxIdFn.md @@ -9,7 +9,7 @@ title: AwaitTxIdFn type AwaitTxIdFn = (txId, timeout?) => Promise; ``` -Defined in: [packages/electric-db-collection/src/electric.ts:396](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L396) +Defined in: [packages/electric-db-collection/src/electric.ts:396](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/electric.ts#L396) Type for the awaitTxId utility function diff --git a/docs/reference/electric-db-collection/type-aliases/Txid.md b/docs/reference/electric-db-collection/type-aliases/Txid.md index 3870788c6..0f485cca3 100644 --- a/docs/reference/electric-db-collection/type-aliases/Txid.md +++ b/docs/reference/electric-db-collection/type-aliases/Txid.md @@ -9,6 +9,6 @@ title: Txid type Txid = number; ``` -Defined in: [packages/electric-db-collection/src/electric.ts:62](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L62) +Defined in: [packages/electric-db-collection/src/electric.ts:62](https://github.com/MAST1999/db/blob/main/packages/electric-db-collection/src/electric.ts#L62) Type representing a transaction ID in ElectricSQL diff --git a/docs/reference/functions/add.md b/docs/reference/functions/add.md index 767e7d8d1..5c9160c3d 100644 --- a/docs/reference/functions/add.md +++ b/docs/reference/functions/add.md @@ -9,7 +9,7 @@ title: add function add(left, right): BinaryNumericReturnType; ``` -Defined in: [packages/db/src/query/builder/functions.ts:295](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L295) +Defined in: [packages/db/src/query/builder/functions.ts:295](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L295) ## Type Parameters diff --git a/docs/reference/functions/and.md b/docs/reference/functions/and.md index b48e66633..a7af192ef 100644 --- a/docs/reference/functions/and.md +++ b/docs/reference/functions/and.md @@ -11,7 +11,7 @@ title: and function and(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:181](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L181) +Defined in: [packages/db/src/query/builder/functions.ts:181](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L181) ### Parameters @@ -36,7 +36,7 @@ function and( rest): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:185](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L185) +Defined in: [packages/db/src/query/builder/functions.ts:185](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L185) ### Parameters diff --git a/docs/reference/functions/avg.md b/docs/reference/functions/avg.md index 98b7f615a..ffa35360f 100644 --- a/docs/reference/functions/avg.md +++ b/docs/reference/functions/avg.md @@ -9,7 +9,7 @@ title: avg function avg(arg): AggregateReturnType; ``` -Defined in: [packages/db/src/query/builder/functions.ts:311](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L311) +Defined in: [packages/db/src/query/builder/functions.ts:311](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L311) ## Type Parameters diff --git a/docs/reference/functions/coalesce.md b/docs/reference/functions/coalesce.md index db59fc945..72edb6896 100644 --- a/docs/reference/functions/coalesce.md +++ b/docs/reference/functions/coalesce.md @@ -9,7 +9,7 @@ title: coalesce function coalesce(...args): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:288](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L288) +Defined in: [packages/db/src/query/builder/functions.ts:288](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L288) ## Parameters diff --git a/docs/reference/functions/compileQuery.md b/docs/reference/functions/compileQuery.md index 729b5ae39..dba39f0cb 100644 --- a/docs/reference/functions/compileQuery.md +++ b/docs/reference/functions/compileQuery.md @@ -19,7 +19,7 @@ function compileQuery( queryMapping): CompilationResult; ``` -Defined in: [packages/db/src/query/compiler/index.ts:85](https://github.com/TanStack/db/blob/main/packages/db/src/query/compiler/index.ts#L85) +Defined in: [packages/db/src/query/compiler/index.ts:85](https://github.com/MAST1999/db/blob/main/packages/db/src/query/compiler/index.ts#L85) Compiles a query IR into a D2 pipeline diff --git a/docs/reference/functions/concat.md b/docs/reference/functions/concat.md index 9c8edfbd6..1065964c7 100644 --- a/docs/reference/functions/concat.md +++ b/docs/reference/functions/concat.md @@ -9,7 +9,7 @@ title: concat function concat(...args): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:279](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L279) +Defined in: [packages/db/src/query/builder/functions.ts:279](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L279) ## Parameters diff --git a/docs/reference/functions/count.md b/docs/reference/functions/count.md index bc82fcf79..1f378f868 100644 --- a/docs/reference/functions/count.md +++ b/docs/reference/functions/count.md @@ -9,7 +9,7 @@ title: count function count(arg): Aggregate; ``` -Defined in: [packages/db/src/query/builder/functions.ts:307](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L307) +Defined in: [packages/db/src/query/builder/functions.ts:307](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L307) ## Parameters diff --git a/docs/reference/functions/createArrayChangeProxy.md b/docs/reference/functions/createArrayChangeProxy.md index 79d80a31c..1a54fbee4 100644 --- a/docs/reference/functions/createArrayChangeProxy.md +++ b/docs/reference/functions/createArrayChangeProxy.md @@ -9,7 +9,7 @@ title: createArrayChangeProxy function createArrayChangeProxy(targets): object; ``` -Defined in: [packages/db/src/proxy.ts:1130](https://github.com/TanStack/db/blob/main/packages/db/src/proxy.ts#L1130) +Defined in: [packages/db/src/proxy.ts:1130](https://github.com/MAST1999/db/blob/main/packages/db/src/proxy.ts#L1130) Creates proxies for an array of objects and tracks changes to each diff --git a/docs/reference/functions/createChangeProxy.md b/docs/reference/functions/createChangeProxy.md index efc5b50b3..c619d29b7 100644 --- a/docs/reference/functions/createChangeProxy.md +++ b/docs/reference/functions/createChangeProxy.md @@ -9,7 +9,7 @@ title: createChangeProxy function createChangeProxy(target, parent?): object; ``` -Defined in: [packages/db/src/proxy.ts:628](https://github.com/TanStack/db/blob/main/packages/db/src/proxy.ts#L628) +Defined in: [packages/db/src/proxy.ts:628](https://github.com/MAST1999/db/blob/main/packages/db/src/proxy.ts#L628) Creates a proxy that tracks changes to the target object diff --git a/docs/reference/functions/createCollection.md b/docs/reference/functions/createCollection.md index 5c71455d2..f18298165 100644 --- a/docs/reference/functions/createCollection.md +++ b/docs/reference/functions/createCollection.md @@ -11,7 +11,7 @@ title: createCollection function createCollection(options): Collection, TKey, TUtils, T, InferSchemaInput> & NonSingleResult; ``` -Defined in: [packages/db/src/collection/index.ts:134](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L134) +Defined in: [packages/db/src/collection/index.ts:134](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L134) Creates a new Collection instance with the given configuration @@ -120,7 +120,7 @@ const todos = createCollection({ function createCollection(options): Collection, TKey, Exclude, T, InferSchemaInput> & NonSingleResult; ``` -Defined in: [packages/db/src/collection/index.ts:151](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L151) +Defined in: [packages/db/src/collection/index.ts:151](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L151) Creates a new Collection instance with the given configuration @@ -229,7 +229,7 @@ const todos = createCollection({ function createCollection(options): Collection, TKey, TUtils, T, InferSchemaInput> & SingleResult; ``` -Defined in: [packages/db/src/collection/index.ts:169](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L169) +Defined in: [packages/db/src/collection/index.ts:169](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L169) Creates a new Collection instance with the given configuration @@ -338,7 +338,7 @@ const todos = createCollection({ function createCollection(options): Collection, TKey, TUtils, T, InferSchemaInput> & SingleResult; ``` -Defined in: [packages/db/src/collection/index.ts:185](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L185) +Defined in: [packages/db/src/collection/index.ts:185](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L185) Creates a new Collection instance with the given configuration @@ -447,7 +447,7 @@ const todos = createCollection({ function createCollection(options): Collection & NonSingleResult; ``` -Defined in: [packages/db/src/collection/index.ts:198](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L198) +Defined in: [packages/db/src/collection/index.ts:198](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L198) Creates a new Collection instance with the given configuration @@ -556,7 +556,7 @@ const todos = createCollection({ function createCollection(options): Collection & NonSingleResult; ``` -Defined in: [packages/db/src/collection/index.ts:211](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L211) +Defined in: [packages/db/src/collection/index.ts:211](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L211) Creates a new Collection instance with the given configuration @@ -665,7 +665,7 @@ const todos = createCollection({ function createCollection(options): Collection & SingleResult; ``` -Defined in: [packages/db/src/collection/index.ts:223](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L223) +Defined in: [packages/db/src/collection/index.ts:223](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L223) Creates a new Collection instance with the given configuration @@ -774,7 +774,7 @@ const todos = createCollection({ function createCollection(options): Collection & SingleResult; ``` -Defined in: [packages/db/src/collection/index.ts:236](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L236) +Defined in: [packages/db/src/collection/index.ts:236](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L236) Creates a new Collection instance with the given configuration diff --git a/docs/reference/functions/createLiveQueryCollection.md b/docs/reference/functions/createLiveQueryCollection.md index b35008dc4..35a5647cd 100644 --- a/docs/reference/functions/createLiveQueryCollection.md +++ b/docs/reference/functions/createLiveQueryCollection.md @@ -12,7 +12,7 @@ function createLiveQueryCollection(query): CollectionForConte }> & object; ``` -Defined in: [packages/db/src/query/live-query-collection.ts:115](https://github.com/TanStack/db/blob/main/packages/db/src/query/live-query-collection.ts#L115) +Defined in: [packages/db/src/query/live-query-collection.ts:115](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live-query-collection.ts#L115) Creates a live query collection directly @@ -75,7 +75,7 @@ function createLiveQueryCollection(config): Collectio }> & object; ``` -Defined in: [packages/db/src/query/live-query-collection.ts:125](https://github.com/TanStack/db/blob/main/packages/db/src/query/live-query-collection.ts#L125) +Defined in: [packages/db/src/query/live-query-collection.ts:125](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live-query-collection.ts#L125) Creates a live query collection directly diff --git a/docs/reference/functions/createOptimisticAction.md b/docs/reference/functions/createOptimisticAction.md index bb19c9432..b2855d449 100644 --- a/docs/reference/functions/createOptimisticAction.md +++ b/docs/reference/functions/createOptimisticAction.md @@ -9,7 +9,7 @@ title: createOptimisticAction function createOptimisticAction(options): (variables) => Transaction; ``` -Defined in: [packages/db/src/optimistic-action.ts:54](https://github.com/TanStack/db/blob/main/packages/db/src/optimistic-action.ts#L54) +Defined in: [packages/db/src/optimistic-action.ts:54](https://github.com/MAST1999/db/blob/main/packages/db/src/optimistic-action.ts#L54) Creates an optimistic action function that applies local optimistic updates immediately before executing the actual mutation on the server. diff --git a/docs/reference/functions/createPacedMutations.md b/docs/reference/functions/createPacedMutations.md index 7418b828e..ee8d264b8 100644 --- a/docs/reference/functions/createPacedMutations.md +++ b/docs/reference/functions/createPacedMutations.md @@ -9,7 +9,7 @@ title: createPacedMutations function createPacedMutations(config): (variables) => Transaction; ``` -Defined in: [packages/db/src/paced-mutations.ts:87](https://github.com/TanStack/db/blob/main/packages/db/src/paced-mutations.ts#L87) +Defined in: [packages/db/src/paced-mutations.ts:87](https://github.com/MAST1999/db/blob/main/packages/db/src/paced-mutations.ts#L87) Creates a paced mutations manager with pluggable timing strategies. diff --git a/docs/reference/functions/createTransaction.md b/docs/reference/functions/createTransaction.md index 5309fffcf..cf0611860 100644 --- a/docs/reference/functions/createTransaction.md +++ b/docs/reference/functions/createTransaction.md @@ -9,7 +9,7 @@ title: createTransaction function createTransaction(config): Transaction; ``` -Defined in: [packages/db/src/transactions.ts:156](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L156) +Defined in: [packages/db/src/transactions.ts:156](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L156) Creates a new transaction for grouping multiple collection operations diff --git a/docs/reference/functions/debounceStrategy.md b/docs/reference/functions/debounceStrategy.md index 44e016bee..db60810ac 100644 --- a/docs/reference/functions/debounceStrategy.md +++ b/docs/reference/functions/debounceStrategy.md @@ -9,7 +9,7 @@ title: debounceStrategy function debounceStrategy(options): DebounceStrategy; ``` -Defined in: [packages/db/src/strategies/debounceStrategy.ts:28](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/debounceStrategy.ts#L28) +Defined in: [packages/db/src/strategies/debounceStrategy.ts:28](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/debounceStrategy.ts#L28) Creates a debounce strategy that delays transaction execution until after a period of inactivity. diff --git a/docs/reference/functions/eq.md b/docs/reference/functions/eq.md index 0199b5da1..0b96f30e9 100644 --- a/docs/reference/functions/eq.md +++ b/docs/reference/functions/eq.md @@ -11,7 +11,7 @@ title: eq function eq(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:115](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L115) +Defined in: [packages/db/src/query/builder/functions.ts:115](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L115) ### Type Parameters @@ -39,7 +39,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:115](https://github.com/ function eq(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:119](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L119) +Defined in: [packages/db/src/query/builder/functions.ts:119](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L119) ### Type Parameters @@ -67,7 +67,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:119](https://github.com/ function eq(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:123](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L123) +Defined in: [packages/db/src/query/builder/functions.ts:123](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L123) ### Type Parameters diff --git a/docs/reference/functions/extractFieldPath.md b/docs/reference/functions/extractFieldPath.md index 4e12e218e..fe2492fec 100644 --- a/docs/reference/functions/extractFieldPath.md +++ b/docs/reference/functions/extractFieldPath.md @@ -9,7 +9,7 @@ title: extractFieldPath function extractFieldPath(expr): FieldPath | null; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:107](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L107) +Defined in: [packages/db/src/query/expression-helpers.ts:107](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L107) Extracts the field path from a PropRef expression. Returns null for non-ref expressions. diff --git a/docs/reference/functions/extractSimpleComparisons.md b/docs/reference/functions/extractSimpleComparisons.md index 282214367..f33590a43 100644 --- a/docs/reference/functions/extractSimpleComparisons.md +++ b/docs/reference/functions/extractSimpleComparisons.md @@ -9,7 +9,7 @@ title: extractSimpleComparisons function extractSimpleComparisons(expr): SimpleComparison[]; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:327](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L327) +Defined in: [packages/db/src/query/expression-helpers.ts:327](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L327) Extracts all simple comparisons from a WHERE expression. This is useful for simple APIs that only support basic filters. diff --git a/docs/reference/functions/extractValue.md b/docs/reference/functions/extractValue.md index e48f9a9d6..571668b41 100644 --- a/docs/reference/functions/extractValue.md +++ b/docs/reference/functions/extractValue.md @@ -9,7 +9,7 @@ title: extractValue function extractValue(expr): any; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:127](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L127) +Defined in: [packages/db/src/query/expression-helpers.ts:127](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L127) Extracts the value from a Value expression. Returns undefined for non-value expressions. diff --git a/docs/reference/functions/getActiveTransaction.md b/docs/reference/functions/getActiveTransaction.md index 31ac09e1c..34c620251 100644 --- a/docs/reference/functions/getActiveTransaction.md +++ b/docs/reference/functions/getActiveTransaction.md @@ -11,7 +11,7 @@ function getActiveTransaction(): | undefined; ``` -Defined in: [packages/db/src/transactions.ts:175](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L175) +Defined in: [packages/db/src/transactions.ts:175](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L175) Gets the currently active ambient transaction, if any Used internally by collection operations to join existing transactions diff --git a/docs/reference/functions/gt.md b/docs/reference/functions/gt.md index 050c7712c..4d3c7a05c 100644 --- a/docs/reference/functions/gt.md +++ b/docs/reference/functions/gt.md @@ -11,7 +11,7 @@ title: gt function gt(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:128](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L128) +Defined in: [packages/db/src/query/builder/functions.ts:128](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L128) ### Type Parameters @@ -39,7 +39,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:128](https://github.com/ function gt(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:132](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L132) +Defined in: [packages/db/src/query/builder/functions.ts:132](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L132) ### Type Parameters @@ -67,7 +67,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:132](https://github.com/ function gt(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:136](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L136) +Defined in: [packages/db/src/query/builder/functions.ts:136](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L136) ### Type Parameters diff --git a/docs/reference/functions/gte.md b/docs/reference/functions/gte.md index 7a6798a69..3fa7fa17d 100644 --- a/docs/reference/functions/gte.md +++ b/docs/reference/functions/gte.md @@ -11,7 +11,7 @@ title: gte function gte(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:141](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L141) +Defined in: [packages/db/src/query/builder/functions.ts:141](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L141) ### Type Parameters @@ -39,7 +39,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:141](https://github.com/ function gte(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:145](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L145) +Defined in: [packages/db/src/query/builder/functions.ts:145](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L145) ### Type Parameters @@ -67,7 +67,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:145](https://github.com/ function gte(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:149](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L149) +Defined in: [packages/db/src/query/builder/functions.ts:149](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L149) ### Type Parameters diff --git a/docs/reference/functions/ilike.md b/docs/reference/functions/ilike.md index 989b7e9f5..3d746f332 100644 --- a/docs/reference/functions/ilike.md +++ b/docs/reference/functions/ilike.md @@ -9,7 +9,7 @@ title: ilike function ilike(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:252](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L252) +Defined in: [packages/db/src/query/builder/functions.ts:252](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L252) ## Parameters diff --git a/docs/reference/functions/inArray.md b/docs/reference/functions/inArray.md index c48e33a81..d8c397889 100644 --- a/docs/reference/functions/inArray.md +++ b/docs/reference/functions/inArray.md @@ -9,7 +9,7 @@ title: inArray function inArray(value, array): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:237](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L237) +Defined in: [packages/db/src/query/builder/functions.ts:237](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L237) ## Parameters diff --git a/docs/reference/functions/isLimitSubset.md b/docs/reference/functions/isLimitSubset.md index ac464fcb2..902beb42e 100644 --- a/docs/reference/functions/isLimitSubset.md +++ b/docs/reference/functions/isLimitSubset.md @@ -9,7 +9,7 @@ title: isLimitSubset function isLimitSubset(subset, superset): boolean; ``` -Defined in: [packages/db/src/query/predicate-utils.ts:768](https://github.com/TanStack/db/blob/main/packages/db/src/query/predicate-utils.ts#L768) +Defined in: [packages/db/src/query/predicate-utils.ts:768](https://github.com/MAST1999/db/blob/main/packages/db/src/query/predicate-utils.ts#L768) Check if one limit is a subset of another. Returns true if the subset limit requirements are satisfied by the superset limit. diff --git a/docs/reference/functions/isNull.md b/docs/reference/functions/isNull.md index 704ae7f33..bba680438 100644 --- a/docs/reference/functions/isNull.md +++ b/docs/reference/functions/isNull.md @@ -9,7 +9,7 @@ title: isNull function isNull(value): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:233](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L233) +Defined in: [packages/db/src/query/builder/functions.ts:233](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L233) ## Parameters diff --git a/docs/reference/functions/isOrderBySubset.md b/docs/reference/functions/isOrderBySubset.md index 0a23a6505..7e12f64d4 100644 --- a/docs/reference/functions/isOrderBySubset.md +++ b/docs/reference/functions/isOrderBySubset.md @@ -9,7 +9,7 @@ title: isOrderBySubset function isOrderBySubset(subset, superset): boolean; ``` -Defined in: [packages/db/src/query/predicate-utils.ts:713](https://github.com/TanStack/db/blob/main/packages/db/src/query/predicate-utils.ts#L713) +Defined in: [packages/db/src/query/predicate-utils.ts:713](https://github.com/MAST1999/db/blob/main/packages/db/src/query/predicate-utils.ts#L713) Check if one orderBy clause is a subset of another. Returns true if the subset ordering requirements are satisfied by the superset ordering. diff --git a/docs/reference/functions/isPredicateSubset.md b/docs/reference/functions/isPredicateSubset.md index d898b144d..ee72c2554 100644 --- a/docs/reference/functions/isPredicateSubset.md +++ b/docs/reference/functions/isPredicateSubset.md @@ -9,7 +9,7 @@ title: isPredicateSubset function isPredicateSubset(subset, superset): boolean; ``` -Defined in: [packages/db/src/query/predicate-utils.ts:801](https://github.com/TanStack/db/blob/main/packages/db/src/query/predicate-utils.ts#L801) +Defined in: [packages/db/src/query/predicate-utils.ts:801](https://github.com/MAST1999/db/blob/main/packages/db/src/query/predicate-utils.ts#L801) Check if one predicate (where + orderBy + limit) is a subset of another. Returns true if all aspects of the subset predicate are satisfied by the superset. diff --git a/docs/reference/functions/isUndefined.md b/docs/reference/functions/isUndefined.md index 0862c3cc9..5e4c89e8c 100644 --- a/docs/reference/functions/isUndefined.md +++ b/docs/reference/functions/isUndefined.md @@ -9,7 +9,7 @@ title: isUndefined function isUndefined(value): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:229](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L229) +Defined in: [packages/db/src/query/builder/functions.ts:229](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L229) ## Parameters diff --git a/docs/reference/functions/isWhereSubset.md b/docs/reference/functions/isWhereSubset.md index 3c68dc250..fabf572e1 100644 --- a/docs/reference/functions/isWhereSubset.md +++ b/docs/reference/functions/isWhereSubset.md @@ -9,7 +9,7 @@ title: isWhereSubset function isWhereSubset(subset, superset): boolean; ``` -Defined in: [packages/db/src/query/predicate-utils.ts:21](https://github.com/TanStack/db/blob/main/packages/db/src/query/predicate-utils.ts#L21) +Defined in: [packages/db/src/query/predicate-utils.ts:21](https://github.com/MAST1999/db/blob/main/packages/db/src/query/predicate-utils.ts#L21) Check if one where clause is a logical subset of another. Returns true if the subset predicate is more restrictive than (or equal to) the superset predicate. diff --git a/docs/reference/functions/length.md b/docs/reference/functions/length.md index 93ae660bd..d3b62cb04 100644 --- a/docs/reference/functions/length.md +++ b/docs/reference/functions/length.md @@ -9,7 +9,7 @@ title: length function length(arg): NumericFunctionReturnType; ``` -Defined in: [packages/db/src/query/builder/functions.ts:273](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L273) +Defined in: [packages/db/src/query/builder/functions.ts:273](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L273) ## Type Parameters diff --git a/docs/reference/functions/like.md b/docs/reference/functions/like.md index d94a428d4..1bf20b472 100644 --- a/docs/reference/functions/like.md +++ b/docs/reference/functions/like.md @@ -9,7 +9,7 @@ title: like function like(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:244](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L244) +Defined in: [packages/db/src/query/builder/functions.ts:244](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L244) ## Parameters diff --git a/docs/reference/functions/liveQueryCollectionOptions.md b/docs/reference/functions/liveQueryCollectionOptions.md index 20b266568..9b95def62 100644 --- a/docs/reference/functions/liveQueryCollectionOptions.md +++ b/docs/reference/functions/liveQueryCollectionOptions.md @@ -10,7 +10,7 @@ function liveQueryCollectionOptions(config): CollectionConfig }> & object; ``` -Defined in: [packages/db/src/query/live-query-collection.ts:62](https://github.com/TanStack/db/blob/main/packages/db/src/query/live-query-collection.ts#L62) +Defined in: [packages/db/src/query/live-query-collection.ts:62](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live-query-collection.ts#L62) Creates live query collection options for use with createCollection diff --git a/docs/reference/functions/localOnlyCollectionOptions.md b/docs/reference/functions/localOnlyCollectionOptions.md index f473f9599..dffce500f 100644 --- a/docs/reference/functions/localOnlyCollectionOptions.md +++ b/docs/reference/functions/localOnlyCollectionOptions.md @@ -11,7 +11,7 @@ title: localOnlyCollectionOptions function localOnlyCollectionOptions(config): CollectionConfig, TKey, T, UtilsRecord> & object & object; ``` -Defined in: [packages/db/src/local-only.ts:149](https://github.com/TanStack/db/blob/main/packages/db/src/local-only.ts#L149) +Defined in: [packages/db/src/local-only.ts:149](https://github.com/MAST1999/db/blob/main/packages/db/src/local-only.ts#L149) Creates Local-only collection options for use with a standard Collection @@ -123,7 +123,7 @@ await tx.commit() function localOnlyCollectionOptions(config): CollectionConfig & object & object; ``` -Defined in: [packages/db/src/local-only.ts:162](https://github.com/TanStack/db/blob/main/packages/db/src/local-only.ts#L162) +Defined in: [packages/db/src/local-only.ts:162](https://github.com/MAST1999/db/blob/main/packages/db/src/local-only.ts#L162) Creates Local-only collection options for use with a standard Collection diff --git a/docs/reference/functions/localStorageCollectionOptions.md b/docs/reference/functions/localStorageCollectionOptions.md index 48e42965d..2247b964a 100644 --- a/docs/reference/functions/localStorageCollectionOptions.md +++ b/docs/reference/functions/localStorageCollectionOptions.md @@ -11,7 +11,7 @@ title: localStorageCollectionOptions function localStorageCollectionOptions(config): CollectionConfig, TKey, T, LocalStorageCollectionUtils> & object; ``` -Defined in: [packages/db/src/local-storage.ts:316](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L316) +Defined in: [packages/db/src/local-storage.ts:316](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L316) Creates localStorage collection options for use with a standard Collection @@ -126,7 +126,7 @@ await tx.commit() function localStorageCollectionOptions(config): CollectionConfig & object; ``` -Defined in: [packages/db/src/local-storage.ts:336](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L336) +Defined in: [packages/db/src/local-storage.ts:336](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L336) Creates localStorage collection options for use with a standard Collection diff --git a/docs/reference/functions/lower.md b/docs/reference/functions/lower.md index a2b6c0ab8..a3c85c124 100644 --- a/docs/reference/functions/lower.md +++ b/docs/reference/functions/lower.md @@ -9,7 +9,7 @@ title: lower function lower(arg): StringFunctionReturnType; ``` -Defined in: [packages/db/src/query/builder/functions.ts:267](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L267) +Defined in: [packages/db/src/query/builder/functions.ts:267](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L267) ## Type Parameters diff --git a/docs/reference/functions/lt.md b/docs/reference/functions/lt.md index b7cbe7e61..24215ac3d 100644 --- a/docs/reference/functions/lt.md +++ b/docs/reference/functions/lt.md @@ -11,7 +11,7 @@ title: lt function lt(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:154](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L154) +Defined in: [packages/db/src/query/builder/functions.ts:154](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L154) ### Type Parameters @@ -39,7 +39,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:154](https://github.com/ function lt(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:158](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L158) +Defined in: [packages/db/src/query/builder/functions.ts:158](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L158) ### Type Parameters @@ -67,7 +67,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:158](https://github.com/ function lt(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:162](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L162) +Defined in: [packages/db/src/query/builder/functions.ts:162](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L162) ### Type Parameters diff --git a/docs/reference/functions/lte.md b/docs/reference/functions/lte.md index 25db4b12f..294482bec 100644 --- a/docs/reference/functions/lte.md +++ b/docs/reference/functions/lte.md @@ -11,7 +11,7 @@ title: lte function lte(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:167](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L167) +Defined in: [packages/db/src/query/builder/functions.ts:167](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L167) ### Type Parameters @@ -39,7 +39,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:167](https://github.com/ function lte(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:171](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L171) +Defined in: [packages/db/src/query/builder/functions.ts:171](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L171) ### Type Parameters @@ -67,7 +67,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:171](https://github.com/ function lte(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:175](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L175) +Defined in: [packages/db/src/query/builder/functions.ts:175](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L175) ### Type Parameters diff --git a/docs/reference/functions/max.md b/docs/reference/functions/max.md index 81889962b..6871b981d 100644 --- a/docs/reference/functions/max.md +++ b/docs/reference/functions/max.md @@ -9,7 +9,7 @@ title: max function max(arg): AggregateReturnType; ``` -Defined in: [packages/db/src/query/builder/functions.ts:323](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L323) +Defined in: [packages/db/src/query/builder/functions.ts:323](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L323) ## Type Parameters diff --git a/docs/reference/functions/min.md b/docs/reference/functions/min.md index 6335fff82..98f8ca86b 100644 --- a/docs/reference/functions/min.md +++ b/docs/reference/functions/min.md @@ -9,7 +9,7 @@ title: min function min(arg): AggregateReturnType; ``` -Defined in: [packages/db/src/query/builder/functions.ts:319](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L319) +Defined in: [packages/db/src/query/builder/functions.ts:319](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L319) ## Type Parameters diff --git a/docs/reference/functions/minusWherePredicates.md b/docs/reference/functions/minusWherePredicates.md index e5e33e6c7..1e58cea13 100644 --- a/docs/reference/functions/minusWherePredicates.md +++ b/docs/reference/functions/minusWherePredicates.md @@ -11,7 +11,7 @@ function minusWherePredicates(fromPredicate, subtractPredicate): | null; ``` -Defined in: [packages/db/src/query/predicate-utils.ts:338](https://github.com/TanStack/db/blob/main/packages/db/src/query/predicate-utils.ts#L338) +Defined in: [packages/db/src/query/predicate-utils.ts:338](https://github.com/MAST1999/db/blob/main/packages/db/src/query/predicate-utils.ts#L338) Compute the difference between two where predicates: `fromPredicate AND NOT(subtractPredicate)`. Returns the simplified predicate, or null if the difference cannot be simplified diff --git a/docs/reference/functions/not.md b/docs/reference/functions/not.md index d0bab9aff..55b2d6261 100644 --- a/docs/reference/functions/not.md +++ b/docs/reference/functions/not.md @@ -9,7 +9,7 @@ title: not function not(value): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:224](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L224) +Defined in: [packages/db/src/query/builder/functions.ts:224](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L224) ## Parameters diff --git a/docs/reference/functions/or.md b/docs/reference/functions/or.md index 11e471f9e..df253fa17 100644 --- a/docs/reference/functions/or.md +++ b/docs/reference/functions/or.md @@ -11,7 +11,7 @@ title: or function or(left, right): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:203](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L203) +Defined in: [packages/db/src/query/builder/functions.ts:203](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L203) ### Parameters @@ -36,7 +36,7 @@ function or( rest): BasicExpression; ``` -Defined in: [packages/db/src/query/builder/functions.ts:207](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L207) +Defined in: [packages/db/src/query/builder/functions.ts:207](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L207) ### Parameters diff --git a/docs/reference/functions/parseLoadSubsetOptions.md b/docs/reference/functions/parseLoadSubsetOptions.md index 880c34177..b9f575090 100644 --- a/docs/reference/functions/parseLoadSubsetOptions.md +++ b/docs/reference/functions/parseLoadSubsetOptions.md @@ -9,7 +9,7 @@ title: parseLoadSubsetOptions function parseLoadSubsetOptions(options): object; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:499](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L499) +Defined in: [packages/db/src/query/expression-helpers.ts:499](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L499) Convenience function to get all LoadSubsetOptions in a pre-parsed format. Good starting point for simple use cases. diff --git a/docs/reference/functions/parseOrderByExpression.md b/docs/reference/functions/parseOrderByExpression.md index 13e2d77f0..7584b8542 100644 --- a/docs/reference/functions/parseOrderByExpression.md +++ b/docs/reference/functions/parseOrderByExpression.md @@ -9,7 +9,7 @@ title: parseOrderByExpression function parseOrderByExpression(orderBy): ParsedOrderBy[]; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:265](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L265) +Defined in: [packages/db/src/query/expression-helpers.ts:265](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L265) Parses an ORDER BY expression into a simple array of sort specifications. diff --git a/docs/reference/functions/parseWhereExpression.md b/docs/reference/functions/parseWhereExpression.md index a15a8f7e3..45a2b5e5d 100644 --- a/docs/reference/functions/parseWhereExpression.md +++ b/docs/reference/functions/parseWhereExpression.md @@ -9,7 +9,7 @@ title: parseWhereExpression function parseWhereExpression(expr, options): T | null; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:201](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L201) +Defined in: [packages/db/src/query/expression-helpers.ts:201](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L201) Parses a WHERE expression into a custom format using provided handlers. diff --git a/docs/reference/functions/queueStrategy.md b/docs/reference/functions/queueStrategy.md index 8752c1746..cf0752375 100644 --- a/docs/reference/functions/queueStrategy.md +++ b/docs/reference/functions/queueStrategy.md @@ -9,7 +9,7 @@ title: queueStrategy function queueStrategy(options?): QueueStrategy; ``` -Defined in: [packages/db/src/strategies/queueStrategy.ts:46](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/queueStrategy.ts#L46) +Defined in: [packages/db/src/strategies/queueStrategy.ts:46](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/queueStrategy.ts#L46) Creates a queue strategy that processes all mutations in order with proper serialization. diff --git a/docs/reference/functions/sum.md b/docs/reference/functions/sum.md index 760550dff..7bf47dc22 100644 --- a/docs/reference/functions/sum.md +++ b/docs/reference/functions/sum.md @@ -9,7 +9,7 @@ title: sum function sum(arg): AggregateReturnType; ``` -Defined in: [packages/db/src/query/builder/functions.ts:315](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L315) +Defined in: [packages/db/src/query/builder/functions.ts:315](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L315) ## Type Parameters diff --git a/docs/reference/functions/throttleStrategy.md b/docs/reference/functions/throttleStrategy.md index b9ac28644..0edae660e 100644 --- a/docs/reference/functions/throttleStrategy.md +++ b/docs/reference/functions/throttleStrategy.md @@ -9,7 +9,7 @@ title: throttleStrategy function throttleStrategy(options): ThrottleStrategy; ``` -Defined in: [packages/db/src/strategies/throttleStrategy.ts:48](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/throttleStrategy.ts#L48) +Defined in: [packages/db/src/strategies/throttleStrategy.ts:48](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/throttleStrategy.ts#L48) Creates a throttle strategy that ensures transactions are evenly spaced over time. diff --git a/docs/reference/functions/unionWherePredicates.md b/docs/reference/functions/unionWherePredicates.md index eb34b9775..862a40b15 100644 --- a/docs/reference/functions/unionWherePredicates.md +++ b/docs/reference/functions/unionWherePredicates.md @@ -9,7 +9,7 @@ title: unionWherePredicates function unionWherePredicates(predicates): BasicExpression; ``` -Defined in: [packages/db/src/query/predicate-utils.ts:295](https://github.com/TanStack/db/blob/main/packages/db/src/query/predicate-utils.ts#L295) +Defined in: [packages/db/src/query/predicate-utils.ts:295](https://github.com/MAST1999/db/blob/main/packages/db/src/query/predicate-utils.ts#L295) Combine multiple where predicates with OR logic (union). Returns a predicate that is satisfied when any input predicate is satisfied. diff --git a/docs/reference/functions/upper.md b/docs/reference/functions/upper.md index af4652235..d43e5b6ab 100644 --- a/docs/reference/functions/upper.md +++ b/docs/reference/functions/upper.md @@ -9,7 +9,7 @@ title: upper function upper(arg): StringFunctionReturnType; ``` -Defined in: [packages/db/src/query/builder/functions.ts:261](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L261) +Defined in: [packages/db/src/query/builder/functions.ts:261](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L261) ## Type Parameters diff --git a/docs/reference/functions/walkExpression.md b/docs/reference/functions/walkExpression.md index 9f5b412d0..59622f872 100644 --- a/docs/reference/functions/walkExpression.md +++ b/docs/reference/functions/walkExpression.md @@ -9,7 +9,7 @@ title: walkExpression function walkExpression(expr, visitor): void; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:150](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L150) +Defined in: [packages/db/src/query/expression-helpers.ts:150](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L150) Generic expression tree walker that visits each node in the expression. Useful for implementing custom parsing logic. diff --git a/docs/reference/functions/withArrayChangeTracking.md b/docs/reference/functions/withArrayChangeTracking.md index 363f47c42..ed41af584 100644 --- a/docs/reference/functions/withArrayChangeTracking.md +++ b/docs/reference/functions/withArrayChangeTracking.md @@ -9,7 +9,7 @@ title: withArrayChangeTracking function withArrayChangeTracking(targets, callback): Record[]; ``` -Defined in: [packages/db/src/proxy.ts:1171](https://github.com/TanStack/db/blob/main/packages/db/src/proxy.ts#L1171) +Defined in: [packages/db/src/proxy.ts:1171](https://github.com/MAST1999/db/blob/main/packages/db/src/proxy.ts#L1171) Creates proxies for an array of objects, passes them to a callback function, and returns the changes made by the callback for each object diff --git a/docs/reference/functions/withChangeTracking.md b/docs/reference/functions/withChangeTracking.md index 70ce03300..76b6fa00e 100644 --- a/docs/reference/functions/withChangeTracking.md +++ b/docs/reference/functions/withChangeTracking.md @@ -9,7 +9,7 @@ title: withChangeTracking function withChangeTracking(target, callback): Record; ``` -Defined in: [packages/db/src/proxy.ts:1152](https://github.com/TanStack/db/blob/main/packages/db/src/proxy.ts#L1152) +Defined in: [packages/db/src/proxy.ts:1152](https://github.com/MAST1999/db/blob/main/packages/db/src/proxy.ts#L1152) Creates a proxy for an object, passes it to a callback function, and returns the changes made by the callback diff --git a/docs/reference/interfaces/BTreeIndexOptions.md b/docs/reference/interfaces/BTreeIndexOptions.md index 6e6b27aa2..0a8d92a61 100644 --- a/docs/reference/interfaces/BTreeIndexOptions.md +++ b/docs/reference/interfaces/BTreeIndexOptions.md @@ -5,7 +5,7 @@ title: BTreeIndexOptions # Interface: BTreeIndexOptions -Defined in: [packages/db/src/indexes/btree-index.ts:11](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L11) +Defined in: [packages/db/src/indexes/btree-index.ts:11](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L11) Options for Ordered index @@ -17,7 +17,7 @@ Options for Ordered index optional compareFn: (a, b) => number; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:12](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L12) +Defined in: [packages/db/src/indexes/btree-index.ts:12](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L12) #### Parameters @@ -41,4 +41,4 @@ Defined in: [packages/db/src/indexes/btree-index.ts:12](https://github.com/TanSt optional compareOptions: CompareOptions; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:13](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L13) +Defined in: [packages/db/src/indexes/btree-index.ts:13](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L13) diff --git a/docs/reference/interfaces/BaseCollectionConfig.md b/docs/reference/interfaces/BaseCollectionConfig.md index df59ed52a..e1512ab96 100644 --- a/docs/reference/interfaces/BaseCollectionConfig.md +++ b/docs/reference/interfaces/BaseCollectionConfig.md @@ -5,7 +5,7 @@ title: BaseCollectionConfig # Interface: BaseCollectionConfig\ -Defined in: [packages/db/src/types.ts:438](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L438) +Defined in: [packages/db/src/types.ts:438](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L438) ## Extended by @@ -42,7 +42,7 @@ Defined in: [packages/db/src/types.ts:438](https://github.com/TanStack/db/blob/m optional autoIndex: "eager" | "off"; ``` -Defined in: [packages/db/src/types.ts:487](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L487) +Defined in: [packages/db/src/types.ts:487](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L487) Auto-indexing mode for the collection. When enabled, indexes will be automatically created for simple where expressions. @@ -66,7 +66,7 @@ When enabled, indexes will be automatically created for simple where expressions optional compare: (x, y) => number; ``` -Defined in: [packages/db/src/types.ts:498](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L498) +Defined in: [packages/db/src/types.ts:498](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L498) Optional function to compare two items. This is used to order the items in the collection. @@ -106,7 +106,7 @@ compare: (x, y) => x.createdAt.getTime() - y.createdAt.getTime() optional defaultStringCollation: StringCollationConfig; ``` -Defined in: [packages/db/src/types.ts:644](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L644) +Defined in: [packages/db/src/types.ts:644](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L644) Specifies how to compare data in the collection. This should be configured to match data ordering on the backend. @@ -121,7 +121,7 @@ E.g., when using the Electric DB collection these options optional gcTime: number; ``` -Defined in: [packages/db/src/types.ts:467](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L467) +Defined in: [packages/db/src/types.ts:467](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L467) Time in milliseconds after which the collection will be garbage collected when it has no active subscribers. Defaults to 5 minutes (300000ms). @@ -134,7 +134,7 @@ when it has no active subscribers. Defaults to 5 minutes (300000ms). getKey: (item) => TKey; ``` -Defined in: [packages/db/src/types.ts:462](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L462) +Defined in: [packages/db/src/types.ts:462](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L462) Function to extract the ID from an object This is required for update/delete operations which now only accept IDs @@ -168,7 +168,7 @@ getKey: (item) => item.uuid optional id: string; ``` -Defined in: [packages/db/src/types.ts:451](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L451) +Defined in: [packages/db/src/types.ts:451](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L451) *** @@ -178,7 +178,7 @@ Defined in: [packages/db/src/types.ts:451](https://github.com/TanStack/db/blob/m optional onDelete: DeleteMutationFn; ``` -Defined in: [packages/db/src/types.ts:636](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L636) +Defined in: [packages/db/src/types.ts:636](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L636) Optional asynchronous handler function called before a delete operation @@ -242,7 +242,7 @@ onDelete: async ({ transaction, collection }) => { optional onInsert: InsertMutationFn; ``` -Defined in: [packages/db/src/types.ts:549](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L549) +Defined in: [packages/db/src/types.ts:549](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L549) Optional asynchronous handler function called before an insert operation @@ -305,7 +305,7 @@ onInsert: async ({ transaction, collection }) => { optional onUpdate: UpdateMutationFn; ``` -Defined in: [packages/db/src/types.ts:593](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L593) +Defined in: [packages/db/src/types.ts:593](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L593) Optional asynchronous handler function called before an update operation @@ -369,7 +369,7 @@ onUpdate: async ({ transaction, collection }) => { optional schema: TSchema; ``` -Defined in: [packages/db/src/types.ts:452](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L452) +Defined in: [packages/db/src/types.ts:452](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L452) *** @@ -379,7 +379,7 @@ Defined in: [packages/db/src/types.ts:452](https://github.com/TanStack/db/blob/m optional startSync: boolean; ``` -Defined in: [packages/db/src/types.ts:478](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L478) +Defined in: [packages/db/src/types.ts:478](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L478) Whether to eagerly start syncing on collection creation. When true, syncing begins immediately. When false, syncing starts when the first subscriber attaches. @@ -402,7 +402,7 @@ false optional syncMode: SyncMode; ``` -Defined in: [packages/db/src/types.ts:507](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L507) +Defined in: [packages/db/src/types.ts:507](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L507) The mode of sync to use for the collection. @@ -424,4 +424,4 @@ The exact implementation of the sync mode is up to the sync implementation. optional utils: TUtils; ``` -Defined in: [packages/db/src/types.ts:646](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L646) +Defined in: [packages/db/src/types.ts:646](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L646) diff --git a/docs/reference/interfaces/BaseStrategy.md b/docs/reference/interfaces/BaseStrategy.md index fdfb8354c..4cb08e039 100644 --- a/docs/reference/interfaces/BaseStrategy.md +++ b/docs/reference/interfaces/BaseStrategy.md @@ -5,7 +5,7 @@ title: BaseStrategy # Interface: BaseStrategy\ -Defined in: [packages/db/src/strategies/types.ts:6](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L6) +Defined in: [packages/db/src/strategies/types.ts:6](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L6) Base strategy interface that all strategy implementations must conform to @@ -29,7 +29,7 @@ Base strategy interface that all strategy implementations must conform to _type: TName; ``` -Defined in: [packages/db/src/strategies/types.ts:8](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L8) +Defined in: [packages/db/src/strategies/types.ts:8](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L8) Type discriminator for strategy identification @@ -41,7 +41,7 @@ Type discriminator for strategy identification cleanup: () => void; ``` -Defined in: [packages/db/src/strategies/types.ts:23](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L23) +Defined in: [packages/db/src/strategies/types.ts:23](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L23) Clean up any resources held by the strategy Should be called when the strategy is no longer needed @@ -58,7 +58,7 @@ Should be called when the strategy is no longer needed execute: (fn) => void | Promise; ``` -Defined in: [packages/db/src/strategies/types.ts:15](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L15) +Defined in: [packages/db/src/strategies/types.ts:15](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L15) Execute a function according to the strategy's timing rules diff --git a/docs/reference/interfaces/ChangeMessage.md b/docs/reference/interfaces/ChangeMessage.md index d8b61bf5c..4bf1d545e 100644 --- a/docs/reference/interfaces/ChangeMessage.md +++ b/docs/reference/interfaces/ChangeMessage.md @@ -5,7 +5,7 @@ title: ChangeMessage # Interface: ChangeMessage\ -Defined in: [packages/db/src/types.ts:314](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L314) +Defined in: [packages/db/src/types.ts:314](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L314) ## Extended by @@ -29,7 +29,7 @@ Defined in: [packages/db/src/types.ts:314](https://github.com/TanStack/db/blob/m key: TKey; ``` -Defined in: [packages/db/src/types.ts:318](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L318) +Defined in: [packages/db/src/types.ts:318](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L318) *** @@ -39,7 +39,7 @@ Defined in: [packages/db/src/types.ts:318](https://github.com/TanStack/db/blob/m optional metadata: Record; ``` -Defined in: [packages/db/src/types.ts:322](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L322) +Defined in: [packages/db/src/types.ts:322](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L322) *** @@ -49,7 +49,7 @@ Defined in: [packages/db/src/types.ts:322](https://github.com/TanStack/db/blob/m optional previousValue: T; ``` -Defined in: [packages/db/src/types.ts:320](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L320) +Defined in: [packages/db/src/types.ts:320](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L320) *** @@ -59,7 +59,7 @@ Defined in: [packages/db/src/types.ts:320](https://github.com/TanStack/db/blob/m type: OperationType; ``` -Defined in: [packages/db/src/types.ts:321](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L321) +Defined in: [packages/db/src/types.ts:321](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L321) *** @@ -69,4 +69,4 @@ Defined in: [packages/db/src/types.ts:321](https://github.com/TanStack/db/blob/m value: T; ``` -Defined in: [packages/db/src/types.ts:319](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L319) +Defined in: [packages/db/src/types.ts:319](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L319) diff --git a/docs/reference/interfaces/Collection.md b/docs/reference/interfaces/Collection.md index 9b57df6ba..05b52a975 100644 --- a/docs/reference/interfaces/Collection.md +++ b/docs/reference/interfaces/Collection.md @@ -5,7 +5,7 @@ title: Collection # Interface: Collection\ -Defined in: [packages/db/src/collection/index.ts:48](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L48) +Defined in: [packages/db/src/collection/index.ts:48](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L48) Enhanced Collection interface that includes both data type T and utilities TUtils @@ -51,7 +51,7 @@ The type for insert operations (can be different from T for schemas with default _lifecycle: CollectionLifecycleManager; ``` -Defined in: [packages/db/src/collection/index.ts:283](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L283) +Defined in: [packages/db/src/collection/index.ts:283](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L283) #### Inherited from @@ -65,7 +65,7 @@ Defined in: [packages/db/src/collection/index.ts:283](https://github.com/TanStac _state: CollectionStateManager; ``` -Defined in: [packages/db/src/collection/index.ts:295](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L295) +Defined in: [packages/db/src/collection/index.ts:295](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L295) #### Inherited from @@ -79,7 +79,7 @@ Defined in: [packages/db/src/collection/index.ts:295](https://github.com/TanStac _sync: CollectionSyncManager; ``` -Defined in: [packages/db/src/collection/index.ts:284](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L284) +Defined in: [packages/db/src/collection/index.ts:284](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L284) #### Inherited from @@ -93,7 +93,7 @@ Defined in: [packages/db/src/collection/index.ts:284](https://github.com/TanStac config: CollectionConfig; ``` -Defined in: [packages/db/src/collection/index.ts:274](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L274) +Defined in: [packages/db/src/collection/index.ts:274](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L274) #### Inherited from @@ -107,7 +107,7 @@ Defined in: [packages/db/src/collection/index.ts:274](https://github.com/TanStac id: string; ``` -Defined in: [packages/db/src/collection/index.ts:273](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L273) +Defined in: [packages/db/src/collection/index.ts:273](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L273) #### Inherited from @@ -121,7 +121,7 @@ Defined in: [packages/db/src/collection/index.ts:273](https://github.com/TanStac readonly optional singleResult: true; ``` -Defined in: [packages/db/src/collection/index.ts:56](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L56) +Defined in: [packages/db/src/collection/index.ts:56](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L56) *** @@ -131,7 +131,7 @@ Defined in: [packages/db/src/collection/index.ts:56](https://github.com/TanStack readonly utils: TUtils; ``` -Defined in: [packages/db/src/collection/index.ts:55](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L55) +Defined in: [packages/db/src/collection/index.ts:55](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L55) #### Overrides @@ -147,7 +147,7 @@ Defined in: [packages/db/src/collection/index.ts:55](https://github.com/TanStack get compareOptions(): StringCollationConfig; ``` -Defined in: [packages/db/src/collection/index.ts:579](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L579) +Defined in: [packages/db/src/collection/index.ts:579](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L579) ##### Returns @@ -167,7 +167,7 @@ Defined in: [packages/db/src/collection/index.ts:579](https://github.com/TanStac get indexes(): Map>; ``` -Defined in: [packages/db/src/collection/index.ts:564](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L564) +Defined in: [packages/db/src/collection/index.ts:564](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L564) Get resolved indexes for query optimization @@ -189,7 +189,7 @@ Get resolved indexes for query optimization get isLoadingSubset(): boolean; ``` -Defined in: [packages/db/src/collection/index.ts:430](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L430) +Defined in: [packages/db/src/collection/index.ts:430](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L430) Check if the collection is currently loading more data @@ -213,7 +213,7 @@ true if the collection has pending load more operations, false otherwise get size(): number; ``` -Defined in: [packages/db/src/collection/index.ts:467](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L467) +Defined in: [packages/db/src/collection/index.ts:467](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L467) Get the current size of the collection (cached) @@ -235,7 +235,7 @@ Get the current size of the collection (cached) get state(): Map; ``` -Defined in: [packages/db/src/collection/index.ts:756](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L756) +Defined in: [packages/db/src/collection/index.ts:756](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L756) Gets the current state of the collection as a Map @@ -275,7 +275,7 @@ Map containing all items in the collection, with keys as identifiers get status(): CollectionStatus; ``` -Defined in: [packages/db/src/collection/index.ts:385](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L385) +Defined in: [packages/db/src/collection/index.ts:385](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L385) Gets the current status of the collection @@ -297,7 +297,7 @@ Gets the current status of the collection get subscriberCount(): number; ``` -Defined in: [packages/db/src/collection/index.ts:392](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L392) +Defined in: [packages/db/src/collection/index.ts:392](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L392) Get the number of subscribers to the collection @@ -319,7 +319,7 @@ Get the number of subscribers to the collection get toArray(): TOutput[]; ``` -Defined in: [packages/db/src/collection/index.ts:785](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L785) +Defined in: [packages/db/src/collection/index.ts:785](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L785) Gets the current state of the collection as an Array @@ -341,7 +341,7 @@ An Array containing all items in the collection iterator: IterableIterator<[TKey, T]>; ``` -Defined in: [packages/db/src/collection/index.ts:495](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L495) +Defined in: [packages/db/src/collection/index.ts:495](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L495) Get all entries (virtual derived state) @@ -361,7 +361,7 @@ Get all entries (virtual derived state) cleanup(): Promise; ``` -Defined in: [packages/db/src/collection/index.ts:919](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L919) +Defined in: [packages/db/src/collection/index.ts:919](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L919) Clean up the collection by stopping sync and clearing data This can be called manually or automatically by garbage collection @@ -382,7 +382,7 @@ This can be called manually or automatically by garbage collection createIndex(indexCallback, config): IndexProxy; ``` -Defined in: [packages/db/src/collection/index.ts:554](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L554) +Defined in: [packages/db/src/collection/index.ts:554](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L554) Creates an index on a collection for faster queries. Indexes significantly improve query performance by allowing constant time lookups @@ -456,7 +456,7 @@ currentStateAsChanges(options): | ChangeMessage[]; ``` -Defined in: [packages/db/src/collection/index.ts:823](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L823) +Defined in: [packages/db/src/collection/index.ts:823](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L823) Returns the current state of the collection as an array of changes @@ -504,7 +504,7 @@ const activeChanges = collection.currentStateAsChanges({ delete(keys, config?): Transaction; ``` -Defined in: [packages/db/src/collection/index.ts:733](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L733) +Defined in: [packages/db/src/collection/index.ts:733](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L733) Deletes one or more items from the collection @@ -571,7 +571,7 @@ try { entries(): IterableIterator<[TKey, T]>; ``` -Defined in: [packages/db/src/collection/index.ts:488](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L488) +Defined in: [packages/db/src/collection/index.ts:488](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L488) Get all entries (virtual derived state) @@ -591,7 +591,7 @@ Get all entries (virtual derived state) forEach(callbackfn): void; ``` -Defined in: [packages/db/src/collection/index.ts:502](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L502) +Defined in: [packages/db/src/collection/index.ts:502](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L502) Execute a callback for each entry in the collection @@ -617,7 +617,7 @@ Execute a callback for each entry in the collection get(key): T | undefined; ``` -Defined in: [packages/db/src/collection/index.ts:453](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L453) +Defined in: [packages/db/src/collection/index.ts:453](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L453) Get the current value for a key (virtual derived state) @@ -643,7 +643,7 @@ Get the current value for a key (virtual derived state) getKeyFromItem(item): TKey; ``` -Defined in: [packages/db/src/collection/index.ts:517](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L517) +Defined in: [packages/db/src/collection/index.ts:517](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L517) #### Parameters @@ -667,7 +667,7 @@ Defined in: [packages/db/src/collection/index.ts:517](https://github.com/TanStac has(key): boolean; ``` -Defined in: [packages/db/src/collection/index.ts:460](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L460) +Defined in: [packages/db/src/collection/index.ts:460](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L460) Check if a key exists in the collection (virtual derived state) @@ -695,7 +695,7 @@ insert(data, config?): | Transaction; ``` -Defined in: [packages/db/src/collection/index.ts:620](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L620) +Defined in: [packages/db/src/collection/index.ts:620](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L620) Inserts one or more items into the collection @@ -770,7 +770,7 @@ try { isReady(): boolean; ``` -Defined in: [packages/db/src/collection/index.ts:422](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L422) +Defined in: [packages/db/src/collection/index.ts:422](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L422) Check if the collection is ready for use Returns true if the collection has been marked as ready by its sync implementation @@ -804,7 +804,7 @@ if (collection.isReady()) { keys(): IterableIterator; ``` -Defined in: [packages/db/src/collection/index.ts:474](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L474) +Defined in: [packages/db/src/collection/index.ts:474](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L474) Get all keys (virtual derived state) @@ -824,7 +824,7 @@ Get all keys (virtual derived state) map(callbackfn): U[]; ``` -Defined in: [packages/db/src/collection/index.ts:511](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L511) +Defined in: [packages/db/src/collection/index.ts:511](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L511) Create a new array with the results of calling a function for each entry in the collection @@ -856,7 +856,7 @@ Create a new array with the results of calling a function for each entry in the off(event, callback): void; ``` -Defined in: [packages/db/src/collection/index.ts:898](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L898) +Defined in: [packages/db/src/collection/index.ts:898](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L898) Unsubscribe from a collection event @@ -900,7 +900,7 @@ Unsubscribe from a collection event on(event, callback): () => void; ``` -Defined in: [packages/db/src/collection/index.ts:878](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L878) +Defined in: [packages/db/src/collection/index.ts:878](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L878) Subscribe to a collection event @@ -950,7 +950,7 @@ Subscribe to a collection event once(event, callback): () => void; ``` -Defined in: [packages/db/src/collection/index.ts:888](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L888) +Defined in: [packages/db/src/collection/index.ts:888](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L888) Subscribe to a collection event once @@ -1000,7 +1000,7 @@ Subscribe to a collection event once onFirstReady(callback): void; ``` -Defined in: [packages/db/src/collection/index.ts:406](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L406) +Defined in: [packages/db/src/collection/index.ts:406](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L406) Register a callback to be executed when the collection first becomes ready Useful for preloading collections @@ -1038,7 +1038,7 @@ collection.onFirstReady(() => { preload(): Promise; ``` -Defined in: [packages/db/src/collection/index.ts:446](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L446) +Defined in: [packages/db/src/collection/index.ts:446](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L446) Preload the collection data by starting sync if not already started Multiple concurrent calls will share the same promise @@ -1059,7 +1059,7 @@ Multiple concurrent calls will share the same promise startSyncImmediate(): void; ``` -Defined in: [packages/db/src/collection/index.ts:438](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L438) +Defined in: [packages/db/src/collection/index.ts:438](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L438) Start sync immediately - internal method for compiled queries This bypasses lazy loading for special cases like live query results @@ -1080,7 +1080,7 @@ This bypasses lazy loading for special cases like live query results stateWhenReady(): Promise>; ``` -Defined in: [packages/db/src/collection/index.ts:770](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L770) +Defined in: [packages/db/src/collection/index.ts:770](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L770) Gets the current state of the collection as a Map, but only resolves when data is available Waits for the first sync commit to complete before resolving @@ -1103,7 +1103,7 @@ Promise that resolves to a Map containing all items in the collection subscribeChanges(callback, options): CollectionSubscription; ``` -Defined in: [packages/db/src/collection/index.ts:868](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L868) +Defined in: [packages/db/src/collection/index.ts:868](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L868) Subscribe to changes in the collection @@ -1179,7 +1179,7 @@ const subscription = collection.subscribeChanges((changes) => { toArrayWhenReady(): Promise; ``` -Defined in: [packages/db/src/collection/index.ts:795](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L795) +Defined in: [packages/db/src/collection/index.ts:795](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L795) Gets the current state of the collection as an Array, but only resolves when data is available Waits for the first sync commit to complete before resolving @@ -1204,7 +1204,7 @@ Promise that resolves to an Array containing all items in the collection update(key, callback): Transaction; ``` -Defined in: [packages/db/src/collection/index.ts:665](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L665) +Defined in: [packages/db/src/collection/index.ts:665](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L665) Updates one or more items in the collection using a callback function @@ -1279,7 +1279,7 @@ update( callback): Transaction; ``` -Defined in: [packages/db/src/collection/index.ts:671](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L671) +Defined in: [packages/db/src/collection/index.ts:671](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L671) Updates one or more items in the collection using a callback function @@ -1357,7 +1357,7 @@ try { update(id, callback): Transaction; ``` -Defined in: [packages/db/src/collection/index.ts:678](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L678) +Defined in: [packages/db/src/collection/index.ts:678](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L678) Updates one or more items in the collection using a callback function @@ -1432,7 +1432,7 @@ update( callback): Transaction; ``` -Defined in: [packages/db/src/collection/index.ts:684](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L684) +Defined in: [packages/db/src/collection/index.ts:684](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L684) Updates one or more items in the collection using a callback function @@ -1513,7 +1513,7 @@ validateData( key?): T; ``` -Defined in: [packages/db/src/collection/index.ts:571](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L571) +Defined in: [packages/db/src/collection/index.ts:571](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L571) Validates the data against the schema @@ -1547,7 +1547,7 @@ Validates the data against the schema values(): IterableIterator; ``` -Defined in: [packages/db/src/collection/index.ts:481](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L481) +Defined in: [packages/db/src/collection/index.ts:481](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L481) Get all values (virtual derived state) @@ -1567,7 +1567,7 @@ Get all values (virtual derived state) waitFor(event, timeout?): Promise; ``` -Defined in: [packages/db/src/collection/index.ts:908](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L908) +Defined in: [packages/db/src/collection/index.ts:908](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L908) Wait for a collection event diff --git a/docs/reference/interfaces/CollectionConfig.md b/docs/reference/interfaces/CollectionConfig.md index e3ce87cd6..73b78c9d2 100644 --- a/docs/reference/interfaces/CollectionConfig.md +++ b/docs/reference/interfaces/CollectionConfig.md @@ -5,7 +5,7 @@ title: CollectionConfig # Interface: CollectionConfig\ -Defined in: [packages/db/src/types.ts:649](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L649) +Defined in: [packages/db/src/types.ts:649](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L649) ## Extends @@ -37,7 +37,7 @@ Defined in: [packages/db/src/types.ts:649](https://github.com/TanStack/db/blob/m optional autoIndex: "eager" | "off"; ``` -Defined in: [packages/db/src/types.ts:487](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L487) +Defined in: [packages/db/src/types.ts:487](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L487) Auto-indexing mode for the collection. When enabled, indexes will be automatically created for simple where expressions. @@ -65,7 +65,7 @@ When enabled, indexes will be automatically created for simple where expressions optional compare: (x, y) => number; ``` -Defined in: [packages/db/src/types.ts:498](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L498) +Defined in: [packages/db/src/types.ts:498](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L498) Optional function to compare two items. This is used to order the items in the collection. @@ -109,7 +109,7 @@ compare: (x, y) => x.createdAt.getTime() - y.createdAt.getTime() optional defaultStringCollation: StringCollationConfig; ``` -Defined in: [packages/db/src/types.ts:644](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L644) +Defined in: [packages/db/src/types.ts:644](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L644) Specifies how to compare data in the collection. This should be configured to match data ordering on the backend. @@ -128,7 +128,7 @@ E.g., when using the Electric DB collection these options optional gcTime: number; ``` -Defined in: [packages/db/src/types.ts:467](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L467) +Defined in: [packages/db/src/types.ts:467](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L467) Time in milliseconds after which the collection will be garbage collected when it has no active subscribers. Defaults to 5 minutes (300000ms). @@ -145,7 +145,7 @@ when it has no active subscribers. Defaults to 5 minutes (300000ms). getKey: (item) => TKey; ``` -Defined in: [packages/db/src/types.ts:462](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L462) +Defined in: [packages/db/src/types.ts:462](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L462) Function to extract the ID from an object This is required for update/delete operations which now only accept IDs @@ -183,7 +183,7 @@ getKey: (item) => item.uuid optional id: string; ``` -Defined in: [packages/db/src/types.ts:451](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L451) +Defined in: [packages/db/src/types.ts:451](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L451) #### Inherited from @@ -197,7 +197,7 @@ Defined in: [packages/db/src/types.ts:451](https://github.com/TanStack/db/blob/m optional onDelete: DeleteMutationFn; ``` -Defined in: [packages/db/src/types.ts:636](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L636) +Defined in: [packages/db/src/types.ts:636](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L636) Optional asynchronous handler function called before a delete operation @@ -265,7 +265,7 @@ onDelete: async ({ transaction, collection }) => { optional onInsert: InsertMutationFn; ``` -Defined in: [packages/db/src/types.ts:549](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L549) +Defined in: [packages/db/src/types.ts:549](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L549) Optional asynchronous handler function called before an insert operation @@ -332,7 +332,7 @@ onInsert: async ({ transaction, collection }) => { optional onUpdate: UpdateMutationFn; ``` -Defined in: [packages/db/src/types.ts:593](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L593) +Defined in: [packages/db/src/types.ts:593](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L593) Optional asynchronous handler function called before an update operation @@ -400,7 +400,7 @@ onUpdate: async ({ transaction, collection }) => { optional schema: TSchema; ``` -Defined in: [packages/db/src/types.ts:452](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L452) +Defined in: [packages/db/src/types.ts:452](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L452) #### Inherited from @@ -414,7 +414,7 @@ Defined in: [packages/db/src/types.ts:452](https://github.com/TanStack/db/blob/m optional startSync: boolean; ``` -Defined in: [packages/db/src/types.ts:478](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L478) +Defined in: [packages/db/src/types.ts:478](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L478) Whether to eagerly start syncing on collection creation. When true, syncing begins immediately. When false, syncing starts when the first subscriber attaches. @@ -441,7 +441,7 @@ false sync: SyncConfig; ``` -Defined in: [packages/db/src/types.ts:655](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L655) +Defined in: [packages/db/src/types.ts:655](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L655) *** @@ -451,7 +451,7 @@ Defined in: [packages/db/src/types.ts:655](https://github.com/TanStack/db/blob/m optional syncMode: SyncMode; ``` -Defined in: [packages/db/src/types.ts:507](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L507) +Defined in: [packages/db/src/types.ts:507](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L507) The mode of sync to use for the collection. @@ -477,7 +477,7 @@ The exact implementation of the sync mode is up to the sync implementation. optional utils: TUtils; ``` -Defined in: [packages/db/src/types.ts:646](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L646) +Defined in: [packages/db/src/types.ts:646](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L646) #### Inherited from diff --git a/docs/reference/interfaces/CollectionLike.md b/docs/reference/interfaces/CollectionLike.md index 05679c1ad..994f3a323 100644 --- a/docs/reference/interfaces/CollectionLike.md +++ b/docs/reference/interfaces/CollectionLike.md @@ -5,7 +5,7 @@ title: CollectionLike # Interface: CollectionLike\ -Defined in: [packages/db/src/types.ts:12](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L12) +Defined in: [packages/db/src/types.ts:12](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L12) Interface for a collection-like object that provides the necessary methods for the change events system to work @@ -32,7 +32,7 @@ for the change events system to work compareOptions: StringCollationConfig; ``` -Defined in: [packages/db/src/collection/index.ts:579](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L579) +Defined in: [packages/db/src/collection/index.ts:579](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L579) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [packages/db/src/collection/index.ts:579](https://github.com/TanStac id: string; ``` -Defined in: [packages/db/src/collection/index.ts:273](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L273) +Defined in: [packages/db/src/collection/index.ts:273](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L273) #### Inherited from @@ -60,7 +60,7 @@ Defined in: [packages/db/src/collection/index.ts:273](https://github.com/TanStac indexes: Map>; ``` -Defined in: [packages/db/src/collection/index.ts:564](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L564) +Defined in: [packages/db/src/collection/index.ts:564](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L564) #### Inherited from @@ -76,7 +76,7 @@ Pick.indexes entries(): IterableIterator<[TKey, T]>; ``` -Defined in: [packages/db/src/collection/index.ts:488](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L488) +Defined in: [packages/db/src/collection/index.ts:488](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L488) Get all entries (virtual derived state) @@ -98,7 +98,7 @@ Pick.entries get(key): T | undefined; ``` -Defined in: [packages/db/src/collection/index.ts:453](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L453) +Defined in: [packages/db/src/collection/index.ts:453](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L453) Get the current value for a key (virtual derived state) @@ -126,7 +126,7 @@ Pick.get has(key): boolean; ``` -Defined in: [packages/db/src/collection/index.ts:460](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L460) +Defined in: [packages/db/src/collection/index.ts:460](https://github.com/MAST1999/db/blob/main/packages/db/src/collection/index.ts#L460) Check if a key exists in the collection (virtual derived state) diff --git a/docs/reference/interfaces/Context.md b/docs/reference/interfaces/Context.md index 246dca186..886b956b1 100644 --- a/docs/reference/interfaces/Context.md +++ b/docs/reference/interfaces/Context.md @@ -5,7 +5,7 @@ title: Context # Interface: Context -Defined in: [packages/db/src/query/builder/types.ts:35](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L35) +Defined in: [packages/db/src/query/builder/types.ts:35](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/types.ts#L35) Context - The central state container for query builder operations @@ -36,7 +36,7 @@ The context evolves through the query builder chain: baseSchema: ContextSchema; ``` -Defined in: [packages/db/src/query/builder/types.ts:37](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L37) +Defined in: [packages/db/src/query/builder/types.ts:37](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/types.ts#L37) *** @@ -46,7 +46,7 @@ Defined in: [packages/db/src/query/builder/types.ts:37](https://github.com/TanSt fromSourceName: string; ``` -Defined in: [packages/db/src/query/builder/types.ts:41](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L41) +Defined in: [packages/db/src/query/builder/types.ts:41](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/types.ts#L41) *** @@ -56,7 +56,7 @@ Defined in: [packages/db/src/query/builder/types.ts:41](https://github.com/TanSt optional hasJoins: boolean; ``` -Defined in: [packages/db/src/query/builder/types.ts:43](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L43) +Defined in: [packages/db/src/query/builder/types.ts:43](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/types.ts#L43) *** @@ -66,7 +66,7 @@ Defined in: [packages/db/src/query/builder/types.ts:43](https://github.com/TanSt optional joinTypes: Record; ``` -Defined in: [packages/db/src/query/builder/types.ts:45](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L45) +Defined in: [packages/db/src/query/builder/types.ts:45](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/types.ts#L45) *** @@ -76,7 +76,7 @@ Defined in: [packages/db/src/query/builder/types.ts:45](https://github.com/TanSt optional result: any; ``` -Defined in: [packages/db/src/query/builder/types.ts:50](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L50) +Defined in: [packages/db/src/query/builder/types.ts:50](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/types.ts#L50) *** @@ -86,7 +86,7 @@ Defined in: [packages/db/src/query/builder/types.ts:50](https://github.com/TanSt schema: ContextSchema; ``` -Defined in: [packages/db/src/query/builder/types.ts:39](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L39) +Defined in: [packages/db/src/query/builder/types.ts:39](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/types.ts#L39) *** @@ -96,4 +96,4 @@ Defined in: [packages/db/src/query/builder/types.ts:39](https://github.com/TanSt optional singleResult: boolean; ``` -Defined in: [packages/db/src/query/builder/types.ts:52](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L52) +Defined in: [packages/db/src/query/builder/types.ts:52](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/types.ts#L52) diff --git a/docs/reference/interfaces/CreateOptimisticActionsOptions.md b/docs/reference/interfaces/CreateOptimisticActionsOptions.md index 166e135dc..980b4ca9b 100644 --- a/docs/reference/interfaces/CreateOptimisticActionsOptions.md +++ b/docs/reference/interfaces/CreateOptimisticActionsOptions.md @@ -5,7 +5,7 @@ title: CreateOptimisticActionsOptions # Interface: CreateOptimisticActionsOptions\ -Defined in: [packages/db/src/types.ts:178](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L178) +Defined in: [packages/db/src/types.ts:178](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L178) Options for the createOptimisticAction helper @@ -31,7 +31,7 @@ Options for the createOptimisticAction helper optional autoCommit: boolean; ``` -Defined in: [packages/db/src/types.ts:169](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L169) +Defined in: [packages/db/src/types.ts:169](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L169) #### Inherited from @@ -45,7 +45,7 @@ Defined in: [packages/db/src/types.ts:169](https://github.com/TanStack/db/blob/m optional id: string; ``` -Defined in: [packages/db/src/types.ts:167](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L167) +Defined in: [packages/db/src/types.ts:167](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L167) Unique identifier for the transaction @@ -63,7 +63,7 @@ Omit.id optional metadata: Record; ``` -Defined in: [packages/db/src/types.ts:172](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L172) +Defined in: [packages/db/src/types.ts:172](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L172) Custom metadata to associate with the transaction @@ -81,7 +81,7 @@ Omit.metadata mutationFn: (vars, params) => Promise; ``` -Defined in: [packages/db/src/types.ts:185](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L185) +Defined in: [packages/db/src/types.ts:185](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L185) Function to execute the mutation on the server @@ -107,7 +107,7 @@ Function to execute the mutation on the server onMutate: (vars) => void; ``` -Defined in: [packages/db/src/types.ts:183](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L183) +Defined in: [packages/db/src/types.ts:183](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L183) Function to apply optimistic updates locally before the mutation completes diff --git a/docs/reference/interfaces/CurrentStateAsChangesOptions.md b/docs/reference/interfaces/CurrentStateAsChangesOptions.md index 0774a7c7b..6993970f6 100644 --- a/docs/reference/interfaces/CurrentStateAsChangesOptions.md +++ b/docs/reference/interfaces/CurrentStateAsChangesOptions.md @@ -5,7 +5,7 @@ title: CurrentStateAsChangesOptions # Interface: CurrentStateAsChangesOptions -Defined in: [packages/db/src/types.ts:741](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L741) +Defined in: [packages/db/src/types.ts:741](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L741) Options for getting current state as changes @@ -17,7 +17,7 @@ Options for getting current state as changes optional limit: number; ``` -Defined in: [packages/db/src/types.ts:745](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L745) +Defined in: [packages/db/src/types.ts:745](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L745) *** @@ -27,7 +27,7 @@ Defined in: [packages/db/src/types.ts:745](https://github.com/TanStack/db/blob/m optional optimizedOnly: boolean; ``` -Defined in: [packages/db/src/types.ts:746](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L746) +Defined in: [packages/db/src/types.ts:746](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L746) *** @@ -37,7 +37,7 @@ Defined in: [packages/db/src/types.ts:746](https://github.com/TanStack/db/blob/m optional orderBy: OrderBy; ``` -Defined in: [packages/db/src/types.ts:744](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L744) +Defined in: [packages/db/src/types.ts:744](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L744) *** @@ -47,6 +47,6 @@ Defined in: [packages/db/src/types.ts:744](https://github.com/TanStack/db/blob/m optional where: BasicExpression; ``` -Defined in: [packages/db/src/types.ts:743](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L743) +Defined in: [packages/db/src/types.ts:743](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L743) Pre-compiled expression for filtering the current state diff --git a/docs/reference/interfaces/DebounceStrategy.md b/docs/reference/interfaces/DebounceStrategy.md index f0418edc7..d74f71aa3 100644 --- a/docs/reference/interfaces/DebounceStrategy.md +++ b/docs/reference/interfaces/DebounceStrategy.md @@ -5,7 +5,7 @@ title: DebounceStrategy # Interface: DebounceStrategy -Defined in: [packages/db/src/strategies/types.ts:42](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L42) +Defined in: [packages/db/src/strategies/types.ts:42](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L42) Debounce strategy that delays execution until activity stops @@ -21,7 +21,7 @@ Debounce strategy that delays execution until activity stops _type: "debounce"; ``` -Defined in: [packages/db/src/strategies/types.ts:8](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L8) +Defined in: [packages/db/src/strategies/types.ts:8](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L8) Type discriminator for strategy identification @@ -37,7 +37,7 @@ Type discriminator for strategy identification cleanup: () => void; ``` -Defined in: [packages/db/src/strategies/types.ts:23](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L23) +Defined in: [packages/db/src/strategies/types.ts:23](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L23) Clean up any resources held by the strategy Should be called when the strategy is no longer needed @@ -58,7 +58,7 @@ Should be called when the strategy is no longer needed execute: (fn) => void | Promise; ``` -Defined in: [packages/db/src/strategies/types.ts:15](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L15) +Defined in: [packages/db/src/strategies/types.ts:15](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L15) Execute a function according to the strategy's timing rules @@ -94,4 +94,4 @@ The result of the function execution (if applicable) options: DebounceStrategyOptions; ``` -Defined in: [packages/db/src/strategies/types.ts:43](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L43) +Defined in: [packages/db/src/strategies/types.ts:43](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L43) diff --git a/docs/reference/interfaces/DebounceStrategyOptions.md b/docs/reference/interfaces/DebounceStrategyOptions.md index 99e5fe458..a05531dbf 100644 --- a/docs/reference/interfaces/DebounceStrategyOptions.md +++ b/docs/reference/interfaces/DebounceStrategyOptions.md @@ -5,7 +5,7 @@ title: DebounceStrategyOptions # Interface: DebounceStrategyOptions -Defined in: [packages/db/src/strategies/types.ts:30](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L30) +Defined in: [packages/db/src/strategies/types.ts:30](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L30) Options for debounce strategy Delays execution until after a period of inactivity @@ -18,7 +18,7 @@ Delays execution until after a period of inactivity optional leading: boolean; ``` -Defined in: [packages/db/src/strategies/types.ts:34](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L34) +Defined in: [packages/db/src/strategies/types.ts:34](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L34) Execute immediately on the first call @@ -30,7 +30,7 @@ Execute immediately on the first call optional trailing: boolean; ``` -Defined in: [packages/db/src/strategies/types.ts:36](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L36) +Defined in: [packages/db/src/strategies/types.ts:36](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L36) Execute after the wait period on the last call @@ -42,6 +42,6 @@ Execute after the wait period on the last call wait: number; ``` -Defined in: [packages/db/src/strategies/types.ts:32](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L32) +Defined in: [packages/db/src/strategies/types.ts:32](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L32) Wait time in milliseconds before execution diff --git a/docs/reference/interfaces/IndexInterface.md b/docs/reference/interfaces/IndexInterface.md index ebb33b416..136d3660c 100644 --- a/docs/reference/interfaces/IndexInterface.md +++ b/docs/reference/interfaces/IndexInterface.md @@ -5,7 +5,7 @@ title: IndexInterface # Interface: IndexInterface\ -Defined in: [packages/db/src/indexes/base-index.ts:28](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L28) +Defined in: [packages/db/src/indexes/base-index.ts:28](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L28) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:28](https://github.com/TanSta add: (key, item) => void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:31](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L31) +Defined in: [packages/db/src/indexes/base-index.ts:31](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L31) #### Parameters @@ -45,7 +45,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:31](https://github.com/TanSta build: (entries) => void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:35](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L35) +Defined in: [packages/db/src/indexes/base-index.ts:35](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L35) #### Parameters @@ -65,7 +65,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:35](https://github.com/TanSta clear: () => void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:36](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L36) +Defined in: [packages/db/src/indexes/base-index.ts:36](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L36) #### Returns @@ -79,7 +79,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:36](https://github.com/TanSta equalityLookup: (value) => Set; ``` -Defined in: [packages/db/src/indexes/base-index.ts:40](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L40) +Defined in: [packages/db/src/indexes/base-index.ts:40](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L40) #### Parameters @@ -99,7 +99,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:40](https://github.com/TanSta getStats: () => IndexStats; ``` -Defined in: [packages/db/src/indexes/base-index.ts:70](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L70) +Defined in: [packages/db/src/indexes/base-index.ts:70](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L70) #### Returns @@ -113,7 +113,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:70](https://github.com/TanSta inArrayLookup: (values) => Set; ``` -Defined in: [packages/db/src/indexes/base-index.ts:41](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L41) +Defined in: [packages/db/src/indexes/base-index.ts:41](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L41) #### Parameters @@ -133,7 +133,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:41](https://github.com/TanSta lookup: (operation, value) => Set; ``` -Defined in: [packages/db/src/indexes/base-index.ts:38](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L38) +Defined in: [packages/db/src/indexes/base-index.ts:38](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L38) #### Parameters @@ -157,7 +157,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:38](https://github.com/TanSta matchesCompareOptions: (compareOptions) => boolean; ``` -Defined in: [packages/db/src/indexes/base-index.ts:67](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L67) +Defined in: [packages/db/src/indexes/base-index.ts:67](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L67) #### Parameters @@ -177,7 +177,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:67](https://github.com/TanSta matchesDirection: (direction) => boolean; ``` -Defined in: [packages/db/src/indexes/base-index.ts:68](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L68) +Defined in: [packages/db/src/indexes/base-index.ts:68](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L68) #### Parameters @@ -197,7 +197,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:68](https://github.com/TanSta matchesField: (fieldPath) => boolean; ``` -Defined in: [packages/db/src/indexes/base-index.ts:66](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L66) +Defined in: [packages/db/src/indexes/base-index.ts:66](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L66) #### Parameters @@ -217,7 +217,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:66](https://github.com/TanSta rangeQuery: (options) => Set; ``` -Defined in: [packages/db/src/indexes/base-index.ts:43](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L43) +Defined in: [packages/db/src/indexes/base-index.ts:43](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L43) #### Parameters @@ -237,7 +237,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:43](https://github.com/TanSta rangeQueryReversed: (options) => Set; ``` -Defined in: [packages/db/src/indexes/base-index.ts:44](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L44) +Defined in: [packages/db/src/indexes/base-index.ts:44](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L44) #### Parameters @@ -257,7 +257,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:44](https://github.com/TanSta remove: (key, item) => void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:32](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L32) +Defined in: [packages/db/src/indexes/base-index.ts:32](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L32) #### Parameters @@ -281,7 +281,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:32](https://github.com/TanSta supports: (operation) => boolean; ``` -Defined in: [packages/db/src/indexes/base-index.ts:64](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L64) +Defined in: [packages/db/src/indexes/base-index.ts:64](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L64) #### Parameters @@ -301,7 +301,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:64](https://github.com/TanSta take: (n, from?, filterFn?) => TKey[]; ``` -Defined in: [packages/db/src/indexes/base-index.ts:46](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L46) +Defined in: [packages/db/src/indexes/base-index.ts:46](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L46) #### Parameters @@ -329,7 +329,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:46](https://github.com/TanSta takeReversed: (n, from?, filterFn?) => TKey[]; ``` -Defined in: [packages/db/src/indexes/base-index.ts:51](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L51) +Defined in: [packages/db/src/indexes/base-index.ts:51](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L51) #### Parameters @@ -357,7 +357,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:51](https://github.com/TanSta update: (key, oldItem, newItem) => void; ``` -Defined in: [packages/db/src/indexes/base-index.ts:33](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L33) +Defined in: [packages/db/src/indexes/base-index.ts:33](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L33) #### Parameters @@ -387,7 +387,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:33](https://github.com/TanSta get indexedKeysSet(): Set; ``` -Defined in: [packages/db/src/indexes/base-index.ts:61](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L61) +Defined in: [packages/db/src/indexes/base-index.ts:61](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L61) ##### Returns @@ -403,7 +403,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:61](https://github.com/TanSta get keyCount(): number; ``` -Defined in: [packages/db/src/indexes/base-index.ts:57](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L57) +Defined in: [packages/db/src/indexes/base-index.ts:57](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L57) ##### Returns @@ -419,7 +419,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:57](https://github.com/TanSta get orderedEntriesArray(): [any, Set][]; ``` -Defined in: [packages/db/src/indexes/base-index.ts:58](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L58) +Defined in: [packages/db/src/indexes/base-index.ts:58](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L58) ##### Returns @@ -435,7 +435,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:58](https://github.com/TanSta get orderedEntriesArrayReversed(): [any, Set][]; ``` -Defined in: [packages/db/src/indexes/base-index.ts:59](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L59) +Defined in: [packages/db/src/indexes/base-index.ts:59](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L59) ##### Returns @@ -451,7 +451,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:59](https://github.com/TanSta get valueMapData(): Map>; ``` -Defined in: [packages/db/src/indexes/base-index.ts:62](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L62) +Defined in: [packages/db/src/indexes/base-index.ts:62](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L62) ##### Returns diff --git a/docs/reference/interfaces/IndexOptions.md b/docs/reference/interfaces/IndexOptions.md index 8a99a578a..641f6cd5a 100644 --- a/docs/reference/interfaces/IndexOptions.md +++ b/docs/reference/interfaces/IndexOptions.md @@ -5,7 +5,7 @@ title: IndexOptions # Interface: IndexOptions\ -Defined in: [packages/db/src/indexes/index-options.ts:6](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/index-options.ts#L6) +Defined in: [packages/db/src/indexes/index-options.ts:6](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/index-options.ts#L6) Enhanced index options that support both sync and async resolvers @@ -23,7 +23,7 @@ Enhanced index options that support both sync and async resolvers optional indexType: TResolver; ``` -Defined in: [packages/db/src/indexes/index-options.ts:8](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/index-options.ts#L8) +Defined in: [packages/db/src/indexes/index-options.ts:8](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/index-options.ts#L8) *** @@ -33,7 +33,7 @@ Defined in: [packages/db/src/indexes/index-options.ts:8](https://github.com/TanS optional name: string; ``` -Defined in: [packages/db/src/indexes/index-options.ts:7](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/index-options.ts#L7) +Defined in: [packages/db/src/indexes/index-options.ts:7](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/index-options.ts#L7) *** @@ -43,4 +43,4 @@ Defined in: [packages/db/src/indexes/index-options.ts:7](https://github.com/TanS optional options: TResolver extends IndexConstructor ? TResolver extends (id, expr, name?, options?) => any ? O : never : TResolver extends () => Promise ? TCtor extends (id, expr, name?, options?) => any ? O : never : never; ``` -Defined in: [packages/db/src/indexes/index-options.ts:9](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/index-options.ts#L9) +Defined in: [packages/db/src/indexes/index-options.ts:9](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/index-options.ts#L9) diff --git a/docs/reference/interfaces/IndexStats.md b/docs/reference/interfaces/IndexStats.md index ff3db9e4b..114146c60 100644 --- a/docs/reference/interfaces/IndexStats.md +++ b/docs/reference/interfaces/IndexStats.md @@ -5,7 +5,7 @@ title: IndexStats # Interface: IndexStats -Defined in: [packages/db/src/indexes/base-index.ts:21](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L21) +Defined in: [packages/db/src/indexes/base-index.ts:21](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L21) Statistics about index usage and performance @@ -17,7 +17,7 @@ Statistics about index usage and performance readonly averageLookupTime: number; ``` -Defined in: [packages/db/src/indexes/base-index.ts:24](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L24) +Defined in: [packages/db/src/indexes/base-index.ts:24](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L24) *** @@ -27,7 +27,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:24](https://github.com/TanSta readonly entryCount: number; ``` -Defined in: [packages/db/src/indexes/base-index.ts:22](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L22) +Defined in: [packages/db/src/indexes/base-index.ts:22](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L22) *** @@ -37,7 +37,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:22](https://github.com/TanSta readonly lastUpdated: Date; ``` -Defined in: [packages/db/src/indexes/base-index.ts:25](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L25) +Defined in: [packages/db/src/indexes/base-index.ts:25](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L25) *** @@ -47,4 +47,4 @@ Defined in: [packages/db/src/indexes/base-index.ts:25](https://github.com/TanSta readonly lookupCount: number; ``` -Defined in: [packages/db/src/indexes/base-index.ts:23](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L23) +Defined in: [packages/db/src/indexes/base-index.ts:23](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L23) diff --git a/docs/reference/interfaces/InsertConfig.md b/docs/reference/interfaces/InsertConfig.md index 47410c1e4..0f8b6b35d 100644 --- a/docs/reference/interfaces/InsertConfig.md +++ b/docs/reference/interfaces/InsertConfig.md @@ -5,7 +5,7 @@ title: InsertConfig # Interface: InsertConfig -Defined in: [packages/db/src/types.ts:356](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L356) +Defined in: [packages/db/src/types.ts:356](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L356) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/db/src/types.ts:356](https://github.com/TanStack/db/blob/m optional metadata: Record; ``` -Defined in: [packages/db/src/types.ts:357](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L357) +Defined in: [packages/db/src/types.ts:357](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L357) *** @@ -25,6 +25,6 @@ Defined in: [packages/db/src/types.ts:357](https://github.com/TanStack/db/blob/m optional optimistic: boolean; ``` -Defined in: [packages/db/src/types.ts:359](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L359) +Defined in: [packages/db/src/types.ts:359](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L359) Whether to apply optimistic updates immediately. Defaults to true. diff --git a/docs/reference/interfaces/LiveQueryCollectionConfig.md b/docs/reference/interfaces/LiveQueryCollectionConfig.md index 1c3a8ed77..f659d37e9 100644 --- a/docs/reference/interfaces/LiveQueryCollectionConfig.md +++ b/docs/reference/interfaces/LiveQueryCollectionConfig.md @@ -5,7 +5,7 @@ title: LiveQueryCollectionConfig # Interface: LiveQueryCollectionConfig\ -Defined in: [packages/db/src/query/live/types.ts:53](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L53) +Defined in: [packages/db/src/query/live/types.ts:53](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live/types.ts#L53) Configuration interface for live query collection options @@ -49,7 +49,7 @@ const config: LiveQueryCollectionConfig = { optional defaultStringCollation: StringCollationConfig; ``` -Defined in: [packages/db/src/query/live/types.ts:107](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L107) +Defined in: [packages/db/src/query/live/types.ts:107](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live/types.ts#L107) Optional compare options for string sorting. If provided, these will be used instead of inheriting from the FROM collection. @@ -62,7 +62,7 @@ If provided, these will be used instead of inheriting from the FROM collection. optional gcTime: number; ``` -Defined in: [packages/db/src/query/live/types.ts:96](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L96) +Defined in: [packages/db/src/query/live/types.ts:96](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live/types.ts#L96) GC time for the collection @@ -74,7 +74,7 @@ GC time for the collection optional getKey: (item) => string | number; ``` -Defined in: [packages/db/src/query/live/types.ts:74](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L74) +Defined in: [packages/db/src/query/live/types.ts:74](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live/types.ts#L74) Function to extract the key from result items If not provided, defaults to using the key from the D2 stream @@ -97,7 +97,7 @@ If not provided, defaults to using the key from the D2 stream optional id: string; ``` -Defined in: [packages/db/src/query/live/types.ts:61](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L61) +Defined in: [packages/db/src/query/live/types.ts:61](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live/types.ts#L61) Unique identifier for the collection If not provided, defaults to `live-query-${number}` with auto-incrementing number @@ -110,7 +110,7 @@ If not provided, defaults to `live-query-${number}` with auto-incrementing numbe optional onDelete: DeleteMutationFn; ``` -Defined in: [packages/db/src/query/live/types.ts:86](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L86) +Defined in: [packages/db/src/query/live/types.ts:86](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live/types.ts#L86) *** @@ -120,7 +120,7 @@ Defined in: [packages/db/src/query/live/types.ts:86](https://github.com/TanStack optional onInsert: InsertMutationFn; ``` -Defined in: [packages/db/src/query/live/types.ts:84](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L84) +Defined in: [packages/db/src/query/live/types.ts:84](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live/types.ts#L84) Optional mutation handlers @@ -132,7 +132,7 @@ Optional mutation handlers optional onUpdate: UpdateMutationFn; ``` -Defined in: [packages/db/src/query/live/types.ts:85](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L85) +Defined in: [packages/db/src/query/live/types.ts:85](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live/types.ts#L85) *** @@ -144,7 +144,7 @@ query: | (q) => QueryBuilder; ``` -Defined in: [packages/db/src/query/live/types.ts:66](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L66) +Defined in: [packages/db/src/query/live/types.ts:66](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live/types.ts#L66) Query builder function that defines the live query @@ -156,7 +156,7 @@ Query builder function that defines the live query optional schema: undefined; ``` -Defined in: [packages/db/src/query/live/types.ts:79](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L79) +Defined in: [packages/db/src/query/live/types.ts:79](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live/types.ts#L79) Optional schema for validation @@ -168,7 +168,7 @@ Optional schema for validation optional singleResult: true; ``` -Defined in: [packages/db/src/query/live/types.ts:101](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L101) +Defined in: [packages/db/src/query/live/types.ts:101](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live/types.ts#L101) If enabled the collection will return a single object instead of an array @@ -180,6 +180,6 @@ If enabled the collection will return a single object instead of an array optional startSync: boolean; ``` -Defined in: [packages/db/src/query/live/types.ts:91](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L91) +Defined in: [packages/db/src/query/live/types.ts:91](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live/types.ts#L91) Start sync / the query immediately diff --git a/docs/reference/interfaces/LocalOnlyCollectionConfig.md b/docs/reference/interfaces/LocalOnlyCollectionConfig.md index 5174a1e32..1159735b1 100644 --- a/docs/reference/interfaces/LocalOnlyCollectionConfig.md +++ b/docs/reference/interfaces/LocalOnlyCollectionConfig.md @@ -5,7 +5,7 @@ title: LocalOnlyCollectionConfig # Interface: LocalOnlyCollectionConfig\ -Defined in: [packages/db/src/local-only.ts:22](https://github.com/TanStack/db/blob/main/packages/db/src/local-only.ts#L22) +Defined in: [packages/db/src/local-only.ts:22](https://github.com/MAST1999/db/blob/main/packages/db/src/local-only.ts#L22) Configuration interface for Local-only collection options @@ -41,7 +41,7 @@ The type of the key returned by `getKey` optional autoIndex: "eager" | "off"; ``` -Defined in: [packages/db/src/types.ts:487](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L487) +Defined in: [packages/db/src/types.ts:487](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L487) Auto-indexing mode for the collection. When enabled, indexes will be automatically created for simple where expressions. @@ -69,7 +69,7 @@ When enabled, indexes will be automatically created for simple where expressions optional compare: (x, y) => number; ``` -Defined in: [packages/db/src/types.ts:498](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L498) +Defined in: [packages/db/src/types.ts:498](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L498) Optional function to compare two items. This is used to order the items in the collection. @@ -115,7 +115,7 @@ Omit.compare optional defaultStringCollation: StringCollationConfig; ``` -Defined in: [packages/db/src/types.ts:644](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L644) +Defined in: [packages/db/src/types.ts:644](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L644) Specifies how to compare data in the collection. This should be configured to match data ordering on the backend. @@ -136,7 +136,7 @@ Omit.defaultStringCollation getKey: (item) => TKey; ``` -Defined in: [packages/db/src/types.ts:462](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L462) +Defined in: [packages/db/src/types.ts:462](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L462) Function to extract the ID from an object This is required for update/delete operations which now only accept IDs @@ -176,7 +176,7 @@ Omit.getKey optional id: string; ``` -Defined in: [packages/db/src/types.ts:451](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L451) +Defined in: [packages/db/src/types.ts:451](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L451) #### Inherited from @@ -190,7 +190,7 @@ Defined in: [packages/db/src/types.ts:451](https://github.com/TanStack/db/blob/m optional initialData: T[]; ``` -Defined in: [packages/db/src/local-only.ts:34](https://github.com/TanStack/db/blob/main/packages/db/src/local-only.ts#L34) +Defined in: [packages/db/src/local-only.ts:34](https://github.com/MAST1999/db/blob/main/packages/db/src/local-only.ts#L34) Optional initial data to populate the collection with on creation This data will be applied during the initial sync process @@ -203,7 +203,7 @@ This data will be applied during the initial sync process optional onDelete: DeleteMutationFn; ``` -Defined in: [packages/db/src/types.ts:636](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L636) +Defined in: [packages/db/src/types.ts:636](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L636) Optional asynchronous handler function called before a delete operation @@ -273,7 +273,7 @@ Omit.onDelete optional onInsert: InsertMutationFn; ``` -Defined in: [packages/db/src/types.ts:549](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L549) +Defined in: [packages/db/src/types.ts:549](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L549) Optional asynchronous handler function called before an insert operation @@ -342,7 +342,7 @@ Omit.onInsert optional onUpdate: UpdateMutationFn; ``` -Defined in: [packages/db/src/types.ts:593](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L593) +Defined in: [packages/db/src/types.ts:593](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L593) Optional asynchronous handler function called before an update operation @@ -412,7 +412,7 @@ Omit.onUpdate optional schema: TSchema; ``` -Defined in: [packages/db/src/types.ts:452](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L452) +Defined in: [packages/db/src/types.ts:452](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L452) #### Inherited from @@ -428,7 +428,7 @@ Omit.schema optional syncMode: SyncMode; ``` -Defined in: [packages/db/src/types.ts:507](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L507) +Defined in: [packages/db/src/types.ts:507](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L507) The mode of sync to use for the collection. @@ -454,7 +454,7 @@ The exact implementation of the sync mode is up to the sync implementation. optional utils: LocalOnlyCollectionUtils; ``` -Defined in: [packages/db/src/types.ts:646](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L646) +Defined in: [packages/db/src/types.ts:646](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L646) #### Inherited from diff --git a/docs/reference/interfaces/LocalOnlyCollectionUtils.md b/docs/reference/interfaces/LocalOnlyCollectionUtils.md index 75d3e41ce..aa5afd17c 100644 --- a/docs/reference/interfaces/LocalOnlyCollectionUtils.md +++ b/docs/reference/interfaces/LocalOnlyCollectionUtils.md @@ -5,7 +5,7 @@ title: LocalOnlyCollectionUtils # Interface: LocalOnlyCollectionUtils -Defined in: [packages/db/src/local-only.ts:40](https://github.com/TanStack/db/blob/main/packages/db/src/local-only.ts#L40) +Defined in: [packages/db/src/local-only.ts:40](https://github.com/MAST1999/db/blob/main/packages/db/src/local-only.ts#L40) Local-only collection utilities type @@ -27,7 +27,7 @@ Local-only collection utilities type acceptMutations: (transaction) => void; ``` -Defined in: [packages/db/src/local-only.ts:58](https://github.com/TanStack/db/blob/main/packages/db/src/local-only.ts#L58) +Defined in: [packages/db/src/local-only.ts:58](https://github.com/MAST1999/db/blob/main/packages/db/src/local-only.ts#L58) Accepts mutations from a transaction that belong to this collection and persists them. This should be called in your transaction's mutationFn to persist local-only data. diff --git a/docs/reference/interfaces/LocalStorageCollectionConfig.md b/docs/reference/interfaces/LocalStorageCollectionConfig.md index 358d4e72f..9d25bf852 100644 --- a/docs/reference/interfaces/LocalStorageCollectionConfig.md +++ b/docs/reference/interfaces/LocalStorageCollectionConfig.md @@ -5,7 +5,7 @@ title: LocalStorageCollectionConfig # Interface: LocalStorageCollectionConfig\ -Defined in: [packages/db/src/local-storage.ts:58](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L58) +Defined in: [packages/db/src/local-storage.ts:58](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L58) Configuration interface for localStorage collection options @@ -41,7 +41,7 @@ The type of the key returned by `getKey` optional autoIndex: "eager" | "off"; ``` -Defined in: [packages/db/src/types.ts:487](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L487) +Defined in: [packages/db/src/types.ts:487](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L487) Auto-indexing mode for the collection. When enabled, indexes will be automatically created for simple where expressions. @@ -69,7 +69,7 @@ When enabled, indexes will be automatically created for simple where expressions optional compare: (x, y) => number; ``` -Defined in: [packages/db/src/types.ts:498](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L498) +Defined in: [packages/db/src/types.ts:498](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L498) Optional function to compare two items. This is used to order the items in the collection. @@ -113,7 +113,7 @@ compare: (x, y) => x.createdAt.getTime() - y.createdAt.getTime() optional defaultStringCollation: StringCollationConfig; ``` -Defined in: [packages/db/src/types.ts:644](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L644) +Defined in: [packages/db/src/types.ts:644](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L644) Specifies how to compare data in the collection. This should be configured to match data ordering on the backend. @@ -132,7 +132,7 @@ E.g., when using the Electric DB collection these options optional gcTime: number; ``` -Defined in: [packages/db/src/types.ts:467](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L467) +Defined in: [packages/db/src/types.ts:467](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L467) Time in milliseconds after which the collection will be garbage collected when it has no active subscribers. Defaults to 5 minutes (300000ms). @@ -149,7 +149,7 @@ when it has no active subscribers. Defaults to 5 minutes (300000ms). getKey: (item) => TKey; ``` -Defined in: [packages/db/src/types.ts:462](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L462) +Defined in: [packages/db/src/types.ts:462](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L462) Function to extract the ID from an object This is required for update/delete operations which now only accept IDs @@ -187,7 +187,7 @@ getKey: (item) => item.uuid optional id: string; ``` -Defined in: [packages/db/src/types.ts:451](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L451) +Defined in: [packages/db/src/types.ts:451](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L451) #### Inherited from @@ -201,7 +201,7 @@ Defined in: [packages/db/src/types.ts:451](https://github.com/TanStack/db/blob/m optional onDelete: DeleteMutationFn; ``` -Defined in: [packages/db/src/types.ts:636](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L636) +Defined in: [packages/db/src/types.ts:636](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L636) Optional asynchronous handler function called before a delete operation @@ -269,7 +269,7 @@ onDelete: async ({ transaction, collection }) => { optional onInsert: InsertMutationFn; ``` -Defined in: [packages/db/src/types.ts:549](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L549) +Defined in: [packages/db/src/types.ts:549](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L549) Optional asynchronous handler function called before an insert operation @@ -336,7 +336,7 @@ onInsert: async ({ transaction, collection }) => { optional onUpdate: UpdateMutationFn; ``` -Defined in: [packages/db/src/types.ts:593](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L593) +Defined in: [packages/db/src/types.ts:593](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L593) Optional asynchronous handler function called before an update operation @@ -404,7 +404,7 @@ onUpdate: async ({ transaction, collection }) => { optional parser: Parser; ``` -Defined in: [packages/db/src/local-storage.ts:84](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L84) +Defined in: [packages/db/src/local-storage.ts:84](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L84) Parser to use for serializing and deserializing data to and from storage Defaults to JSON @@ -417,7 +417,7 @@ Defaults to JSON optional schema: TSchema; ``` -Defined in: [packages/db/src/types.ts:452](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L452) +Defined in: [packages/db/src/types.ts:452](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L452) #### Inherited from @@ -431,7 +431,7 @@ Defined in: [packages/db/src/types.ts:452](https://github.com/TanStack/db/blob/m optional startSync: boolean; ``` -Defined in: [packages/db/src/types.ts:478](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L478) +Defined in: [packages/db/src/types.ts:478](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L478) Whether to eagerly start syncing on collection creation. When true, syncing begins immediately. When false, syncing starts when the first subscriber attaches. @@ -458,7 +458,7 @@ false optional storage: StorageApi; ``` -Defined in: [packages/db/src/local-storage.ts:72](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L72) +Defined in: [packages/db/src/local-storage.ts:72](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L72) Storage API to use (defaults to window.localStorage) Can be any object that implements the Storage interface (e.g., sessionStorage) @@ -471,7 +471,7 @@ Can be any object that implements the Storage interface (e.g., sessionStorage) optional storageEventApi: StorageEventApi; ``` -Defined in: [packages/db/src/local-storage.ts:78](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L78) +Defined in: [packages/db/src/local-storage.ts:78](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L78) Storage event API to use for cross-tab synchronization (defaults to window) Can be any object that implements addEventListener/removeEventListener for storage events @@ -484,7 +484,7 @@ Can be any object that implements addEventListener/removeEventListener for stora storageKey: string; ``` -Defined in: [packages/db/src/local-storage.ts:66](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L66) +Defined in: [packages/db/src/local-storage.ts:66](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L66) The key to use for storing the collection data in localStorage/sessionStorage @@ -496,7 +496,7 @@ The key to use for storing the collection data in localStorage/sessionStorage optional syncMode: SyncMode; ``` -Defined in: [packages/db/src/types.ts:507](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L507) +Defined in: [packages/db/src/types.ts:507](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L507) The mode of sync to use for the collection. @@ -522,7 +522,7 @@ The exact implementation of the sync mode is up to the sync implementation. optional utils: UtilsRecord; ``` -Defined in: [packages/db/src/types.ts:646](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L646) +Defined in: [packages/db/src/types.ts:646](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L646) #### Inherited from diff --git a/docs/reference/interfaces/LocalStorageCollectionUtils.md b/docs/reference/interfaces/LocalStorageCollectionUtils.md index 9b35e540d..1a368d7ee 100644 --- a/docs/reference/interfaces/LocalStorageCollectionUtils.md +++ b/docs/reference/interfaces/LocalStorageCollectionUtils.md @@ -5,7 +5,7 @@ title: LocalStorageCollectionUtils # Interface: LocalStorageCollectionUtils -Defined in: [packages/db/src/local-storage.ts:100](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L100) +Defined in: [packages/db/src/local-storage.ts:100](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L100) LocalStorage collection utilities type @@ -27,7 +27,7 @@ LocalStorage collection utilities type acceptMutations: (transaction) => void; ``` -Defined in: [packages/db/src/local-storage.ts:120](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L120) +Defined in: [packages/db/src/local-storage.ts:120](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L120) Accepts mutations from a transaction that belong to this collection and persists them to localStorage. This should be called in your transaction's mutationFn to persist local-storage data. @@ -69,7 +69,7 @@ const tx = createTransaction({ clearStorage: ClearStorageFn; ``` -Defined in: [packages/db/src/local-storage.ts:101](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L101) +Defined in: [packages/db/src/local-storage.ts:101](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L101) *** @@ -79,4 +79,4 @@ Defined in: [packages/db/src/local-storage.ts:101](https://github.com/TanStack/d getStorageSize: GetStorageSizeFn; ``` -Defined in: [packages/db/src/local-storage.ts:102](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L102) +Defined in: [packages/db/src/local-storage.ts:102](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L102) diff --git a/docs/reference/interfaces/OperationConfig.md b/docs/reference/interfaces/OperationConfig.md index 66c3e6e55..92f29eacb 100644 --- a/docs/reference/interfaces/OperationConfig.md +++ b/docs/reference/interfaces/OperationConfig.md @@ -5,7 +5,7 @@ title: OperationConfig # Interface: OperationConfig -Defined in: [packages/db/src/types.ts:350](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L350) +Defined in: [packages/db/src/types.ts:350](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L350) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/db/src/types.ts:350](https://github.com/TanStack/db/blob/m optional metadata: Record; ``` -Defined in: [packages/db/src/types.ts:351](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L351) +Defined in: [packages/db/src/types.ts:351](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L351) *** @@ -25,6 +25,6 @@ Defined in: [packages/db/src/types.ts:351](https://github.com/TanStack/db/blob/m optional optimistic: boolean; ``` -Defined in: [packages/db/src/types.ts:353](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L353) +Defined in: [packages/db/src/types.ts:353](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L353) Whether to apply optimistic updates immediately. Defaults to true. diff --git a/docs/reference/interfaces/OptimisticChangeMessage.md b/docs/reference/interfaces/OptimisticChangeMessage.md index cda28f0f3..f7cc19af3 100644 --- a/docs/reference/interfaces/OptimisticChangeMessage.md +++ b/docs/reference/interfaces/OptimisticChangeMessage.md @@ -5,7 +5,7 @@ title: OptimisticChangeMessage # Interface: OptimisticChangeMessage\ -Defined in: [packages/db/src/types.ts:325](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L325) +Defined in: [packages/db/src/types.ts:325](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L325) ## Extends @@ -25,7 +25,7 @@ Defined in: [packages/db/src/types.ts:325](https://github.com/TanStack/db/blob/m optional isActive: boolean; ``` -Defined in: [packages/db/src/types.ts:329](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L329) +Defined in: [packages/db/src/types.ts:329](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L329) *** @@ -35,7 +35,7 @@ Defined in: [packages/db/src/types.ts:329](https://github.com/TanStack/db/blob/m key: string | number; ``` -Defined in: [packages/db/src/types.ts:318](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L318) +Defined in: [packages/db/src/types.ts:318](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L318) #### Inherited from @@ -49,7 +49,7 @@ Defined in: [packages/db/src/types.ts:318](https://github.com/TanStack/db/blob/m optional metadata: Record; ``` -Defined in: [packages/db/src/types.ts:322](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L322) +Defined in: [packages/db/src/types.ts:322](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L322) #### Inherited from @@ -63,7 +63,7 @@ Defined in: [packages/db/src/types.ts:322](https://github.com/TanStack/db/blob/m optional previousValue: T; ``` -Defined in: [packages/db/src/types.ts:320](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L320) +Defined in: [packages/db/src/types.ts:320](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L320) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [packages/db/src/types.ts:320](https://github.com/TanStack/db/blob/m type: OperationType; ``` -Defined in: [packages/db/src/types.ts:321](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L321) +Defined in: [packages/db/src/types.ts:321](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L321) #### Inherited from @@ -91,7 +91,7 @@ Defined in: [packages/db/src/types.ts:321](https://github.com/TanStack/db/blob/m value: T; ``` -Defined in: [packages/db/src/types.ts:319](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L319) +Defined in: [packages/db/src/types.ts:319](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L319) #### Inherited from diff --git a/docs/reference/interfaces/PacedMutationsConfig.md b/docs/reference/interfaces/PacedMutationsConfig.md index ead589087..c98c0732b 100644 --- a/docs/reference/interfaces/PacedMutationsConfig.md +++ b/docs/reference/interfaces/PacedMutationsConfig.md @@ -5,7 +5,7 @@ title: PacedMutationsConfig # Interface: PacedMutationsConfig\ -Defined in: [packages/db/src/paced-mutations.ts:8](https://github.com/TanStack/db/blob/main/packages/db/src/paced-mutations.ts#L8) +Defined in: [packages/db/src/paced-mutations.ts:8](https://github.com/MAST1999/db/blob/main/packages/db/src/paced-mutations.ts#L8) Configuration for creating a paced mutations manager @@ -27,7 +27,7 @@ Configuration for creating a paced mutations manager optional metadata: Record; ``` -Defined in: [packages/db/src/paced-mutations.ts:30](https://github.com/TanStack/db/blob/main/packages/db/src/paced-mutations.ts#L30) +Defined in: [packages/db/src/paced-mutations.ts:30](https://github.com/MAST1999/db/blob/main/packages/db/src/paced-mutations.ts#L30) Custom metadata to associate with transactions @@ -39,7 +39,7 @@ Custom metadata to associate with transactions mutationFn: MutationFn; ``` -Defined in: [packages/db/src/paced-mutations.ts:21](https://github.com/TanStack/db/blob/main/packages/db/src/paced-mutations.ts#L21) +Defined in: [packages/db/src/paced-mutations.ts:21](https://github.com/MAST1999/db/blob/main/packages/db/src/paced-mutations.ts#L21) Function to execute the mutation on the server. Receives the transaction parameters containing all merged mutations. @@ -52,7 +52,7 @@ Receives the transaction parameters containing all merged mutations. onMutate: (variables) => void; ``` -Defined in: [packages/db/src/paced-mutations.ts:16](https://github.com/TanStack/db/blob/main/packages/db/src/paced-mutations.ts#L16) +Defined in: [packages/db/src/paced-mutations.ts:16](https://github.com/MAST1999/db/blob/main/packages/db/src/paced-mutations.ts#L16) Callback to apply optimistic updates immediately. Receives the variables passed to the mutate function. @@ -75,7 +75,7 @@ Receives the variables passed to the mutate function. strategy: Strategy; ``` -Defined in: [packages/db/src/paced-mutations.ts:26](https://github.com/TanStack/db/blob/main/packages/db/src/paced-mutations.ts#L26) +Defined in: [packages/db/src/paced-mutations.ts:26](https://github.com/MAST1999/db/blob/main/packages/db/src/paced-mutations.ts#L26) Strategy for controlling mutation execution timing Examples: debounceStrategy, queueStrategy, throttleStrategy diff --git a/docs/reference/interfaces/ParseWhereOptions.md b/docs/reference/interfaces/ParseWhereOptions.md index 8a90e9014..b1754bedf 100644 --- a/docs/reference/interfaces/ParseWhereOptions.md +++ b/docs/reference/interfaces/ParseWhereOptions.md @@ -5,7 +5,7 @@ title: ParseWhereOptions # Interface: ParseWhereOptions\ -Defined in: [packages/db/src/query/expression-helpers.ts:53](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L53) +Defined in: [packages/db/src/query/expression-helpers.ts:53](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L53) Options for customizing how WHERE expressions are parsed @@ -23,7 +23,7 @@ Options for customizing how WHERE expressions are parsed handlers: object & object; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:67](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L67) +Defined in: [packages/db/src/query/expression-helpers.ts:67](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L67) Handler functions for different operators. Each handler receives the parsed field path(s) and value(s) and returns your custom format. @@ -431,7 +431,7 @@ optional upper: (...args) => T; optional onUnknownOperator: (operator, args) => T; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:76](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L76) +Defined in: [packages/db/src/query/expression-helpers.ts:76](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L76) Optional handler for when an unknown operator is encountered. If not provided, unknown operators throw an error. diff --git a/docs/reference/interfaces/ParsedOrderBy.md b/docs/reference/interfaces/ParsedOrderBy.md index 48a1773bf..9cf75323c 100644 --- a/docs/reference/interfaces/ParsedOrderBy.md +++ b/docs/reference/interfaces/ParsedOrderBy.md @@ -5,7 +5,7 @@ title: ParsedOrderBy # Interface: ParsedOrderBy -Defined in: [packages/db/src/query/expression-helpers.ts:82](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L82) +Defined in: [packages/db/src/query/expression-helpers.ts:82](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L82) Result of parsing an ORDER BY expression @@ -17,7 +17,7 @@ Result of parsing an ORDER BY expression direction: "asc" | "desc"; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:84](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L84) +Defined in: [packages/db/src/query/expression-helpers.ts:84](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L84) *** @@ -27,7 +27,7 @@ Defined in: [packages/db/src/query/expression-helpers.ts:84](https://github.com/ field: FieldPath; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:83](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L83) +Defined in: [packages/db/src/query/expression-helpers.ts:83](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L83) *** @@ -37,7 +37,7 @@ Defined in: [packages/db/src/query/expression-helpers.ts:83](https://github.com/ optional locale: string; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:89](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L89) +Defined in: [packages/db/src/query/expression-helpers.ts:89](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L89) Locale for locale-aware string sorting (e.g., 'en-US') @@ -49,7 +49,7 @@ Locale for locale-aware string sorting (e.g., 'en-US') optional localeOptions: object; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:91](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L91) +Defined in: [packages/db/src/query/expression-helpers.ts:91](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L91) Additional options for locale-aware sorting @@ -61,7 +61,7 @@ Additional options for locale-aware sorting nulls: "first" | "last"; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:85](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L85) +Defined in: [packages/db/src/query/expression-helpers.ts:85](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L85) *** @@ -71,6 +71,6 @@ Defined in: [packages/db/src/query/expression-helpers.ts:85](https://github.com/ optional stringSort: "lexical" | "locale"; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:87](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L87) +Defined in: [packages/db/src/query/expression-helpers.ts:87](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L87) String sorting method: 'lexical' (default) or 'locale' (locale-aware) diff --git a/docs/reference/interfaces/Parser.md b/docs/reference/interfaces/Parser.md index d1eafc24c..038845b1b 100644 --- a/docs/reference/interfaces/Parser.md +++ b/docs/reference/interfaces/Parser.md @@ -5,7 +5,7 @@ title: Parser # Interface: Parser -Defined in: [packages/db/src/local-storage.ts:47](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L47) +Defined in: [packages/db/src/local-storage.ts:47](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L47) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/db/src/local-storage.ts:47](https://github.com/TanStack/db parse: (data) => unknown; ``` -Defined in: [packages/db/src/local-storage.ts:48](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L48) +Defined in: [packages/db/src/local-storage.ts:48](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L48) #### Parameters @@ -35,7 +35,7 @@ Defined in: [packages/db/src/local-storage.ts:48](https://github.com/TanStack/db stringify: (data) => string; ``` -Defined in: [packages/db/src/local-storage.ts:49](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L49) +Defined in: [packages/db/src/local-storage.ts:49](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L49) #### Parameters diff --git a/docs/reference/interfaces/PendingMutation.md b/docs/reference/interfaces/PendingMutation.md index 2a5264f25..3cee0dbc1 100644 --- a/docs/reference/interfaces/PendingMutation.md +++ b/docs/reference/interfaces/PendingMutation.md @@ -5,7 +5,7 @@ title: PendingMutation # Interface: PendingMutation\ -Defined in: [packages/db/src/types.ts:88](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L88) +Defined in: [packages/db/src/types.ts:88](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L88) Represents a pending mutation within a transaction Contains information about the original and modified data, as well as metadata @@ -32,7 +32,7 @@ Contains information about the original and modified data, as well as metadata changes: ResolveTransactionChanges; ``` -Defined in: [packages/db/src/types.ts:105](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L105) +Defined in: [packages/db/src/types.ts:105](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L105) *** @@ -42,7 +42,7 @@ Defined in: [packages/db/src/types.ts:105](https://github.com/TanStack/db/blob/m collection: TCollection; ``` -Defined in: [packages/db/src/types.ts:116](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L116) +Defined in: [packages/db/src/types.ts:116](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L116) *** @@ -52,7 +52,7 @@ Defined in: [packages/db/src/types.ts:116](https://github.com/TanStack/db/blob/m createdAt: Date; ``` -Defined in: [packages/db/src/types.ts:114](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L114) +Defined in: [packages/db/src/types.ts:114](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L114) *** @@ -62,7 +62,7 @@ Defined in: [packages/db/src/types.ts:114](https://github.com/TanStack/db/blob/m globalKey: string; ``` -Defined in: [packages/db/src/types.ts:106](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L106) +Defined in: [packages/db/src/types.ts:106](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L106) *** @@ -72,7 +72,7 @@ Defined in: [packages/db/src/types.ts:106](https://github.com/TanStack/db/blob/m key: any; ``` -Defined in: [packages/db/src/types.ts:108](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L108) +Defined in: [packages/db/src/types.ts:108](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L108) *** @@ -82,7 +82,7 @@ Defined in: [packages/db/src/types.ts:108](https://github.com/TanStack/db/blob/m metadata: unknown; ``` -Defined in: [packages/db/src/types.ts:110](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L110) +Defined in: [packages/db/src/types.ts:110](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L110) *** @@ -92,7 +92,7 @@ Defined in: [packages/db/src/types.ts:110](https://github.com/TanStack/db/blob/m modified: T; ``` -Defined in: [packages/db/src/types.ts:103](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L103) +Defined in: [packages/db/src/types.ts:103](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L103) *** @@ -102,7 +102,7 @@ Defined in: [packages/db/src/types.ts:103](https://github.com/TanStack/db/blob/m mutationId: string; ``` -Defined in: [packages/db/src/types.ts:99](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L99) +Defined in: [packages/db/src/types.ts:99](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L99) *** @@ -112,7 +112,7 @@ Defined in: [packages/db/src/types.ts:99](https://github.com/TanStack/db/blob/ma optimistic: boolean; ``` -Defined in: [packages/db/src/types.ts:113](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L113) +Defined in: [packages/db/src/types.ts:113](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L113) Whether this mutation should be applied optimistically (defaults to true) @@ -124,7 +124,7 @@ Whether this mutation should be applied optimistically (defaults to true) original: TOperation extends "insert" ? object : T; ``` -Defined in: [packages/db/src/types.ts:101](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L101) +Defined in: [packages/db/src/types.ts:101](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L101) *** @@ -134,7 +134,7 @@ Defined in: [packages/db/src/types.ts:101](https://github.com/TanStack/db/blob/m syncMetadata: Record; ``` -Defined in: [packages/db/src/types.ts:111](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L111) +Defined in: [packages/db/src/types.ts:111](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L111) *** @@ -144,7 +144,7 @@ Defined in: [packages/db/src/types.ts:111](https://github.com/TanStack/db/blob/m type: TOperation; ``` -Defined in: [packages/db/src/types.ts:109](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L109) +Defined in: [packages/db/src/types.ts:109](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L109) *** @@ -154,4 +154,4 @@ Defined in: [packages/db/src/types.ts:109](https://github.com/TanStack/db/blob/m updatedAt: Date; ``` -Defined in: [packages/db/src/types.ts:115](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L115) +Defined in: [packages/db/src/types.ts:115](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L115) diff --git a/docs/reference/interfaces/QueueStrategy.md b/docs/reference/interfaces/QueueStrategy.md index d22576848..f87fda3d1 100644 --- a/docs/reference/interfaces/QueueStrategy.md +++ b/docs/reference/interfaces/QueueStrategy.md @@ -5,7 +5,7 @@ title: QueueStrategy # Interface: QueueStrategy -Defined in: [packages/db/src/strategies/types.ts:66](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L66) +Defined in: [packages/db/src/strategies/types.ts:66](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L66) Queue strategy that processes all executions in order FIFO: { addItemsTo: 'back', getItemsFrom: 'front' } @@ -23,7 +23,7 @@ LIFO: { addItemsTo: 'back', getItemsFrom: 'back' } _type: "queue"; ``` -Defined in: [packages/db/src/strategies/types.ts:8](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L8) +Defined in: [packages/db/src/strategies/types.ts:8](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L8) Type discriminator for strategy identification @@ -39,7 +39,7 @@ Type discriminator for strategy identification cleanup: () => void; ``` -Defined in: [packages/db/src/strategies/types.ts:23](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L23) +Defined in: [packages/db/src/strategies/types.ts:23](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L23) Clean up any resources held by the strategy Should be called when the strategy is no longer needed @@ -60,7 +60,7 @@ Should be called when the strategy is no longer needed execute: (fn) => void | Promise; ``` -Defined in: [packages/db/src/strategies/types.ts:15](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L15) +Defined in: [packages/db/src/strategies/types.ts:15](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L15) Execute a function according to the strategy's timing rules @@ -96,4 +96,4 @@ The result of the function execution (if applicable) optional options: QueueStrategyOptions; ``` -Defined in: [packages/db/src/strategies/types.ts:67](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L67) +Defined in: [packages/db/src/strategies/types.ts:67](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L67) diff --git a/docs/reference/interfaces/QueueStrategyOptions.md b/docs/reference/interfaces/QueueStrategyOptions.md index cefdd24e5..d755d9a1f 100644 --- a/docs/reference/interfaces/QueueStrategyOptions.md +++ b/docs/reference/interfaces/QueueStrategyOptions.md @@ -5,7 +5,7 @@ title: QueueStrategyOptions # Interface: QueueStrategyOptions -Defined in: [packages/db/src/strategies/types.ts:50](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L50) +Defined in: [packages/db/src/strategies/types.ts:50](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L50) Options for queue strategy Processes all executions in order (FIFO/LIFO) @@ -18,7 +18,7 @@ Processes all executions in order (FIFO/LIFO) optional addItemsTo: "front" | "back"; ``` -Defined in: [packages/db/src/strategies/types.ts:56](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L56) +Defined in: [packages/db/src/strategies/types.ts:56](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L56) Where to add new items in the queue @@ -30,7 +30,7 @@ Where to add new items in the queue optional getItemsFrom: "front" | "back"; ``` -Defined in: [packages/db/src/strategies/types.ts:58](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L58) +Defined in: [packages/db/src/strategies/types.ts:58](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L58) Where to get items from when processing @@ -42,7 +42,7 @@ Where to get items from when processing optional maxSize: number; ``` -Defined in: [packages/db/src/strategies/types.ts:54](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L54) +Defined in: [packages/db/src/strategies/types.ts:54](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L54) Maximum queue size (items are dropped if exceeded) @@ -54,6 +54,6 @@ Maximum queue size (items are dropped if exceeded) optional wait: number; ``` -Defined in: [packages/db/src/strategies/types.ts:52](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L52) +Defined in: [packages/db/src/strategies/types.ts:52](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L52) Wait time between processing queue items (milliseconds) diff --git a/docs/reference/interfaces/RangeQueryOptions.md b/docs/reference/interfaces/RangeQueryOptions.md index cae26c2a6..85945dd26 100644 --- a/docs/reference/interfaces/RangeQueryOptions.md +++ b/docs/reference/interfaces/RangeQueryOptions.md @@ -5,7 +5,7 @@ title: RangeQueryOptions # Interface: RangeQueryOptions -Defined in: [packages/db/src/indexes/btree-index.ts:19](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L19) +Defined in: [packages/db/src/indexes/btree-index.ts:19](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L19) Options for range queries @@ -17,7 +17,7 @@ Options for range queries optional from: any; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:20](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L20) +Defined in: [packages/db/src/indexes/btree-index.ts:20](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L20) *** @@ -27,7 +27,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:20](https://github.com/TanSt optional fromInclusive: boolean; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:22](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L22) +Defined in: [packages/db/src/indexes/btree-index.ts:22](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L22) *** @@ -37,7 +37,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:22](https://github.com/TanSt optional to: any; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:21](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L21) +Defined in: [packages/db/src/indexes/btree-index.ts:21](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L21) *** @@ -47,4 +47,4 @@ Defined in: [packages/db/src/indexes/btree-index.ts:21](https://github.com/TanSt optional toInclusive: boolean; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:23](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L23) +Defined in: [packages/db/src/indexes/btree-index.ts:23](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/btree-index.ts#L23) diff --git a/docs/reference/interfaces/SimpleComparison.md b/docs/reference/interfaces/SimpleComparison.md index f8f71f670..19c092f4a 100644 --- a/docs/reference/interfaces/SimpleComparison.md +++ b/docs/reference/interfaces/SimpleComparison.md @@ -5,7 +5,7 @@ title: SimpleComparison # Interface: SimpleComparison -Defined in: [packages/db/src/query/expression-helpers.ts:44](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L44) +Defined in: [packages/db/src/query/expression-helpers.ts:44](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L44) Represents a simple comparison operation @@ -17,7 +17,7 @@ Represents a simple comparison operation field: FieldPath; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:45](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L45) +Defined in: [packages/db/src/query/expression-helpers.ts:45](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L45) *** @@ -27,7 +27,7 @@ Defined in: [packages/db/src/query/expression-helpers.ts:45](https://github.com/ operator: string; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:46](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L46) +Defined in: [packages/db/src/query/expression-helpers.ts:46](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L46) *** @@ -37,4 +37,4 @@ Defined in: [packages/db/src/query/expression-helpers.ts:46](https://github.com/ optional value: any; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:47](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L47) +Defined in: [packages/db/src/query/expression-helpers.ts:47](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L47) diff --git a/docs/reference/interfaces/SubscribeChangesOptions.md b/docs/reference/interfaces/SubscribeChangesOptions.md index 901fa75b6..dc843672f 100644 --- a/docs/reference/interfaces/SubscribeChangesOptions.md +++ b/docs/reference/interfaces/SubscribeChangesOptions.md @@ -5,7 +5,7 @@ title: SubscribeChangesOptions # Interface: SubscribeChangesOptions -Defined in: [packages/db/src/types.ts:723](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L723) +Defined in: [packages/db/src/types.ts:723](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L723) Options for subscribing to collection changes @@ -17,7 +17,7 @@ Options for subscribing to collection changes optional includeInitialState: boolean; ``` -Defined in: [packages/db/src/types.ts:725](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L725) +Defined in: [packages/db/src/types.ts:725](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L725) Whether to include the current state as initial changes @@ -29,6 +29,6 @@ Whether to include the current state as initial changes optional whereExpression: BasicExpression; ``` -Defined in: [packages/db/src/types.ts:727](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L727) +Defined in: [packages/db/src/types.ts:727](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L727) Pre-compiled expression for filtering changes diff --git a/docs/reference/interfaces/SubscribeChangesSnapshotOptions.md b/docs/reference/interfaces/SubscribeChangesSnapshotOptions.md index 34d59c8ad..a3285b5c0 100644 --- a/docs/reference/interfaces/SubscribeChangesSnapshotOptions.md +++ b/docs/reference/interfaces/SubscribeChangesSnapshotOptions.md @@ -5,7 +5,7 @@ title: SubscribeChangesSnapshotOptions # Interface: SubscribeChangesSnapshotOptions -Defined in: [packages/db/src/types.ts:730](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L730) +Defined in: [packages/db/src/types.ts:730](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L730) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/db/src/types.ts:730](https://github.com/TanStack/db/blob/m optional limit: number; ``` -Defined in: [packages/db/src/types.ts:735](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L735) +Defined in: [packages/db/src/types.ts:735](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L735) *** @@ -29,7 +29,7 @@ Defined in: [packages/db/src/types.ts:735](https://github.com/TanStack/db/blob/m optional orderBy: OrderBy; ``` -Defined in: [packages/db/src/types.ts:734](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L734) +Defined in: [packages/db/src/types.ts:734](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L734) *** @@ -39,7 +39,7 @@ Defined in: [packages/db/src/types.ts:734](https://github.com/TanStack/db/blob/m optional whereExpression: BasicExpression; ``` -Defined in: [packages/db/src/types.ts:727](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L727) +Defined in: [packages/db/src/types.ts:727](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L727) Pre-compiled expression for filtering changes diff --git a/docs/reference/interfaces/Subscription.md b/docs/reference/interfaces/Subscription.md index 7c7e38148..de0a97607 100644 --- a/docs/reference/interfaces/Subscription.md +++ b/docs/reference/interfaces/Subscription.md @@ -5,7 +5,7 @@ title: Subscription # Interface: Subscription -Defined in: [packages/db/src/types.ts:251](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L251) +Defined in: [packages/db/src/types.ts:251](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L251) Public interface for a collection subscription Used by sync implementations to track subscription lifecycle @@ -22,7 +22,7 @@ Used by sync implementations to track subscription lifecycle readonly status: SubscriptionStatus; ``` -Defined in: [packages/db/src/types.ts:253](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L253) +Defined in: [packages/db/src/types.ts:253](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L253) Current status of the subscription @@ -34,7 +34,7 @@ Current status of the subscription protected clearListeners(): void; ``` -Defined in: [packages/db/src/event-emitter.ts:115](https://github.com/TanStack/db/blob/main/packages/db/src/event-emitter.ts#L115) +Defined in: [packages/db/src/event-emitter.ts:115](https://github.com/MAST1999/db/blob/main/packages/db/src/event-emitter.ts#L115) Clear all listeners @@ -56,7 +56,7 @@ EventEmitter.clearListeners protected emitInner(event, eventPayload): void; ``` -Defined in: [packages/db/src/event-emitter.ts:96](https://github.com/TanStack/db/blob/main/packages/db/src/event-emitter.ts#L96) +Defined in: [packages/db/src/event-emitter.ts:96](https://github.com/MAST1999/db/blob/main/packages/db/src/event-emitter.ts#L96) **`Internal`** @@ -101,7 +101,7 @@ EventEmitter.emitInner off(event, callback): void; ``` -Defined in: [packages/db/src/event-emitter.ts:53](https://github.com/TanStack/db/blob/main/packages/db/src/event-emitter.ts#L53) +Defined in: [packages/db/src/event-emitter.ts:53](https://github.com/MAST1999/db/blob/main/packages/db/src/event-emitter.ts#L53) Unsubscribe from an event @@ -143,7 +143,7 @@ EventEmitter.off on(event, callback): () => void; ``` -Defined in: [packages/db/src/event-emitter.ts:17](https://github.com/TanStack/db/blob/main/packages/db/src/event-emitter.ts#L17) +Defined in: [packages/db/src/event-emitter.ts:17](https://github.com/MAST1999/db/blob/main/packages/db/src/event-emitter.ts#L17) Subscribe to an event @@ -193,7 +193,7 @@ EventEmitter.on once(event, callback): () => void; ``` -Defined in: [packages/db/src/event-emitter.ts:37](https://github.com/TanStack/db/blob/main/packages/db/src/event-emitter.ts#L37) +Defined in: [packages/db/src/event-emitter.ts:37](https://github.com/MAST1999/db/blob/main/packages/db/src/event-emitter.ts#L37) Subscribe to an event once (automatically unsubscribes after first emission) @@ -243,7 +243,7 @@ EventEmitter.once waitFor(event, timeout?): Promise; ``` -Defined in: [packages/db/src/event-emitter.ts:66](https://github.com/TanStack/db/blob/main/packages/db/src/event-emitter.ts#L66) +Defined in: [packages/db/src/event-emitter.ts:66](https://github.com/MAST1999/db/blob/main/packages/db/src/event-emitter.ts#L66) Wait for an event to be emitted diff --git a/docs/reference/interfaces/SubscriptionStatusChangeEvent.md b/docs/reference/interfaces/SubscriptionStatusChangeEvent.md index a14b841c3..3a62f03a9 100644 --- a/docs/reference/interfaces/SubscriptionStatusChangeEvent.md +++ b/docs/reference/interfaces/SubscriptionStatusChangeEvent.md @@ -5,7 +5,7 @@ title: SubscriptionStatusChangeEvent # Interface: SubscriptionStatusChangeEvent -Defined in: [packages/db/src/types.ts:212](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L212) +Defined in: [packages/db/src/types.ts:212](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L212) Event emitted when subscription status changes @@ -17,7 +17,7 @@ Event emitted when subscription status changes previousStatus: SubscriptionStatus; ``` -Defined in: [packages/db/src/types.ts:215](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L215) +Defined in: [packages/db/src/types.ts:215](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L215) *** @@ -27,7 +27,7 @@ Defined in: [packages/db/src/types.ts:215](https://github.com/TanStack/db/blob/m status: SubscriptionStatus; ``` -Defined in: [packages/db/src/types.ts:216](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L216) +Defined in: [packages/db/src/types.ts:216](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L216) *** @@ -37,7 +37,7 @@ Defined in: [packages/db/src/types.ts:216](https://github.com/TanStack/db/blob/m subscription: Subscription; ``` -Defined in: [packages/db/src/types.ts:214](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L214) +Defined in: [packages/db/src/types.ts:214](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L214) *** @@ -47,4 +47,4 @@ Defined in: [packages/db/src/types.ts:214](https://github.com/TanStack/db/blob/m type: "status:change"; ``` -Defined in: [packages/db/src/types.ts:213](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L213) +Defined in: [packages/db/src/types.ts:213](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L213) diff --git a/docs/reference/interfaces/SubscriptionStatusEvent.md b/docs/reference/interfaces/SubscriptionStatusEvent.md index 4e9b14f26..d08360ba5 100644 --- a/docs/reference/interfaces/SubscriptionStatusEvent.md +++ b/docs/reference/interfaces/SubscriptionStatusEvent.md @@ -5,7 +5,7 @@ title: SubscriptionStatusEvent # Interface: SubscriptionStatusEvent\ -Defined in: [packages/db/src/types.ts:222](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L222) +Defined in: [packages/db/src/types.ts:222](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L222) Event emitted when subscription status changes to a specific status @@ -23,7 +23,7 @@ Event emitted when subscription status changes to a specific status previousStatus: SubscriptionStatus; ``` -Defined in: [packages/db/src/types.ts:225](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L225) +Defined in: [packages/db/src/types.ts:225](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L225) *** @@ -33,7 +33,7 @@ Defined in: [packages/db/src/types.ts:225](https://github.com/TanStack/db/blob/m status: T; ``` -Defined in: [packages/db/src/types.ts:226](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L226) +Defined in: [packages/db/src/types.ts:226](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L226) *** @@ -43,7 +43,7 @@ Defined in: [packages/db/src/types.ts:226](https://github.com/TanStack/db/blob/m subscription: Subscription; ``` -Defined in: [packages/db/src/types.ts:224](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L224) +Defined in: [packages/db/src/types.ts:224](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L224) *** @@ -53,4 +53,4 @@ Defined in: [packages/db/src/types.ts:224](https://github.com/TanStack/db/blob/m type: `status:${T}`; ``` -Defined in: [packages/db/src/types.ts:223](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L223) +Defined in: [packages/db/src/types.ts:223](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L223) diff --git a/docs/reference/interfaces/SubscriptionUnsubscribedEvent.md b/docs/reference/interfaces/SubscriptionUnsubscribedEvent.md index df71d1075..d178cda89 100644 --- a/docs/reference/interfaces/SubscriptionUnsubscribedEvent.md +++ b/docs/reference/interfaces/SubscriptionUnsubscribedEvent.md @@ -5,7 +5,7 @@ title: SubscriptionUnsubscribedEvent # Interface: SubscriptionUnsubscribedEvent -Defined in: [packages/db/src/types.ts:232](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L232) +Defined in: [packages/db/src/types.ts:232](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L232) Event emitted when subscription is unsubscribed @@ -17,7 +17,7 @@ Event emitted when subscription is unsubscribed subscription: Subscription; ``` -Defined in: [packages/db/src/types.ts:234](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L234) +Defined in: [packages/db/src/types.ts:234](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L234) *** @@ -27,4 +27,4 @@ Defined in: [packages/db/src/types.ts:234](https://github.com/TanStack/db/blob/m type: "unsubscribed"; ``` -Defined in: [packages/db/src/types.ts:233](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L233) +Defined in: [packages/db/src/types.ts:233](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L233) diff --git a/docs/reference/interfaces/SyncConfig.md b/docs/reference/interfaces/SyncConfig.md index d49cfbb86..2c9598a30 100644 --- a/docs/reference/interfaces/SyncConfig.md +++ b/docs/reference/interfaces/SyncConfig.md @@ -5,7 +5,7 @@ title: SyncConfig # Interface: SyncConfig\ -Defined in: [packages/db/src/types.ts:285](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L285) +Defined in: [packages/db/src/types.ts:285](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L285) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/db/src/types.ts:285](https://github.com/TanStack/db/blob/m optional getSyncMetadata: () => Record; ``` -Defined in: [packages/db/src/types.ts:302](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L302) +Defined in: [packages/db/src/types.ts:302](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L302) Get the sync metadata for insert operations @@ -43,7 +43,7 @@ Record containing relation information optional rowUpdateMode: "full" | "partial"; ``` -Defined in: [packages/db/src/types.ts:311](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L311) +Defined in: [packages/db/src/types.ts:311](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L311) The row update mode used to sync to the collection. @@ -67,7 +67,7 @@ sync: (params) => | SyncConfigRes; ``` -Defined in: [packages/db/src/types.ts:289](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L289) +Defined in: [packages/db/src/types.ts:289](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L289) #### Parameters diff --git a/docs/reference/interfaces/ThrottleStrategy.md b/docs/reference/interfaces/ThrottleStrategy.md index e21a6f88e..54cbeebbe 100644 --- a/docs/reference/interfaces/ThrottleStrategy.md +++ b/docs/reference/interfaces/ThrottleStrategy.md @@ -5,7 +5,7 @@ title: ThrottleStrategy # Interface: ThrottleStrategy -Defined in: [packages/db/src/strategies/types.ts:86](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L86) +Defined in: [packages/db/src/strategies/types.ts:86](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L86) Throttle strategy that spaces executions evenly over time @@ -21,7 +21,7 @@ Throttle strategy that spaces executions evenly over time _type: "throttle"; ``` -Defined in: [packages/db/src/strategies/types.ts:8](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L8) +Defined in: [packages/db/src/strategies/types.ts:8](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L8) Type discriminator for strategy identification @@ -37,7 +37,7 @@ Type discriminator for strategy identification cleanup: () => void; ``` -Defined in: [packages/db/src/strategies/types.ts:23](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L23) +Defined in: [packages/db/src/strategies/types.ts:23](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L23) Clean up any resources held by the strategy Should be called when the strategy is no longer needed @@ -58,7 +58,7 @@ Should be called when the strategy is no longer needed execute: (fn) => void | Promise; ``` -Defined in: [packages/db/src/strategies/types.ts:15](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L15) +Defined in: [packages/db/src/strategies/types.ts:15](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L15) Execute a function according to the strategy's timing rules @@ -94,4 +94,4 @@ The result of the function execution (if applicable) options: ThrottleStrategyOptions; ``` -Defined in: [packages/db/src/strategies/types.ts:87](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L87) +Defined in: [packages/db/src/strategies/types.ts:87](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L87) diff --git a/docs/reference/interfaces/ThrottleStrategyOptions.md b/docs/reference/interfaces/ThrottleStrategyOptions.md index ab54fdeb0..031bb2aae 100644 --- a/docs/reference/interfaces/ThrottleStrategyOptions.md +++ b/docs/reference/interfaces/ThrottleStrategyOptions.md @@ -5,7 +5,7 @@ title: ThrottleStrategyOptions # Interface: ThrottleStrategyOptions -Defined in: [packages/db/src/strategies/types.ts:74](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L74) +Defined in: [packages/db/src/strategies/types.ts:74](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L74) Options for throttle strategy Ensures executions are evenly spaced over time @@ -18,7 +18,7 @@ Ensures executions are evenly spaced over time optional leading: boolean; ``` -Defined in: [packages/db/src/strategies/types.ts:78](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L78) +Defined in: [packages/db/src/strategies/types.ts:78](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L78) Execute immediately on the first call @@ -30,7 +30,7 @@ Execute immediately on the first call optional trailing: boolean; ``` -Defined in: [packages/db/src/strategies/types.ts:80](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L80) +Defined in: [packages/db/src/strategies/types.ts:80](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L80) Execute on the last call after wait period @@ -42,6 +42,6 @@ Execute on the last call after wait period wait: number; ``` -Defined in: [packages/db/src/strategies/types.ts:76](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L76) +Defined in: [packages/db/src/strategies/types.ts:76](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L76) Minimum wait time between executions (milliseconds) diff --git a/docs/reference/interfaces/Transaction.md b/docs/reference/interfaces/Transaction.md index 5ad434341..fa2a1d07f 100644 --- a/docs/reference/interfaces/Transaction.md +++ b/docs/reference/interfaces/Transaction.md @@ -5,7 +5,7 @@ title: Transaction # Interface: Transaction\ -Defined in: [packages/db/src/transactions.ts:208](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L208) +Defined in: [packages/db/src/transactions.ts:208](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L208) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/db/src/transactions.ts:208](https://github.com/TanStack/db autoCommit: boolean; ``` -Defined in: [packages/db/src/transactions.ts:214](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L214) +Defined in: [packages/db/src/transactions.ts:214](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L214) *** @@ -31,7 +31,7 @@ Defined in: [packages/db/src/transactions.ts:214](https://github.com/TanStack/db createdAt: Date; ``` -Defined in: [packages/db/src/transactions.ts:215](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L215) +Defined in: [packages/db/src/transactions.ts:215](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L215) *** @@ -41,7 +41,7 @@ Defined in: [packages/db/src/transactions.ts:215](https://github.com/TanStack/db optional error: object; ``` -Defined in: [packages/db/src/transactions.ts:218](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L218) +Defined in: [packages/db/src/transactions.ts:218](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L218) #### error @@ -63,7 +63,7 @@ message: string; id: string; ``` -Defined in: [packages/db/src/transactions.ts:209](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L209) +Defined in: [packages/db/src/transactions.ts:209](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L209) *** @@ -73,7 +73,7 @@ Defined in: [packages/db/src/transactions.ts:209](https://github.com/TanStack/db isPersisted: Deferred>; ``` -Defined in: [packages/db/src/transactions.ts:213](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L213) +Defined in: [packages/db/src/transactions.ts:213](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L213) *** @@ -83,7 +83,7 @@ Defined in: [packages/db/src/transactions.ts:213](https://github.com/TanStack/db metadata: Record; ``` -Defined in: [packages/db/src/transactions.ts:217](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L217) +Defined in: [packages/db/src/transactions.ts:217](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L217) *** @@ -93,7 +93,7 @@ Defined in: [packages/db/src/transactions.ts:217](https://github.com/TanStack/db mutationFn: MutationFn; ``` -Defined in: [packages/db/src/transactions.ts:211](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L211) +Defined in: [packages/db/src/transactions.ts:211](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L211) *** @@ -103,7 +103,7 @@ Defined in: [packages/db/src/transactions.ts:211](https://github.com/TanStack/db mutations: PendingMutation>[]; ``` -Defined in: [packages/db/src/transactions.ts:212](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L212) +Defined in: [packages/db/src/transactions.ts:212](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L212) *** @@ -113,7 +113,7 @@ Defined in: [packages/db/src/transactions.ts:212](https://github.com/TanStack/db sequenceNumber: number; ``` -Defined in: [packages/db/src/transactions.ts:216](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L216) +Defined in: [packages/db/src/transactions.ts:216](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L216) *** @@ -123,7 +123,7 @@ Defined in: [packages/db/src/transactions.ts:216](https://github.com/TanStack/db state: TransactionState; ``` -Defined in: [packages/db/src/transactions.ts:210](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L210) +Defined in: [packages/db/src/transactions.ts:210](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L210) ## Methods @@ -133,7 +133,7 @@ Defined in: [packages/db/src/transactions.ts:210](https://github.com/TanStack/db applyMutations(mutations): void; ``` -Defined in: [packages/db/src/transactions.ts:327](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L327) +Defined in: [packages/db/src/transactions.ts:327](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L327) Apply new mutations to this transaction, intelligently merging with existing mutations @@ -169,7 +169,7 @@ Array of new mutations to apply commit(): Promise>; ``` -Defined in: [packages/db/src/transactions.ts:472](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L472) +Defined in: [packages/db/src/transactions.ts:472](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L472) Commit the transaction and execute the mutation function @@ -228,7 +228,7 @@ console.log(tx.state) // "completed" or "failed" compareCreatedAt(other): number; ``` -Defined in: [packages/db/src/transactions.ts:526](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L526) +Defined in: [packages/db/src/transactions.ts:526](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L526) Compare two transactions by their createdAt time and sequence number in order to sort them in the order they were created. @@ -255,7 +255,7 @@ The other transaction to compare to mutate(callback): Transaction; ``` -Defined in: [packages/db/src/transactions.ts:287](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L287) +Defined in: [packages/db/src/transactions.ts:287](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L287) Execute collection operations within this transaction @@ -323,7 +323,7 @@ await tx.commit() rollback(config?): Transaction; ``` -Defined in: [packages/db/src/transactions.ts:389](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L389) +Defined in: [packages/db/src/transactions.ts:389](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L389) Rollback the transaction and any conflicting transactions @@ -390,7 +390,7 @@ try { setState(newState): void; ``` -Defined in: [packages/db/src/transactions.ts:238](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L238) +Defined in: [packages/db/src/transactions.ts:238](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L238) #### Parameters @@ -410,7 +410,7 @@ Defined in: [packages/db/src/transactions.ts:238](https://github.com/TanStack/db touchCollection(): void; ``` -Defined in: [packages/db/src/transactions.ts:417](https://github.com/TanStack/db/blob/main/packages/db/src/transactions.ts#L417) +Defined in: [packages/db/src/transactions.ts:417](https://github.com/MAST1999/db/blob/main/packages/db/src/transactions.ts#L417) #### Returns diff --git a/docs/reference/interfaces/TransactionConfig.md b/docs/reference/interfaces/TransactionConfig.md index 3550c36dc..f9bf478ce 100644 --- a/docs/reference/interfaces/TransactionConfig.md +++ b/docs/reference/interfaces/TransactionConfig.md @@ -5,7 +5,7 @@ title: TransactionConfig # Interface: TransactionConfig\ -Defined in: [packages/db/src/types.ts:165](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L165) +Defined in: [packages/db/src/types.ts:165](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L165) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/db/src/types.ts:165](https://github.com/TanStack/db/blob/m optional autoCommit: boolean; ``` -Defined in: [packages/db/src/types.ts:169](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L169) +Defined in: [packages/db/src/types.ts:169](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L169) *** @@ -31,7 +31,7 @@ Defined in: [packages/db/src/types.ts:169](https://github.com/TanStack/db/blob/m optional id: string; ``` -Defined in: [packages/db/src/types.ts:167](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L167) +Defined in: [packages/db/src/types.ts:167](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L167) Unique identifier for the transaction @@ -43,7 +43,7 @@ Unique identifier for the transaction optional metadata: Record; ``` -Defined in: [packages/db/src/types.ts:172](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L172) +Defined in: [packages/db/src/types.ts:172](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L172) Custom metadata to associate with the transaction @@ -55,4 +55,4 @@ Custom metadata to associate with the transaction mutationFn: MutationFn; ``` -Defined in: [packages/db/src/types.ts:170](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L170) +Defined in: [packages/db/src/types.ts:170](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L170) diff --git a/docs/reference/powersync-db-collection/classes/PowerSyncTransactor.md b/docs/reference/powersync-db-collection/classes/PowerSyncTransactor.md index e06450b40..eb38b9aee 100644 --- a/docs/reference/powersync-db-collection/classes/PowerSyncTransactor.md +++ b/docs/reference/powersync-db-collection/classes/PowerSyncTransactor.md @@ -5,7 +5,7 @@ title: PowerSyncTransactor # Class: PowerSyncTransactor -Defined in: [PowerSyncTransactor.ts:51](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L51) +Defined in: [PowerSyncTransactor.ts:51](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L51) Applies mutations to the PowerSync database. This method is called automatically by the collection's insert, update, and delete operations. You typically don't need to call this directly unless you @@ -51,7 +51,7 @@ The transaction containing mutations to apply new PowerSyncTransactor(options): PowerSyncTransactor; ``` -Defined in: [PowerSyncTransactor.ts:55](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L55) +Defined in: [PowerSyncTransactor.ts:55](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L55) #### Parameters @@ -71,7 +71,7 @@ Defined in: [PowerSyncTransactor.ts:55](https://github.com/TanStack/db/blob/main database: AbstractPowerSyncDatabase; ``` -Defined in: [PowerSyncTransactor.ts:52](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L52) +Defined in: [PowerSyncTransactor.ts:52](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L52) *** @@ -81,7 +81,7 @@ Defined in: [PowerSyncTransactor.ts:52](https://github.com/TanStack/db/blob/main pendingOperationStore: PendingOperationStore; ``` -Defined in: [PowerSyncTransactor.ts:53](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L53) +Defined in: [PowerSyncTransactor.ts:53](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L53) ## Methods @@ -91,7 +91,7 @@ Defined in: [PowerSyncTransactor.ts:53](https://github.com/TanStack/db/blob/main applyTransaction(transaction): Promise; ``` -Defined in: [PowerSyncTransactor.ts:63](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L63) +Defined in: [PowerSyncTransactor.ts:63](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L63) Persists a Transaction to the PowerSync SQLite database. @@ -116,7 +116,7 @@ protected handleDelete( waitForCompletion): Promise; ``` -Defined in: [PowerSyncTransactor.ts:204](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L204) +Defined in: [PowerSyncTransactor.ts:204](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L204) #### Parameters @@ -147,7 +147,7 @@ protected handleInsert( waitForCompletion): Promise; ``` -Defined in: [PowerSyncTransactor.ts:149](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L149) +Defined in: [PowerSyncTransactor.ts:149](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L149) #### Parameters @@ -179,7 +179,7 @@ protected handleOperationWithCompletion( handler): Promise; ``` -Defined in: [PowerSyncTransactor.ts:232](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L232) +Defined in: [PowerSyncTransactor.ts:232](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L232) Helper function which wraps a persistence operation by: - Fetching the mutation's collection's SQLite table details @@ -219,7 +219,7 @@ protected handleUpdate( waitForCompletion): Promise; ``` -Defined in: [PowerSyncTransactor.ts:177](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L177) +Defined in: [PowerSyncTransactor.ts:177](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L177) #### Parameters diff --git a/docs/reference/powersync-db-collection/functions/powerSyncCollectionOptions.md b/docs/reference/powersync-db-collection/functions/powerSyncCollectionOptions.md index e18eebcb9..d72eee6ea 100644 --- a/docs/reference/powersync-db-collection/functions/powerSyncCollectionOptions.md +++ b/docs/reference/powersync-db-collection/functions/powerSyncCollectionOptions.md @@ -13,7 +13,7 @@ Implementation of powerSyncCollectionOptions that handles both schema and non-sc function powerSyncCollectionOptions(config): EnhancedPowerSyncCollectionConfig, never>; ``` -Defined in: [powersync.ts:71](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/powersync.ts#L71) +Defined in: [powersync.ts:71](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/powersync.ts#L71) Creates a PowerSync collection configuration with basic default validation. Input and Output types are the SQLite column types. @@ -66,7 +66,7 @@ const collection = createCollection( function powerSyncCollectionOptions(config): CollectionConfig, string, TSchema, UtilsRecord> & object & object; ``` -Defined in: [powersync.ts:128](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/powersync.ts#L128) +Defined in: [powersync.ts:128](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/powersync.ts#L128) Creates a PowerSync collection configuration with schema validation. @@ -141,7 +141,7 @@ const collection = createCollection( function powerSyncCollectionOptions(config): CollectionConfig, string, TSchema, UtilsRecord> & object & object; ``` -Defined in: [powersync.ts:196](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/powersync.ts#L196) +Defined in: [powersync.ts:196](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/powersync.ts#L196) Creates a PowerSync collection configuration with schema validation. diff --git a/docs/reference/powersync-db-collection/type-aliases/BasePowerSyncCollectionConfig.md b/docs/reference/powersync-db-collection/type-aliases/BasePowerSyncCollectionConfig.md index ab1d26dcc..72695ad5a 100644 --- a/docs/reference/powersync-db-collection/type-aliases/BasePowerSyncCollectionConfig.md +++ b/docs/reference/powersync-db-collection/type-aliases/BasePowerSyncCollectionConfig.md @@ -9,7 +9,7 @@ title: BasePowerSyncCollectionConfig type BasePowerSyncCollectionConfig = Omit, string, TSchema>, "onInsert" | "onUpdate" | "onDelete" | "getKey"> & object; ``` -Defined in: [definitions.ts:165](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L165) +Defined in: [definitions.ts:165](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L165) ## Type Declaration diff --git a/docs/reference/powersync-db-collection/type-aliases/ConfigWithArbitraryCollectionTypes.md b/docs/reference/powersync-db-collection/type-aliases/ConfigWithArbitraryCollectionTypes.md index a51250077..3492e7fdc 100644 --- a/docs/reference/powersync-db-collection/type-aliases/ConfigWithArbitraryCollectionTypes.md +++ b/docs/reference/powersync-db-collection/type-aliases/ConfigWithArbitraryCollectionTypes.md @@ -9,7 +9,7 @@ title: ConfigWithArbitraryCollectionTypes type ConfigWithArbitraryCollectionTypes = SerializerConfig, ExtractedTable> & object; ``` -Defined in: [definitions.ts:125](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L125) +Defined in: [definitions.ts:125](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L125) Config where TInput and TOutput have arbitrarily typed values. The keys of the types need to equal the SQLite types. diff --git a/docs/reference/powersync-db-collection/type-aliases/ConfigWithSQLiteInputType.md b/docs/reference/powersync-db-collection/type-aliases/ConfigWithSQLiteInputType.md index 1d58b51a6..6f6091495 100644 --- a/docs/reference/powersync-db-collection/type-aliases/ConfigWithSQLiteInputType.md +++ b/docs/reference/powersync-db-collection/type-aliases/ConfigWithSQLiteInputType.md @@ -9,7 +9,7 @@ title: ConfigWithSQLiteInputType type ConfigWithSQLiteInputType = SerializerConfig, ExtractedTable> & object; ``` -Defined in: [definitions.ts:106](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L106) +Defined in: [definitions.ts:106](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L106) Config where TInput is the SQLite types while TOutput can be defined by TSchema. We can use the same schema to validate TInput and incoming SQLite changes. diff --git a/docs/reference/powersync-db-collection/type-aliases/ConfigWithSQLiteTypes.md b/docs/reference/powersync-db-collection/type-aliases/ConfigWithSQLiteTypes.md index edc414511..3e9b2bdb0 100644 --- a/docs/reference/powersync-db-collection/type-aliases/ConfigWithSQLiteTypes.md +++ b/docs/reference/powersync-db-collection/type-aliases/ConfigWithSQLiteTypes.md @@ -9,6 +9,6 @@ title: ConfigWithSQLiteTypes type ConfigWithSQLiteTypes = object; ``` -Defined in: [definitions.ts:100](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L100) +Defined in: [definitions.ts:100](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L100) Config for when TInput and TOutput are both the SQLite types. diff --git a/docs/reference/powersync-db-collection/type-aliases/CustomSQLiteSerializer.md b/docs/reference/powersync-db-collection/type-aliases/CustomSQLiteSerializer.md index 898bf6119..8ddcc7dcd 100644 --- a/docs/reference/powersync-db-collection/type-aliases/CustomSQLiteSerializer.md +++ b/docs/reference/powersync-db-collection/type-aliases/CustomSQLiteSerializer.md @@ -9,7 +9,7 @@ title: CustomSQLiteSerializer type CustomSQLiteSerializer = Partial<{ [Key in keyof TOutput]: (value: TOutput[Key]) => Key extends keyof TSQLite ? TSQLite[Key] : never }>; ``` -Defined in: [definitions.ts:52](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L52) +Defined in: [definitions.ts:52](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L52) A mapping type for custom serialization of object properties to SQLite-compatible values. diff --git a/docs/reference/powersync-db-collection/type-aliases/EnhancedPowerSyncCollectionConfig.md b/docs/reference/powersync-db-collection/type-aliases/EnhancedPowerSyncCollectionConfig.md index 79c292301..35ac09212 100644 --- a/docs/reference/powersync-db-collection/type-aliases/EnhancedPowerSyncCollectionConfig.md +++ b/docs/reference/powersync-db-collection/type-aliases/EnhancedPowerSyncCollectionConfig.md @@ -9,7 +9,7 @@ title: EnhancedPowerSyncCollectionConfig type EnhancedPowerSyncCollectionConfig = CollectionConfig & object; ``` -Defined in: [definitions.ts:254](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L254) +Defined in: [definitions.ts:254](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L254) A CollectionConfig which includes utilities for PowerSync. diff --git a/docs/reference/powersync-db-collection/type-aliases/InferPowerSyncOutputType.md b/docs/reference/powersync-db-collection/type-aliases/InferPowerSyncOutputType.md index d7e31998e..6585d6ef0 100644 --- a/docs/reference/powersync-db-collection/type-aliases/InferPowerSyncOutputType.md +++ b/docs/reference/powersync-db-collection/type-aliases/InferPowerSyncOutputType.md @@ -9,7 +9,7 @@ title: InferPowerSyncOutputType type InferPowerSyncOutputType = TSchema extends never ? ExtractedTable : InferSchemaOutput; ``` -Defined in: [definitions.ts:20](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L20) +Defined in: [definitions.ts:20](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L20) Small helper which determines the output type if: - Standard SQLite types are to be used OR diff --git a/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionConfig.md b/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionConfig.md index d06b3d3b7..b7cf67092 100644 --- a/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionConfig.md +++ b/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionConfig.md @@ -12,7 +12,7 @@ type PowerSyncCollectionConfig = BasePowerSyncCollectionConfig< | ConfigWithArbitraryCollectionTypes; ``` -Defined in: [definitions.ts:222](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L222) +Defined in: [definitions.ts:222](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L222) Configuration options for creating a PowerSync collection. diff --git a/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionMeta.md b/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionMeta.md index 1fab936e6..715a92c4f 100644 --- a/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionMeta.md +++ b/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionMeta.md @@ -9,7 +9,7 @@ title: PowerSyncCollectionMeta type PowerSyncCollectionMeta = object; ``` -Defined in: [definitions.ts:235](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L235) +Defined in: [definitions.ts:235](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L235) Metadata for the PowerSync Collection. @@ -27,7 +27,7 @@ Metadata for the PowerSync Collection. serializeValue: (value) => ExtractedTable; ``` -Defined in: [definitions.ts:248](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L248) +Defined in: [definitions.ts:248](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L248) Serializes a collection value to the SQLite type @@ -49,7 +49,7 @@ Serializes a collection value to the SQLite type tableName: string; ``` -Defined in: [definitions.ts:239](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L239) +Defined in: [definitions.ts:239](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L239) The SQLite table representing the collection. @@ -61,6 +61,6 @@ The SQLite table representing the collection. trackedTableName: string; ``` -Defined in: [definitions.ts:243](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L243) +Defined in: [definitions.ts:243](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L243) The internal table used to track diffs for the collection. diff --git a/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionUtils.md b/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionUtils.md index 28ab62975..1592bcb4f 100644 --- a/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionUtils.md +++ b/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionUtils.md @@ -9,7 +9,7 @@ title: PowerSyncCollectionUtils type PowerSyncCollectionUtils = object; ``` -Defined in: [definitions.ts:267](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L267) +Defined in: [definitions.ts:267](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L267) Collection-level utilities for PowerSync. @@ -27,7 +27,7 @@ Collection-level utilities for PowerSync. getMeta: () => PowerSyncCollectionMeta; ``` -Defined in: [definitions.ts:268](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L268) +Defined in: [definitions.ts:268](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L268) #### Returns diff --git a/docs/reference/powersync-db-collection/type-aliases/SerializerConfig.md b/docs/reference/powersync-db-collection/type-aliases/SerializerConfig.md index f437cdbf2..5b9aa94fb 100644 --- a/docs/reference/powersync-db-collection/type-aliases/SerializerConfig.md +++ b/docs/reference/powersync-db-collection/type-aliases/SerializerConfig.md @@ -9,7 +9,7 @@ title: SerializerConfig type SerializerConfig = object; ``` -Defined in: [definitions.ts:61](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L61) +Defined in: [definitions.ts:61](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L61) ## Type Parameters @@ -29,7 +29,7 @@ Defined in: [definitions.ts:61](https://github.com/TanStack/db/blob/main/package onDeserializationError: (error) => void; ``` -Defined in: [definitions.ts:94](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L94) +Defined in: [definitions.ts:94](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L94) Application logic should ensure that incoming synced data is always valid. Failing to deserialize and apply incoming changes results in data inconsistency - which is a fatal error. @@ -53,7 +53,7 @@ Use this callback to react to deserialization errors. optional serializer: CustomSQLiteSerializer; ``` -Defined in: [definitions.ts:87](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L87) +Defined in: [definitions.ts:87](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L87) Optional partial serializer object for customizing how individual columns are serialized for SQLite. diff --git a/docs/reference/powersync-db-collection/type-aliases/TransactorOptions.md b/docs/reference/powersync-db-collection/type-aliases/TransactorOptions.md index d38e7152f..527a3ca55 100644 --- a/docs/reference/powersync-db-collection/type-aliases/TransactorOptions.md +++ b/docs/reference/powersync-db-collection/type-aliases/TransactorOptions.md @@ -9,7 +9,7 @@ title: TransactorOptions type TransactorOptions = object; ``` -Defined in: [PowerSyncTransactor.ts:12](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L12) +Defined in: [PowerSyncTransactor.ts:12](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L12) ## Properties @@ -19,4 +19,4 @@ Defined in: [PowerSyncTransactor.ts:12](https://github.com/TanStack/db/blob/main database: AbstractPowerSyncDatabase; ``` -Defined in: [PowerSyncTransactor.ts:13](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L13) +Defined in: [PowerSyncTransactor.ts:13](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L13) diff --git a/docs/reference/powersync-db-collection/variables/DEFAULT_BATCH_SIZE.md b/docs/reference/powersync-db-collection/variables/DEFAULT_BATCH_SIZE.md index 46f9f447a..b084c1fe4 100644 --- a/docs/reference/powersync-db-collection/variables/DEFAULT_BATCH_SIZE.md +++ b/docs/reference/powersync-db-collection/variables/DEFAULT_BATCH_SIZE.md @@ -9,6 +9,6 @@ title: DEFAULT_BATCH_SIZE const DEFAULT_BATCH_SIZE: 1000 = 1000; ``` -Defined in: [definitions.ts:274](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L274) +Defined in: [definitions.ts:274](https://github.com/MAST1999/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L274) Default value for [PowerSyncCollectionConfig#syncBatchSize](../../type-aliases/BasePowerSyncCollectionConfig.md). diff --git a/docs/reference/query-db-collection/classes/DeleteOperationItemNotFoundError.md b/docs/reference/query-db-collection/classes/DeleteOperationItemNotFoundError.md index 34fa05249..cb7af331e 100644 --- a/docs/reference/query-db-collection/classes/DeleteOperationItemNotFoundError.md +++ b/docs/reference/query-db-collection/classes/DeleteOperationItemNotFoundError.md @@ -5,7 +5,7 @@ title: DeleteOperationItemNotFoundError # Class: DeleteOperationItemNotFoundError -Defined in: [packages/query-db-collection/src/errors.ts:76](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L76) +Defined in: [packages/query-db-collection/src/errors.ts:76](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L76) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:76](https://github.com/T new DeleteOperationItemNotFoundError(key): DeleteOperationItemNotFoundError; ``` -Defined in: [packages/query-db-collection/src/errors.ts:77](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L77) +Defined in: [packages/query-db-collection/src/errors.ts:77](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L77) #### Parameters diff --git a/docs/reference/query-db-collection/classes/DuplicateKeyInBatchError.md b/docs/reference/query-db-collection/classes/DuplicateKeyInBatchError.md index 7e04fe138..3a279e220 100644 --- a/docs/reference/query-db-collection/classes/DuplicateKeyInBatchError.md +++ b/docs/reference/query-db-collection/classes/DuplicateKeyInBatchError.md @@ -5,7 +5,7 @@ title: DuplicateKeyInBatchError # Class: DuplicateKeyInBatchError -Defined in: [packages/query-db-collection/src/errors.ts:62](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L62) +Defined in: [packages/query-db-collection/src/errors.ts:62](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L62) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:62](https://github.com/T new DuplicateKeyInBatchError(key): DuplicateKeyInBatchError; ``` -Defined in: [packages/query-db-collection/src/errors.ts:63](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L63) +Defined in: [packages/query-db-collection/src/errors.ts:63](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L63) #### Parameters diff --git a/docs/reference/query-db-collection/classes/GetKeyRequiredError.md b/docs/reference/query-db-collection/classes/GetKeyRequiredError.md index 6a02f66e5..669f94573 100644 --- a/docs/reference/query-db-collection/classes/GetKeyRequiredError.md +++ b/docs/reference/query-db-collection/classes/GetKeyRequiredError.md @@ -5,7 +5,7 @@ title: GetKeyRequiredError # Class: GetKeyRequiredError -Defined in: [packages/query-db-collection/src/errors.ts:32](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L32) +Defined in: [packages/query-db-collection/src/errors.ts:32](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L32) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:32](https://github.com/T new GetKeyRequiredError(): GetKeyRequiredError; ``` -Defined in: [packages/query-db-collection/src/errors.ts:33](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L33) +Defined in: [packages/query-db-collection/src/errors.ts:33](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L33) #### Returns diff --git a/docs/reference/query-db-collection/classes/InvalidItemStructureError.md b/docs/reference/query-db-collection/classes/InvalidItemStructureError.md index be43e7c39..956fbe96b 100644 --- a/docs/reference/query-db-collection/classes/InvalidItemStructureError.md +++ b/docs/reference/query-db-collection/classes/InvalidItemStructureError.md @@ -5,7 +5,7 @@ title: InvalidItemStructureError # Class: InvalidItemStructureError -Defined in: [packages/query-db-collection/src/errors.ts:48](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L48) +Defined in: [packages/query-db-collection/src/errors.ts:48](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L48) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:48](https://github.com/T new InvalidItemStructureError(message): InvalidItemStructureError; ``` -Defined in: [packages/query-db-collection/src/errors.ts:49](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L49) +Defined in: [packages/query-db-collection/src/errors.ts:49](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L49) #### Parameters diff --git a/docs/reference/query-db-collection/classes/InvalidSyncOperationError.md b/docs/reference/query-db-collection/classes/InvalidSyncOperationError.md index 12f97f90f..aea441ec3 100644 --- a/docs/reference/query-db-collection/classes/InvalidSyncOperationError.md +++ b/docs/reference/query-db-collection/classes/InvalidSyncOperationError.md @@ -5,7 +5,7 @@ title: InvalidSyncOperationError # Class: InvalidSyncOperationError -Defined in: [packages/query-db-collection/src/errors.ts:83](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L83) +Defined in: [packages/query-db-collection/src/errors.ts:83](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L83) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:83](https://github.com/T new InvalidSyncOperationError(message): InvalidSyncOperationError; ``` -Defined in: [packages/query-db-collection/src/errors.ts:84](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L84) +Defined in: [packages/query-db-collection/src/errors.ts:84](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L84) #### Parameters diff --git a/docs/reference/query-db-collection/classes/ItemNotFoundError.md b/docs/reference/query-db-collection/classes/ItemNotFoundError.md index 682e70337..b1fe107d8 100644 --- a/docs/reference/query-db-collection/classes/ItemNotFoundError.md +++ b/docs/reference/query-db-collection/classes/ItemNotFoundError.md @@ -5,7 +5,7 @@ title: ItemNotFoundError # Class: ItemNotFoundError -Defined in: [packages/query-db-collection/src/errors.ts:55](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L55) +Defined in: [packages/query-db-collection/src/errors.ts:55](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L55) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:55](https://github.com/T new ItemNotFoundError(key): ItemNotFoundError; ``` -Defined in: [packages/query-db-collection/src/errors.ts:56](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L56) +Defined in: [packages/query-db-collection/src/errors.ts:56](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L56) #### Parameters diff --git a/docs/reference/query-db-collection/classes/MissingKeyFieldError.md b/docs/reference/query-db-collection/classes/MissingKeyFieldError.md index 6a0e666f3..2603ad468 100644 --- a/docs/reference/query-db-collection/classes/MissingKeyFieldError.md +++ b/docs/reference/query-db-collection/classes/MissingKeyFieldError.md @@ -5,7 +5,7 @@ title: MissingKeyFieldError # Class: MissingKeyFieldError -Defined in: [packages/query-db-collection/src/errors.ts:97](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L97) +Defined in: [packages/query-db-collection/src/errors.ts:97](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L97) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:97](https://github.com/T new MissingKeyFieldError(operation, message): MissingKeyFieldError; ``` -Defined in: [packages/query-db-collection/src/errors.ts:98](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L98) +Defined in: [packages/query-db-collection/src/errors.ts:98](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L98) #### Parameters diff --git a/docs/reference/query-db-collection/classes/QueryClientRequiredError.md b/docs/reference/query-db-collection/classes/QueryClientRequiredError.md index bfd900f4b..8927b10b1 100644 --- a/docs/reference/query-db-collection/classes/QueryClientRequiredError.md +++ b/docs/reference/query-db-collection/classes/QueryClientRequiredError.md @@ -5,7 +5,7 @@ title: QueryClientRequiredError # Class: QueryClientRequiredError -Defined in: [packages/query-db-collection/src/errors.ts:25](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L25) +Defined in: [packages/query-db-collection/src/errors.ts:25](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L25) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:25](https://github.com/T new QueryClientRequiredError(): QueryClientRequiredError; ``` -Defined in: [packages/query-db-collection/src/errors.ts:26](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L26) +Defined in: [packages/query-db-collection/src/errors.ts:26](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L26) #### Returns diff --git a/docs/reference/query-db-collection/classes/QueryCollectionError.md b/docs/reference/query-db-collection/classes/QueryCollectionError.md index 83b6c2d31..3231c5f73 100644 --- a/docs/reference/query-db-collection/classes/QueryCollectionError.md +++ b/docs/reference/query-db-collection/classes/QueryCollectionError.md @@ -5,7 +5,7 @@ title: QueryCollectionError # Class: QueryCollectionError -Defined in: [packages/query-db-collection/src/errors.ts:4](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L4) +Defined in: [packages/query-db-collection/src/errors.ts:4](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L4) ## Extends @@ -35,7 +35,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:4](https://github.com/Ta new QueryCollectionError(message): QueryCollectionError; ``` -Defined in: [packages/query-db-collection/src/errors.ts:5](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L5) +Defined in: [packages/query-db-collection/src/errors.ts:5](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L5) #### Parameters diff --git a/docs/reference/query-db-collection/classes/QueryFnRequiredError.md b/docs/reference/query-db-collection/classes/QueryFnRequiredError.md index 4ba61732f..2d5515936 100644 --- a/docs/reference/query-db-collection/classes/QueryFnRequiredError.md +++ b/docs/reference/query-db-collection/classes/QueryFnRequiredError.md @@ -5,7 +5,7 @@ title: QueryFnRequiredError # Class: QueryFnRequiredError -Defined in: [packages/query-db-collection/src/errors.ts:18](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L18) +Defined in: [packages/query-db-collection/src/errors.ts:18](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L18) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:18](https://github.com/T new QueryFnRequiredError(): QueryFnRequiredError; ``` -Defined in: [packages/query-db-collection/src/errors.ts:19](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L19) +Defined in: [packages/query-db-collection/src/errors.ts:19](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L19) #### Returns diff --git a/docs/reference/query-db-collection/classes/QueryKeyRequiredError.md b/docs/reference/query-db-collection/classes/QueryKeyRequiredError.md index 3988a0acb..8711b85a9 100644 --- a/docs/reference/query-db-collection/classes/QueryKeyRequiredError.md +++ b/docs/reference/query-db-collection/classes/QueryKeyRequiredError.md @@ -5,7 +5,7 @@ title: QueryKeyRequiredError # Class: QueryKeyRequiredError -Defined in: [packages/query-db-collection/src/errors.ts:11](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L11) +Defined in: [packages/query-db-collection/src/errors.ts:11](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L11) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:11](https://github.com/T new QueryKeyRequiredError(): QueryKeyRequiredError; ``` -Defined in: [packages/query-db-collection/src/errors.ts:12](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L12) +Defined in: [packages/query-db-collection/src/errors.ts:12](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L12) #### Returns diff --git a/docs/reference/query-db-collection/classes/SyncNotInitializedError.md b/docs/reference/query-db-collection/classes/SyncNotInitializedError.md index 8adee5e9a..e4c6a0445 100644 --- a/docs/reference/query-db-collection/classes/SyncNotInitializedError.md +++ b/docs/reference/query-db-collection/classes/SyncNotInitializedError.md @@ -5,7 +5,7 @@ title: SyncNotInitializedError # Class: SyncNotInitializedError -Defined in: [packages/query-db-collection/src/errors.ts:39](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L39) +Defined in: [packages/query-db-collection/src/errors.ts:39](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L39) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:39](https://github.com/T new SyncNotInitializedError(): SyncNotInitializedError; ``` -Defined in: [packages/query-db-collection/src/errors.ts:40](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L40) +Defined in: [packages/query-db-collection/src/errors.ts:40](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L40) #### Returns diff --git a/docs/reference/query-db-collection/classes/UnknownOperationTypeError.md b/docs/reference/query-db-collection/classes/UnknownOperationTypeError.md index f3bb18fdd..75d908ed8 100644 --- a/docs/reference/query-db-collection/classes/UnknownOperationTypeError.md +++ b/docs/reference/query-db-collection/classes/UnknownOperationTypeError.md @@ -5,7 +5,7 @@ title: UnknownOperationTypeError # Class: UnknownOperationTypeError -Defined in: [packages/query-db-collection/src/errors.ts:90](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L90) +Defined in: [packages/query-db-collection/src/errors.ts:90](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L90) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:90](https://github.com/T new UnknownOperationTypeError(type): UnknownOperationTypeError; ``` -Defined in: [packages/query-db-collection/src/errors.ts:91](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L91) +Defined in: [packages/query-db-collection/src/errors.ts:91](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L91) #### Parameters diff --git a/docs/reference/query-db-collection/classes/UpdateOperationItemNotFoundError.md b/docs/reference/query-db-collection/classes/UpdateOperationItemNotFoundError.md index 2745b0a98..82caea60b 100644 --- a/docs/reference/query-db-collection/classes/UpdateOperationItemNotFoundError.md +++ b/docs/reference/query-db-collection/classes/UpdateOperationItemNotFoundError.md @@ -5,7 +5,7 @@ title: UpdateOperationItemNotFoundError # Class: UpdateOperationItemNotFoundError -Defined in: [packages/query-db-collection/src/errors.ts:69](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L69) +Defined in: [packages/query-db-collection/src/errors.ts:69](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L69) ## Extends @@ -19,7 +19,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:69](https://github.com/T new UpdateOperationItemNotFoundError(key): UpdateOperationItemNotFoundError; ``` -Defined in: [packages/query-db-collection/src/errors.ts:70](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/errors.ts#L70) +Defined in: [packages/query-db-collection/src/errors.ts:70](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/errors.ts#L70) #### Parameters diff --git a/docs/reference/query-db-collection/functions/queryCollectionOptions.md b/docs/reference/query-db-collection/functions/queryCollectionOptions.md index 36fe817f4..cb15c9c34 100644 --- a/docs/reference/query-db-collection/functions/queryCollectionOptions.md +++ b/docs/reference/query-db-collection/functions/queryCollectionOptions.md @@ -11,7 +11,7 @@ title: queryCollectionOptions function queryCollectionOptions(config): CollectionConfig, TKey, T, QueryCollectionUtils, TKey, InferSchemaInput, TError>> & object; ``` -Defined in: [packages/query-db-collection/src/query.ts:393](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L393) +Defined in: [packages/query-db-collection/src/query.ts:393](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L393) Creates query collection options for use with a standard Collection. This integrates TanStack Query with TanStack DB for automatic synchronization. @@ -151,7 +151,7 @@ const todosCollection = createCollection( function queryCollectionOptions(config): CollectionConfig> & object; ``` -Defined in: [packages/query-db-collection/src/query.ts:428](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L428) +Defined in: [packages/query-db-collection/src/query.ts:428](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L428) Creates query collection options for use with a standard Collection. This integrates TanStack Query with TanStack DB for automatic synchronization. @@ -291,7 +291,7 @@ const todosCollection = createCollection( function queryCollectionOptions(config): CollectionConfig, TKey, T, QueryCollectionUtils, TKey, InferSchemaInput, TError>> & object; ``` -Defined in: [packages/query-db-collection/src/query.ts:461](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L461) +Defined in: [packages/query-db-collection/src/query.ts:461](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L461) Creates query collection options for use with a standard Collection. This integrates TanStack Query with TanStack DB for automatic synchronization. @@ -423,7 +423,7 @@ const todosCollection = createCollection( function queryCollectionOptions(config): CollectionConfig> & object; ``` -Defined in: [packages/query-db-collection/src/query.ts:495](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L495) +Defined in: [packages/query-db-collection/src/query.ts:495](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L495) Creates query collection options for use with a standard Collection. This integrates TanStack Query with TanStack DB for automatic synchronization. diff --git a/docs/reference/query-db-collection/interfaces/QueryCollectionConfig.md b/docs/reference/query-db-collection/interfaces/QueryCollectionConfig.md index f2c1b8498..bf0167f10 100644 --- a/docs/reference/query-db-collection/interfaces/QueryCollectionConfig.md +++ b/docs/reference/query-db-collection/interfaces/QueryCollectionConfig.md @@ -5,7 +5,7 @@ title: QueryCollectionConfig # Interface: QueryCollectionConfig\ -Defined in: [packages/query-db-collection/src/query.ts:59](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L59) +Defined in: [packages/query-db-collection/src/query.ts:59](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L59) Configuration options for creating a Query Collection @@ -63,7 +63,7 @@ The schema type for validation optional enabled: boolean; ``` -Defined in: [packages/query-db-collection/src/query.ts:85](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L85) +Defined in: [packages/query-db-collection/src/query.ts:85](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L85) Whether the query should automatically run (default: true) @@ -75,7 +75,7 @@ Whether the query should automatically run (default: true) optional meta: Record; ``` -Defined in: [packages/query-db-collection/src/query.ts:135](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L135) +Defined in: [packages/query-db-collection/src/query.ts:135](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L135) Metadata to pass to the query. Available in queryFn via context.meta @@ -107,7 +107,7 @@ meta: { queryClient: QueryClient; ``` -Defined in: [packages/query-db-collection/src/query.ts:81](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L81) +Defined in: [packages/query-db-collection/src/query.ts:81](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L81) The TanStack Query client instance @@ -119,7 +119,7 @@ The TanStack Query client instance queryFn: TQueryFn extends (context) => Promise ? (context) => Promise : TQueryFn; ``` -Defined in: [packages/query-db-collection/src/query.ts:73](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L73) +Defined in: [packages/query-db-collection/src/query.ts:73](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L73) Function that fetches data from the server. Must return the complete collection state @@ -131,7 +131,7 @@ Function that fetches data from the server. Must return the complete collection queryKey: TQueryKey | TQueryKeyBuilder; ``` -Defined in: [packages/query-db-collection/src/query.ts:71](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L71) +Defined in: [packages/query-db-collection/src/query.ts:71](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L71) The query key used by TanStack Query to identify this query @@ -143,7 +143,7 @@ The query key used by TanStack Query to identify this query optional refetchInterval: number | false | (query) => number | false | undefined; ``` -Defined in: [packages/query-db-collection/src/query.ts:86](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L86) +Defined in: [packages/query-db-collection/src/query.ts:86](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L86) *** @@ -153,7 +153,7 @@ Defined in: [packages/query-db-collection/src/query.ts:86](https://github.com/Ta optional retry: RetryValue; ``` -Defined in: [packages/query-db-collection/src/query.ts:93](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L93) +Defined in: [packages/query-db-collection/src/query.ts:93](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L93) *** @@ -163,7 +163,7 @@ Defined in: [packages/query-db-collection/src/query.ts:93](https://github.com/Ta optional retryDelay: RetryDelayValue; ``` -Defined in: [packages/query-db-collection/src/query.ts:100](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L100) +Defined in: [packages/query-db-collection/src/query.ts:100](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L100) *** @@ -173,7 +173,7 @@ Defined in: [packages/query-db-collection/src/query.ts:100](https://github.com/T optional select: (data) => T[]; ``` -Defined in: [packages/query-db-collection/src/query.ts:79](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L79) +Defined in: [packages/query-db-collection/src/query.ts:79](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L79) #### Parameters @@ -193,4 +193,4 @@ Defined in: [packages/query-db-collection/src/query.ts:79](https://github.com/Ta optional staleTime: StaleTimeFunction; ``` -Defined in: [packages/query-db-collection/src/query.ts:107](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L107) +Defined in: [packages/query-db-collection/src/query.ts:107](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L107) diff --git a/docs/reference/query-db-collection/interfaces/QueryCollectionMeta.md b/docs/reference/query-db-collection/interfaces/QueryCollectionMeta.md index 7c2527c39..bf17e2a52 100644 --- a/docs/reference/query-db-collection/interfaces/QueryCollectionMeta.md +++ b/docs/reference/query-db-collection/interfaces/QueryCollectionMeta.md @@ -5,7 +5,7 @@ title: QueryCollectionMeta # Interface: QueryCollectionMeta -Defined in: [packages/query-db-collection/src/global.ts:30](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/global.ts#L30) +Defined in: [packages/query-db-collection/src/global.ts:30](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/global.ts#L30) Base interface for Query Collection meta properties. Users can extend this interface to add their own custom properties while @@ -40,4 +40,4 @@ declare module "@tanstack/query-db-collection" { loadSubsetOptions: LoadSubsetOptions; ``` -Defined in: [packages/query-db-collection/src/global.ts:31](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/global.ts#L31) +Defined in: [packages/query-db-collection/src/global.ts:31](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/global.ts#L31) diff --git a/docs/reference/query-db-collection/interfaces/QueryCollectionUtils.md b/docs/reference/query-db-collection/interfaces/QueryCollectionUtils.md index 47cb7ea56..e690d9054 100644 --- a/docs/reference/query-db-collection/interfaces/QueryCollectionUtils.md +++ b/docs/reference/query-db-collection/interfaces/QueryCollectionUtils.md @@ -5,7 +5,7 @@ title: QueryCollectionUtils # Interface: QueryCollectionUtils\ -Defined in: [packages/query-db-collection/src/query.ts:154](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L154) +Defined in: [packages/query-db-collection/src/query.ts:154](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L154) Utility methods available on Query Collections for direct writes and manual operations. Direct writes bypass the normal query/mutation flow and write directly to the synced data store. @@ -54,7 +54,7 @@ The type of errors that can occur during queries clearError: () => Promise; ``` -Defined in: [packages/query-db-collection/src/query.ts:199](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L199) +Defined in: [packages/query-db-collection/src/query.ts:199](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L199) Clear the error state and trigger a refetch of the query @@ -76,7 +76,7 @@ Error if the refetch fails dataUpdatedAt: number; ``` -Defined in: [packages/query-db-collection/src/query.ts:190](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L190) +Defined in: [packages/query-db-collection/src/query.ts:190](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L190) Get timestamp of last successful data update (in milliseconds) @@ -88,7 +88,7 @@ Get timestamp of last successful data update (in milliseconds) errorCount: number; ``` -Defined in: [packages/query-db-collection/src/query.ts:182](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L182) +Defined in: [packages/query-db-collection/src/query.ts:182](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L182) Get the number of consecutive sync failures. Incremented only when query fails completely (not per retry attempt); reset on success. @@ -101,7 +101,7 @@ Incremented only when query fails completely (not per retry attempt); reset on s fetchStatus: "idle" | "fetching" | "paused"; ``` -Defined in: [packages/query-db-collection/src/query.ts:192](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L192) +Defined in: [packages/query-db-collection/src/query.ts:192](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L192) Get current fetch status @@ -113,7 +113,7 @@ Get current fetch status isError: boolean; ``` -Defined in: [packages/query-db-collection/src/query.ts:177](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L177) +Defined in: [packages/query-db-collection/src/query.ts:177](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L177) Check if the collection is in an error state @@ -125,7 +125,7 @@ Check if the collection is in an error state isFetching: boolean; ``` -Defined in: [packages/query-db-collection/src/query.ts:184](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L184) +Defined in: [packages/query-db-collection/src/query.ts:184](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L184) Check if query is currently fetching (initial or background) @@ -137,7 +137,7 @@ Check if query is currently fetching (initial or background) isLoading: boolean; ``` -Defined in: [packages/query-db-collection/src/query.ts:188](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L188) +Defined in: [packages/query-db-collection/src/query.ts:188](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L188) Check if query is loading for the first time (no data yet) @@ -149,7 +149,7 @@ Check if query is loading for the first time (no data yet) isRefetching: boolean; ``` -Defined in: [packages/query-db-collection/src/query.ts:186](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L186) +Defined in: [packages/query-db-collection/src/query.ts:186](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L186) Check if query is refetching in background (not initial fetch) @@ -161,7 +161,7 @@ Check if query is refetching in background (not initial fetch) lastError: TError | undefined; ``` -Defined in: [packages/query-db-collection/src/query.ts:175](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L175) +Defined in: [packages/query-db-collection/src/query.ts:175](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L175) Get the last error encountered by the query (if any); reset on success @@ -173,7 +173,7 @@ Get the last error encountered by the query (if any); reset on success refetch: RefetchFn; ``` -Defined in: [packages/query-db-collection/src/query.ts:161](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L161) +Defined in: [packages/query-db-collection/src/query.ts:161](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L161) Manually trigger a refetch of the query @@ -185,7 +185,7 @@ Manually trigger a refetch of the query writeBatch: (callback) => void; ``` -Defined in: [packages/query-db-collection/src/query.ts:171](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L171) +Defined in: [packages/query-db-collection/src/query.ts:171](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L171) Execute multiple write operations as a single atomic batch to the synced data store @@ -207,7 +207,7 @@ Execute multiple write operations as a single atomic batch to the synced data st writeDelete: (keys) => void; ``` -Defined in: [packages/query-db-collection/src/query.ts:167](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L167) +Defined in: [packages/query-db-collection/src/query.ts:167](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L167) Delete one or more items directly from the synced data store without triggering a query refetch or optimistic update @@ -229,7 +229,7 @@ Delete one or more items directly from the synced data store without triggering writeInsert: (data) => void; ``` -Defined in: [packages/query-db-collection/src/query.ts:163](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L163) +Defined in: [packages/query-db-collection/src/query.ts:163](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L163) Insert one or more items directly into the synced data store without triggering a query refetch or optimistic update @@ -251,7 +251,7 @@ Insert one or more items directly into the synced data store without triggering writeUpdate: (updates) => void; ``` -Defined in: [packages/query-db-collection/src/query.ts:165](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L165) +Defined in: [packages/query-db-collection/src/query.ts:165](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L165) Update one or more items directly in the synced data store without triggering a query refetch or optimistic update @@ -273,7 +273,7 @@ Update one or more items directly in the synced data store without triggering a writeUpsert: (data) => void; ``` -Defined in: [packages/query-db-collection/src/query.ts:169](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L169) +Defined in: [packages/query-db-collection/src/query.ts:169](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/query.ts#L169) Insert or update one or more items directly in the synced data store without triggering a query refetch or optimistic update diff --git a/docs/reference/query-db-collection/type-aliases/SyncOperation.md b/docs/reference/query-db-collection/type-aliases/SyncOperation.md index 9cb0b5eb9..e9543d113 100644 --- a/docs/reference/query-db-collection/type-aliases/SyncOperation.md +++ b/docs/reference/query-db-collection/type-aliases/SyncOperation.md @@ -25,7 +25,7 @@ type SyncOperation = }; ``` -Defined in: [packages/query-db-collection/src/manual-sync.ts:20](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/manual-sync.ts#L20) +Defined in: [packages/query-db-collection/src/manual-sync.ts:20](https://github.com/MAST1999/db/blob/main/packages/query-db-collection/src/manual-sync.ts#L20) ## Type Parameters diff --git a/docs/reference/type-aliases/ChangeListener.md b/docs/reference/type-aliases/ChangeListener.md index 5c5950806..51131baac 100644 --- a/docs/reference/type-aliases/ChangeListener.md +++ b/docs/reference/type-aliases/ChangeListener.md @@ -9,7 +9,7 @@ title: ChangeListener type ChangeListener = (changes) => void; ``` -Defined in: [packages/db/src/types.ts:780](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L780) +Defined in: [packages/db/src/types.ts:780](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L780) Function type for listening to collection changes diff --git a/docs/reference/type-aliases/ChangesPayload.md b/docs/reference/type-aliases/ChangesPayload.md index 492558932..9f0eb4af1 100644 --- a/docs/reference/type-aliases/ChangesPayload.md +++ b/docs/reference/type-aliases/ChangesPayload.md @@ -9,7 +9,7 @@ title: ChangesPayload type ChangesPayload = ChangeMessage[]; ``` -Defined in: [packages/db/src/types.ts:681](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L681) +Defined in: [packages/db/src/types.ts:681](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L681) ## Type Parameters diff --git a/docs/reference/type-aliases/CleanupFn.md b/docs/reference/type-aliases/CleanupFn.md index 75202b7a1..67f83a330 100644 --- a/docs/reference/type-aliases/CleanupFn.md +++ b/docs/reference/type-aliases/CleanupFn.md @@ -9,7 +9,7 @@ title: CleanupFn type CleanupFn = () => void; ``` -Defined in: [packages/db/src/types.ts:278](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L278) +Defined in: [packages/db/src/types.ts:278](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L278) ## Returns diff --git a/docs/reference/type-aliases/ClearStorageFn.md b/docs/reference/type-aliases/ClearStorageFn.md index 05751d091..3a9e247f7 100644 --- a/docs/reference/type-aliases/ClearStorageFn.md +++ b/docs/reference/type-aliases/ClearStorageFn.md @@ -9,7 +9,7 @@ title: ClearStorageFn type ClearStorageFn = () => void; ``` -Defined in: [packages/db/src/local-storage.ts:90](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L90) +Defined in: [packages/db/src/local-storage.ts:90](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L90) Type for the clear utility function diff --git a/docs/reference/type-aliases/CollectionConfigSingleRowOption.md b/docs/reference/type-aliases/CollectionConfigSingleRowOption.md index 950a98e3f..3ffaa6ba0 100644 --- a/docs/reference/type-aliases/CollectionConfigSingleRowOption.md +++ b/docs/reference/type-aliases/CollectionConfigSingleRowOption.md @@ -9,7 +9,7 @@ title: CollectionConfigSingleRowOption type CollectionConfigSingleRowOption = CollectionConfig & MaybeSingleResult; ``` -Defined in: [packages/db/src/types.ts:674](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L674) +Defined in: [packages/db/src/types.ts:674](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L674) ## Type Parameters diff --git a/docs/reference/type-aliases/CollectionStatus.md b/docs/reference/type-aliases/CollectionStatus.md index de248cd6e..63adb39ef 100644 --- a/docs/reference/type-aliases/CollectionStatus.md +++ b/docs/reference/type-aliases/CollectionStatus.md @@ -9,7 +9,7 @@ title: CollectionStatus type CollectionStatus = "idle" | "loading" | "ready" | "error" | "cleaned-up"; ``` -Defined in: [packages/db/src/types.ts:424](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L424) +Defined in: [packages/db/src/types.ts:424](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L424) Collection status values for lifecycle management diff --git a/docs/reference/type-aliases/DeleteMutationFn.md b/docs/reference/type-aliases/DeleteMutationFn.md index 5f48caad8..3c075de7f 100644 --- a/docs/reference/type-aliases/DeleteMutationFn.md +++ b/docs/reference/type-aliases/DeleteMutationFn.md @@ -9,7 +9,7 @@ title: DeleteMutationFn type DeleteMutationFn = (params) => Promise; ``` -Defined in: [packages/db/src/types.ts:402](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L402) +Defined in: [packages/db/src/types.ts:402](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L402) ## Type Parameters diff --git a/docs/reference/type-aliases/DeleteMutationFnParams.md b/docs/reference/type-aliases/DeleteMutationFnParams.md index 872eccd9b..24c903e6c 100644 --- a/docs/reference/type-aliases/DeleteMutationFnParams.md +++ b/docs/reference/type-aliases/DeleteMutationFnParams.md @@ -9,7 +9,7 @@ title: DeleteMutationFnParams type DeleteMutationFnParams = object; ``` -Defined in: [packages/db/src/types.ts:379](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L379) +Defined in: [packages/db/src/types.ts:379](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L379) ## Type Parameters @@ -33,7 +33,7 @@ Defined in: [packages/db/src/types.ts:379](https://github.com/TanStack/db/blob/m collection: Collection; ``` -Defined in: [packages/db/src/types.ts:385](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L385) +Defined in: [packages/db/src/types.ts:385](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L385) *** @@ -43,4 +43,4 @@ Defined in: [packages/db/src/types.ts:385](https://github.com/TanStack/db/blob/m transaction: TransactionWithMutations; ``` -Defined in: [packages/db/src/types.ts:384](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L384) +Defined in: [packages/db/src/types.ts:384](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L384) diff --git a/docs/reference/type-aliases/FieldPath.md b/docs/reference/type-aliases/FieldPath.md index 0dfa258e0..523890c77 100644 --- a/docs/reference/type-aliases/FieldPath.md +++ b/docs/reference/type-aliases/FieldPath.md @@ -9,7 +9,7 @@ title: FieldPath type FieldPath = (string | number)[]; ``` -Defined in: [packages/db/src/query/expression-helpers.ts:39](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L39) +Defined in: [packages/db/src/query/expression-helpers.ts:39](https://github.com/MAST1999/db/blob/main/packages/db/src/query/expression-helpers.ts#L39) Represents a simple field path extracted from an expression. Can include string keys for object properties and numbers for array indices. diff --git a/docs/reference/type-aliases/Fn.md b/docs/reference/type-aliases/Fn.md index d4cc38176..570de8f4d 100644 --- a/docs/reference/type-aliases/Fn.md +++ b/docs/reference/type-aliases/Fn.md @@ -9,7 +9,7 @@ title: Fn type Fn = (...args) => any; ``` -Defined in: [packages/db/src/types.ts:66](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L66) +Defined in: [packages/db/src/types.ts:66](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L66) Represents a utility function that can be attached to a collection diff --git a/docs/reference/type-aliases/GetResult.md b/docs/reference/type-aliases/GetResult.md index fde3475a2..7a0307376 100644 --- a/docs/reference/type-aliases/GetResult.md +++ b/docs/reference/type-aliases/GetResult.md @@ -9,7 +9,7 @@ title: GetResult type GetResult = Prettify; ``` -Defined in: [packages/db/src/query/builder/types.ts:653](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L653) +Defined in: [packages/db/src/query/builder/types.ts:653](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/types.ts#L653) GetResult - Determines the final result type of a query diff --git a/docs/reference/type-aliases/GetStorageSizeFn.md b/docs/reference/type-aliases/GetStorageSizeFn.md index 2008fbbd6..9494c8eb3 100644 --- a/docs/reference/type-aliases/GetStorageSizeFn.md +++ b/docs/reference/type-aliases/GetStorageSizeFn.md @@ -9,7 +9,7 @@ title: GetStorageSizeFn type GetStorageSizeFn = () => number; ``` -Defined in: [packages/db/src/local-storage.ts:95](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L95) +Defined in: [packages/db/src/local-storage.ts:95](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L95) Type for the getStorageSize utility function diff --git a/docs/reference/type-aliases/IndexConstructor.md b/docs/reference/type-aliases/IndexConstructor.md index fa3e2d37b..982446e94 100644 --- a/docs/reference/type-aliases/IndexConstructor.md +++ b/docs/reference/type-aliases/IndexConstructor.md @@ -9,7 +9,7 @@ title: IndexConstructor type IndexConstructor = (id, expression, name?, options?) => BaseIndex; ``` -Defined in: [packages/db/src/indexes/base-index.ts:201](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L201) +Defined in: [packages/db/src/indexes/base-index.ts:201](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L201) Type for index constructor diff --git a/docs/reference/type-aliases/IndexOperation.md b/docs/reference/type-aliases/IndexOperation.md index 3dbce14d1..52313441b 100644 --- a/docs/reference/type-aliases/IndexOperation.md +++ b/docs/reference/type-aliases/IndexOperation.md @@ -9,6 +9,6 @@ title: IndexOperation type IndexOperation = typeof comparisonFunctions[number]; ``` -Defined in: [packages/db/src/indexes/base-index.ts:11](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L11) +Defined in: [packages/db/src/indexes/base-index.ts:11](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L11) Type for index operation values diff --git a/docs/reference/type-aliases/IndexResolver.md b/docs/reference/type-aliases/IndexResolver.md index 8dcd5c3e5..517c3f708 100644 --- a/docs/reference/type-aliases/IndexResolver.md +++ b/docs/reference/type-aliases/IndexResolver.md @@ -11,7 +11,7 @@ type IndexResolver = | () => Promise>; ``` -Defined in: [packages/db/src/indexes/base-index.ts:212](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L212) +Defined in: [packages/db/src/indexes/base-index.ts:212](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L212) Index resolver can be either a class constructor or async loader diff --git a/docs/reference/type-aliases/InferResultType.md b/docs/reference/type-aliases/InferResultType.md index 851862eee..dbd1fb24e 100644 --- a/docs/reference/type-aliases/InferResultType.md +++ b/docs/reference/type-aliases/InferResultType.md @@ -9,7 +9,7 @@ title: InferResultType type InferResultType = TContext extends SingleResult ? GetResult | undefined : GetResult[]; ``` -Defined in: [packages/db/src/query/builder/types.ts:623](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L623) +Defined in: [packages/db/src/query/builder/types.ts:623](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/types.ts#L623) Utility type to infer the query result size (single row or an array) diff --git a/docs/reference/type-aliases/InferSchemaInput.md b/docs/reference/type-aliases/InferSchemaInput.md index e209e5475..efcd796c2 100644 --- a/docs/reference/type-aliases/InferSchemaInput.md +++ b/docs/reference/type-aliases/InferSchemaInput.md @@ -9,7 +9,7 @@ title: InferSchemaInput type InferSchemaInput = T extends StandardSchemaV1 ? StandardSchemaV1.InferInput extends object ? StandardSchemaV1.InferInput : Record : Record; ``` -Defined in: [packages/db/src/types.ts:55](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L55) +Defined in: [packages/db/src/types.ts:55](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L55) **`Internal`** diff --git a/docs/reference/type-aliases/InferSchemaOutput.md b/docs/reference/type-aliases/InferSchemaOutput.md index 9069db64b..c235d4d19 100644 --- a/docs/reference/type-aliases/InferSchemaOutput.md +++ b/docs/reference/type-aliases/InferSchemaOutput.md @@ -9,7 +9,7 @@ title: InferSchemaOutput type InferSchemaOutput = T extends StandardSchemaV1 ? StandardSchemaV1.InferOutput extends object ? StandardSchemaV1.InferOutput : Record : Record; ``` -Defined in: [packages/db/src/types.ts:44](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L44) +Defined in: [packages/db/src/types.ts:44](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L44) **`Internal`** diff --git a/docs/reference/type-aliases/InitialQueryBuilder.md b/docs/reference/type-aliases/InitialQueryBuilder.md index f10f27678..4359c01b9 100644 --- a/docs/reference/type-aliases/InitialQueryBuilder.md +++ b/docs/reference/type-aliases/InitialQueryBuilder.md @@ -9,4 +9,4 @@ title: InitialQueryBuilder type InitialQueryBuilder = Pick, "from">; ``` -Defined in: [packages/db/src/query/builder/index.ts:846](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L846) +Defined in: [packages/db/src/query/builder/index.ts:846](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L846) diff --git a/docs/reference/type-aliases/InputRow.md b/docs/reference/type-aliases/InputRow.md index 991ce93f7..41882db56 100644 --- a/docs/reference/type-aliases/InputRow.md +++ b/docs/reference/type-aliases/InputRow.md @@ -9,6 +9,6 @@ title: InputRow type InputRow = [unknown, Record]; ``` -Defined in: [packages/db/src/types.ts:688](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L688) +Defined in: [packages/db/src/types.ts:688](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L688) An input row from a collection diff --git a/docs/reference/type-aliases/InsertMutationFn.md b/docs/reference/type-aliases/InsertMutationFn.md index 573a31414..d0109a8f5 100644 --- a/docs/reference/type-aliases/InsertMutationFn.md +++ b/docs/reference/type-aliases/InsertMutationFn.md @@ -9,7 +9,7 @@ title: InsertMutationFn type InsertMutationFn = (params) => Promise; ``` -Defined in: [packages/db/src/types.ts:388](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L388) +Defined in: [packages/db/src/types.ts:388](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L388) ## Type Parameters diff --git a/docs/reference/type-aliases/InsertMutationFnParams.md b/docs/reference/type-aliases/InsertMutationFnParams.md index 6080b4a33..e1ac11905 100644 --- a/docs/reference/type-aliases/InsertMutationFnParams.md +++ b/docs/reference/type-aliases/InsertMutationFnParams.md @@ -9,7 +9,7 @@ title: InsertMutationFnParams type InsertMutationFnParams = object; ``` -Defined in: [packages/db/src/types.ts:371](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L371) +Defined in: [packages/db/src/types.ts:371](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L371) ## Type Parameters @@ -33,7 +33,7 @@ Defined in: [packages/db/src/types.ts:371](https://github.com/TanStack/db/blob/m collection: Collection; ``` -Defined in: [packages/db/src/types.ts:377](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L377) +Defined in: [packages/db/src/types.ts:377](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L377) *** @@ -43,4 +43,4 @@ Defined in: [packages/db/src/types.ts:377](https://github.com/TanStack/db/blob/m transaction: TransactionWithMutations; ``` -Defined in: [packages/db/src/types.ts:376](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L376) +Defined in: [packages/db/src/types.ts:376](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L376) diff --git a/docs/reference/type-aliases/KeyedNamespacedRow.md b/docs/reference/type-aliases/KeyedNamespacedRow.md index 8a1de5808..f02de58c6 100644 --- a/docs/reference/type-aliases/KeyedNamespacedRow.md +++ b/docs/reference/type-aliases/KeyedNamespacedRow.md @@ -9,7 +9,7 @@ title: KeyedNamespacedRow type KeyedNamespacedRow = [unknown, NamespacedRow]; ``` -Defined in: [packages/db/src/types.ts:711](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L711) +Defined in: [packages/db/src/types.ts:711](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L711) A keyed namespaced row is a row with a key and a namespaced row This is the main representation of a row in a query pipeline diff --git a/docs/reference/type-aliases/KeyedStream.md b/docs/reference/type-aliases/KeyedStream.md index d8607f87a..88a4be2e9 100644 --- a/docs/reference/type-aliases/KeyedStream.md +++ b/docs/reference/type-aliases/KeyedStream.md @@ -9,7 +9,7 @@ title: KeyedStream type KeyedStream = IStreamBuilder; ``` -Defined in: [packages/db/src/types.ts:694](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L694) +Defined in: [packages/db/src/types.ts:694](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L694) A keyed stream is a stream of rows This is used as the inputs from a collection to a query diff --git a/docs/reference/type-aliases/LiveQueryCollectionUtils.md b/docs/reference/type-aliases/LiveQueryCollectionUtils.md index 468fa1bf5..8709bcfba 100644 --- a/docs/reference/type-aliases/LiveQueryCollectionUtils.md +++ b/docs/reference/type-aliases/LiveQueryCollectionUtils.md @@ -9,7 +9,7 @@ title: LiveQueryCollectionUtils type LiveQueryCollectionUtils = UtilsRecord & object; ``` -Defined in: [packages/db/src/query/live/collection-config-builder.ts:39](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/collection-config-builder.ts#L39) +Defined in: [packages/db/src/query/live/collection-config-builder.ts:39](https://github.com/MAST1999/db/blob/main/packages/db/src/query/live/collection-config-builder.ts#L39) ## Type Declaration diff --git a/docs/reference/type-aliases/LoadSubsetFn.md b/docs/reference/type-aliases/LoadSubsetFn.md index 9c6d796e5..b392f297e 100644 --- a/docs/reference/type-aliases/LoadSubsetFn.md +++ b/docs/reference/type-aliases/LoadSubsetFn.md @@ -9,7 +9,7 @@ title: LoadSubsetFn type LoadSubsetFn = (options) => true | Promise; ``` -Defined in: [packages/db/src/types.ts:274](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L274) +Defined in: [packages/db/src/types.ts:274](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L274) ## Parameters diff --git a/docs/reference/type-aliases/LoadSubsetOptions.md b/docs/reference/type-aliases/LoadSubsetOptions.md index 64c0a3c4e..2024fde2a 100644 --- a/docs/reference/type-aliases/LoadSubsetOptions.md +++ b/docs/reference/type-aliases/LoadSubsetOptions.md @@ -9,7 +9,7 @@ title: LoadSubsetOptions type LoadSubsetOptions = object; ``` -Defined in: [packages/db/src/types.ts:256](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L256) +Defined in: [packages/db/src/types.ts:256](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L256) ## Properties @@ -19,7 +19,7 @@ Defined in: [packages/db/src/types.ts:256](https://github.com/TanStack/db/blob/m optional limit: number; ``` -Defined in: [packages/db/src/types.ts:262](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L262) +Defined in: [packages/db/src/types.ts:262](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L262) The limit of the data to load @@ -31,7 +31,7 @@ The limit of the data to load optional orderBy: OrderBy; ``` -Defined in: [packages/db/src/types.ts:260](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L260) +Defined in: [packages/db/src/types.ts:260](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L260) The order by clause to sort the data @@ -43,7 +43,7 @@ The order by clause to sort the data optional subscription: Subscription; ``` -Defined in: [packages/db/src/types.ts:271](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L271) +Defined in: [packages/db/src/types.ts:271](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L271) The subscription that triggered the load. Advanced sync implementations can use this for: @@ -63,6 +63,6 @@ Available when called from CollectionSubscription, may be undefined for direct c optional where: BasicExpression; ``` -Defined in: [packages/db/src/types.ts:258](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L258) +Defined in: [packages/db/src/types.ts:258](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L258) The where expression to filter the data diff --git a/docs/reference/type-aliases/MaybeSingleResult.md b/docs/reference/type-aliases/MaybeSingleResult.md index 95512ef93..11b998db0 100644 --- a/docs/reference/type-aliases/MaybeSingleResult.md +++ b/docs/reference/type-aliases/MaybeSingleResult.md @@ -9,7 +9,7 @@ title: MaybeSingleResult type MaybeSingleResult = object; ``` -Defined in: [packages/db/src/types.ts:666](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L666) +Defined in: [packages/db/src/types.ts:666](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L666) ## Properties @@ -19,6 +19,6 @@ Defined in: [packages/db/src/types.ts:666](https://github.com/TanStack/db/blob/m optional singleResult: true; ``` -Defined in: [packages/db/src/types.ts:670](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L670) +Defined in: [packages/db/src/types.ts:670](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L670) If enabled the collection will return a single object instead of an array diff --git a/docs/reference/type-aliases/MutationFn.md b/docs/reference/type-aliases/MutationFn.md index 146de19e0..2d79dc9b3 100644 --- a/docs/reference/type-aliases/MutationFn.md +++ b/docs/reference/type-aliases/MutationFn.md @@ -9,7 +9,7 @@ title: MutationFn type MutationFn = (params) => Promise; ``` -Defined in: [packages/db/src/types.ts:126](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L126) +Defined in: [packages/db/src/types.ts:126](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L126) ## Type Parameters diff --git a/docs/reference/type-aliases/MutationFnParams.md b/docs/reference/type-aliases/MutationFnParams.md index e7b51681f..dcf07e021 100644 --- a/docs/reference/type-aliases/MutationFnParams.md +++ b/docs/reference/type-aliases/MutationFnParams.md @@ -9,7 +9,7 @@ title: MutationFnParams type MutationFnParams = object; ``` -Defined in: [packages/db/src/types.ts:122](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L122) +Defined in: [packages/db/src/types.ts:122](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L122) Configuration options for creating a new transaction @@ -27,4 +27,4 @@ Configuration options for creating a new transaction transaction: TransactionWithMutations; ``` -Defined in: [packages/db/src/types.ts:123](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L123) +Defined in: [packages/db/src/types.ts:123](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L123) diff --git a/docs/reference/type-aliases/NamespacedAndKeyedStream.md b/docs/reference/type-aliases/NamespacedAndKeyedStream.md index c7d501506..2290c620e 100644 --- a/docs/reference/type-aliases/NamespacedAndKeyedStream.md +++ b/docs/reference/type-aliases/NamespacedAndKeyedStream.md @@ -9,7 +9,7 @@ title: NamespacedAndKeyedStream type NamespacedAndKeyedStream = IStreamBuilder; ``` -Defined in: [packages/db/src/types.ts:718](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L718) +Defined in: [packages/db/src/types.ts:718](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L718) A namespaced and keyed stream is a stream of rows This is used throughout a query pipeline and as the output from a query without diff --git a/docs/reference/type-aliases/NamespacedRow.md b/docs/reference/type-aliases/NamespacedRow.md index f2759dc9e..c89ad158a 100644 --- a/docs/reference/type-aliases/NamespacedRow.md +++ b/docs/reference/type-aliases/NamespacedRow.md @@ -9,6 +9,6 @@ title: NamespacedRow type NamespacedRow = Record>; ``` -Defined in: [packages/db/src/types.ts:705](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L705) +Defined in: [packages/db/src/types.ts:705](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L705) A namespaced row is a row withing a pipeline that had each table wrapped in its alias diff --git a/docs/reference/type-aliases/NonEmptyArray.md b/docs/reference/type-aliases/NonEmptyArray.md index 563202223..d3c5a65ac 100644 --- a/docs/reference/type-aliases/NonEmptyArray.md +++ b/docs/reference/type-aliases/NonEmptyArray.md @@ -9,7 +9,7 @@ title: NonEmptyArray type NonEmptyArray = [T, ...T[]]; ``` -Defined in: [packages/db/src/types.ts:133](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L133) +Defined in: [packages/db/src/types.ts:133](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L133) Represents a non-empty array (at least one element) diff --git a/docs/reference/type-aliases/NonSingleResult.md b/docs/reference/type-aliases/NonSingleResult.md index 7a7306afb..f037ecb73 100644 --- a/docs/reference/type-aliases/NonSingleResult.md +++ b/docs/reference/type-aliases/NonSingleResult.md @@ -9,7 +9,7 @@ title: NonSingleResult type NonSingleResult = object; ``` -Defined in: [packages/db/src/types.ts:662](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L662) +Defined in: [packages/db/src/types.ts:662](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L662) ## Properties @@ -19,4 +19,4 @@ Defined in: [packages/db/src/types.ts:662](https://github.com/TanStack/db/blob/m optional singleResult: never; ``` -Defined in: [packages/db/src/types.ts:663](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L663) +Defined in: [packages/db/src/types.ts:663](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L663) diff --git a/docs/reference/type-aliases/OperationType.md b/docs/reference/type-aliases/OperationType.md index 20c3578a8..2e1e57f35 100644 --- a/docs/reference/type-aliases/OperationType.md +++ b/docs/reference/type-aliases/OperationType.md @@ -9,4 +9,4 @@ title: OperationType type OperationType = "insert" | "update" | "delete"; ``` -Defined in: [packages/db/src/types.ts:202](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L202) +Defined in: [packages/db/src/types.ts:202](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L202) diff --git a/docs/reference/type-aliases/OperatorName.md b/docs/reference/type-aliases/OperatorName.md index 6535be23f..6d9197e72 100644 --- a/docs/reference/type-aliases/OperatorName.md +++ b/docs/reference/type-aliases/OperatorName.md @@ -9,4 +9,4 @@ title: OperatorName type OperatorName = typeof operators[number]; ``` -Defined in: [packages/db/src/query/builder/functions.ts:378](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L378) +Defined in: [packages/db/src/query/builder/functions.ts:378](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L378) diff --git a/docs/reference/type-aliases/QueryBuilder.md b/docs/reference/type-aliases/QueryBuilder.md index 63ca2622f..b24001643 100644 --- a/docs/reference/type-aliases/QueryBuilder.md +++ b/docs/reference/type-aliases/QueryBuilder.md @@ -9,7 +9,7 @@ title: QueryBuilder type QueryBuilder = Omit, "from" | "_getQuery">; ``` -Defined in: [packages/db/src/query/builder/index.ts:850](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L850) +Defined in: [packages/db/src/query/builder/index.ts:850](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L850) ## Type Parameters diff --git a/docs/reference/type-aliases/Ref.md b/docs/reference/type-aliases/Ref.md index 3e54d7780..8a0f72470 100644 --- a/docs/reference/type-aliases/Ref.md +++ b/docs/reference/type-aliases/Ref.md @@ -9,7 +9,7 @@ title: Ref type Ref = { [K in keyof T]: IsNonExactOptional extends true ? IsNonExactNullable extends true ? IsPlainObject> extends true ? Ref> | undefined : RefLeaf> | undefined : IsPlainObject> extends true ? Ref> | undefined : RefLeaf> | undefined : IsNonExactNullable extends true ? IsPlainObject> extends true ? Ref> | null : RefLeaf> | null : IsPlainObject extends true ? Ref : RefLeaf } & RefLeaf; ``` -Defined in: [packages/db/src/query/builder/types.ts:471](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L471) +Defined in: [packages/db/src/query/builder/types.ts:471](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/types.ts#L471) Ref - The user-facing ref interface for the query builder diff --git a/docs/reference/type-aliases/ResolveTransactionChanges.md b/docs/reference/type-aliases/ResolveTransactionChanges.md index d8349caab..a5394fd83 100644 --- a/docs/reference/type-aliases/ResolveTransactionChanges.md +++ b/docs/reference/type-aliases/ResolveTransactionChanges.md @@ -9,7 +9,7 @@ title: ResolveTransactionChanges type ResolveTransactionChanges = TOperation extends "delete" ? T : Partial; ``` -Defined in: [packages/db/src/types.ts:79](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L79) +Defined in: [packages/db/src/types.ts:79](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L79) ## Type Parameters diff --git a/docs/reference/type-aliases/ResultStream.md b/docs/reference/type-aliases/ResultStream.md index bce6ea4af..10e7f4221 100644 --- a/docs/reference/type-aliases/ResultStream.md +++ b/docs/reference/type-aliases/ResultStream.md @@ -9,7 +9,7 @@ title: ResultStream type ResultStream = IStreamBuilder<[unknown, [any, string | undefined]]>; ``` -Defined in: [packages/db/src/types.ts:700](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L700) +Defined in: [packages/db/src/types.ts:700](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L700) Result stream type representing the output of compiled queries Always returns [key, [result, orderByIndex]] where orderByIndex is undefined for unordered queries diff --git a/docs/reference/type-aliases/Row.md b/docs/reference/type-aliases/Row.md index 1fa149323..ad5ad20f6 100644 --- a/docs/reference/type-aliases/Row.md +++ b/docs/reference/type-aliases/Row.md @@ -9,7 +9,7 @@ title: Row type Row = Record>; ``` -Defined in: [packages/db/src/types.ts:200](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L200) +Defined in: [packages/db/src/types.ts:200](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L200) ## Type Parameters diff --git a/docs/reference/type-aliases/SingleResult.md b/docs/reference/type-aliases/SingleResult.md index f0b9e74b8..7f8d4dd31 100644 --- a/docs/reference/type-aliases/SingleResult.md +++ b/docs/reference/type-aliases/SingleResult.md @@ -9,7 +9,7 @@ title: SingleResult type SingleResult = object; ``` -Defined in: [packages/db/src/types.ts:658](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L658) +Defined in: [packages/db/src/types.ts:658](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L658) ## Properties @@ -19,4 +19,4 @@ Defined in: [packages/db/src/types.ts:658](https://github.com/TanStack/db/blob/m singleResult: true; ``` -Defined in: [packages/db/src/types.ts:659](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L659) +Defined in: [packages/db/src/types.ts:659](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L659) diff --git a/docs/reference/type-aliases/Source.md b/docs/reference/type-aliases/Source.md index 3d5b59b01..8c6a24603 100644 --- a/docs/reference/type-aliases/Source.md +++ b/docs/reference/type-aliases/Source.md @@ -9,7 +9,7 @@ title: Source type Source = object; ``` -Defined in: [packages/db/src/query/builder/types.ts:75](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L75) +Defined in: [packages/db/src/query/builder/types.ts:75](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/types.ts#L75) Source - Input definition for query builder `from()` clause diff --git a/docs/reference/type-aliases/StandardSchema.md b/docs/reference/type-aliases/StandardSchema.md index d59b54f94..054adaf48 100644 --- a/docs/reference/type-aliases/StandardSchema.md +++ b/docs/reference/type-aliases/StandardSchema.md @@ -9,7 +9,7 @@ title: StandardSchema type StandardSchema = StandardSchemaV1 & object; ``` -Defined in: [packages/db/src/types.ts:336](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L336) +Defined in: [packages/db/src/types.ts:336](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L336) The Standard Schema interface. This follows the standard-schema specification: https://github.com/standard-schema/standard-schema diff --git a/docs/reference/type-aliases/StandardSchemaAlias.md b/docs/reference/type-aliases/StandardSchemaAlias.md index f2ac532e4..0ab624176 100644 --- a/docs/reference/type-aliases/StandardSchemaAlias.md +++ b/docs/reference/type-aliases/StandardSchemaAlias.md @@ -9,7 +9,7 @@ title: StandardSchemaAlias type StandardSchemaAlias = StandardSchema; ``` -Defined in: [packages/db/src/types.ts:348](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L348) +Defined in: [packages/db/src/types.ts:348](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L348) Type alias for StandardSchema diff --git a/docs/reference/type-aliases/StorageApi.md b/docs/reference/type-aliases/StorageApi.md index fde4dcad5..bb1001b24 100644 --- a/docs/reference/type-aliases/StorageApi.md +++ b/docs/reference/type-aliases/StorageApi.md @@ -9,6 +9,6 @@ title: StorageApi type StorageApi = Pick; ``` -Defined in: [packages/db/src/local-storage.ts:23](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L23) +Defined in: [packages/db/src/local-storage.ts:23](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L23) Storage API interface - subset of DOM Storage that we need diff --git a/docs/reference/type-aliases/StorageEventApi.md b/docs/reference/type-aliases/StorageEventApi.md index 4e3d8f10a..aa7aac6e9 100644 --- a/docs/reference/type-aliases/StorageEventApi.md +++ b/docs/reference/type-aliases/StorageEventApi.md @@ -9,7 +9,7 @@ title: StorageEventApi type StorageEventApi = object; ``` -Defined in: [packages/db/src/local-storage.ts:28](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L28) +Defined in: [packages/db/src/local-storage.ts:28](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L28) Storage event API - subset of Window for 'storage' events only @@ -21,7 +21,7 @@ Storage event API - subset of Window for 'storage' events only addEventListener: (type, listener) => void; ``` -Defined in: [packages/db/src/local-storage.ts:29](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L29) +Defined in: [packages/db/src/local-storage.ts:29](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L29) #### Parameters @@ -45,7 +45,7 @@ Defined in: [packages/db/src/local-storage.ts:29](https://github.com/TanStack/db removeEventListener: (type, listener) => void; ``` -Defined in: [packages/db/src/local-storage.ts:33](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L33) +Defined in: [packages/db/src/local-storage.ts:33](https://github.com/MAST1999/db/blob/main/packages/db/src/local-storage.ts#L33) #### Parameters diff --git a/docs/reference/type-aliases/Strategy.md b/docs/reference/type-aliases/Strategy.md index 561cefb37..87db8ccca 100644 --- a/docs/reference/type-aliases/Strategy.md +++ b/docs/reference/type-aliases/Strategy.md @@ -13,6 +13,6 @@ type Strategy = | BatchStrategy; ``` -Defined in: [packages/db/src/strategies/types.ts:113](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L113) +Defined in: [packages/db/src/strategies/types.ts:113](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L113) Union type of all available strategies diff --git a/docs/reference/type-aliases/StrategyOptions.md b/docs/reference/type-aliases/StrategyOptions.md index e4b212030..1ae9eb190 100644 --- a/docs/reference/type-aliases/StrategyOptions.md +++ b/docs/reference/type-aliases/StrategyOptions.md @@ -9,7 +9,7 @@ title: StrategyOptions type StrategyOptions = T extends DebounceStrategy ? DebounceStrategyOptions : T extends QueueStrategy ? QueueStrategyOptions : T extends ThrottleStrategy ? ThrottleStrategyOptions : T extends BatchStrategy ? BatchStrategyOptions : never; ``` -Defined in: [packages/db/src/strategies/types.ts:122](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/types.ts#L122) +Defined in: [packages/db/src/strategies/types.ts:122](https://github.com/MAST1999/db/blob/main/packages/db/src/strategies/types.ts#L122) Extract the options type from a strategy diff --git a/docs/reference/type-aliases/StringCollationConfig.md b/docs/reference/type-aliases/StringCollationConfig.md index 9ca2c7b15..41eb3562f 100644 --- a/docs/reference/type-aliases/StringCollationConfig.md +++ b/docs/reference/type-aliases/StringCollationConfig.md @@ -17,7 +17,7 @@ type StringCollationConfig = }; ``` -Defined in: [packages/db/src/types.ts:29](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L29) +Defined in: [packages/db/src/types.ts:29](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L29) StringSortOpts - Options for string sorting behavior diff --git a/docs/reference/type-aliases/SubscriptionEvents.md b/docs/reference/type-aliases/SubscriptionEvents.md index 9beb16a79..d94adea08 100644 --- a/docs/reference/type-aliases/SubscriptionEvents.md +++ b/docs/reference/type-aliases/SubscriptionEvents.md @@ -9,7 +9,7 @@ title: SubscriptionEvents type SubscriptionEvents = object; ``` -Defined in: [packages/db/src/types.ts:240](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L240) +Defined in: [packages/db/src/types.ts:240](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L240) All subscription events @@ -21,7 +21,7 @@ All subscription events status:change: SubscriptionStatusChangeEvent; ``` -Defined in: [packages/db/src/types.ts:241](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L241) +Defined in: [packages/db/src/types.ts:241](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L241) *** @@ -31,7 +31,7 @@ Defined in: [packages/db/src/types.ts:241](https://github.com/TanStack/db/blob/m status:loadingSubset: SubscriptionStatusEvent<"loadingSubset">; ``` -Defined in: [packages/db/src/types.ts:243](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L243) +Defined in: [packages/db/src/types.ts:243](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L243) *** @@ -41,7 +41,7 @@ Defined in: [packages/db/src/types.ts:243](https://github.com/TanStack/db/blob/m status:ready: SubscriptionStatusEvent<"ready">; ``` -Defined in: [packages/db/src/types.ts:242](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L242) +Defined in: [packages/db/src/types.ts:242](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L242) *** @@ -51,4 +51,4 @@ Defined in: [packages/db/src/types.ts:242](https://github.com/TanStack/db/blob/m unsubscribed: SubscriptionUnsubscribedEvent; ``` -Defined in: [packages/db/src/types.ts:244](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L244) +Defined in: [packages/db/src/types.ts:244](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L244) diff --git a/docs/reference/type-aliases/SubscriptionStatus.md b/docs/reference/type-aliases/SubscriptionStatus.md index b036e0b41..9e1d60a84 100644 --- a/docs/reference/type-aliases/SubscriptionStatus.md +++ b/docs/reference/type-aliases/SubscriptionStatus.md @@ -9,6 +9,6 @@ title: SubscriptionStatus type SubscriptionStatus = "ready" | "loadingSubset"; ``` -Defined in: [packages/db/src/types.ts:207](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L207) +Defined in: [packages/db/src/types.ts:207](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L207) Subscription status values diff --git a/docs/reference/type-aliases/SyncConfigRes.md b/docs/reference/type-aliases/SyncConfigRes.md index 6e0e64aca..0a488f1f8 100644 --- a/docs/reference/type-aliases/SyncConfigRes.md +++ b/docs/reference/type-aliases/SyncConfigRes.md @@ -9,7 +9,7 @@ title: SyncConfigRes type SyncConfigRes = object; ``` -Defined in: [packages/db/src/types.ts:280](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L280) +Defined in: [packages/db/src/types.ts:280](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L280) ## Properties @@ -19,7 +19,7 @@ Defined in: [packages/db/src/types.ts:280](https://github.com/TanStack/db/blob/m optional cleanup: CleanupFn; ``` -Defined in: [packages/db/src/types.ts:281](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L281) +Defined in: [packages/db/src/types.ts:281](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L281) *** @@ -29,7 +29,7 @@ Defined in: [packages/db/src/types.ts:281](https://github.com/TanStack/db/blob/m optional loadSubset: LoadSubsetFn; ``` -Defined in: [packages/db/src/types.ts:282](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L282) +Defined in: [packages/db/src/types.ts:282](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L282) *** @@ -39,4 +39,4 @@ Defined in: [packages/db/src/types.ts:282](https://github.com/TanStack/db/blob/m optional unloadSubset: UnloadSubsetFn; ``` -Defined in: [packages/db/src/types.ts:283](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L283) +Defined in: [packages/db/src/types.ts:283](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L283) diff --git a/docs/reference/type-aliases/SyncMode.md b/docs/reference/type-aliases/SyncMode.md index 6e72cfbf4..04a584375 100644 --- a/docs/reference/type-aliases/SyncMode.md +++ b/docs/reference/type-aliases/SyncMode.md @@ -9,4 +9,4 @@ title: SyncMode type SyncMode = "eager" | "on-demand"; ``` -Defined in: [packages/db/src/types.ts:436](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L436) +Defined in: [packages/db/src/types.ts:436](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L436) diff --git a/docs/reference/type-aliases/TransactionState.md b/docs/reference/type-aliases/TransactionState.md index 7f3c41897..b40fd87ac 100644 --- a/docs/reference/type-aliases/TransactionState.md +++ b/docs/reference/type-aliases/TransactionState.md @@ -9,4 +9,4 @@ title: TransactionState type TransactionState = "pending" | "persisting" | "completed" | "failed"; ``` -Defined in: [packages/db/src/types.ts:61](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L61) +Defined in: [packages/db/src/types.ts:61](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L61) diff --git a/docs/reference/type-aliases/TransactionWithMutations.md b/docs/reference/type-aliases/TransactionWithMutations.md index 493335cd9..e43b62fae 100644 --- a/docs/reference/type-aliases/TransactionWithMutations.md +++ b/docs/reference/type-aliases/TransactionWithMutations.md @@ -9,7 +9,7 @@ title: TransactionWithMutations type TransactionWithMutations = Omit, "mutations"> & object; ``` -Defined in: [packages/db/src/types.ts:139](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L139) +Defined in: [packages/db/src/types.ts:139](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L139) Utility type for a Transaction with at least one mutation This is used internally by the Transaction.commit method diff --git a/docs/reference/type-aliases/UnloadSubsetFn.md b/docs/reference/type-aliases/UnloadSubsetFn.md index 3a8eb3d37..b7824eed7 100644 --- a/docs/reference/type-aliases/UnloadSubsetFn.md +++ b/docs/reference/type-aliases/UnloadSubsetFn.md @@ -9,7 +9,7 @@ title: UnloadSubsetFn type UnloadSubsetFn = (options) => void; ``` -Defined in: [packages/db/src/types.ts:276](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L276) +Defined in: [packages/db/src/types.ts:276](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L276) ## Parameters diff --git a/docs/reference/type-aliases/UpdateMutationFn.md b/docs/reference/type-aliases/UpdateMutationFn.md index cda049813..8e165aaad 100644 --- a/docs/reference/type-aliases/UpdateMutationFn.md +++ b/docs/reference/type-aliases/UpdateMutationFn.md @@ -9,7 +9,7 @@ title: UpdateMutationFn type UpdateMutationFn = (params) => Promise; ``` -Defined in: [packages/db/src/types.ts:395](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L395) +Defined in: [packages/db/src/types.ts:395](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L395) ## Type Parameters diff --git a/docs/reference/type-aliases/UpdateMutationFnParams.md b/docs/reference/type-aliases/UpdateMutationFnParams.md index 56e33c0e0..c873305c4 100644 --- a/docs/reference/type-aliases/UpdateMutationFnParams.md +++ b/docs/reference/type-aliases/UpdateMutationFnParams.md @@ -9,7 +9,7 @@ title: UpdateMutationFnParams type UpdateMutationFnParams = object; ``` -Defined in: [packages/db/src/types.ts:362](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L362) +Defined in: [packages/db/src/types.ts:362](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L362) ## Type Parameters @@ -33,7 +33,7 @@ Defined in: [packages/db/src/types.ts:362](https://github.com/TanStack/db/blob/m collection: Collection; ``` -Defined in: [packages/db/src/types.ts:368](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L368) +Defined in: [packages/db/src/types.ts:368](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L368) *** @@ -43,4 +43,4 @@ Defined in: [packages/db/src/types.ts:368](https://github.com/TanStack/db/blob/m transaction: TransactionWithMutations; ``` -Defined in: [packages/db/src/types.ts:367](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L367) +Defined in: [packages/db/src/types.ts:367](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L367) diff --git a/docs/reference/type-aliases/UtilsRecord.md b/docs/reference/type-aliases/UtilsRecord.md index b2835a0a8..1a9861e99 100644 --- a/docs/reference/type-aliases/UtilsRecord.md +++ b/docs/reference/type-aliases/UtilsRecord.md @@ -9,6 +9,6 @@ title: UtilsRecord type UtilsRecord = Record; ``` -Defined in: [packages/db/src/types.ts:71](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L71) +Defined in: [packages/db/src/types.ts:71](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L71) A record of utilities (functions or getters) that can be attached to a collection diff --git a/docs/reference/type-aliases/WritableDeep.md b/docs/reference/type-aliases/WritableDeep.md index fd6c796ed..946e50659 100644 --- a/docs/reference/type-aliases/WritableDeep.md +++ b/docs/reference/type-aliases/WritableDeep.md @@ -9,7 +9,7 @@ title: WritableDeep type WritableDeep = T extends BuiltIns ? T : T extends (...arguments_) => unknown ? object extends WritableObjectDeep ? T : HasMultipleCallSignatures extends true ? T : (...arguments_) => ReturnType & WritableObjectDeep : T extends ReadonlyMap ? WritableMapDeep : T extends ReadonlySet ? WritableSetDeep : T extends ReadonlyArray ? WritableArrayDeep : T extends object ? WritableObjectDeep : unknown; ``` -Defined in: [packages/db/src/types.ts:840](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L840) +Defined in: [packages/db/src/types.ts:840](https://github.com/MAST1999/db/blob/main/packages/db/src/types.ts#L840) ## Type Parameters diff --git a/docs/reference/variables/IndexOperation.md b/docs/reference/variables/IndexOperation.md index e0ec16ffa..7342d7609 100644 --- a/docs/reference/variables/IndexOperation.md +++ b/docs/reference/variables/IndexOperation.md @@ -9,6 +9,6 @@ title: IndexOperation const IndexOperation: readonly ["eq", "gt", "gte", "lt", "lte", "in", "like", "ilike"] = comparisonFunctions; ``` -Defined in: [packages/db/src/indexes/base-index.ts:11](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L11) +Defined in: [packages/db/src/indexes/base-index.ts:11](https://github.com/MAST1999/db/blob/main/packages/db/src/indexes/base-index.ts#L11) Operations that indexes can support, imported from available comparison functions diff --git a/docs/reference/variables/Query.md b/docs/reference/variables/Query.md index aaa030d17..6f965e618 100644 --- a/docs/reference/variables/Query.md +++ b/docs/reference/variables/Query.md @@ -9,4 +9,4 @@ title: Query const Query: InitialQueryBuilderConstructor = BaseQueryBuilder; ``` -Defined in: [packages/db/src/query/builder/index.ts:857](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L857) +Defined in: [packages/db/src/query/builder/index.ts:857](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/index.ts#L857) diff --git a/docs/reference/variables/operators.md b/docs/reference/variables/operators.md index 1d6471cc9..8aa7a8b2c 100644 --- a/docs/reference/variables/operators.md +++ b/docs/reference/variables/operators.md @@ -9,6 +9,6 @@ title: operators const operators: readonly ["eq", "gt", "gte", "lt", "lte", "in", "like", "ilike", "and", "or", "not", "isNull", "isUndefined", "upper", "lower", "length", "concat", "add", "coalesce", "count", "avg", "sum", "min", "max"]; ``` -Defined in: [packages/db/src/query/builder/functions.ts:344](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/functions.ts#L344) +Defined in: [packages/db/src/query/builder/functions.ts:344](https://github.com/MAST1999/db/blob/main/packages/db/src/query/builder/functions.ts#L344) All supported operator names in TanStack DB expressions