From 9b719dea19d784cc0f77c55a828e6153e48ea2b7 Mon Sep 17 00:00:00 2001 From: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com> Date: Fri, 5 Dec 2025 21:46:48 +1100 Subject: [PATCH] docs: correct local relative links --- docs/framework/angular/overview.md | 4 +- .../reference/functions/injectLiveQuery.md | 12 +- docs/framework/angular/reference/index.md | 4 +- docs/framework/react/overview.md | 4 +- .../functions/useLiveInfiniteQuery.md | 8 +- docs/framework/react/reference/index.md | 14 +- docs/framework/solid/overview.md | 4 +- docs/framework/solid/reference/index.md | 2 +- docs/framework/svelte/overview.md | 2 +- docs/framework/vue/overview.md | 4 +- .../vue/reference/functions/useLiveQuery.md | 8 +- docs/framework/vue/reference/index.md | 6 +- docs/guides/error-handling.md | 6 +- docs/guides/live-queries.md | 4 +- docs/overview.md | 30 +- docs/quick-start.md | 6 +- .../namespaces/IR/classes/Aggregate.md | 2 +- .../namespaces/IR/classes/CollectionRef.md | 2 +- .../@tanstack/namespaces/IR/classes/Func.md | 2 +- .../namespaces/IR/classes/QueryRef.md | 2 +- .../IR/functions/createResidualWhere.md | 4 +- .../namespaces/IR/functions/followRef.md | 8 +- .../IR/functions/getHavingExpression.md | 6 +- .../IR/functions/getWhereExpression.md | 4 +- .../IR/functions/isResidualWhere.md | 2 +- .../@tanstack/namespaces/IR/index.md | 52 +- .../namespaces/IR/interfaces/QueryIR.md | 6 +- .../AggregateFunctionNotInSelectError.md | 18 +- .../classes/AggregateNotSupportedError.md | 18 +- docs/reference/classes/BTreeIndex.md | 84 +-- docs/reference/classes/BaseIndex.md | 58 +- docs/reference/classes/BaseQueryBuilder.md | 56 +- .../CannotCombineEmptyExpressionListError.md | 18 +- .../classes/CollectionConfigurationError.md | 26 +- docs/reference/classes/CollectionImpl.md | 46 +- .../classes/CollectionInErrorStateError.md | 18 +- .../classes/CollectionInputNotFoundError.md | 18 +- .../classes/CollectionIsInErrorStateError.md | 18 +- .../classes/CollectionOperationError.md | 36 +- .../classes/CollectionRequiresConfigError.md | 18 +- .../CollectionRequiresSyncConfigError.md | 18 +- .../reference/classes/CollectionStateError.md | 26 +- .../classes/DeduplicatedLoadSubset.md | 2 +- .../classes/DeleteKeyNotFoundError.md | 18 +- .../classes/DistinctRequiresSelectError.md | 18 +- .../classes/DuplicateAliasInSubqueryError.md | 18 +- .../classes/DuplicateDbInstanceError.md | 18 +- docs/reference/classes/DuplicateKeyError.md | 18 +- .../classes/DuplicateKeySyncError.md | 18 +- .../classes/EmptyReferencePathError.md | 18 +- docs/reference/classes/GroupByError.md | 26 +- .../classes/HavingRequiresGroupByError.md | 18 +- docs/reference/classes/IndexProxy.md | 12 +- .../InvalidCollectionStatusTransitionError.md | 18 +- .../reference/classes/InvalidJoinCondition.md | 18 +- .../InvalidJoinConditionLeftSourceError.md | 18 +- .../InvalidJoinConditionRightSourceError.md | 18 +- .../InvalidJoinConditionSameSourceError.md | 18 +- ...InvalidJoinConditionSourceMismatchError.md | 18 +- docs/reference/classes/InvalidSchemaError.md | 18 +- docs/reference/classes/InvalidSourceError.md | 18 +- .../classes/InvalidSourceTypeError.md | 18 +- .../classes/InvalidStorageDataFormatError.md | 18 +- .../InvalidStorageObjectFormatError.md | 18 +- .../classes/JoinCollectionNotFoundError.md | 18 +- .../JoinConditionMustBeEqualityError.md | 18 +- docs/reference/classes/JoinError.md | 32 +- .../classes/KeyUpdateNotAllowedError.md | 18 +- docs/reference/classes/LazyIndexWrapper.md | 10 +- .../classes/LimitOffsetRequireOrderByError.md | 18 +- .../classes/LocalStorageCollectionError.md | 24 +- .../classes/MissingAliasInputsError.md | 18 +- .../classes/MissingDeleteHandlerError.md | 18 +- docs/reference/classes/MissingHandlerError.md | 24 +- .../classes/MissingInsertHandlerError.md | 18 +- .../classes/MissingMutationFunctionError.md | 18 +- .../classes/MissingUpdateArgumentError.md | 18 +- .../classes/MissingUpdateHandlerError.md | 18 +- .../classes/NegativeActiveSubscribersError.md | 18 +- .../classes/NoKeysPassedToDeleteError.md | 18 +- .../classes/NoKeysPassedToUpdateError.md | 18 +- .../NoPendingSyncTransactionCommitError.md | 18 +- .../NoPendingSyncTransactionWriteError.md | 18 +- ...NonAggregateExpressionNotInGroupByError.md | 18 +- docs/reference/classes/NonRetriableError.md | 18 +- .../classes/OnMutateMustBeSynchronousError.md | 18 +- .../classes/OnlyOneSourceAllowedError.md | 18 +- docs/reference/classes/QueryBuilderError.md | 30 +- .../classes/QueryCompilationError.md | 46 +- .../classes/QueryMustHaveFromClauseError.md | 18 +- docs/reference/classes/QueryOptimizerError.md | 22 +- .../classes/SchemaMustBeSynchronousError.md | 18 +- .../classes/SchemaValidationError.md | 18 +- docs/reference/classes/SerializationError.md | 18 +- .../classes/SetWindowRequiresOrderByError.md | 18 +- docs/reference/classes/StorageError.md | 22 +- .../classes/StorageKeyRequiredError.md | 18 +- .../SubQueryMustHaveFromClauseError.md | 18 +- .../classes/SubscriptionNotFoundError.md | 18 +- docs/reference/classes/SyncCleanupError.md | 18 +- .../SyncTransactionAlreadyCommittedError.md | 18 +- ...ncTransactionAlreadyCommittedWriteError.md | 18 +- docs/reference/classes/TanStackDBError.md | 30 +- ...ransactionAlreadyCompletedRollbackError.md | 18 +- docs/reference/classes/TransactionError.md | 36 +- .../TransactionNotPendingCommitError.md | 18 +- .../TransactionNotPendingMutateError.md | 18 +- docs/reference/classes/UndefinedKeyError.md | 18 +- .../classes/UnknownExpressionTypeError.md | 18 +- .../reference/classes/UnknownFunctionError.md | 18 +- .../UnknownHavingExpressionTypeError.md | 18 +- .../UnsupportedAggregateFunctionError.md | 18 +- .../classes/UnsupportedFromTypeError.md | 18 +- .../classes/UnsupportedJoinSourceTypeError.md | 18 +- .../classes/UnsupportedJoinTypeError.md | 18 +- .../classes/UpdateKeyNotFoundError.md | 18 +- .../classes/WhereClauseConversionError.md | 18 +- .../classes/ElectricDBCollectionError.md | 8 +- .../classes/ExpectedNumberInAwaitTxIdError.md | 18 +- .../classes/StreamAbortedError.md | 18 +- .../classes/TimeoutWaitingForMatchError.md | 18 +- .../classes/TimeoutWaitingForTxIdError.md | 18 +- .../functions/electricCollectionOptions.md | 4 +- .../reference/electric-db-collection/index.md | 20 +- .../interfaces/ElectricCollectionConfig.md | 8 +- .../type-aliases/AwaitTxIdFn.md | 2 +- docs/reference/functions/and.md | 4 +- docs/reference/functions/coalesce.md | 2 +- docs/reference/functions/compileQuery.md | 6 +- docs/reference/functions/concat.md | 2 +- docs/reference/functions/count.md | 2 +- docs/reference/functions/createCollection.md | 48 +- .../functions/createLiveQueryCollection.md | 10 +- .../functions/createOptimisticAction.md | 4 +- .../functions/createPacedMutations.md | 4 +- docs/reference/functions/createTransaction.md | 4 +- docs/reference/functions/debounceStrategy.md | 4 +- docs/reference/functions/eq.md | 8 +- docs/reference/functions/extractFieldPath.md | 2 +- .../functions/extractSimpleComparisons.md | 2 +- .../functions/getActiveTransaction.md | 2 +- docs/reference/functions/gt.md | 8 +- docs/reference/functions/gte.md | 8 +- docs/reference/functions/ilike.md | 2 +- docs/reference/functions/inArray.md | 2 +- docs/reference/functions/isNull.md | 2 +- docs/reference/functions/isOrderBySubset.md | 4 +- docs/reference/functions/isPredicateSubset.md | 4 +- docs/reference/functions/isUndefined.md | 2 +- docs/reference/functions/isWhereSubset.md | 4 +- docs/reference/functions/like.md | 2 +- .../functions/liveQueryCollectionOptions.md | 4 +- .../functions/localOnlyCollectionOptions.md | 8 +- .../localStorageCollectionOptions.md | 8 +- docs/reference/functions/lt.md | 8 +- docs/reference/functions/lte.md | 8 +- .../functions/minusWherePredicates.md | 6 +- docs/reference/functions/not.md | 2 +- docs/reference/functions/or.md | 4 +- .../functions/parseLoadSubsetOptions.md | 2 +- .../functions/parseOrderByExpression.md | 4 +- .../functions/parseWhereExpression.md | 2 +- docs/reference/functions/queueStrategy.md | 4 +- docs/reference/functions/throttleStrategy.md | 4 +- .../functions/unionWherePredicates.md | 4 +- docs/reference/index.md | 508 +++++++++--------- .../interfaces/BaseCollectionConfig.md | 6 +- docs/reference/interfaces/BaseStrategy.md | 8 +- docs/reference/interfaces/ChangeMessage.md | 2 +- docs/reference/interfaces/Collection.md | 132 ++--- docs/reference/interfaces/CollectionConfig.md | 30 +- docs/reference/interfaces/CollectionLike.md | 6 +- .../CreateOptimisticActionsOptions.md | 6 +- docs/reference/interfaces/DebounceStrategy.md | 10 +- docs/reference/interfaces/IndexInterface.md | 8 +- docs/reference/interfaces/IndexOptions.md | 2 +- .../interfaces/LiveQueryCollectionConfig.md | 4 +- .../interfaces/LocalOnlyCollectionConfig.md | 8 +- .../interfaces/LocalOnlyCollectionUtils.md | 4 +- .../LocalStorageCollectionConfig.md | 28 +- .../interfaces/LocalStorageCollectionUtils.md | 4 +- .../interfaces/OptimisticChangeMessage.md | 12 +- docs/reference/interfaces/PendingMutation.md | 4 +- docs/reference/interfaces/QueueStrategy.md | 10 +- .../SubscribeChangesSnapshotOptions.md | 4 +- docs/reference/interfaces/Subscription.md | 16 +- .../interfaces/SubscriptionStatusEvent.md | 2 +- docs/reference/interfaces/SyncConfig.md | 6 +- docs/reference/interfaces/ThrottleStrategy.md | 10 +- docs/reference/interfaces/Transaction.md | 4 +- .../classes/PowerSyncTransactor.md | 2 +- .../functions/powerSyncCollectionOptions.md | 10 +- .../powersync-db-collection/index.md | 30 +- .../BasePowerSyncCollectionConfig.md | 2 +- .../type-aliases/PowerSyncCollectionUtils.md | 2 +- .../type-aliases/SerializerConfig.md | 2 +- .../variables/DEFAULT_BATCH_SIZE.md | 2 +- .../DeleteOperationItemNotFoundError.md | 18 +- .../classes/DuplicateKeyInBatchError.md | 18 +- .../classes/GetKeyRequiredError.md | 18 +- .../classes/InvalidItemStructureError.md | 18 +- .../classes/InvalidSyncOperationError.md | 18 +- .../classes/ItemNotFoundError.md | 18 +- .../classes/MissingKeyFieldError.md | 18 +- .../classes/QueryClientRequiredError.md | 18 +- .../classes/QueryCollectionError.md | 26 +- .../classes/QueryFnRequiredError.md | 18 +- .../classes/QueryKeyRequiredError.md | 18 +- .../classes/SyncNotInitializedError.md | 18 +- .../classes/UnknownOperationTypeError.md | 18 +- .../UpdateOperationItemNotFoundError.md | 18 +- .../functions/queryCollectionOptions.md | 16 +- docs/reference/query-db-collection/index.md | 38 +- docs/reference/type-aliases/ChangeListener.md | 2 +- .../CollectionConfigSingleRowOption.md | 2 +- .../type-aliases/DeleteMutationFn.md | 4 +- .../type-aliases/DeleteMutationFnParams.md | 2 +- docs/reference/type-aliases/GetResult.md | 2 +- .../type-aliases/IndexConstructor.md | 4 +- .../reference/type-aliases/InferResultType.md | 2 +- .../type-aliases/InsertMutationFn.md | 4 +- .../type-aliases/InsertMutationFnParams.md | 2 +- docs/reference/type-aliases/LoadSubsetFn.md | 2 +- docs/reference/type-aliases/MutationFn.md | 2 +- docs/reference/type-aliases/QueryBuilder.md | 2 +- .../type-aliases/ResolveTransactionChanges.md | 2 +- .../reference/type-aliases/StrategyOptions.md | 2 +- .../type-aliases/TransactionWithMutations.md | 2 +- docs/reference/type-aliases/UnloadSubsetFn.md | 2 +- .../type-aliases/UpdateMutationFn.md | 4 +- .../type-aliases/UpdateMutationFnParams.md | 2 +- eslint.config.js | 2 +- package.json | 4 +- packages/angular-db/vite.config.ts | 2 +- packages/db-ivm/vite.config.ts | 2 +- packages/db/vite.config.ts | 2 +- .../electric-db-collection/vite.config.ts | 2 +- packages/offline-transactions/vite.config.ts | 2 +- .../powersync-db-collection/vite.config.ts | 2 +- packages/query-db-collection/vite.config.ts | 2 +- packages/react-db/vite.config.ts | 2 +- packages/rxdb-db-collection/vite.config.ts | 2 +- packages/solid-db/vite.config.ts | 2 +- .../trailbase-db-collection/vite.config.ts | 2 +- packages/vue-db/vite.config.ts | 2 +- pnpm-lock.yaml | 192 +------ scripts/generate-docs.ts | 30 +- scripts/verify-links.ts | 104 ++-- 248 files changed, 1915 insertions(+), 2123 deletions(-) diff --git a/docs/framework/angular/overview.md b/docs/framework/angular/overview.md index 15adcaf6c..0d6740b49 100644 --- a/docs/framework/angular/overview.md +++ b/docs/framework/angular/overview.md @@ -11,9 +11,9 @@ npm install @tanstack/angular-db ## Angular inject function -See the [Angular Functions Reference](../reference/index.md) to see the full list of functions available in the Angular Adapter. +See the [Angular Functions Reference](./reference/index.md) to see the full list of functions available in the Angular Adapter. -For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries). +For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries). ## Basic Usage diff --git a/docs/framework/angular/reference/functions/injectLiveQuery.md b/docs/framework/angular/reference/functions/injectLiveQuery.md index f5becd93c..46660544b 100644 --- a/docs/framework/angular/reference/functions/injectLiveQuery.md +++ b/docs/framework/angular/reference/functions/injectLiveQuery.md @@ -37,7 +37,7 @@ Defined in: [index.ts:51](https://github.com/TanStack/db/blob/main/packages/angu ### Returns -[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> +[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> ## Call Signature @@ -71,7 +71,7 @@ Defined in: [index.ts:61](https://github.com/TanStack/db/blob/main/packages/angu ### Returns -[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> +[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> ## Call Signature @@ -95,7 +95,7 @@ Defined in: [index.ts:71](https://github.com/TanStack/db/blob/main/packages/angu ### Returns -[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> +[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> ## Call Signature @@ -119,7 +119,7 @@ Defined in: [index.ts:74](https://github.com/TanStack/db/blob/main/packages/angu ### Returns -[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> +[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> ## Call Signature @@ -143,7 +143,7 @@ Defined in: [index.ts:77](https://github.com/TanStack/db/blob/main/packages/angu ### Returns -[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> +[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> ## Call Signature @@ -175,4 +175,4 @@ Defined in: [index.ts:80](https://github.com/TanStack/db/blob/main/packages/angu ### Returns -[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<`TResult`, `TKey`, `TUtils`\> +[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<`TResult`, `TKey`, `TUtils`\> diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index 3dfb77c21..28f54dc29 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -7,8 +7,8 @@ title: "@tanstack/angular-db" ## Interfaces -- [InjectLiveQueryResult](../interfaces/InjectLiveQueryResult.md) +- [InjectLiveQueryResult](./interfaces/InjectLiveQueryResult.md) ## Functions -- [injectLiveQuery](../functions/injectLiveQuery.md) +- [injectLiveQuery](./functions/injectLiveQuery.md) diff --git a/docs/framework/react/overview.md b/docs/framework/react/overview.md index 0e53916f9..69dbff6cf 100644 --- a/docs/framework/react/overview.md +++ b/docs/framework/react/overview.md @@ -11,9 +11,9 @@ npm install @tanstack/react-db ## React Hooks -See the [React Functions Reference](../reference/index.md) to see the full list of hooks available in the React Adapter. +See the [React Functions Reference](./reference/index.md) to see the full list of hooks available in the React Adapter. -For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries). +For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries). ## Basic Usage diff --git a/docs/framework/react/reference/functions/useLiveInfiniteQuery.md b/docs/framework/react/reference/functions/useLiveInfiniteQuery.md index 49f258cf6..8fe91f730 100644 --- a/docs/framework/react/reference/functions/useLiveInfiniteQuery.md +++ b/docs/framework/react/reference/functions/useLiveInfiniteQuery.md @@ -40,13 +40,13 @@ without recreating the live query collection on each page change. #### config -[`UseLiveInfiniteQueryConfig`](../../type-aliases/UseLiveInfiniteQueryConfig.md)\<`any`\> +[`UseLiveInfiniteQueryConfig`](../type-aliases/UseLiveInfiniteQueryConfig.md)\<`any`\> Configuration including pageSize and getNextPageParam ### Returns -[`UseLiveInfiniteQueryReturn`](../../type-aliases/UseLiveInfiniteQueryReturn.md)\<`any`\> +[`UseLiveInfiniteQueryReturn`](../type-aliases/UseLiveInfiniteQueryReturn.md)\<`any`\> Object with pages, data, and pagination controls @@ -141,7 +141,7 @@ Query function that defines what data to fetch. Must include `.orderBy()` for se #### config -[`UseLiveInfiniteQueryConfig`](../../type-aliases/UseLiveInfiniteQueryConfig.md)\<`TContext`\> +[`UseLiveInfiniteQueryConfig`](../type-aliases/UseLiveInfiniteQueryConfig.md)\<`TContext`\> Configuration including pageSize and getNextPageParam @@ -153,7 +153,7 @@ Array of dependencies that trigger query re-execution when changed ### Returns -[`UseLiveInfiniteQueryReturn`](../../type-aliases/UseLiveInfiniteQueryReturn.md)\<`TContext`\> +[`UseLiveInfiniteQueryReturn`](../type-aliases/UseLiveInfiniteQueryReturn.md)\<`TContext`\> Object with pages, data, and pagination controls diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md index f60a0261c..cb80c9a2e 100644 --- a/docs/framework/react/reference/index.md +++ b/docs/framework/react/reference/index.md @@ -7,13 +7,13 @@ title: "@tanstack/react-db" ## Type Aliases -- [UseLiveInfiniteQueryConfig](../type-aliases/UseLiveInfiniteQueryConfig.md) -- [UseLiveInfiniteQueryReturn](../type-aliases/UseLiveInfiniteQueryReturn.md) -- [UseLiveQueryStatus](../type-aliases/UseLiveQueryStatus.md) +- [UseLiveInfiniteQueryConfig](./type-aliases/UseLiveInfiniteQueryConfig.md) +- [UseLiveInfiniteQueryReturn](./type-aliases/UseLiveInfiniteQueryReturn.md) +- [UseLiveQueryStatus](./type-aliases/UseLiveQueryStatus.md) ## Functions -- [useLiveInfiniteQuery](../functions/useLiveInfiniteQuery.md) -- [useLiveQuery](../functions/useLiveQuery.md) -- [useLiveSuspenseQuery](../functions/useLiveSuspenseQuery.md) -- [usePacedMutations](../functions/usePacedMutations.md) +- [useLiveInfiniteQuery](./functions/useLiveInfiniteQuery.md) +- [useLiveQuery](./functions/useLiveQuery.md) +- [useLiveSuspenseQuery](./functions/useLiveSuspenseQuery.md) +- [usePacedMutations](./functions/usePacedMutations.md) diff --git a/docs/framework/solid/overview.md b/docs/framework/solid/overview.md index d7781bfbc..3f2c5e6fa 100644 --- a/docs/framework/solid/overview.md +++ b/docs/framework/solid/overview.md @@ -11,9 +11,9 @@ npm install @tanstack/solid-db ## Solid Primitives -See the [Solid Functions Reference](../reference/index.md) to see the full list of primitives available in the Solid Adapter. +See the [Solid Functions Reference](./reference/index.md) to see the full list of primitives available in the Solid Adapter. -For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries). +For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries). ## Basic Usage diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index c44007f86..dccd217f5 100644 --- a/docs/framework/solid/reference/index.md +++ b/docs/framework/solid/reference/index.md @@ -7,4 +7,4 @@ title: "@tanstack/solid-db" ## Functions -- [useLiveQuery](../functions/useLiveQuery.md) +- [useLiveQuery](./functions/useLiveQuery.md) diff --git a/docs/framework/svelte/overview.md b/docs/framework/svelte/overview.md index aeaa8cd95..f7497d0e7 100644 --- a/docs/framework/svelte/overview.md +++ b/docs/framework/svelte/overview.md @@ -11,7 +11,7 @@ npm install @tanstack/svelte-db ## Svelte Utilities -See the [Svelte Functions Reference](../reference/index.md) to see the full list of utilities available in the Svelte Adapter. +See the [Svelte Functions Reference](./reference/index.md) to see the full list of utilities available in the Svelte Adapter. For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries). diff --git a/docs/framework/vue/overview.md b/docs/framework/vue/overview.md index f4b2a3f6d..2e42cf8a1 100644 --- a/docs/framework/vue/overview.md +++ b/docs/framework/vue/overview.md @@ -11,9 +11,9 @@ npm install @tanstack/vue-db ## Vue Composables -See the [Vue Functions Reference](../reference/index.md) to see the full list of composables available in the Vue Adapter. +See the [Vue Functions Reference](./reference/index.md) to see the full list of composables available in the Vue Adapter. -For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../../guides/live-queries). +For comprehensive documentation on writing queries (filtering, joins, aggregations, etc.), see the [Live Queries Guide](../guides/live-queries). ## Basic Usage diff --git a/docs/framework/vue/reference/functions/useLiveQuery.md b/docs/framework/vue/reference/functions/useLiveQuery.md index b9a384cd8..b00e512e5 100644 --- a/docs/framework/vue/reference/functions/useLiveQuery.md +++ b/docs/framework/vue/reference/functions/useLiveQuery.md @@ -37,7 +37,7 @@ Array of reactive dependencies that trigger query re-execution when changed ### Returns -[`UseLiveQueryReturn`](../../interfaces/UseLiveQueryReturn.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> +[`UseLiveQueryReturn`](../interfaces/UseLiveQueryReturn.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> Reactive object with query data, state, and status information @@ -123,7 +123,7 @@ Array of reactive dependencies that trigger query re-execution when changed ### Returns -[`UseLiveQueryReturn`](../../interfaces/UseLiveQueryReturn.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> +[`UseLiveQueryReturn`](../interfaces/UseLiveQueryReturn.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> Reactive object with query data, state, and status information @@ -209,7 +209,7 @@ Array of reactive dependencies that trigger query re-execution when changed ### Returns -[`UseLiveQueryReturn`](../../interfaces/UseLiveQueryReturn.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> +[`UseLiveQueryReturn`](../interfaces/UseLiveQueryReturn.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\> Reactive object with query data, state, and status information @@ -279,7 +279,7 @@ Pre-created query collection to subscribe to (can be a ref) ### Returns -[`UseLiveQueryReturnWithCollection`](../../interfaces/UseLiveQueryReturnWithCollection.md)\<`TResult`, `TKey`, `TUtils`\> +[`UseLiveQueryReturnWithCollection`](../interfaces/UseLiveQueryReturnWithCollection.md)\<`TResult`, `TKey`, `TUtils`\> Reactive object with query data, state, and status information diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md index d9fc4a358..6a731310e 100644 --- a/docs/framework/vue/reference/index.md +++ b/docs/framework/vue/reference/index.md @@ -7,9 +7,9 @@ title: "@tanstack/vue-db" ## Interfaces -- [UseLiveQueryReturn](../interfaces/UseLiveQueryReturn.md) -- [UseLiveQueryReturnWithCollection](../interfaces/UseLiveQueryReturnWithCollection.md) +- [UseLiveQueryReturn](./interfaces/UseLiveQueryReturn.md) +- [UseLiveQueryReturnWithCollection](./interfaces/UseLiveQueryReturnWithCollection.md) ## Functions -- [useLiveQuery](../functions/useLiveQuery.md) +- [useLiveQuery](./functions/useLiveQuery.md) diff --git a/docs/guides/error-handling.md b/docs/guides/error-handling.md index 8f6573d7b..dfd4fa0b8 100644 --- a/docs/guides/error-handling.md +++ b/docs/guides/error-handling.md @@ -177,7 +177,7 @@ const App = () => ( ) ``` -With this approach, loading states are handled by `` and error states are handled by `` instead of within your component logic. See the [React Suspense section in Live Queries](../live-queries#using-with-react-suspense) for more details. +With this approach, loading states are handled by `` and error states are handled by `` instead of within your component logic. See the [React Suspense section in Live Queries](./live-queries#using-with-react-suspense) for more details. ## Transaction Error Handling @@ -810,6 +810,6 @@ const TodoApp = () => { ## See Also -- [API Reference](../../overview.md#api-reference) - Detailed API documentation -- [Mutations Guide](../../overview.md#making-optimistic-mutations) - Learn about optimistic updates and rollbacks +- [API Reference](../overview.md#api-reference) - Detailed API documentation +- [Mutations Guide](../overview.md#making-optimistic-mutations) - Learn about optimistic updates and rollbacks - [TanStack Query Error Handling](https://tanstack.com/query/latest/docs/react/guides/error-handling) - Query-specific error handling diff --git a/docs/guides/live-queries.md b/docs/guides/live-queries.md index f02c68d22..1c83fec5a 100644 --- a/docs/guides/live-queries.md +++ b/docs/guides/live-queries.md @@ -161,9 +161,9 @@ export class UserListComponent { } ``` -> **Note:** React hooks (`useLiveQuery`, `useLiveInfiniteQuery`, `useLiveSuspenseQuery`) accept an optional dependency array parameter to re-execute queries when values change, similar to React's `useEffect`. See the [React Adapter documentation](../../framework/react/adapter#dependency-arrays) for details on when and how to use dependency arrays. +> **Note:** React hooks (`useLiveQuery`, `useLiveInfiniteQuery`, `useLiveSuspenseQuery`) accept an optional dependency array parameter to re-execute queries when values change, similar to React's `useEffect`. See the [React Adapter documentation](../framework/react/adapter#dependency-arrays) for details on when and how to use dependency arrays. -For more details on framework integration, see the [React](../../framework/react/adapter), [Vue](../../framework/vue/adapter), and [Angular](../../framework/angular/adapter) adapter documentation. +For more details on framework integration, see the [React](../framework/react/adapter), [Vue](../framework/vue/adapter), and [Angular](../framework/angular/adapter) adapter documentation. ### Using with React Suspense diff --git a/docs/overview.md b/docs/overview.md index 3f068b7c8..8af0254c3 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -87,7 +87,7 @@ Collections can be populated in many ways, including: - fetching data, for example [from API endpoints using TanStack Query](https://tanstack.com/query/latest) - syncing data, for example [using a sync engine like ElectricSQL](https://electric-sql.com/) -- storing local data, for example [using localStorage for user preferences and settings](../collections/local-storage-collection.md) or [in-memory client data or UI state](../collections/local-only-collection.md) +- storing local data, for example [using localStorage for user preferences and settings](./collections/local-storage-collection.md) or [in-memory client data or UI state](./collections/local-only-collection.md) - from live collection queries, creating [derived collections as materialised views](#using-live-queries) Once you have your data in collections, you can query across them using live queries in your components. @@ -118,7 +118,7 @@ const productsCollection = createCollection( TanStack DB automatically collapses duplicate requests, performs delta loading when expanding queries, optimizes joins into minimal batched requests, and respects your TanStack Query cache policies. You often end up with _fewer_ network requests than custom view-specific APIs. -See the [Query Collection documentation](../collections/query-collection.md#queryfn-and-predicate-push-down) for full predicate mapping details. +See the [Query Collection documentation](./collections/query-collection.md#queryfn-and-predicate-push-down) for full predicate mapping details. ### Using live queries @@ -135,7 +135,7 @@ Live queries support joins across collections. This allows you to: Every query returns another collection which can _also_ be queried. -For more details on live queries, see the [Live Queries](../guides/live-queries.md) documentation. +For more details on live queries, see the [Live Queries](./guides/live-queries.md) documentation. ### Making optimistic mutations @@ -162,7 +162,7 @@ The collection maintains optimistic state separately from synced data. When live The optimistic state is held until the handler resolves, at which point the data is persisted to the server and synced back. If the handler throws an error, the optimistic state is rolled back. -For more complex mutations, you can create custom actions with `createOptimisticAction` or custom transactions with `createTransaction`. See the [Mutations guide](../guides/mutations.md) for details. +For more complex mutations, you can create custom actions with `createOptimisticAction` or custom transactions with `createTransaction`. See the [Mutations guide](./guides/mutations.md) for details. ### Uni-directional data flow @@ -186,23 +186,23 @@ TanStack DB provides several built-in collection types for different data source **Fetch Collections** -- **[QueryCollection](../collections/query-collection.md)** — Load data into collections using TanStack Query for REST APIs and data fetching. +- **[QueryCollection](./collections/query-collection.md)** — Load data into collections using TanStack Query for REST APIs and data fetching. **Sync Collections** -- **[ElectricCollection](../collections/electric-collection.md)** — Sync data into collections from Postgres using ElectricSQL's real-time sync engine. +- **[ElectricCollection](./collections/electric-collection.md)** — Sync data into collections from Postgres using ElectricSQL's real-time sync engine. -- **[TrailBaseCollection](../collections/trailbase-collection.md)** — Sync data into collections using TrailBase's self-hosted backend with real-time subscriptions. +- **[TrailBaseCollection](./collections/trailbase-collection.md)** — Sync data into collections using TrailBase's self-hosted backend with real-time subscriptions. -- **[RxDBCollection](../collections/rxdb-collection.md)** — Integrate with RxDB for offline-first local persistence with powerful replication and sync capabilities. +- **[RxDBCollection](./collections/rxdb-collection.md)** — Integrate with RxDB for offline-first local persistence with powerful replication and sync capabilities. -- **[PowerSyncCollection](../collections/powersync-collection.md)** — Sync with PowerSync's SQLite-based database for offline-first persistence with real-time synchronization with PostgreSQL, MongoDB, and MySQL backends. +- **[PowerSyncCollection](./collections/powersync-collection.md)** — Sync with PowerSync's SQLite-based database for offline-first persistence with real-time synchronization with PostgreSQL, MongoDB, and MySQL backends. **Local Collections** -- **[LocalStorageCollection](../collections/local-storage-collection.md)** — Store small amounts of local-only state that persists across sessions and syncs across browser tabs. +- **[LocalStorageCollection](./collections/local-storage-collection.md)** — Store small amounts of local-only state that persists across sessions and syncs across browser tabs. -- **[LocalOnlyCollection](../collections/local-only-collection.md)** — Manage in-memory client data or UI state that doesn't need persistence or cross-tab sync. +- **[LocalOnlyCollection](./collections/local-only-collection.md)** — Manage in-memory client data or UI state that doesn't need persistence or cross-tab sync. #### Collection Schemas @@ -256,7 +256,7 @@ The collection will use the schema for its type inference. If you provide a sche You can create your own collection types by implementing the `Collection` interface found in [`../packages/db/src/collection/index.ts`](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts). -See the existing implementations in [`../packages/db`](https://github.com/TanStack/db/tree/main/packages/db), [`../packages/query-db-collection`](https://github.com/TanStack/db/tree/main/packages/query-db-collection), [`../packages/electric-db-collection`](https://github.com/TanStack/db/tree/main/packages/electric-db-collection) and [`../packages/trailbase-db-collection`](https://github.com/TanStack/db/tree/main/packages/trailbase-db-collection) for reference. Also see the [Collection Options Creator guide](../guides/collection-options-creator.md) for a pattern to create reusable collection configuration factories. +See the existing implementations in [`../packages/db`](https://github.com/TanStack/db/tree/main/packages/db), [`../packages/query-db-collection`](https://github.com/TanStack/db/tree/main/packages/query-db-collection), [`../packages/electric-db-collection`](https://github.com/TanStack/db/tree/main/packages/electric-db-collection) and [`../packages/trailbase-db-collection`](https://github.com/TanStack/db/tree/main/packages/trailbase-db-collection) for reference. Also see the [Collection Options Creator guide](./guides/collection-options-creator.md) for a pattern to create reusable collection configuration factories. ### Live queries @@ -337,7 +337,7 @@ const App = () => ( ) ``` -See the [React Suspense section in Live Queries](../guides/live-queries#using-with-react-suspense) for detailed usage patterns and when to use `useLiveSuspenseQuery` vs `useLiveQuery`. +See the [React Suspense section in Live Queries](./guides/live-queries#using-with-react-suspense) for detailed usage patterns and when to use `useLiveSuspenseQuery` vs `useLiveQuery`. #### `queryBuilder` @@ -362,13 +362,13 @@ Note also that: 1. the query results [are themselves a collection](#derived-collections) 2. the `useLiveQuery` automatically starts and stops live query subscriptions when you mount and unmount your components; if you're creating queries manually, you need to manually manage the subscription lifecycle yourself -See the [Live Queries](../guides/live-queries.md) documentation for more details. +See the [Live Queries](./guides/live-queries.md) documentation for more details. ### Transactional mutators For more complex mutations beyond simple CRUD operations, TanStack DB provides `createOptimisticAction` and `createTransaction` for creating custom mutations with full control over the mutation lifecycle. -See the [Mutations guide](../guides/mutations.md) for comprehensive documentation on: +See the [Mutations guide](./guides/mutations.md) for comprehensive documentation on: - Creating custom actions with `createOptimisticAction` - Manual transactions with `createTransaction` diff --git a/docs/quick-start.md b/docs/quick-start.md index 5b53bff94..ea6799974 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -178,6 +178,6 @@ You now understand the basics of TanStack DB! The collection loads and persists Explore the docs to learn more about: -- **[Installation](../installation.md)** - All framework and collection packages -- **[Overview](../overview.md)** - Complete feature overview and examples -- **[Live Queries](../guides/live-queries.md)** - Advanced querying, joins, and aggregations +- **[Installation](./installation.md)** - All framework and collection packages +- **[Overview](./overview.md)** - Complete feature overview and examples +- **[Live Queries](./guides/live-queries.md)** - Advanced querying, joins, and aggregations diff --git a/docs/reference/@tanstack/namespaces/IR/classes/Aggregate.md b/docs/reference/@tanstack/namespaces/IR/classes/Aggregate.md index 7a9758d72..75915c41c 100644 --- a/docs/reference/@tanstack/namespaces/IR/classes/Aggregate.md +++ b/docs/reference/@tanstack/namespaces/IR/classes/Aggregate.md @@ -35,7 +35,7 @@ Defined in: [packages/db/src/query/ir.ts:127](https://github.com/TanStack/db/blo ##### args -[`BasicExpression`](../../type-aliases/BasicExpression.md)\<`any`\>[] +[`BasicExpression`](../type-aliases/BasicExpression.md)\<`any`\>[] #### Returns diff --git a/docs/reference/@tanstack/namespaces/IR/classes/CollectionRef.md b/docs/reference/@tanstack/namespaces/IR/classes/CollectionRef.md index 0d820a8b1..1550a7e6f 100644 --- a/docs/reference/@tanstack/namespaces/IR/classes/CollectionRef.md +++ b/docs/reference/@tanstack/namespaces/IR/classes/CollectionRef.md @@ -25,7 +25,7 @@ Defined in: [packages/db/src/query/ir.ts:74](https://github.com/TanStack/db/blob ##### collection -[`CollectionImpl`](../../../../../classes/CollectionImpl.md) +[`CollectionImpl`](../../../../classes/CollectionImpl.md) ##### alias diff --git a/docs/reference/@tanstack/namespaces/IR/classes/Func.md b/docs/reference/@tanstack/namespaces/IR/classes/Func.md index 3550d8362..37fe6c377 100644 --- a/docs/reference/@tanstack/namespaces/IR/classes/Func.md +++ b/docs/reference/@tanstack/namespaces/IR/classes/Func.md @@ -35,7 +35,7 @@ Defined in: [packages/db/src/query/ir.ts:112](https://github.com/TanStack/db/blo ##### args -[`BasicExpression`](../../type-aliases/BasicExpression.md)\<`any`\>[] +[`BasicExpression`](../type-aliases/BasicExpression.md)\<`any`\>[] #### Returns diff --git a/docs/reference/@tanstack/namespaces/IR/classes/QueryRef.md b/docs/reference/@tanstack/namespaces/IR/classes/QueryRef.md index 6650b0389..5f29109ba 100644 --- a/docs/reference/@tanstack/namespaces/IR/classes/QueryRef.md +++ b/docs/reference/@tanstack/namespaces/IR/classes/QueryRef.md @@ -25,7 +25,7 @@ Defined in: [packages/db/src/query/ir.ts:84](https://github.com/TanStack/db/blob ##### query -[`QueryIR`](../../interfaces/QueryIR.md) +[`QueryIR`](../interfaces/QueryIR.md) ##### alias diff --git a/docs/reference/@tanstack/namespaces/IR/functions/createResidualWhere.md b/docs/reference/@tanstack/namespaces/IR/functions/createResidualWhere.md index 05ed3ea3d..93851c21c 100644 --- a/docs/reference/@tanstack/namespaces/IR/functions/createResidualWhere.md +++ b/docs/reference/@tanstack/namespaces/IR/functions/createResidualWhere.md @@ -17,8 +17,8 @@ Create a residual Where clause from an expression ### expression -[`BasicExpression`](../../type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../type-aliases/BasicExpression.md)\<`boolean`\> ## Returns -[`Where`](../../type-aliases/Where.md) +[`Where`](../type-aliases/Where.md) diff --git a/docs/reference/@tanstack/namespaces/IR/functions/followRef.md b/docs/reference/@tanstack/namespaces/IR/functions/followRef.md index 8b1fca465..3147d38c1 100644 --- a/docs/reference/@tanstack/namespaces/IR/functions/followRef.md +++ b/docs/reference/@tanstack/namespaces/IR/functions/followRef.md @@ -26,21 +26,21 @@ until its finds the root field the reference points to. ### query -[`QueryIR`](../../interfaces/QueryIR.md) +[`QueryIR`](../interfaces/QueryIR.md) ### ref -[`PropRef`](../../classes/PropRef.md)\<`any`\> +[`PropRef`](../classes/PropRef.md)\<`any`\> ### collection -[`Collection`](../../../../../interfaces/Collection.md) +[`Collection`](../../../../interfaces/Collection.md) ## Returns \| `void` \| \{ - `collection`: [`Collection`](../../../../../interfaces/Collection.md); + `collection`: [`Collection`](../../../../interfaces/Collection.md); `path`: `string`[]; \} diff --git a/docs/reference/@tanstack/namespaces/IR/functions/getHavingExpression.md b/docs/reference/@tanstack/namespaces/IR/functions/getHavingExpression.md index 0fe5ee30c..a52e0646a 100644 --- a/docs/reference/@tanstack/namespaces/IR/functions/getHavingExpression.md +++ b/docs/reference/@tanstack/namespaces/IR/functions/getHavingExpression.md @@ -20,9 +20,9 @@ HAVING clauses can contain aggregates, unlike regular WHERE clauses ### having -[`Where`](../../type-aliases/Where.md) +[`Where`](../type-aliases/Where.md) ## Returns - \| [`Aggregate`](../../classes/Aggregate.md)\<`any`\> - \| [`BasicExpression`](../../type-aliases/BasicExpression.md)\<`any`\> + \| [`Aggregate`](../classes/Aggregate.md)\<`any`\> + \| [`BasicExpression`](../type-aliases/BasicExpression.md)\<`any`\> diff --git a/docs/reference/@tanstack/namespaces/IR/functions/getWhereExpression.md b/docs/reference/@tanstack/namespaces/IR/functions/getWhereExpression.md index fbc8b9808..41bb467a8 100644 --- a/docs/reference/@tanstack/namespaces/IR/functions/getWhereExpression.md +++ b/docs/reference/@tanstack/namespaces/IR/functions/getWhereExpression.md @@ -17,8 +17,8 @@ Extract the expression from a Where clause ### where -[`Where`](../../type-aliases/Where.md) +[`Where`](../type-aliases/Where.md) ## Returns -[`BasicExpression`](../../type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../type-aliases/BasicExpression.md)\<`boolean`\> diff --git a/docs/reference/@tanstack/namespaces/IR/functions/isResidualWhere.md b/docs/reference/@tanstack/namespaces/IR/functions/isResidualWhere.md index 3b433feff..28f2a059c 100644 --- a/docs/reference/@tanstack/namespaces/IR/functions/isResidualWhere.md +++ b/docs/reference/@tanstack/namespaces/IR/functions/isResidualWhere.md @@ -17,7 +17,7 @@ Check if a Where clause is marked as residual ### where -[`Where`](../../type-aliases/Where.md) +[`Where`](../type-aliases/Where.md) ## Returns diff --git a/docs/reference/@tanstack/namespaces/IR/index.md b/docs/reference/@tanstack/namespaces/IR/index.md index e1937961e..cda593313 100644 --- a/docs/reference/@tanstack/namespaces/IR/index.md +++ b/docs/reference/@tanstack/namespaces/IR/index.md @@ -7,38 +7,38 @@ title: IR ## Classes -- [Aggregate](../classes/Aggregate.md) -- [CollectionRef](../classes/CollectionRef.md) -- [Func](../classes/Func.md) -- [PropRef](../classes/PropRef.md) -- [QueryRef](../classes/QueryRef.md) -- [Value](../classes/Value.md) +- [Aggregate](./classes/Aggregate.md) +- [CollectionRef](./classes/CollectionRef.md) +- [Func](./classes/Func.md) +- [PropRef](./classes/PropRef.md) +- [QueryRef](./classes/QueryRef.md) +- [Value](./classes/Value.md) ## Interfaces -- [JoinClause](../interfaces/JoinClause.md) -- [QueryIR](../interfaces/QueryIR.md) +- [JoinClause](./interfaces/JoinClause.md) +- [QueryIR](./interfaces/QueryIR.md) ## Type Aliases -- [BasicExpression](../type-aliases/BasicExpression.md) -- [From](../type-aliases/From.md) -- [GroupBy](../type-aliases/GroupBy.md) -- [Having](../type-aliases/Having.md) -- [Join](../type-aliases/Join.md) -- [Limit](../type-aliases/Limit.md) -- [Offset](../type-aliases/Offset.md) -- [OrderBy](../type-aliases/OrderBy.md) -- [OrderByClause](../type-aliases/OrderByClause.md) -- [OrderByDirection](../type-aliases/OrderByDirection.md) -- [Select](../type-aliases/Select.md) -- [Where](../type-aliases/Where.md) +- [BasicExpression](./type-aliases/BasicExpression.md) +- [From](./type-aliases/From.md) +- [GroupBy](./type-aliases/GroupBy.md) +- [Having](./type-aliases/Having.md) +- [Join](./type-aliases/Join.md) +- [Limit](./type-aliases/Limit.md) +- [Offset](./type-aliases/Offset.md) +- [OrderBy](./type-aliases/OrderBy.md) +- [OrderByClause](./type-aliases/OrderByClause.md) +- [OrderByDirection](./type-aliases/OrderByDirection.md) +- [Select](./type-aliases/Select.md) +- [Where](./type-aliases/Where.md) ## Functions -- [createResidualWhere](../functions/createResidualWhere.md) -- [followRef](../functions/followRef.md) -- [getHavingExpression](../functions/getHavingExpression.md) -- [getWhereExpression](../functions/getWhereExpression.md) -- [isExpressionLike](../functions/isExpressionLike.md) -- [isResidualWhere](../functions/isResidualWhere.md) +- [createResidualWhere](./functions/createResidualWhere.md) +- [followRef](./functions/followRef.md) +- [getHavingExpression](./functions/getHavingExpression.md) +- [getWhereExpression](./functions/getWhereExpression.md) +- [isExpressionLike](./functions/isExpressionLike.md) +- [isResidualWhere](./functions/isResidualWhere.md) diff --git a/docs/reference/@tanstack/namespaces/IR/interfaces/QueryIR.md b/docs/reference/@tanstack/namespaces/IR/interfaces/QueryIR.md index 835f2b562..c47622a9e 100644 --- a/docs/reference/@tanstack/namespaces/IR/interfaces/QueryIR.md +++ b/docs/reference/@tanstack/namespaces/IR/interfaces/QueryIR.md @@ -31,7 +31,7 @@ Defined in: [packages/db/src/query/ir.ts:25](https://github.com/TanStack/db/blob ##### row -[`NamespacedRow`](../../../../../type-aliases/NamespacedRow.md) +[`NamespacedRow`](../../../../type-aliases/NamespacedRow.md) #### Returns @@ -51,7 +51,7 @@ Defined in: [packages/db/src/query/ir.ts:23](https://github.com/TanStack/db/blob ##### row -[`NamespacedRow`](../../../../../type-aliases/NamespacedRow.md) +[`NamespacedRow`](../../../../type-aliases/NamespacedRow.md) #### Returns @@ -71,7 +71,7 @@ Defined in: [packages/db/src/query/ir.ts:24](https://github.com/TanStack/db/blob ##### row -[`NamespacedRow`](../../../../../type-aliases/NamespacedRow.md) +[`NamespacedRow`](../../../../type-aliases/NamespacedRow.md) #### Returns diff --git a/docs/reference/classes/AggregateFunctionNotInSelectError.md b/docs/reference/classes/AggregateFunctionNotInSelectError.md index d4d41540e..e1835482d 100644 --- a/docs/reference/classes/AggregateFunctionNotInSelectError.md +++ b/docs/reference/classes/AggregateFunctionNotInSelectError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:556](https://github.com/TanStack/db/blob/ ## Extends -- [`GroupByError`](../GroupByError.md) +- [`GroupByError`](./GroupByError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:557](https://github.com/TanStack/db/blob/ #### Overrides -[`GroupByError`](../GroupByError.md).[`constructor`](../GroupByError.md#constructor) +[`GroupByError`](./GroupByError.md).[`constructor`](./GroupByError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`cause`](../GroupByError.md#cause) +[`GroupByError`](./GroupByError.md).[`cause`](./GroupByError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`message`](../GroupByError.md#message) +[`GroupByError`](./GroupByError.md).[`message`](./GroupByError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`name`](../GroupByError.md#name) +[`GroupByError`](./GroupByError.md).[`name`](./GroupByError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`stack`](../GroupByError.md#stack) +[`GroupByError`](./GroupByError.md).[`stack`](./GroupByError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`GroupByError`](../GroupByError.md).[`stackTraceLimit`](../GroupByError.md#stacktracelimit) +[`GroupByError`](./GroupByError.md).[`stackTraceLimit`](./GroupByError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`GroupByError`](../GroupByError.md).[`captureStackTrace`](../GroupByError.md#capturestacktrace) +[`GroupByError`](./GroupByError.md).[`captureStackTrace`](./GroupByError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`GroupByError`](../GroupByError.md).[`prepareStackTrace`](../GroupByError.md#preparestacktrace) +[`GroupByError`](./GroupByError.md).[`prepareStackTrace`](./GroupByError.md#preparestacktrace) diff --git a/docs/reference/classes/AggregateNotSupportedError.md b/docs/reference/classes/AggregateNotSupportedError.md index a880fa93a..3ac7f904a 100644 --- a/docs/reference/classes/AggregateNotSupportedError.md +++ b/docs/reference/classes/AggregateNotSupportedError.md @@ -11,7 +11,7 @@ Error thrown when aggregate expressions are used outside of a GROUP BY context. ## Extends -- [`QueryCompilationError`](../QueryCompilationError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) ## Constructors @@ -29,7 +29,7 @@ Defined in: [packages/db/src/errors.ts:673](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryCompilationError`](../QueryCompilationError.md).[`constructor`](../QueryCompilationError.md#constructor) +[`QueryCompilationError`](./QueryCompilationError.md).[`constructor`](./QueryCompilationError.md#constructor) ## Properties @@ -43,7 +43,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`cause`](../QueryCompilationError.md#cause) +[`QueryCompilationError`](./QueryCompilationError.md).[`cause`](./QueryCompilationError.md#cause) *** @@ -57,7 +57,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`message`](../QueryCompilationError.md#message) +[`QueryCompilationError`](./QueryCompilationError.md).[`message`](./QueryCompilationError.md#message) *** @@ -71,7 +71,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`name`](../QueryCompilationError.md#name) +[`QueryCompilationError`](./QueryCompilationError.md).[`name`](./QueryCompilationError.md#name) *** @@ -85,7 +85,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stack`](../QueryCompilationError.md#stack) +[`QueryCompilationError`](./QueryCompilationError.md).[`stack`](./QueryCompilationError.md#stack) *** @@ -109,7 +109,7 @@ not capture any frames. #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stackTraceLimit`](../QueryCompilationError.md#stacktracelimit) +[`QueryCompilationError`](./QueryCompilationError.md).[`stackTraceLimit`](./QueryCompilationError.md#stacktracelimit) ## Methods @@ -181,7 +181,7 @@ a(); #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`captureStackTrace`](../QueryCompilationError.md#capturestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`captureStackTrace`](./QueryCompilationError.md#capturestacktrace) *** @@ -213,4 +213,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`prepareStackTrace`](../QueryCompilationError.md#preparestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`prepareStackTrace`](./QueryCompilationError.md#preparestacktrace) diff --git a/docs/reference/classes/BTreeIndex.md b/docs/reference/classes/BTreeIndex.md index fe55cef10..53777dfff 100644 --- a/docs/reference/classes/BTreeIndex.md +++ b/docs/reference/classes/BTreeIndex.md @@ -12,7 +12,7 @@ This maintains items in sorted order and provides efficient range operations ## Extends -- [`BaseIndex`](../BaseIndex.md)\<`TKey`\> +- [`BaseIndex`](./BaseIndex.md)\<`TKey`\> ## Type Parameters @@ -42,7 +42,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:50](https://github.com/TanSt ##### expression -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md) +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md) ##### name? @@ -58,7 +58,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:50](https://github.com/TanSt #### Overrides -[`BaseIndex`](../BaseIndex.md).[`constructor`](../BaseIndex.md#constructor) +[`BaseIndex`](./BaseIndex.md).[`constructor`](./BaseIndex.md#constructor) ## Properties @@ -72,7 +72,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:87](https://github.com/TanSta #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`compareOptions`](../BaseIndex.md#compareoptions) +[`BaseIndex`](./BaseIndex.md).[`compareOptions`](./BaseIndex.md#compareoptions) *** @@ -86,7 +86,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:81](https://github.com/TanSta #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`expression`](../BaseIndex.md#expression) +[`BaseIndex`](./BaseIndex.md).[`expression`](./BaseIndex.md#expression) *** @@ -100,7 +100,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:79](https://github.com/TanSta #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`id`](../BaseIndex.md#id) +[`BaseIndex`](./BaseIndex.md).[`id`](./BaseIndex.md#id) *** @@ -114,7 +114,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:86](https://github.com/TanSta #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`lastUpdated`](../BaseIndex.md#lastupdated) +[`BaseIndex`](./BaseIndex.md).[`lastUpdated`](./BaseIndex.md#lastupdated) *** @@ -128,7 +128,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:84](https://github.com/TanSta #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`lookupCount`](../BaseIndex.md#lookupcount) +[`BaseIndex`](./BaseIndex.md).[`lookupCount`](./BaseIndex.md#lookupcount) *** @@ -142,7 +142,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:80](https://github.com/TanSta #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`name`](../BaseIndex.md#name) +[`BaseIndex`](./BaseIndex.md).[`name`](./BaseIndex.md#name) *** @@ -156,7 +156,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:33](https://github.com/TanSt #### Overrides -[`BaseIndex`](../BaseIndex.md).[`supportedOperations`](../BaseIndex.md#supportedoperations) +[`BaseIndex`](./BaseIndex.md).[`supportedOperations`](./BaseIndex.md#supportedoperations) *** @@ -170,7 +170,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:85](https://github.com/TanSta #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`totalLookupTime`](../BaseIndex.md#totallookuptime) +[`BaseIndex`](./BaseIndex.md).[`totalLookupTime`](./BaseIndex.md#totallookuptime) ## Accessors @@ -190,7 +190,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:333](https://github.com/TanS #### Overrides -[`BaseIndex`](../BaseIndex.md).[`indexedKeysSet`](../BaseIndex.md#indexedkeysset) +[`BaseIndex`](./BaseIndex.md).[`indexedKeysSet`](./BaseIndex.md#indexedkeysset) *** @@ -212,7 +212,7 @@ Gets the number of indexed keys #### Overrides -[`BaseIndex`](../BaseIndex.md).[`keyCount`](../BaseIndex.md#keycount) +[`BaseIndex`](./BaseIndex.md).[`keyCount`](./BaseIndex.md#keycount) *** @@ -232,7 +232,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:337](https://github.com/TanS #### Overrides -[`BaseIndex`](../BaseIndex.md).[`orderedEntriesArray`](../BaseIndex.md#orderedentriesarray) +[`BaseIndex`](./BaseIndex.md).[`orderedEntriesArray`](./BaseIndex.md#orderedentriesarray) *** @@ -252,7 +252,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:343](https://github.com/TanS #### Overrides -[`BaseIndex`](../BaseIndex.md).[`orderedEntriesArrayReversed`](../BaseIndex.md#orderedentriesarrayreversed) +[`BaseIndex`](./BaseIndex.md).[`orderedEntriesArrayReversed`](./BaseIndex.md#orderedentriesarrayreversed) *** @@ -272,7 +272,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:350](https://github.com/TanS #### Overrides -[`BaseIndex`](../BaseIndex.md).[`valueMapData`](../BaseIndex.md#valuemapdata) +[`BaseIndex`](./BaseIndex.md).[`valueMapData`](./BaseIndex.md#valuemapdata) ## Methods @@ -302,7 +302,7 @@ Adds a value to the index #### Overrides -[`BaseIndex`](../BaseIndex.md).[`add`](../BaseIndex.md#add) +[`BaseIndex`](./BaseIndex.md).[`add`](./BaseIndex.md#add) *** @@ -328,7 +328,7 @@ Builds the index from a collection of entries #### Overrides -[`BaseIndex`](../BaseIndex.md).[`build`](../BaseIndex.md#build) +[`BaseIndex`](./BaseIndex.md).[`build`](./BaseIndex.md#build) *** @@ -348,7 +348,7 @@ Clears all data from the index #### Overrides -[`BaseIndex`](../BaseIndex.md).[`clear`](../BaseIndex.md#clear) +[`BaseIndex`](./BaseIndex.md).[`clear`](./BaseIndex.md#clear) *** @@ -374,7 +374,7 @@ Performs an equality lookup #### Overrides -[`BaseIndex`](../BaseIndex.md).[`equalityLookup`](../BaseIndex.md#equalitylookup) +[`BaseIndex`](./BaseIndex.md).[`equalityLookup`](./BaseIndex.md#equalitylookup) *** @@ -398,7 +398,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:182](https://github.com/TanSt #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`evaluateIndexExpression`](../BaseIndex.md#evaluateindexexpression) +[`BaseIndex`](./BaseIndex.md).[`evaluateIndexExpression`](./BaseIndex.md#evaluateindexexpression) *** @@ -412,11 +412,11 @@ Defined in: [packages/db/src/indexes/base-index.ts:169](https://github.com/TanSt #### Returns -[`IndexStats`](../../interfaces/IndexStats.md) +[`IndexStats`](../interfaces/IndexStats.md) #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`getStats`](../BaseIndex.md#getstats) +[`BaseIndex`](./BaseIndex.md).[`getStats`](./BaseIndex.md#getstats) *** @@ -442,7 +442,7 @@ Performs an IN array lookup #### Overrides -[`BaseIndex`](../BaseIndex.md).[`inArrayLookup`](../BaseIndex.md#inarraylookup) +[`BaseIndex`](./BaseIndex.md).[`inArrayLookup`](./BaseIndex.md#inarraylookup) *** @@ -458,7 +458,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:64](https://github.com/TanSt ##### \_options? -[`BTreeIndexOptions`](../../interfaces/BTreeIndexOptions.md) +[`BTreeIndexOptions`](../interfaces/BTreeIndexOptions.md) #### Returns @@ -466,7 +466,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:64](https://github.com/TanSt #### Overrides -[`BaseIndex`](../BaseIndex.md).[`initialize`](../BaseIndex.md#initialize) +[`BaseIndex`](./BaseIndex.md).[`initialize`](./BaseIndex.md#initialize) *** @@ -496,7 +496,7 @@ Performs a lookup operation #### Overrides -[`BaseIndex`](../BaseIndex.md).[`lookup`](../BaseIndex.md#lookup) +[`BaseIndex`](./BaseIndex.md).[`lookup`](./BaseIndex.md#lookup) *** @@ -523,7 +523,7 @@ The direction is ignored because the index can be reversed if the direction is d #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`matchesCompareOptions`](../BaseIndex.md#matchescompareoptions) +[`BaseIndex`](./BaseIndex.md).[`matchesCompareOptions`](./BaseIndex.md#matchescompareoptions) *** @@ -541,7 +541,7 @@ Checks if the index matches the provided direction. ##### direction -[`OrderByDirection`](../../@tanstack/namespaces/IR/type-aliases/OrderByDirection.md) +[`OrderByDirection`](../@tanstack/namespaces/IR/type-aliases/OrderByDirection.md) #### Returns @@ -549,7 +549,7 @@ Checks if the index matches the provided direction. #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`matchesDirection`](../BaseIndex.md#matchesdirection) +[`BaseIndex`](./BaseIndex.md).[`matchesDirection`](./BaseIndex.md#matchesdirection) *** @@ -573,7 +573,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:134](https://github.com/TanSt #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`matchesField`](../BaseIndex.md#matchesfield) +[`BaseIndex`](./BaseIndex.md).[`matchesField`](./BaseIndex.md#matchesfield) *** @@ -592,7 +592,7 @@ This is more efficient for compound queries like "WHERE a > 5 AND a < 10" ##### options -[`RangeQueryOptions`](../../interfaces/RangeQueryOptions.md) = `{}` +[`RangeQueryOptions`](../interfaces/RangeQueryOptions.md) = `{}` #### Returns @@ -600,7 +600,7 @@ This is more efficient for compound queries like "WHERE a > 5 AND a < 10" #### Overrides -[`BaseIndex`](../BaseIndex.md).[`rangeQuery`](../BaseIndex.md#rangequery) +[`BaseIndex`](./BaseIndex.md).[`rangeQuery`](./BaseIndex.md#rangequery) *** @@ -618,7 +618,7 @@ Performs a reversed range query ##### options -[`RangeQueryOptions`](../../interfaces/RangeQueryOptions.md) = `{}` +[`RangeQueryOptions`](../interfaces/RangeQueryOptions.md) = `{}` #### Returns @@ -626,7 +626,7 @@ Performs a reversed range query #### Overrides -[`BaseIndex`](../BaseIndex.md).[`rangeQueryReversed`](../BaseIndex.md#rangequeryreversed) +[`BaseIndex`](./BaseIndex.md).[`rangeQueryReversed`](./BaseIndex.md#rangequeryreversed) *** @@ -656,7 +656,7 @@ Removes a value from the index #### Overrides -[`BaseIndex`](../BaseIndex.md).[`remove`](../BaseIndex.md#remove) +[`BaseIndex`](./BaseIndex.md).[`remove`](./BaseIndex.md#remove) *** @@ -680,7 +680,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:130](https://github.com/TanSt #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`supports`](../BaseIndex.md#supports) +[`BaseIndex`](./BaseIndex.md).[`supports`](./BaseIndex.md#supports) *** @@ -723,7 +723,7 @@ The next n items after the provided key. Returns the first n items if no from it #### Overrides -[`BaseIndex`](../BaseIndex.md).[`take`](../BaseIndex.md#take) +[`BaseIndex`](./BaseIndex.md).[`take`](./BaseIndex.md#take) *** @@ -766,7 +766,7 @@ The next n items **before** the provided key. Returns the last n items if no fro #### Overrides -[`BaseIndex`](../BaseIndex.md).[`takeReversed`](../BaseIndex.md#takereversed) +[`BaseIndex`](./BaseIndex.md).[`takeReversed`](./BaseIndex.md#takereversed) *** @@ -790,7 +790,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:187](https://github.com/TanSt #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`trackLookup`](../BaseIndex.md#tracklookup) +[`BaseIndex`](./BaseIndex.md).[`trackLookup`](./BaseIndex.md#tracklookup) *** @@ -827,7 +827,7 @@ Updates a value in the index #### Overrides -[`BaseIndex`](../BaseIndex.md).[`update`](../BaseIndex.md#update) +[`BaseIndex`](./BaseIndex.md).[`update`](./BaseIndex.md#update) *** @@ -845,4 +845,4 @@ Defined in: [packages/db/src/indexes/base-index.ts:193](https://github.com/TanSt #### Inherited from -[`BaseIndex`](../BaseIndex.md).[`updateTimestamp`](../BaseIndex.md#updatetimestamp) +[`BaseIndex`](./BaseIndex.md).[`updateTimestamp`](./BaseIndex.md#updatetimestamp) diff --git a/docs/reference/classes/BaseIndex.md b/docs/reference/classes/BaseIndex.md index a1a6434c5..820142565 100644 --- a/docs/reference/classes/BaseIndex.md +++ b/docs/reference/classes/BaseIndex.md @@ -11,7 +11,7 @@ Base abstract class that all index types extend ## Extended by -- [`BTreeIndex`](../BTreeIndex.md) +- [`BTreeIndex`](./BTreeIndex.md) ## Type Parameters @@ -21,7 +21,7 @@ Base abstract class that all index types extend ## Implements -- [`IndexInterface`](../../interfaces/IndexInterface.md)\<`TKey`\> +- [`IndexInterface`](../interfaces/IndexInterface.md)\<`TKey`\> ## Constructors @@ -45,7 +45,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:89](https://github.com/TanSta ##### expression -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md) +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md) ##### name? @@ -157,7 +157,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:126](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`indexedKeysSet`](../../interfaces/IndexInterface.md#indexedkeysset) +[`IndexInterface`](../interfaces/IndexInterface.md).[`indexedKeysSet`](../interfaces/IndexInterface.md#indexedkeysset) *** @@ -177,7 +177,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:119](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`keyCount`](../../interfaces/IndexInterface.md#keycount) +[`IndexInterface`](../interfaces/IndexInterface.md).[`keyCount`](../interfaces/IndexInterface.md#keycount) *** @@ -197,7 +197,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:124](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`orderedEntriesArray`](../../interfaces/IndexInterface.md#orderedentriesarray) +[`IndexInterface`](../interfaces/IndexInterface.md).[`orderedEntriesArray`](../interfaces/IndexInterface.md#orderedentriesarray) *** @@ -217,7 +217,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:125](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`orderedEntriesArrayReversed`](../../interfaces/IndexInterface.md#orderedentriesarrayreversed) +[`IndexInterface`](../interfaces/IndexInterface.md).[`orderedEntriesArrayReversed`](../interfaces/IndexInterface.md#orderedentriesarrayreversed) *** @@ -237,7 +237,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:127](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`valueMapData`](../../interfaces/IndexInterface.md#valuemapdata) +[`IndexInterface`](../interfaces/IndexInterface.md).[`valueMapData`](../interfaces/IndexInterface.md#valuemapdata) ## Methods @@ -265,7 +265,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:103](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`add`](../../interfaces/IndexInterface.md#add) +[`IndexInterface`](../interfaces/IndexInterface.md).[`add`](../interfaces/IndexInterface.md#add) *** @@ -289,7 +289,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:106](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`build`](../../interfaces/IndexInterface.md#build) +[`IndexInterface`](../interfaces/IndexInterface.md).[`build`](../interfaces/IndexInterface.md#build) *** @@ -307,7 +307,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:107](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`clear`](../../interfaces/IndexInterface.md#clear) +[`IndexInterface`](../interfaces/IndexInterface.md).[`clear`](../interfaces/IndexInterface.md#clear) *** @@ -331,7 +331,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:120](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`equalityLookup`](../../interfaces/IndexInterface.md#equalitylookup) +[`IndexInterface`](../interfaces/IndexInterface.md).[`equalityLookup`](../interfaces/IndexInterface.md#equalitylookup) *** @@ -365,11 +365,11 @@ Defined in: [packages/db/src/indexes/base-index.ts:169](https://github.com/TanSt #### Returns -[`IndexStats`](../../interfaces/IndexStats.md) +[`IndexStats`](../interfaces/IndexStats.md) #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`getStats`](../../interfaces/IndexInterface.md#getstats) +[`IndexInterface`](../interfaces/IndexInterface.md).[`getStats`](../interfaces/IndexInterface.md#getstats) *** @@ -393,7 +393,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:121](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`inArrayLookup`](../../interfaces/IndexInterface.md#inarraylookup) +[`IndexInterface`](../interfaces/IndexInterface.md).[`inArrayLookup`](../interfaces/IndexInterface.md#inarraylookup) *** @@ -441,7 +441,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:108](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`lookup`](../../interfaces/IndexInterface.md#lookup) +[`IndexInterface`](../interfaces/IndexInterface.md).[`lookup`](../interfaces/IndexInterface.md#lookup) *** @@ -468,7 +468,7 @@ The direction is ignored because the index can be reversed if the direction is d #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`matchesCompareOptions`](../../interfaces/IndexInterface.md#matchescompareoptions) +[`IndexInterface`](../interfaces/IndexInterface.md).[`matchesCompareOptions`](../interfaces/IndexInterface.md#matchescompareoptions) *** @@ -486,7 +486,7 @@ Checks if the index matches the provided direction. ##### direction -[`OrderByDirection`](../../@tanstack/namespaces/IR/type-aliases/OrderByDirection.md) +[`OrderByDirection`](../@tanstack/namespaces/IR/type-aliases/OrderByDirection.md) #### Returns @@ -494,7 +494,7 @@ Checks if the index matches the provided direction. #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`matchesDirection`](../../interfaces/IndexInterface.md#matchesdirection) +[`IndexInterface`](../interfaces/IndexInterface.md).[`matchesDirection`](../interfaces/IndexInterface.md#matchesdirection) *** @@ -518,7 +518,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:134](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`matchesField`](../../interfaces/IndexInterface.md#matchesfield) +[`IndexInterface`](../interfaces/IndexInterface.md).[`matchesField`](../interfaces/IndexInterface.md#matchesfield) *** @@ -534,7 +534,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:122](https://github.com/TanSt ##### options -[`RangeQueryOptions`](../../interfaces/RangeQueryOptions.md) +[`RangeQueryOptions`](../interfaces/RangeQueryOptions.md) #### Returns @@ -542,7 +542,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:122](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`rangeQuery`](../../interfaces/IndexInterface.md#rangequery) +[`IndexInterface`](../interfaces/IndexInterface.md).[`rangeQuery`](../interfaces/IndexInterface.md#rangequery) *** @@ -558,7 +558,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:123](https://github.com/TanSt ##### options -[`RangeQueryOptions`](../../interfaces/RangeQueryOptions.md) +[`RangeQueryOptions`](../interfaces/RangeQueryOptions.md) #### Returns @@ -566,7 +566,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:123](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`rangeQueryReversed`](../../interfaces/IndexInterface.md#rangequeryreversed) +[`IndexInterface`](../interfaces/IndexInterface.md).[`rangeQueryReversed`](../interfaces/IndexInterface.md#rangequeryreversed) *** @@ -594,7 +594,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:104](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`remove`](../../interfaces/IndexInterface.md#remove) +[`IndexInterface`](../interfaces/IndexInterface.md).[`remove`](../interfaces/IndexInterface.md#remove) *** @@ -618,7 +618,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:130](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`supports`](../../interfaces/IndexInterface.md#supports) +[`IndexInterface`](../interfaces/IndexInterface.md).[`supports`](../interfaces/IndexInterface.md#supports) *** @@ -653,7 +653,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:109](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`take`](../../interfaces/IndexInterface.md#take) +[`IndexInterface`](../interfaces/IndexInterface.md).[`take`](../interfaces/IndexInterface.md#take) *** @@ -688,7 +688,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:114](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`takeReversed`](../../interfaces/IndexInterface.md#takereversed) +[`IndexInterface`](../interfaces/IndexInterface.md).[`takeReversed`](../interfaces/IndexInterface.md#takereversed) *** @@ -743,7 +743,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:105](https://github.com/TanSt #### Implementation of -[`IndexInterface`](../../interfaces/IndexInterface.md).[`update`](../../interfaces/IndexInterface.md#update) +[`IndexInterface`](../interfaces/IndexInterface.md).[`update`](../interfaces/IndexInterface.md#update) *** diff --git a/docs/reference/classes/BaseQueryBuilder.md b/docs/reference/classes/BaseQueryBuilder.md index 7789b52f1..57b094f15 100644 --- a/docs/reference/classes/BaseQueryBuilder.md +++ b/docs/reference/classes/BaseQueryBuilder.md @@ -11,7 +11,7 @@ Defined in: [packages/db/src/query/builder/index.ts:47](https://github.com/TanSt ### TContext -`TContext` *extends* [`Context`](../../interfaces/Context.md) = [`Context`](../../interfaces/Context.md) +`TContext` *extends* [`Context`](../interfaces/Context.md) = [`Context`](../interfaces/Context.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/query/builder/index.ts:50](https://github.com/TanSt ##### query -`Partial`\<[`QueryIR`](../../@tanstack/namespaces/IR/interfaces/QueryIR.md)\> = `{}` +`Partial`\<[`QueryIR`](../@tanstack/namespaces/IR/interfaces/QueryIR.md)\> = `{}` #### Returns @@ -80,7 +80,7 @@ A function that receives an aggregated row and returns a boolean ###### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`TContext`\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`TContext`\> A QueryBuilder with functional having filter applied @@ -119,7 +119,7 @@ A function that receives a row and returns the selected value ###### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`WithResult`\<`TContext`, `TFuncSelectResult`\>\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`WithResult`\<`TContext`, `TFuncSelectResult`\>\> A QueryBuilder with functional selection applied @@ -154,7 +154,7 @@ A function that receives a row and returns a boolean ###### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`TContext`\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`TContext`\> A QueryBuilder with functional filtering applied @@ -179,7 +179,7 @@ Defined in: [packages/db/src/query/builder/index.ts:784](https://github.com/TanS #### Returns -[`QueryIR`](../../@tanstack/namespaces/IR/interfaces/QueryIR.md) +[`QueryIR`](../@tanstack/namespaces/IR/interfaces/QueryIR.md) *** @@ -196,7 +196,7 @@ Deduplicates rows based on the selected columns. #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`TContext`\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`TContext`\> A QueryBuilder with distinct enabled @@ -224,7 +224,7 @@ Specify that the query should return a single result #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`TContext` & [`SingleResult`](../../type-aliases/SingleResult.md)\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`TContext` & [`SingleResult`](../type-aliases/SingleResult.md)\> A QueryBuilder that returns the first result @@ -259,7 +259,7 @@ Specify the source table or subquery for the query ##### TSource -`TSource` *extends* [`Source`](../../type-aliases/Source.md) +`TSource` *extends* [`Source`](../type-aliases/Source.md) #### Parameters @@ -271,7 +271,7 @@ An object with a single key-value pair where the key is the table alias and the #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<\{ +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<\{ `baseSchema`: `SchemaFromSource`\<`TSource`\>; `fromSourceName`: keyof `TSource` & `string`; `hasJoins`: `false`; @@ -307,7 +307,7 @@ Perform a FULL JOIN with another table or subquery ##### TSource -`TSource` *extends* [`Source`](../../type-aliases/Source.md) +`TSource` *extends* [`Source`](../type-aliases/Source.md) #### Parameters @@ -325,7 +325,7 @@ A function that receives table references and returns the join condition #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`MergeContextWithJoinType`\<`TContext`, `SchemaFromSource`\<`TSource`\>, `"full"`\>\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`MergeContextWithJoinType`\<`TContext`, `SchemaFromSource`\<`TSource`\>, `"full"`\>\> A QueryBuilder with the full joined table available @@ -360,7 +360,7 @@ A function that receives table references and returns the field(s) to group by #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`TContext`\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`TContext`\> A QueryBuilder with grouping applied (enables aggregate functions in SELECT and HAVING) @@ -409,7 +409,7 @@ A function that receives table references and returns an expression #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`TContext`\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`TContext`\> A QueryBuilder with the having condition applied @@ -452,7 +452,7 @@ Perform an INNER JOIN with another table or subquery ##### TSource -`TSource` *extends* [`Source`](../../type-aliases/Source.md) +`TSource` *extends* [`Source`](../type-aliases/Source.md) #### Parameters @@ -470,7 +470,7 @@ A function that receives table references and returns the join condition #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`MergeContextWithJoinType`\<`TContext`, `SchemaFromSource`\<`TSource`\>, `"inner"`\>\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`MergeContextWithJoinType`\<`TContext`, `SchemaFromSource`\<`TSource`\>, `"inner"`\>\> A QueryBuilder with the inner joined table available @@ -502,7 +502,7 @@ Join another table or subquery to the current query ##### TSource -`TSource` *extends* [`Source`](../../type-aliases/Source.md) +`TSource` *extends* [`Source`](../type-aliases/Source.md) ##### TJoinType @@ -530,7 +530,7 @@ The type of join: 'inner', 'left', 'right', or 'full' (defaults to 'left') #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`MergeContextWithJoinType`\<`TContext`, `SchemaFromSource`\<`TSource`\>, `TJoinType`\>\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`MergeContextWithJoinType`\<`TContext`, `SchemaFromSource`\<`TSource`\>, `TJoinType`\>\> A QueryBuilder with the joined table available @@ -570,7 +570,7 @@ Perform a LEFT JOIN with another table or subquery ##### TSource -`TSource` *extends* [`Source`](../../type-aliases/Source.md) +`TSource` *extends* [`Source`](../type-aliases/Source.md) #### Parameters @@ -588,7 +588,7 @@ A function that receives table references and returns the join condition #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`MergeContextWithJoinType`\<`TContext`, `SchemaFromSource`\<`TSource`\>, `"left"`\>\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`MergeContextWithJoinType`\<`TContext`, `SchemaFromSource`\<`TSource`\>, `"left"`\>\> A QueryBuilder with the left joined table available @@ -624,7 +624,7 @@ Maximum number of rows to return #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`TContext`\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`TContext`\> A QueryBuilder with the limit applied @@ -661,7 +661,7 @@ Number of rows to skip #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`TContext`\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`TContext`\> A QueryBuilder with the offset applied @@ -698,11 +698,11 @@ A function that receives table references and returns the field to sort by ##### options -[`OrderByDirection`](../../@tanstack/namespaces/IR/type-aliases/OrderByDirection.md) | `OrderByOptions` +[`OrderByDirection`](../@tanstack/namespaces/IR/type-aliases/OrderByDirection.md) | `OrderByOptions` #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`TContext`\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`TContext`\> A QueryBuilder with the ordering applied @@ -742,7 +742,7 @@ Perform a RIGHT JOIN with another table or subquery ##### TSource -`TSource` *extends* [`Source`](../../type-aliases/Source.md) +`TSource` *extends* [`Source`](../type-aliases/Source.md) #### Parameters @@ -760,7 +760,7 @@ A function that receives table references and returns the join condition #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`MergeContextWithJoinType`\<`TContext`, `SchemaFromSource`\<`TSource`\>, `"right"`\>\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`MergeContextWithJoinType`\<`TContext`, `SchemaFromSource`\<`TSource`\>, `"right"`\>\> A QueryBuilder with the right joined table available @@ -801,7 +801,7 @@ A function that receives table references and returns an object with selected fi #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`WithResult`\<`TContext`, `ResultTypeFromSelect`\<`TSelectObject`\>\>\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`WithResult`\<`TContext`, `ResultTypeFromSelect`\<`TSelectObject`\>\>\> A QueryBuilder that returns only the selected fields @@ -856,7 +856,7 @@ A function that receives table references and returns an expression #### Returns -[`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`TContext`\> +[`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`TContext`\> A QueryBuilder with the where condition applied diff --git a/docs/reference/classes/CannotCombineEmptyExpressionListError.md b/docs/reference/classes/CannotCombineEmptyExpressionListError.md index 93536c9f8..39ff798c2 100644 --- a/docs/reference/classes/CannotCombineEmptyExpressionListError.md +++ b/docs/reference/classes/CannotCombineEmptyExpressionListError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:635](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryOptimizerError`](../QueryOptimizerError.md) +- [`QueryOptimizerError`](./QueryOptimizerError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:636](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryOptimizerError`](../QueryOptimizerError.md).[`constructor`](../QueryOptimizerError.md#constructor) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`constructor`](./QueryOptimizerError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryOptimizerError`](../QueryOptimizerError.md).[`cause`](../QueryOptimizerError.md#cause) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`cause`](./QueryOptimizerError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryOptimizerError`](../QueryOptimizerError.md).[`message`](../QueryOptimizerError.md#message) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`message`](./QueryOptimizerError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryOptimizerError`](../QueryOptimizerError.md).[`name`](../QueryOptimizerError.md#name) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`name`](./QueryOptimizerError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryOptimizerError`](../QueryOptimizerError.md).[`stack`](../QueryOptimizerError.md#stack) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`stack`](./QueryOptimizerError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`QueryOptimizerError`](../QueryOptimizerError.md).[`stackTraceLimit`](../QueryOptimizerError.md#stacktracelimit) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`stackTraceLimit`](./QueryOptimizerError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`QueryOptimizerError`](../QueryOptimizerError.md).[`captureStackTrace`](../QueryOptimizerError.md#capturestacktrace) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`captureStackTrace`](./QueryOptimizerError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryOptimizerError`](../QueryOptimizerError.md).[`prepareStackTrace`](../QueryOptimizerError.md#preparestacktrace) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`prepareStackTrace`](./QueryOptimizerError.md#preparestacktrace) diff --git a/docs/reference/classes/CollectionConfigurationError.md b/docs/reference/classes/CollectionConfigurationError.md index 2a1d4274f..eab7850f0 100644 --- a/docs/reference/classes/CollectionConfigurationError.md +++ b/docs/reference/classes/CollectionConfigurationError.md @@ -9,14 +9,14 @@ Defined in: [packages/db/src/errors.ts:71](https://github.com/TanStack/db/blob/m ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Extended by -- [`CollectionRequiresConfigError`](../CollectionRequiresConfigError.md) -- [`CollectionRequiresSyncConfigError`](../CollectionRequiresSyncConfigError.md) -- [`InvalidSchemaError`](../InvalidSchemaError.md) -- [`SchemaMustBeSynchronousError`](../SchemaMustBeSynchronousError.md) +- [`CollectionRequiresConfigError`](./CollectionRequiresConfigError.md) +- [`CollectionRequiresSyncConfigError`](./CollectionRequiresSyncConfigError.md) +- [`InvalidSchemaError`](./InvalidSchemaError.md) +- [`SchemaMustBeSynchronousError`](./SchemaMustBeSynchronousError.md) ## Constructors @@ -40,7 +40,7 @@ Defined in: [packages/db/src/errors.ts:72](https://github.com/TanStack/db/blob/m #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -54,7 +54,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -68,7 +68,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -82,7 +82,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -96,7 +96,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -120,7 +120,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -192,7 +192,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -224,4 +224,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/CollectionImpl.md b/docs/reference/classes/CollectionImpl.md index 3177f0e93..dd8ff69cb 100644 --- a/docs/reference/classes/CollectionImpl.md +++ b/docs/reference/classes/CollectionImpl.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/collection/index.ts:266](https://github.com/TanStac ## Extended by -- [`Collection`](../../interfaces/Collection.md) +- [`Collection`](../interfaces/Collection.md) ## Type Parameters @@ -23,7 +23,7 @@ Defined in: [packages/db/src/collection/index.ts:266](https://github.com/TanStac ### TUtils -`TUtils` *extends* [`UtilsRecord`](../../type-aliases/UtilsRecord.md) = \{ +`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) = \{ \} ### TSchema @@ -50,7 +50,7 @@ Creates a new Collection instance ##### config -[`CollectionConfig`](../../interfaces/CollectionConfig.md)\<`TOutput`, `TKey`, `TSchema`\> +[`CollectionConfig`](../interfaces/CollectionConfig.md)\<`TOutput`, `TKey`, `TSchema`\> Configuration object for the collection @@ -136,7 +136,7 @@ Defined in: [packages/db/src/collection/index.ts:579](https://github.com/TanStac ##### Returns -[`StringCollationConfig`](../../type-aliases/StringCollationConfig.md) +[`StringCollationConfig`](../type-aliases/StringCollationConfig.md) *** @@ -154,7 +154,7 @@ Get resolved indexes for query optimization ##### Returns -`Map`\<`number`, [`BaseIndex`](../BaseIndex.md)\<`TKey`\>\> +`Map`\<`number`, [`BaseIndex`](./BaseIndex.md)\<`TKey`\>\> *** @@ -246,7 +246,7 @@ Gets the current status of the collection ##### Returns -[`CollectionStatus`](../../type-aliases/CollectionStatus.md) +[`CollectionStatus`](../type-aliases/CollectionStatus.md) *** @@ -337,7 +337,7 @@ and logarithmic time range queries instead of full scans. ##### TResolver -`TResolver` *extends* [`IndexResolver`](../../type-aliases/IndexResolver.md)\<`TKey`\> = *typeof* [`BTreeIndex`](../BTreeIndex.md) +`TResolver` *extends* [`IndexResolver`](../type-aliases/IndexResolver.md)\<`TKey`\> = *typeof* [`BTreeIndex`](./BTreeIndex.md) The type of the index resolver (constructor or async loader) @@ -351,13 +351,13 @@ Function that extracts the indexed value from each item ##### config -[`IndexOptions`](../../interfaces/IndexOptions.md)\<`TResolver`\> = `{}` +[`IndexOptions`](../interfaces/IndexOptions.md)\<`TResolver`\> = `{}` Configuration including index type and type-specific options #### Returns -[`IndexProxy`](../IndexProxy.md)\<`TKey`\> +[`IndexProxy`](./IndexProxy.md)\<`TKey`\> An index proxy that provides access to the index when ready @@ -405,14 +405,14 @@ Returns the current state of the collection as an array of changes ##### options -[`CurrentStateAsChangesOptions`](../../interfaces/CurrentStateAsChangesOptions.md) = `{}` +[`CurrentStateAsChangesOptions`](../interfaces/CurrentStateAsChangesOptions.md) = `{}` Options including optional where filter #### Returns \| `void` - \| [`ChangeMessage`](../../interfaces/ChangeMessage.md)\<`TOutput`, `string` \| `number`\>[] + \| [`ChangeMessage`](../interfaces/ChangeMessage.md)\<`TOutput`, `string` \| `number`\>[] An array of changes @@ -455,13 +455,13 @@ Single key or array of keys to delete ##### config? -[`OperationConfig`](../../interfaces/OperationConfig.md) +[`OperationConfig`](../interfaces/OperationConfig.md) Optional configuration including metadata #### Returns -[`Transaction`](../../interfaces/Transaction.md)\<`any`\> +[`Transaction`](../interfaces/Transaction.md)\<`any`\> A Transaction object representing the delete operation(s) @@ -620,14 +620,14 @@ Inserts one or more items into the collection ##### config? -[`InsertConfig`](../../interfaces/InsertConfig.md) +[`InsertConfig`](../interfaces/InsertConfig.md) Optional configuration including metadata #### Returns - \| [`Transaction`](../../interfaces/Transaction.md)\<`Record`\<`string`, `unknown`\>\> - \| [`Transaction`](../../interfaces/Transaction.md)\<`TOutput`\> + \| [`Transaction`](../interfaces/Transaction.md)\<`Record`\<`string`, `unknown`\>\> + \| [`Transaction`](../interfaces/Transaction.md)\<`TOutput`\> A Transaction object representing the insert operation(s) @@ -986,7 +986,7 @@ Function called when items change ##### options -[`SubscribeChangesOptions`](../../interfaces/SubscribeChangesOptions.md) = `{}` +[`SubscribeChangesOptions`](../interfaces/SubscribeChangesOptions.md) = `{}` Subscription options including includeInitialState and where filter @@ -1081,7 +1081,7 @@ Updates one or more items in the collection using a callback function ##### Returns -[`Transaction`](../../interfaces/Transaction.md) +[`Transaction`](../interfaces/Transaction.md) A Transaction object representing the update operation(s) @@ -1150,7 +1150,7 @@ Single key or array of keys to update ###### config -[`OperationConfig`](../../interfaces/OperationConfig.md) +[`OperationConfig`](../interfaces/OperationConfig.md) ###### callback @@ -1158,7 +1158,7 @@ Single key or array of keys to update ##### Returns -[`Transaction`](../../interfaces/Transaction.md) +[`Transaction`](../interfaces/Transaction.md) A Transaction object representing the update operation(s) @@ -1226,7 +1226,7 @@ Updates one or more items in the collection using a callback function ##### Returns -[`Transaction`](../../interfaces/Transaction.md) +[`Transaction`](../interfaces/Transaction.md) A Transaction object representing the update operation(s) @@ -1293,7 +1293,7 @@ Updates one or more items in the collection using a callback function ###### config -[`OperationConfig`](../../interfaces/OperationConfig.md) +[`OperationConfig`](../interfaces/OperationConfig.md) ###### callback @@ -1301,7 +1301,7 @@ Updates one or more items in the collection using a callback function ##### Returns -[`Transaction`](../../interfaces/Transaction.md) +[`Transaction`](../interfaces/Transaction.md) A Transaction object representing the update operation(s) diff --git a/docs/reference/classes/CollectionInErrorStateError.md b/docs/reference/classes/CollectionInErrorStateError.md index 6a0da4bd1..e743dd0a7 100644 --- a/docs/reference/classes/CollectionInErrorStateError.md +++ b/docs/reference/classes/CollectionInErrorStateError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:110](https://github.com/TanStack/db/blob/ ## Extends -- [`CollectionStateError`](../CollectionStateError.md) +- [`CollectionStateError`](./CollectionStateError.md) ## Constructors @@ -37,7 +37,7 @@ Defined in: [packages/db/src/errors.ts:111](https://github.com/TanStack/db/blob/ #### Overrides -[`CollectionStateError`](../CollectionStateError.md).[`constructor`](../CollectionStateError.md#constructor) +[`CollectionStateError`](./CollectionStateError.md).[`constructor`](./CollectionStateError.md#constructor) ## Properties @@ -51,7 +51,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`cause`](../CollectionStateError.md#cause) +[`CollectionStateError`](./CollectionStateError.md).[`cause`](./CollectionStateError.md#cause) *** @@ -65,7 +65,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`message`](../CollectionStateError.md#message) +[`CollectionStateError`](./CollectionStateError.md).[`message`](./CollectionStateError.md#message) *** @@ -79,7 +79,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`name`](../CollectionStateError.md#name) +[`CollectionStateError`](./CollectionStateError.md).[`name`](./CollectionStateError.md#name) *** @@ -93,7 +93,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`stack`](../CollectionStateError.md#stack) +[`CollectionStateError`](./CollectionStateError.md).[`stack`](./CollectionStateError.md#stack) *** @@ -117,7 +117,7 @@ not capture any frames. #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`stackTraceLimit`](../CollectionStateError.md#stacktracelimit) +[`CollectionStateError`](./CollectionStateError.md).[`stackTraceLimit`](./CollectionStateError.md#stacktracelimit) ## Methods @@ -189,7 +189,7 @@ a(); #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`captureStackTrace`](../CollectionStateError.md#capturestacktrace) +[`CollectionStateError`](./CollectionStateError.md).[`captureStackTrace`](./CollectionStateError.md#capturestacktrace) *** @@ -221,4 +221,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`prepareStackTrace`](../CollectionStateError.md#preparestacktrace) +[`CollectionStateError`](./CollectionStateError.md).[`prepareStackTrace`](./CollectionStateError.md#preparestacktrace) diff --git a/docs/reference/classes/CollectionInputNotFoundError.md b/docs/reference/classes/CollectionInputNotFoundError.md index 53b6f6970..6e97c8473 100644 --- a/docs/reference/classes/CollectionInputNotFoundError.md +++ b/docs/reference/classes/CollectionInputNotFoundError.md @@ -12,7 +12,7 @@ In self-joins, each alias (e.g., 'employee', 'manager') requires its own input s ## Extends -- [`QueryCompilationError`](../QueryCompilationError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) ## Constructors @@ -47,7 +47,7 @@ Defined in: [packages/db/src/errors.ts:417](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryCompilationError`](../QueryCompilationError.md).[`constructor`](../QueryCompilationError.md#constructor) +[`QueryCompilationError`](./QueryCompilationError.md).[`constructor`](./QueryCompilationError.md#constructor) ## Properties @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`cause`](../QueryCompilationError.md#cause) +[`QueryCompilationError`](./QueryCompilationError.md).[`cause`](./QueryCompilationError.md#cause) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`message`](../QueryCompilationError.md#message) +[`QueryCompilationError`](./QueryCompilationError.md).[`message`](./QueryCompilationError.md#message) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`name`](../QueryCompilationError.md#name) +[`QueryCompilationError`](./QueryCompilationError.md).[`name`](./QueryCompilationError.md#name) *** @@ -103,7 +103,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stack`](../QueryCompilationError.md#stack) +[`QueryCompilationError`](./QueryCompilationError.md).[`stack`](./QueryCompilationError.md#stack) *** @@ -127,7 +127,7 @@ not capture any frames. #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stackTraceLimit`](../QueryCompilationError.md#stacktracelimit) +[`QueryCompilationError`](./QueryCompilationError.md).[`stackTraceLimit`](./QueryCompilationError.md#stacktracelimit) ## Methods @@ -199,7 +199,7 @@ a(); #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`captureStackTrace`](../QueryCompilationError.md#capturestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`captureStackTrace`](./QueryCompilationError.md#capturestacktrace) *** @@ -231,4 +231,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`prepareStackTrace`](../QueryCompilationError.md#preparestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`prepareStackTrace`](./QueryCompilationError.md#preparestacktrace) diff --git a/docs/reference/classes/CollectionIsInErrorStateError.md b/docs/reference/classes/CollectionIsInErrorStateError.md index a116584a7..95d4726e7 100644 --- a/docs/reference/classes/CollectionIsInErrorStateError.md +++ b/docs/reference/classes/CollectionIsInErrorStateError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:126](https://github.com/TanStack/db/blob/ ## Extends -- [`CollectionStateError`](../CollectionStateError.md) +- [`CollectionStateError`](./CollectionStateError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:127](https://github.com/TanStack/db/blob/ #### Overrides -[`CollectionStateError`](../CollectionStateError.md).[`constructor`](../CollectionStateError.md#constructor) +[`CollectionStateError`](./CollectionStateError.md).[`constructor`](./CollectionStateError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`cause`](../CollectionStateError.md#cause) +[`CollectionStateError`](./CollectionStateError.md).[`cause`](./CollectionStateError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`message`](../CollectionStateError.md#message) +[`CollectionStateError`](./CollectionStateError.md).[`message`](./CollectionStateError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`name`](../CollectionStateError.md#name) +[`CollectionStateError`](./CollectionStateError.md).[`name`](./CollectionStateError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`stack`](../CollectionStateError.md#stack) +[`CollectionStateError`](./CollectionStateError.md).[`stack`](./CollectionStateError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`stackTraceLimit`](../CollectionStateError.md#stacktracelimit) +[`CollectionStateError`](./CollectionStateError.md).[`stackTraceLimit`](./CollectionStateError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`captureStackTrace`](../CollectionStateError.md#capturestacktrace) +[`CollectionStateError`](./CollectionStateError.md).[`captureStackTrace`](./CollectionStateError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`prepareStackTrace`](../CollectionStateError.md#preparestacktrace) +[`CollectionStateError`](./CollectionStateError.md).[`prepareStackTrace`](./CollectionStateError.md#preparestacktrace) diff --git a/docs/reference/classes/CollectionOperationError.md b/docs/reference/classes/CollectionOperationError.md index e9ce186b1..66121a26b 100644 --- a/docs/reference/classes/CollectionOperationError.md +++ b/docs/reference/classes/CollectionOperationError.md @@ -9,19 +9,19 @@ Defined in: [packages/db/src/errors.ts:139](https://github.com/TanStack/db/blob/ ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Extended by -- [`UndefinedKeyError`](../UndefinedKeyError.md) -- [`DuplicateKeyError`](../DuplicateKeyError.md) -- [`DuplicateKeySyncError`](../DuplicateKeySyncError.md) -- [`MissingUpdateArgumentError`](../MissingUpdateArgumentError.md) -- [`NoKeysPassedToUpdateError`](../NoKeysPassedToUpdateError.md) -- [`UpdateKeyNotFoundError`](../UpdateKeyNotFoundError.md) -- [`KeyUpdateNotAllowedError`](../KeyUpdateNotAllowedError.md) -- [`NoKeysPassedToDeleteError`](../NoKeysPassedToDeleteError.md) -- [`DeleteKeyNotFoundError`](../DeleteKeyNotFoundError.md) +- [`UndefinedKeyError`](./UndefinedKeyError.md) +- [`DuplicateKeyError`](./DuplicateKeyError.md) +- [`DuplicateKeySyncError`](./DuplicateKeySyncError.md) +- [`MissingUpdateArgumentError`](./MissingUpdateArgumentError.md) +- [`NoKeysPassedToUpdateError`](./NoKeysPassedToUpdateError.md) +- [`UpdateKeyNotFoundError`](./UpdateKeyNotFoundError.md) +- [`KeyUpdateNotAllowedError`](./KeyUpdateNotAllowedError.md) +- [`NoKeysPassedToDeleteError`](./NoKeysPassedToDeleteError.md) +- [`DeleteKeyNotFoundError`](./DeleteKeyNotFoundError.md) ## Constructors @@ -45,7 +45,7 @@ Defined in: [packages/db/src/errors.ts:140](https://github.com/TanStack/db/blob/ #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -59,7 +59,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -73,7 +73,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -87,7 +87,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -101,7 +101,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -125,7 +125,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -197,7 +197,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -229,4 +229,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/CollectionRequiresConfigError.md b/docs/reference/classes/CollectionRequiresConfigError.md index 86db7e06d..7bc9412eb 100644 --- a/docs/reference/classes/CollectionRequiresConfigError.md +++ b/docs/reference/classes/CollectionRequiresConfigError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:78](https://github.com/TanStack/db/blob/m ## Extends -- [`CollectionConfigurationError`](../CollectionConfigurationError.md) +- [`CollectionConfigurationError`](./CollectionConfigurationError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:79](https://github.com/TanStack/db/blob/m #### Overrides -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`constructor`](../CollectionConfigurationError.md#constructor) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`constructor`](./CollectionConfigurationError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`cause`](../CollectionConfigurationError.md#cause) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`cause`](./CollectionConfigurationError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`message`](../CollectionConfigurationError.md#message) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`message`](./CollectionConfigurationError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`name`](../CollectionConfigurationError.md#name) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`name`](./CollectionConfigurationError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`stack`](../CollectionConfigurationError.md#stack) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`stack`](./CollectionConfigurationError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`stackTraceLimit`](../CollectionConfigurationError.md#stacktracelimit) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`stackTraceLimit`](./CollectionConfigurationError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`captureStackTrace`](../CollectionConfigurationError.md#capturestacktrace) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`captureStackTrace`](./CollectionConfigurationError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`prepareStackTrace`](../CollectionConfigurationError.md#preparestacktrace) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`prepareStackTrace`](./CollectionConfigurationError.md#preparestacktrace) diff --git a/docs/reference/classes/CollectionRequiresSyncConfigError.md b/docs/reference/classes/CollectionRequiresSyncConfigError.md index 8a2a57092..6d9ecb4fd 100644 --- a/docs/reference/classes/CollectionRequiresSyncConfigError.md +++ b/docs/reference/classes/CollectionRequiresSyncConfigError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:84](https://github.com/TanStack/db/blob/m ## Extends -- [`CollectionConfigurationError`](../CollectionConfigurationError.md) +- [`CollectionConfigurationError`](./CollectionConfigurationError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:85](https://github.com/TanStack/db/blob/m #### Overrides -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`constructor`](../CollectionConfigurationError.md#constructor) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`constructor`](./CollectionConfigurationError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`cause`](../CollectionConfigurationError.md#cause) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`cause`](./CollectionConfigurationError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`message`](../CollectionConfigurationError.md#message) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`message`](./CollectionConfigurationError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`name`](../CollectionConfigurationError.md#name) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`name`](./CollectionConfigurationError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`stack`](../CollectionConfigurationError.md#stack) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`stack`](./CollectionConfigurationError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`stackTraceLimit`](../CollectionConfigurationError.md#stacktracelimit) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`stackTraceLimit`](./CollectionConfigurationError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`captureStackTrace`](../CollectionConfigurationError.md#capturestacktrace) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`captureStackTrace`](./CollectionConfigurationError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`prepareStackTrace`](../CollectionConfigurationError.md#preparestacktrace) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`prepareStackTrace`](./CollectionConfigurationError.md#preparestacktrace) diff --git a/docs/reference/classes/CollectionStateError.md b/docs/reference/classes/CollectionStateError.md index 891c5b4db..f6e390cfe 100644 --- a/docs/reference/classes/CollectionStateError.md +++ b/docs/reference/classes/CollectionStateError.md @@ -9,14 +9,14 @@ Defined in: [packages/db/src/errors.ts:103](https://github.com/TanStack/db/blob/ ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Extended by -- [`CollectionInErrorStateError`](../CollectionInErrorStateError.md) -- [`InvalidCollectionStatusTransitionError`](../InvalidCollectionStatusTransitionError.md) -- [`CollectionIsInErrorStateError`](../CollectionIsInErrorStateError.md) -- [`NegativeActiveSubscribersError`](../NegativeActiveSubscribersError.md) +- [`CollectionInErrorStateError`](./CollectionInErrorStateError.md) +- [`InvalidCollectionStatusTransitionError`](./InvalidCollectionStatusTransitionError.md) +- [`CollectionIsInErrorStateError`](./CollectionIsInErrorStateError.md) +- [`NegativeActiveSubscribersError`](./NegativeActiveSubscribersError.md) ## Constructors @@ -40,7 +40,7 @@ Defined in: [packages/db/src/errors.ts:104](https://github.com/TanStack/db/blob/ #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -54,7 +54,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -68,7 +68,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -82,7 +82,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -96,7 +96,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -120,7 +120,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -192,7 +192,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -224,4 +224,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/DeduplicatedLoadSubset.md b/docs/reference/classes/DeduplicatedLoadSubset.md index 946c4097b..490a8435e 100644 --- a/docs/reference/classes/DeduplicatedLoadSubset.md +++ b/docs/reference/classes/DeduplicatedLoadSubset.md @@ -88,7 +88,7 @@ losing its `this` context (e.g., `loadSubset: dedupe.loadSubset` in a sync confi ##### options -[`LoadSubsetOptions`](../../type-aliases/LoadSubsetOptions.md) +[`LoadSubsetOptions`](../type-aliases/LoadSubsetOptions.md) The predicate options (where, orderBy, limit) diff --git a/docs/reference/classes/DeleteKeyNotFoundError.md b/docs/reference/classes/DeleteKeyNotFoundError.md index bf70f44da..15009dbbf 100644 --- a/docs/reference/classes/DeleteKeyNotFoundError.md +++ b/docs/reference/classes/DeleteKeyNotFoundError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:220](https://github.com/TanStack/db/blob/ ## Extends -- [`CollectionOperationError`](../CollectionOperationError.md) +- [`CollectionOperationError`](./CollectionOperationError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:221](https://github.com/TanStack/db/blob/ #### Overrides -[`CollectionOperationError`](../CollectionOperationError.md).[`constructor`](../CollectionOperationError.md#constructor) +[`CollectionOperationError`](./CollectionOperationError.md).[`constructor`](./CollectionOperationError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`cause`](../CollectionOperationError.md#cause) +[`CollectionOperationError`](./CollectionOperationError.md).[`cause`](./CollectionOperationError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`message`](../CollectionOperationError.md#message) +[`CollectionOperationError`](./CollectionOperationError.md).[`message`](./CollectionOperationError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`name`](../CollectionOperationError.md#name) +[`CollectionOperationError`](./CollectionOperationError.md).[`name`](./CollectionOperationError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stack`](../CollectionOperationError.md#stack) +[`CollectionOperationError`](./CollectionOperationError.md).[`stack`](./CollectionOperationError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stackTraceLimit`](../CollectionOperationError.md#stacktracelimit) +[`CollectionOperationError`](./CollectionOperationError.md).[`stackTraceLimit`](./CollectionOperationError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`captureStackTrace`](../CollectionOperationError.md#capturestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`captureStackTrace`](./CollectionOperationError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`prepareStackTrace`](../CollectionOperationError.md#preparestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`prepareStackTrace`](./CollectionOperationError.md#preparestacktrace) diff --git a/docs/reference/classes/DistinctRequiresSelectError.md b/docs/reference/classes/DistinctRequiresSelectError.md index 135d46e71..f853341bf 100644 --- a/docs/reference/classes/DistinctRequiresSelectError.md +++ b/docs/reference/classes/DistinctRequiresSelectError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:392](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryCompilationError`](../QueryCompilationError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:393](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryCompilationError`](../QueryCompilationError.md).[`constructor`](../QueryCompilationError.md#constructor) +[`QueryCompilationError`](./QueryCompilationError.md).[`constructor`](./QueryCompilationError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`cause`](../QueryCompilationError.md#cause) +[`QueryCompilationError`](./QueryCompilationError.md).[`cause`](./QueryCompilationError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`message`](../QueryCompilationError.md#message) +[`QueryCompilationError`](./QueryCompilationError.md).[`message`](./QueryCompilationError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`name`](../QueryCompilationError.md#name) +[`QueryCompilationError`](./QueryCompilationError.md).[`name`](./QueryCompilationError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stack`](../QueryCompilationError.md#stack) +[`QueryCompilationError`](./QueryCompilationError.md).[`stack`](./QueryCompilationError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stackTraceLimit`](../QueryCompilationError.md#stacktracelimit) +[`QueryCompilationError`](./QueryCompilationError.md).[`stackTraceLimit`](./QueryCompilationError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`captureStackTrace`](../QueryCompilationError.md#capturestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`captureStackTrace`](./QueryCompilationError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`prepareStackTrace`](../QueryCompilationError.md#preparestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`prepareStackTrace`](./QueryCompilationError.md#preparestacktrace) diff --git a/docs/reference/classes/DuplicateAliasInSubqueryError.md b/docs/reference/classes/DuplicateAliasInSubqueryError.md index 5cc24785a..8ce621514 100644 --- a/docs/reference/classes/DuplicateAliasInSubqueryError.md +++ b/docs/reference/classes/DuplicateAliasInSubqueryError.md @@ -13,7 +13,7 @@ leading to empty results or incorrect data (aggregation cross-leaking). ## Extends -- [`QueryCompilationError`](../QueryCompilationError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) ## Constructors @@ -41,7 +41,7 @@ Defined in: [packages/db/src/errors.ts:438](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryCompilationError`](../QueryCompilationError.md).[`constructor`](../QueryCompilationError.md#constructor) +[`QueryCompilationError`](./QueryCompilationError.md).[`constructor`](./QueryCompilationError.md#constructor) ## Properties @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`cause`](../QueryCompilationError.md#cause) +[`QueryCompilationError`](./QueryCompilationError.md).[`cause`](./QueryCompilationError.md#cause) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`message`](../QueryCompilationError.md#message) +[`QueryCompilationError`](./QueryCompilationError.md).[`message`](./QueryCompilationError.md#message) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`name`](../QueryCompilationError.md#name) +[`QueryCompilationError`](./QueryCompilationError.md).[`name`](./QueryCompilationError.md#name) *** @@ -97,7 +97,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stack`](../QueryCompilationError.md#stack) +[`QueryCompilationError`](./QueryCompilationError.md).[`stack`](./QueryCompilationError.md#stack) *** @@ -121,7 +121,7 @@ not capture any frames. #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stackTraceLimit`](../QueryCompilationError.md#stacktracelimit) +[`QueryCompilationError`](./QueryCompilationError.md).[`stackTraceLimit`](./QueryCompilationError.md#stacktracelimit) ## Methods @@ -193,7 +193,7 @@ a(); #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`captureStackTrace`](../QueryCompilationError.md#capturestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`captureStackTrace`](./QueryCompilationError.md#capturestacktrace) *** @@ -225,4 +225,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`prepareStackTrace`](../QueryCompilationError.md#preparestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`prepareStackTrace`](./QueryCompilationError.md#preparestacktrace) diff --git a/docs/reference/classes/DuplicateDbInstanceError.md b/docs/reference/classes/DuplicateDbInstanceError.md index 2d292ae10..2738d9636 100644 --- a/docs/reference/classes/DuplicateDbInstanceError.md +++ b/docs/reference/classes/DuplicateDbInstanceError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:45](https://github.com/TanStack/db/blob/m ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:46](https://github.com/TanStack/db/blob/m #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/DuplicateKeyError.md b/docs/reference/classes/DuplicateKeyError.md index 35d674b3f..7d682f570 100644 --- a/docs/reference/classes/DuplicateKeyError.md +++ b/docs/reference/classes/DuplicateKeyError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:154](https://github.com/TanStack/db/blob/ ## Extends -- [`CollectionOperationError`](../CollectionOperationError.md) +- [`CollectionOperationError`](./CollectionOperationError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:155](https://github.com/TanStack/db/blob/ #### Overrides -[`CollectionOperationError`](../CollectionOperationError.md).[`constructor`](../CollectionOperationError.md#constructor) +[`CollectionOperationError`](./CollectionOperationError.md).[`constructor`](./CollectionOperationError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`cause`](../CollectionOperationError.md#cause) +[`CollectionOperationError`](./CollectionOperationError.md).[`cause`](./CollectionOperationError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`message`](../CollectionOperationError.md#message) +[`CollectionOperationError`](./CollectionOperationError.md).[`message`](./CollectionOperationError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`name`](../CollectionOperationError.md#name) +[`CollectionOperationError`](./CollectionOperationError.md).[`name`](./CollectionOperationError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stack`](../CollectionOperationError.md#stack) +[`CollectionOperationError`](./CollectionOperationError.md).[`stack`](./CollectionOperationError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stackTraceLimit`](../CollectionOperationError.md#stacktracelimit) +[`CollectionOperationError`](./CollectionOperationError.md).[`stackTraceLimit`](./CollectionOperationError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`captureStackTrace`](../CollectionOperationError.md#capturestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`captureStackTrace`](./CollectionOperationError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`prepareStackTrace`](../CollectionOperationError.md#preparestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`prepareStackTrace`](./CollectionOperationError.md#preparestacktrace) diff --git a/docs/reference/classes/DuplicateKeySyncError.md b/docs/reference/classes/DuplicateKeySyncError.md index 42a98eb28..e0b80b1f7 100644 --- a/docs/reference/classes/DuplicateKeySyncError.md +++ b/docs/reference/classes/DuplicateKeySyncError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:162](https://github.com/TanStack/db/blob/ ## Extends -- [`CollectionOperationError`](../CollectionOperationError.md) +- [`CollectionOperationError`](./CollectionOperationError.md) ## Constructors @@ -50,7 +50,7 @@ Defined in: [packages/db/src/errors.ts:163](https://github.com/TanStack/db/blob/ #### Overrides -[`CollectionOperationError`](../CollectionOperationError.md).[`constructor`](../CollectionOperationError.md#constructor) +[`CollectionOperationError`](./CollectionOperationError.md).[`constructor`](./CollectionOperationError.md#constructor) ## Properties @@ -64,7 +64,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`cause`](../CollectionOperationError.md#cause) +[`CollectionOperationError`](./CollectionOperationError.md).[`cause`](./CollectionOperationError.md#cause) *** @@ -78,7 +78,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`message`](../CollectionOperationError.md#message) +[`CollectionOperationError`](./CollectionOperationError.md).[`message`](./CollectionOperationError.md#message) *** @@ -92,7 +92,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`name`](../CollectionOperationError.md#name) +[`CollectionOperationError`](./CollectionOperationError.md).[`name`](./CollectionOperationError.md#name) *** @@ -106,7 +106,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stack`](../CollectionOperationError.md#stack) +[`CollectionOperationError`](./CollectionOperationError.md).[`stack`](./CollectionOperationError.md#stack) *** @@ -130,7 +130,7 @@ not capture any frames. #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stackTraceLimit`](../CollectionOperationError.md#stacktracelimit) +[`CollectionOperationError`](./CollectionOperationError.md).[`stackTraceLimit`](./CollectionOperationError.md#stacktracelimit) ## Methods @@ -202,7 +202,7 @@ a(); #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`captureStackTrace`](../CollectionOperationError.md#capturestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`captureStackTrace`](./CollectionOperationError.md#capturestacktrace) *** @@ -234,4 +234,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`prepareStackTrace`](../CollectionOperationError.md#preparestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`prepareStackTrace`](./CollectionOperationError.md#preparestacktrace) diff --git a/docs/reference/classes/EmptyReferencePathError.md b/docs/reference/classes/EmptyReferencePathError.md index 6fbfb6121..a432a5eff 100644 --- a/docs/reference/classes/EmptyReferencePathError.md +++ b/docs/reference/classes/EmptyReferencePathError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:460](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryCompilationError`](../QueryCompilationError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:461](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryCompilationError`](../QueryCompilationError.md).[`constructor`](../QueryCompilationError.md#constructor) +[`QueryCompilationError`](./QueryCompilationError.md).[`constructor`](./QueryCompilationError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`cause`](../QueryCompilationError.md#cause) +[`QueryCompilationError`](./QueryCompilationError.md).[`cause`](./QueryCompilationError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`message`](../QueryCompilationError.md#message) +[`QueryCompilationError`](./QueryCompilationError.md).[`message`](./QueryCompilationError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`name`](../QueryCompilationError.md#name) +[`QueryCompilationError`](./QueryCompilationError.md).[`name`](./QueryCompilationError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stack`](../QueryCompilationError.md#stack) +[`QueryCompilationError`](./QueryCompilationError.md).[`stack`](./QueryCompilationError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stackTraceLimit`](../QueryCompilationError.md#stacktracelimit) +[`QueryCompilationError`](./QueryCompilationError.md).[`stackTraceLimit`](./QueryCompilationError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`captureStackTrace`](../QueryCompilationError.md#capturestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`captureStackTrace`](./QueryCompilationError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`prepareStackTrace`](../QueryCompilationError.md#preparestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`prepareStackTrace`](./QueryCompilationError.md#preparestacktrace) diff --git a/docs/reference/classes/GroupByError.md b/docs/reference/classes/GroupByError.md index 6656def56..bdd553bbc 100644 --- a/docs/reference/classes/GroupByError.md +++ b/docs/reference/classes/GroupByError.md @@ -9,14 +9,14 @@ Defined in: [packages/db/src/errors.ts:535](https://github.com/TanStack/db/blob/ ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Extended by -- [`NonAggregateExpressionNotInGroupByError`](../NonAggregateExpressionNotInGroupByError.md) -- [`UnsupportedAggregateFunctionError`](../UnsupportedAggregateFunctionError.md) -- [`AggregateFunctionNotInSelectError`](../AggregateFunctionNotInSelectError.md) -- [`UnknownHavingExpressionTypeError`](../UnknownHavingExpressionTypeError.md) +- [`NonAggregateExpressionNotInGroupByError`](./NonAggregateExpressionNotInGroupByError.md) +- [`UnsupportedAggregateFunctionError`](./UnsupportedAggregateFunctionError.md) +- [`AggregateFunctionNotInSelectError`](./AggregateFunctionNotInSelectError.md) +- [`UnknownHavingExpressionTypeError`](./UnknownHavingExpressionTypeError.md) ## Constructors @@ -40,7 +40,7 @@ Defined in: [packages/db/src/errors.ts:536](https://github.com/TanStack/db/blob/ #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -54,7 +54,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -68,7 +68,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -82,7 +82,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -96,7 +96,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -120,7 +120,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -192,7 +192,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -224,4 +224,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/HavingRequiresGroupByError.md b/docs/reference/classes/HavingRequiresGroupByError.md index 423d3a083..5fdb1b76c 100644 --- a/docs/reference/classes/HavingRequiresGroupByError.md +++ b/docs/reference/classes/HavingRequiresGroupByError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:398](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryCompilationError`](../QueryCompilationError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:399](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryCompilationError`](../QueryCompilationError.md).[`constructor`](../QueryCompilationError.md#constructor) +[`QueryCompilationError`](./QueryCompilationError.md).[`constructor`](./QueryCompilationError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`cause`](../QueryCompilationError.md#cause) +[`QueryCompilationError`](./QueryCompilationError.md).[`cause`](./QueryCompilationError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`message`](../QueryCompilationError.md#message) +[`QueryCompilationError`](./QueryCompilationError.md).[`message`](./QueryCompilationError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`name`](../QueryCompilationError.md#name) +[`QueryCompilationError`](./QueryCompilationError.md).[`name`](./QueryCompilationError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stack`](../QueryCompilationError.md#stack) +[`QueryCompilationError`](./QueryCompilationError.md).[`stack`](./QueryCompilationError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stackTraceLimit`](../QueryCompilationError.md#stacktracelimit) +[`QueryCompilationError`](./QueryCompilationError.md).[`stackTraceLimit`](./QueryCompilationError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`captureStackTrace`](../QueryCompilationError.md#capturestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`captureStackTrace`](./QueryCompilationError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`prepareStackTrace`](../QueryCompilationError.md#preparestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`prepareStackTrace`](./QueryCompilationError.md#preparestacktrace) diff --git a/docs/reference/classes/IndexProxy.md b/docs/reference/classes/IndexProxy.md index 0ff7dff72..01a4c2a02 100644 --- a/docs/reference/classes/IndexProxy.md +++ b/docs/reference/classes/IndexProxy.md @@ -33,7 +33,7 @@ Defined in: [packages/db/src/indexes/lazy-index.ts:132](https://github.com/TanSt ##### lazyIndex -[`LazyIndexWrapper`](../LazyIndexWrapper.md)\<`TKey`\> +[`LazyIndexWrapper`](./LazyIndexWrapper.md)\<`TKey`\> #### Returns @@ -55,7 +55,7 @@ Get the index expression (available immediately) ##### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md) +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md) *** @@ -91,7 +91,7 @@ Get the resolved index (throws if not ready) ##### Returns -[`BaseIndex`](../BaseIndex.md)\<`TKey`\> +[`BaseIndex`](./BaseIndex.md)\<`TKey`\> *** @@ -207,7 +207,7 @@ Defined in: [packages/db/src/indexes/lazy-index.ts:248](https://github.com/TanSt #### Returns -[`LazyIndexWrapper`](../LazyIndexWrapper.md)\<`TKey`\> +[`LazyIndexWrapper`](./LazyIndexWrapper.md)\<`TKey`\> *** @@ -243,7 +243,7 @@ Get index statistics (throws if not ready) #### Returns -[`IndexStats`](../../interfaces/IndexStats.md) +[`IndexStats`](../interfaces/IndexStats.md) *** @@ -343,4 +343,4 @@ Wait for index to be ready #### Returns -`Promise`\<[`BaseIndex`](../BaseIndex.md)\<`TKey`\>\> +`Promise`\<[`BaseIndex`](./BaseIndex.md)\<`TKey`\>\> diff --git a/docs/reference/classes/InvalidCollectionStatusTransitionError.md b/docs/reference/classes/InvalidCollectionStatusTransitionError.md index 81c1a3d0c..6bc071e75 100644 --- a/docs/reference/classes/InvalidCollectionStatusTransitionError.md +++ b/docs/reference/classes/InvalidCollectionStatusTransitionError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:118](https://github.com/TanStack/db/blob/ ## Extends -- [`CollectionStateError`](../CollectionStateError.md) +- [`CollectionStateError`](./CollectionStateError.md) ## Constructors @@ -44,7 +44,7 @@ Defined in: [packages/db/src/errors.ts:119](https://github.com/TanStack/db/blob/ #### Overrides -[`CollectionStateError`](../CollectionStateError.md).[`constructor`](../CollectionStateError.md#constructor) +[`CollectionStateError`](./CollectionStateError.md).[`constructor`](./CollectionStateError.md#constructor) ## Properties @@ -58,7 +58,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`cause`](../CollectionStateError.md#cause) +[`CollectionStateError`](./CollectionStateError.md).[`cause`](./CollectionStateError.md#cause) *** @@ -72,7 +72,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`message`](../CollectionStateError.md#message) +[`CollectionStateError`](./CollectionStateError.md).[`message`](./CollectionStateError.md#message) *** @@ -86,7 +86,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`name`](../CollectionStateError.md#name) +[`CollectionStateError`](./CollectionStateError.md).[`name`](./CollectionStateError.md#name) *** @@ -100,7 +100,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`stack`](../CollectionStateError.md#stack) +[`CollectionStateError`](./CollectionStateError.md).[`stack`](./CollectionStateError.md#stack) *** @@ -124,7 +124,7 @@ not capture any frames. #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`stackTraceLimit`](../CollectionStateError.md#stacktracelimit) +[`CollectionStateError`](./CollectionStateError.md).[`stackTraceLimit`](./CollectionStateError.md#stacktracelimit) ## Methods @@ -196,7 +196,7 @@ a(); #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`captureStackTrace`](../CollectionStateError.md#capturestacktrace) +[`CollectionStateError`](./CollectionStateError.md).[`captureStackTrace`](./CollectionStateError.md#capturestacktrace) *** @@ -228,4 +228,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`prepareStackTrace`](../CollectionStateError.md#preparestacktrace) +[`CollectionStateError`](./CollectionStateError.md).[`prepareStackTrace`](./CollectionStateError.md#preparestacktrace) diff --git a/docs/reference/classes/InvalidJoinCondition.md b/docs/reference/classes/InvalidJoinCondition.md index da478f258..3af1cda59 100644 --- a/docs/reference/classes/InvalidJoinCondition.md +++ b/docs/reference/classes/InvalidJoinCondition.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:522](https://github.com/TanStack/db/blob/ ## Extends -- [`JoinError`](../JoinError.md) +- [`JoinError`](./JoinError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:523](https://github.com/TanStack/db/blob/ #### Overrides -[`JoinError`](../JoinError.md).[`constructor`](../JoinError.md#constructor) +[`JoinError`](./JoinError.md).[`constructor`](./JoinError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`cause`](../JoinError.md#cause) +[`JoinError`](./JoinError.md).[`cause`](./JoinError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`message`](../JoinError.md#message) +[`JoinError`](./JoinError.md).[`message`](./JoinError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`name`](../JoinError.md#name) +[`JoinError`](./JoinError.md).[`name`](./JoinError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`stack`](../JoinError.md#stack) +[`JoinError`](./JoinError.md).[`stack`](./JoinError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`JoinError`](../JoinError.md).[`stackTraceLimit`](../JoinError.md#stacktracelimit) +[`JoinError`](./JoinError.md).[`stackTraceLimit`](./JoinError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`JoinError`](../JoinError.md).[`captureStackTrace`](../JoinError.md#capturestacktrace) +[`JoinError`](./JoinError.md).[`captureStackTrace`](./JoinError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`JoinError`](../JoinError.md).[`prepareStackTrace`](../JoinError.md#preparestacktrace) +[`JoinError`](./JoinError.md).[`prepareStackTrace`](./JoinError.md#preparestacktrace) diff --git a/docs/reference/classes/InvalidJoinConditionLeftSourceError.md b/docs/reference/classes/InvalidJoinConditionLeftSourceError.md index 47f2a8e15..04d96c5a2 100644 --- a/docs/reference/classes/InvalidJoinConditionLeftSourceError.md +++ b/docs/reference/classes/InvalidJoinConditionLeftSourceError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:506](https://github.com/TanStack/db/blob/ ## Extends -- [`JoinError`](../JoinError.md) +- [`JoinError`](./JoinError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:507](https://github.com/TanStack/db/blob/ #### Overrides -[`JoinError`](../JoinError.md).[`constructor`](../JoinError.md#constructor) +[`JoinError`](./JoinError.md).[`constructor`](./JoinError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`cause`](../JoinError.md#cause) +[`JoinError`](./JoinError.md).[`cause`](./JoinError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`message`](../JoinError.md#message) +[`JoinError`](./JoinError.md).[`message`](./JoinError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`name`](../JoinError.md#name) +[`JoinError`](./JoinError.md).[`name`](./JoinError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`stack`](../JoinError.md#stack) +[`JoinError`](./JoinError.md).[`stack`](./JoinError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`JoinError`](../JoinError.md).[`stackTraceLimit`](../JoinError.md#stacktracelimit) +[`JoinError`](./JoinError.md).[`stackTraceLimit`](./JoinError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`JoinError`](../JoinError.md).[`captureStackTrace`](../JoinError.md#capturestacktrace) +[`JoinError`](./JoinError.md).[`captureStackTrace`](./JoinError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`JoinError`](../JoinError.md).[`prepareStackTrace`](../JoinError.md#preparestacktrace) +[`JoinError`](./JoinError.md).[`prepareStackTrace`](./JoinError.md#preparestacktrace) diff --git a/docs/reference/classes/InvalidJoinConditionRightSourceError.md b/docs/reference/classes/InvalidJoinConditionRightSourceError.md index 2294e6d0a..ff39de6f9 100644 --- a/docs/reference/classes/InvalidJoinConditionRightSourceError.md +++ b/docs/reference/classes/InvalidJoinConditionRightSourceError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:514](https://github.com/TanStack/db/blob/ ## Extends -- [`JoinError`](../JoinError.md) +- [`JoinError`](./JoinError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:515](https://github.com/TanStack/db/blob/ #### Overrides -[`JoinError`](../JoinError.md).[`constructor`](../JoinError.md#constructor) +[`JoinError`](./JoinError.md).[`constructor`](./JoinError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`cause`](../JoinError.md#cause) +[`JoinError`](./JoinError.md).[`cause`](./JoinError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`message`](../JoinError.md#message) +[`JoinError`](./JoinError.md).[`message`](./JoinError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`name`](../JoinError.md#name) +[`JoinError`](./JoinError.md).[`name`](./JoinError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`stack`](../JoinError.md#stack) +[`JoinError`](./JoinError.md).[`stack`](./JoinError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`JoinError`](../JoinError.md).[`stackTraceLimit`](../JoinError.md#stacktracelimit) +[`JoinError`](./JoinError.md).[`stackTraceLimit`](./JoinError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`JoinError`](../JoinError.md).[`captureStackTrace`](../JoinError.md#capturestacktrace) +[`JoinError`](./JoinError.md).[`captureStackTrace`](./JoinError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`JoinError`](../JoinError.md).[`prepareStackTrace`](../JoinError.md#preparestacktrace) +[`JoinError`](./JoinError.md).[`prepareStackTrace`](./JoinError.md#preparestacktrace) diff --git a/docs/reference/classes/InvalidJoinConditionSameSourceError.md b/docs/reference/classes/InvalidJoinConditionSameSourceError.md index 942301fdb..e4e8e6149 100644 --- a/docs/reference/classes/InvalidJoinConditionSameSourceError.md +++ b/docs/reference/classes/InvalidJoinConditionSameSourceError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:492](https://github.com/TanStack/db/blob/ ## Extends -- [`JoinError`](../JoinError.md) +- [`JoinError`](./JoinError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:493](https://github.com/TanStack/db/blob/ #### Overrides -[`JoinError`](../JoinError.md).[`constructor`](../JoinError.md#constructor) +[`JoinError`](./JoinError.md).[`constructor`](./JoinError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`cause`](../JoinError.md#cause) +[`JoinError`](./JoinError.md).[`cause`](./JoinError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`message`](../JoinError.md#message) +[`JoinError`](./JoinError.md).[`message`](./JoinError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`name`](../JoinError.md#name) +[`JoinError`](./JoinError.md).[`name`](./JoinError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`stack`](../JoinError.md#stack) +[`JoinError`](./JoinError.md).[`stack`](./JoinError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`JoinError`](../JoinError.md).[`stackTraceLimit`](../JoinError.md#stacktracelimit) +[`JoinError`](./JoinError.md).[`stackTraceLimit`](./JoinError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`JoinError`](../JoinError.md).[`captureStackTrace`](../JoinError.md#capturestacktrace) +[`JoinError`](./JoinError.md).[`captureStackTrace`](./JoinError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`JoinError`](../JoinError.md).[`prepareStackTrace`](../JoinError.md#preparestacktrace) +[`JoinError`](./JoinError.md).[`prepareStackTrace`](./JoinError.md#preparestacktrace) diff --git a/docs/reference/classes/InvalidJoinConditionSourceMismatchError.md b/docs/reference/classes/InvalidJoinConditionSourceMismatchError.md index 1a883518c..12c8af374 100644 --- a/docs/reference/classes/InvalidJoinConditionSourceMismatchError.md +++ b/docs/reference/classes/InvalidJoinConditionSourceMismatchError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:500](https://github.com/TanStack/db/blob/ ## Extends -- [`JoinError`](../JoinError.md) +- [`JoinError`](./JoinError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:501](https://github.com/TanStack/db/blob/ #### Overrides -[`JoinError`](../JoinError.md).[`constructor`](../JoinError.md#constructor) +[`JoinError`](./JoinError.md).[`constructor`](./JoinError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`cause`](../JoinError.md#cause) +[`JoinError`](./JoinError.md).[`cause`](./JoinError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`message`](../JoinError.md#message) +[`JoinError`](./JoinError.md).[`message`](./JoinError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`name`](../JoinError.md#name) +[`JoinError`](./JoinError.md).[`name`](./JoinError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`stack`](../JoinError.md#stack) +[`JoinError`](./JoinError.md).[`stack`](./JoinError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`JoinError`](../JoinError.md).[`stackTraceLimit`](../JoinError.md#stacktracelimit) +[`JoinError`](./JoinError.md).[`stackTraceLimit`](./JoinError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`JoinError`](../JoinError.md).[`captureStackTrace`](../JoinError.md#capturestacktrace) +[`JoinError`](./JoinError.md).[`captureStackTrace`](./JoinError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`JoinError`](../JoinError.md).[`prepareStackTrace`](../JoinError.md#preparestacktrace) +[`JoinError`](./JoinError.md).[`prepareStackTrace`](./JoinError.md#preparestacktrace) diff --git a/docs/reference/classes/InvalidSchemaError.md b/docs/reference/classes/InvalidSchemaError.md index a98453c36..74ffa2a0e 100644 --- a/docs/reference/classes/InvalidSchemaError.md +++ b/docs/reference/classes/InvalidSchemaError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:90](https://github.com/TanStack/db/blob/m ## Extends -- [`CollectionConfigurationError`](../CollectionConfigurationError.md) +- [`CollectionConfigurationError`](./CollectionConfigurationError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:91](https://github.com/TanStack/db/blob/m #### Overrides -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`constructor`](../CollectionConfigurationError.md#constructor) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`constructor`](./CollectionConfigurationError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`cause`](../CollectionConfigurationError.md#cause) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`cause`](./CollectionConfigurationError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`message`](../CollectionConfigurationError.md#message) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`message`](./CollectionConfigurationError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`name`](../CollectionConfigurationError.md#name) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`name`](./CollectionConfigurationError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`stack`](../CollectionConfigurationError.md#stack) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`stack`](./CollectionConfigurationError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`stackTraceLimit`](../CollectionConfigurationError.md#stacktracelimit) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`stackTraceLimit`](./CollectionConfigurationError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`captureStackTrace`](../CollectionConfigurationError.md#capturestacktrace) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`captureStackTrace`](./CollectionConfigurationError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`prepareStackTrace`](../CollectionConfigurationError.md#preparestacktrace) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`prepareStackTrace`](./CollectionConfigurationError.md#preparestacktrace) diff --git a/docs/reference/classes/InvalidSourceError.md b/docs/reference/classes/InvalidSourceError.md index 4450c1120..127cdd968 100644 --- a/docs/reference/classes/InvalidSourceError.md +++ b/docs/reference/classes/InvalidSourceError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:355](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryBuilderError`](../QueryBuilderError.md) +- [`QueryBuilderError`](./QueryBuilderError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:356](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryBuilderError`](../QueryBuilderError.md).[`constructor`](../QueryBuilderError.md#constructor) +[`QueryBuilderError`](./QueryBuilderError.md).[`constructor`](./QueryBuilderError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`cause`](../QueryBuilderError.md#cause) +[`QueryBuilderError`](./QueryBuilderError.md).[`cause`](./QueryBuilderError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`message`](../QueryBuilderError.md#message) +[`QueryBuilderError`](./QueryBuilderError.md).[`message`](./QueryBuilderError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`name`](../QueryBuilderError.md#name) +[`QueryBuilderError`](./QueryBuilderError.md).[`name`](./QueryBuilderError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`stack`](../QueryBuilderError.md#stack) +[`QueryBuilderError`](./QueryBuilderError.md).[`stack`](./QueryBuilderError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`stackTraceLimit`](../QueryBuilderError.md#stacktracelimit) +[`QueryBuilderError`](./QueryBuilderError.md).[`stackTraceLimit`](./QueryBuilderError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`captureStackTrace`](../QueryBuilderError.md#capturestacktrace) +[`QueryBuilderError`](./QueryBuilderError.md).[`captureStackTrace`](./QueryBuilderError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`prepareStackTrace`](../QueryBuilderError.md#preparestacktrace) +[`QueryBuilderError`](./QueryBuilderError.md).[`prepareStackTrace`](./QueryBuilderError.md#preparestacktrace) diff --git a/docs/reference/classes/InvalidSourceTypeError.md b/docs/reference/classes/InvalidSourceTypeError.md index 42daca63c..0696dc54b 100644 --- a/docs/reference/classes/InvalidSourceTypeError.md +++ b/docs/reference/classes/InvalidSourceTypeError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:363](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryBuilderError`](../QueryBuilderError.md) +- [`QueryBuilderError`](./QueryBuilderError.md) ## Constructors @@ -37,7 +37,7 @@ Defined in: [packages/db/src/errors.ts:364](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryBuilderError`](../QueryBuilderError.md).[`constructor`](../QueryBuilderError.md#constructor) +[`QueryBuilderError`](./QueryBuilderError.md).[`constructor`](./QueryBuilderError.md#constructor) ## Properties @@ -51,7 +51,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`cause`](../QueryBuilderError.md#cause) +[`QueryBuilderError`](./QueryBuilderError.md).[`cause`](./QueryBuilderError.md#cause) *** @@ -65,7 +65,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`message`](../QueryBuilderError.md#message) +[`QueryBuilderError`](./QueryBuilderError.md).[`message`](./QueryBuilderError.md#message) *** @@ -79,7 +79,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`name`](../QueryBuilderError.md#name) +[`QueryBuilderError`](./QueryBuilderError.md).[`name`](./QueryBuilderError.md#name) *** @@ -93,7 +93,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`stack`](../QueryBuilderError.md#stack) +[`QueryBuilderError`](./QueryBuilderError.md).[`stack`](./QueryBuilderError.md#stack) *** @@ -117,7 +117,7 @@ not capture any frames. #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`stackTraceLimit`](../QueryBuilderError.md#stacktracelimit) +[`QueryBuilderError`](./QueryBuilderError.md).[`stackTraceLimit`](./QueryBuilderError.md#stacktracelimit) ## Methods @@ -189,7 +189,7 @@ a(); #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`captureStackTrace`](../QueryBuilderError.md#capturestacktrace) +[`QueryBuilderError`](./QueryBuilderError.md).[`captureStackTrace`](./QueryBuilderError.md#capturestacktrace) *** @@ -221,4 +221,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`prepareStackTrace`](../QueryBuilderError.md#preparestacktrace) +[`QueryBuilderError`](./QueryBuilderError.md).[`prepareStackTrace`](./QueryBuilderError.md#preparestacktrace) diff --git a/docs/reference/classes/InvalidStorageDataFormatError.md b/docs/reference/classes/InvalidStorageDataFormatError.md index 1a9f10e11..b077c8583 100644 --- a/docs/reference/classes/InvalidStorageDataFormatError.md +++ b/docs/reference/classes/InvalidStorageDataFormatError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:600](https://github.com/TanStack/db/blob/ ## Extends -- [`LocalStorageCollectionError`](../LocalStorageCollectionError.md) +- [`LocalStorageCollectionError`](./LocalStorageCollectionError.md) ## Constructors @@ -37,7 +37,7 @@ Defined in: [packages/db/src/errors.ts:601](https://github.com/TanStack/db/blob/ #### Overrides -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`constructor`](../LocalStorageCollectionError.md#constructor) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`constructor`](./LocalStorageCollectionError.md#constructor) ## Properties @@ -51,7 +51,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`cause`](../LocalStorageCollectionError.md#cause) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`cause`](./LocalStorageCollectionError.md#cause) *** @@ -65,7 +65,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`message`](../LocalStorageCollectionError.md#message) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`message`](./LocalStorageCollectionError.md#message) *** @@ -79,7 +79,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`name`](../LocalStorageCollectionError.md#name) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`name`](./LocalStorageCollectionError.md#name) *** @@ -93,7 +93,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`stack`](../LocalStorageCollectionError.md#stack) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`stack`](./LocalStorageCollectionError.md#stack) *** @@ -117,7 +117,7 @@ not capture any frames. #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`stackTraceLimit`](../LocalStorageCollectionError.md#stacktracelimit) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`stackTraceLimit`](./LocalStorageCollectionError.md#stacktracelimit) ## Methods @@ -189,7 +189,7 @@ a(); #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`captureStackTrace`](../LocalStorageCollectionError.md#capturestacktrace) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`captureStackTrace`](./LocalStorageCollectionError.md#capturestacktrace) *** @@ -221,4 +221,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`prepareStackTrace`](../LocalStorageCollectionError.md#preparestacktrace) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`prepareStackTrace`](./LocalStorageCollectionError.md#preparestacktrace) diff --git a/docs/reference/classes/InvalidStorageObjectFormatError.md b/docs/reference/classes/InvalidStorageObjectFormatError.md index ed3b0efd0..c330556c4 100644 --- a/docs/reference/classes/InvalidStorageObjectFormatError.md +++ b/docs/reference/classes/InvalidStorageObjectFormatError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:608](https://github.com/TanStack/db/blob/ ## Extends -- [`LocalStorageCollectionError`](../LocalStorageCollectionError.md) +- [`LocalStorageCollectionError`](./LocalStorageCollectionError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:609](https://github.com/TanStack/db/blob/ #### Overrides -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`constructor`](../LocalStorageCollectionError.md#constructor) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`constructor`](./LocalStorageCollectionError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`cause`](../LocalStorageCollectionError.md#cause) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`cause`](./LocalStorageCollectionError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`message`](../LocalStorageCollectionError.md#message) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`message`](./LocalStorageCollectionError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`name`](../LocalStorageCollectionError.md#name) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`name`](./LocalStorageCollectionError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`stack`](../LocalStorageCollectionError.md#stack) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`stack`](./LocalStorageCollectionError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`stackTraceLimit`](../LocalStorageCollectionError.md#stacktracelimit) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`stackTraceLimit`](./LocalStorageCollectionError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`captureStackTrace`](../LocalStorageCollectionError.md#capturestacktrace) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`captureStackTrace`](./LocalStorageCollectionError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`prepareStackTrace`](../LocalStorageCollectionError.md#preparestacktrace) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`prepareStackTrace`](./LocalStorageCollectionError.md#preparestacktrace) diff --git a/docs/reference/classes/JoinCollectionNotFoundError.md b/docs/reference/classes/JoinCollectionNotFoundError.md index f21f5b9a5..fde33fac0 100644 --- a/docs/reference/classes/JoinCollectionNotFoundError.md +++ b/docs/reference/classes/JoinCollectionNotFoundError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:472](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryCompilationError`](../QueryCompilationError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:473](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryCompilationError`](../QueryCompilationError.md).[`constructor`](../QueryCompilationError.md#constructor) +[`QueryCompilationError`](./QueryCompilationError.md).[`constructor`](./QueryCompilationError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`cause`](../QueryCompilationError.md#cause) +[`QueryCompilationError`](./QueryCompilationError.md).[`cause`](./QueryCompilationError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`message`](../QueryCompilationError.md#message) +[`QueryCompilationError`](./QueryCompilationError.md).[`message`](./QueryCompilationError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`name`](../QueryCompilationError.md#name) +[`QueryCompilationError`](./QueryCompilationError.md).[`name`](./QueryCompilationError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stack`](../QueryCompilationError.md#stack) +[`QueryCompilationError`](./QueryCompilationError.md).[`stack`](./QueryCompilationError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stackTraceLimit`](../QueryCompilationError.md#stacktracelimit) +[`QueryCompilationError`](./QueryCompilationError.md).[`stackTraceLimit`](./QueryCompilationError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`captureStackTrace`](../QueryCompilationError.md#capturestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`captureStackTrace`](./QueryCompilationError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`prepareStackTrace`](../QueryCompilationError.md#preparestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`prepareStackTrace`](./QueryCompilationError.md#preparestacktrace) diff --git a/docs/reference/classes/JoinConditionMustBeEqualityError.md b/docs/reference/classes/JoinConditionMustBeEqualityError.md index 6e6240e8c..436ee8fb1 100644 --- a/docs/reference/classes/JoinConditionMustBeEqualityError.md +++ b/docs/reference/classes/JoinConditionMustBeEqualityError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:372](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryBuilderError`](../QueryBuilderError.md) +- [`QueryBuilderError`](./QueryBuilderError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:373](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryBuilderError`](../QueryBuilderError.md).[`constructor`](../QueryBuilderError.md#constructor) +[`QueryBuilderError`](./QueryBuilderError.md).[`constructor`](./QueryBuilderError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`cause`](../QueryBuilderError.md#cause) +[`QueryBuilderError`](./QueryBuilderError.md).[`cause`](./QueryBuilderError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`message`](../QueryBuilderError.md#message) +[`QueryBuilderError`](./QueryBuilderError.md).[`message`](./QueryBuilderError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`name`](../QueryBuilderError.md#name) +[`QueryBuilderError`](./QueryBuilderError.md).[`name`](./QueryBuilderError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`stack`](../QueryBuilderError.md#stack) +[`QueryBuilderError`](./QueryBuilderError.md).[`stack`](./QueryBuilderError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`stackTraceLimit`](../QueryBuilderError.md#stacktracelimit) +[`QueryBuilderError`](./QueryBuilderError.md).[`stackTraceLimit`](./QueryBuilderError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`captureStackTrace`](../QueryBuilderError.md#capturestacktrace) +[`QueryBuilderError`](./QueryBuilderError.md).[`captureStackTrace`](./QueryBuilderError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`prepareStackTrace`](../QueryBuilderError.md#preparestacktrace) +[`QueryBuilderError`](./QueryBuilderError.md).[`prepareStackTrace`](./QueryBuilderError.md#preparestacktrace) diff --git a/docs/reference/classes/JoinError.md b/docs/reference/classes/JoinError.md index 6058f4f73..0975a4057 100644 --- a/docs/reference/classes/JoinError.md +++ b/docs/reference/classes/JoinError.md @@ -9,17 +9,17 @@ Defined in: [packages/db/src/errors.ts:479](https://github.com/TanStack/db/blob/ ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Extended by -- [`UnsupportedJoinTypeError`](../UnsupportedJoinTypeError.md) -- [`InvalidJoinConditionSameSourceError`](../InvalidJoinConditionSameSourceError.md) -- [`InvalidJoinConditionSourceMismatchError`](../InvalidJoinConditionSourceMismatchError.md) -- [`InvalidJoinConditionLeftSourceError`](../InvalidJoinConditionLeftSourceError.md) -- [`InvalidJoinConditionRightSourceError`](../InvalidJoinConditionRightSourceError.md) -- [`InvalidJoinCondition`](../InvalidJoinCondition.md) -- [`UnsupportedJoinSourceTypeError`](../UnsupportedJoinSourceTypeError.md) +- [`UnsupportedJoinTypeError`](./UnsupportedJoinTypeError.md) +- [`InvalidJoinConditionSameSourceError`](./InvalidJoinConditionSameSourceError.md) +- [`InvalidJoinConditionSourceMismatchError`](./InvalidJoinConditionSourceMismatchError.md) +- [`InvalidJoinConditionLeftSourceError`](./InvalidJoinConditionLeftSourceError.md) +- [`InvalidJoinConditionRightSourceError`](./InvalidJoinConditionRightSourceError.md) +- [`InvalidJoinCondition`](./InvalidJoinCondition.md) +- [`UnsupportedJoinSourceTypeError`](./UnsupportedJoinSourceTypeError.md) ## Constructors @@ -43,7 +43,7 @@ Defined in: [packages/db/src/errors.ts:480](https://github.com/TanStack/db/blob/ #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -57,7 +57,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -71,7 +71,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -85,7 +85,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -99,7 +99,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -123,7 +123,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -195,7 +195,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -227,4 +227,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/KeyUpdateNotAllowedError.md b/docs/reference/classes/KeyUpdateNotAllowedError.md index 0396ca6ef..1533cdb37 100644 --- a/docs/reference/classes/KeyUpdateNotAllowedError.md +++ b/docs/reference/classes/KeyUpdateNotAllowedError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:206](https://github.com/TanStack/db/blob/ ## Extends -- [`CollectionOperationError`](../CollectionOperationError.md) +- [`CollectionOperationError`](./CollectionOperationError.md) ## Constructors @@ -37,7 +37,7 @@ Defined in: [packages/db/src/errors.ts:207](https://github.com/TanStack/db/blob/ #### Overrides -[`CollectionOperationError`](../CollectionOperationError.md).[`constructor`](../CollectionOperationError.md#constructor) +[`CollectionOperationError`](./CollectionOperationError.md).[`constructor`](./CollectionOperationError.md#constructor) ## Properties @@ -51,7 +51,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`cause`](../CollectionOperationError.md#cause) +[`CollectionOperationError`](./CollectionOperationError.md).[`cause`](./CollectionOperationError.md#cause) *** @@ -65,7 +65,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`message`](../CollectionOperationError.md#message) +[`CollectionOperationError`](./CollectionOperationError.md).[`message`](./CollectionOperationError.md#message) *** @@ -79,7 +79,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`name`](../CollectionOperationError.md#name) +[`CollectionOperationError`](./CollectionOperationError.md).[`name`](./CollectionOperationError.md#name) *** @@ -93,7 +93,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stack`](../CollectionOperationError.md#stack) +[`CollectionOperationError`](./CollectionOperationError.md).[`stack`](./CollectionOperationError.md#stack) *** @@ -117,7 +117,7 @@ not capture any frames. #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stackTraceLimit`](../CollectionOperationError.md#stacktracelimit) +[`CollectionOperationError`](./CollectionOperationError.md).[`stackTraceLimit`](./CollectionOperationError.md#stacktracelimit) ## Methods @@ -189,7 +189,7 @@ a(); #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`captureStackTrace`](../CollectionOperationError.md#capturestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`captureStackTrace`](./CollectionOperationError.md#capturestacktrace) *** @@ -221,4 +221,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`prepareStackTrace`](../CollectionOperationError.md#preparestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`prepareStackTrace`](./CollectionOperationError.md#preparestacktrace) diff --git a/docs/reference/classes/LazyIndexWrapper.md b/docs/reference/classes/LazyIndexWrapper.md index 45592142b..f824daf42 100644 --- a/docs/reference/classes/LazyIndexWrapper.md +++ b/docs/reference/classes/LazyIndexWrapper.md @@ -39,7 +39,7 @@ Defined in: [packages/db/src/indexes/lazy-index.ts:43](https://github.com/TanSta ##### expression -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md) +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md) ##### name @@ -47,7 +47,7 @@ Defined in: [packages/db/src/indexes/lazy-index.ts:43](https://github.com/TanSta ##### resolver -[`IndexResolver`](../../type-aliases/IndexResolver.md)\<`TKey`\> +[`IndexResolver`](../type-aliases/IndexResolver.md)\<`TKey`\> ##### options @@ -75,7 +75,7 @@ Get the index expression #### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md) +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md) *** @@ -123,7 +123,7 @@ Get resolved index (throws if not ready) #### Returns -[`BaseIndex`](../BaseIndex.md)\<`TKey`\> +[`BaseIndex`](./BaseIndex.md)\<`TKey`\> *** @@ -155,4 +155,4 @@ Resolve the actual index #### Returns -`Promise`\<[`BaseIndex`](../BaseIndex.md)\<`TKey`\>\> +`Promise`\<[`BaseIndex`](./BaseIndex.md)\<`TKey`\>\> diff --git a/docs/reference/classes/LimitOffsetRequireOrderByError.md b/docs/reference/classes/LimitOffsetRequireOrderByError.md index 53e0be1f1..15263b0cc 100644 --- a/docs/reference/classes/LimitOffsetRequireOrderByError.md +++ b/docs/reference/classes/LimitOffsetRequireOrderByError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:404](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryCompilationError`](../QueryCompilationError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:405](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryCompilationError`](../QueryCompilationError.md).[`constructor`](../QueryCompilationError.md#constructor) +[`QueryCompilationError`](./QueryCompilationError.md).[`constructor`](./QueryCompilationError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`cause`](../QueryCompilationError.md#cause) +[`QueryCompilationError`](./QueryCompilationError.md).[`cause`](./QueryCompilationError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`message`](../QueryCompilationError.md#message) +[`QueryCompilationError`](./QueryCompilationError.md).[`message`](./QueryCompilationError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`name`](../QueryCompilationError.md#name) +[`QueryCompilationError`](./QueryCompilationError.md).[`name`](./QueryCompilationError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stack`](../QueryCompilationError.md#stack) +[`QueryCompilationError`](./QueryCompilationError.md).[`stack`](./QueryCompilationError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stackTraceLimit`](../QueryCompilationError.md#stacktracelimit) +[`QueryCompilationError`](./QueryCompilationError.md).[`stackTraceLimit`](./QueryCompilationError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`captureStackTrace`](../QueryCompilationError.md#capturestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`captureStackTrace`](./QueryCompilationError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`prepareStackTrace`](../QueryCompilationError.md#preparestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`prepareStackTrace`](./QueryCompilationError.md#preparestacktrace) diff --git a/docs/reference/classes/LocalStorageCollectionError.md b/docs/reference/classes/LocalStorageCollectionError.md index e101629b3..3f31a2412 100644 --- a/docs/reference/classes/LocalStorageCollectionError.md +++ b/docs/reference/classes/LocalStorageCollectionError.md @@ -9,13 +9,13 @@ Defined in: [packages/db/src/errors.ts:587](https://github.com/TanStack/db/blob/ ## Extends -- [`StorageError`](../StorageError.md) +- [`StorageError`](./StorageError.md) ## Extended by -- [`StorageKeyRequiredError`](../StorageKeyRequiredError.md) -- [`InvalidStorageDataFormatError`](../InvalidStorageDataFormatError.md) -- [`InvalidStorageObjectFormatError`](../InvalidStorageObjectFormatError.md) +- [`StorageKeyRequiredError`](./StorageKeyRequiredError.md) +- [`InvalidStorageDataFormatError`](./InvalidStorageDataFormatError.md) +- [`InvalidStorageObjectFormatError`](./InvalidStorageObjectFormatError.md) ## Constructors @@ -39,7 +39,7 @@ Defined in: [packages/db/src/errors.ts:588](https://github.com/TanStack/db/blob/ #### Overrides -[`StorageError`](../StorageError.md).[`constructor`](../StorageError.md#constructor) +[`StorageError`](./StorageError.md).[`constructor`](./StorageError.md#constructor) ## Properties @@ -53,7 +53,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`StorageError`](../StorageError.md).[`cause`](../StorageError.md#cause) +[`StorageError`](./StorageError.md).[`cause`](./StorageError.md#cause) *** @@ -67,7 +67,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`StorageError`](../StorageError.md).[`message`](../StorageError.md#message) +[`StorageError`](./StorageError.md).[`message`](./StorageError.md#message) *** @@ -81,7 +81,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`StorageError`](../StorageError.md).[`name`](../StorageError.md#name) +[`StorageError`](./StorageError.md).[`name`](./StorageError.md#name) *** @@ -95,7 +95,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`StorageError`](../StorageError.md).[`stack`](../StorageError.md#stack) +[`StorageError`](./StorageError.md).[`stack`](./StorageError.md#stack) *** @@ -119,7 +119,7 @@ not capture any frames. #### Inherited from -[`StorageError`](../StorageError.md).[`stackTraceLimit`](../StorageError.md#stacktracelimit) +[`StorageError`](./StorageError.md).[`stackTraceLimit`](./StorageError.md#stacktracelimit) ## Methods @@ -191,7 +191,7 @@ a(); #### Inherited from -[`StorageError`](../StorageError.md).[`captureStackTrace`](../StorageError.md#capturestacktrace) +[`StorageError`](./StorageError.md).[`captureStackTrace`](./StorageError.md#capturestacktrace) *** @@ -223,4 +223,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`StorageError`](../StorageError.md).[`prepareStackTrace`](../StorageError.md#preparestacktrace) +[`StorageError`](./StorageError.md).[`prepareStackTrace`](./StorageError.md#preparestacktrace) diff --git a/docs/reference/classes/MissingAliasInputsError.md b/docs/reference/classes/MissingAliasInputsError.md index bd1cb17e5..fb5ae91c2 100644 --- a/docs/reference/classes/MissingAliasInputsError.md +++ b/docs/reference/classes/MissingAliasInputsError.md @@ -12,7 +12,7 @@ This should never happen since all aliases come from user declarations. ## Extends -- [`QueryCompilationError`](../QueryCompilationError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) ## Constructors @@ -36,7 +36,7 @@ Defined in: [packages/db/src/errors.ts:685](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryCompilationError`](../QueryCompilationError.md).[`constructor`](../QueryCompilationError.md#constructor) +[`QueryCompilationError`](./QueryCompilationError.md).[`constructor`](./QueryCompilationError.md#constructor) ## Properties @@ -50,7 +50,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`cause`](../QueryCompilationError.md#cause) +[`QueryCompilationError`](./QueryCompilationError.md).[`cause`](./QueryCompilationError.md#cause) *** @@ -64,7 +64,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`message`](../QueryCompilationError.md#message) +[`QueryCompilationError`](./QueryCompilationError.md).[`message`](./QueryCompilationError.md#message) *** @@ -78,7 +78,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`name`](../QueryCompilationError.md#name) +[`QueryCompilationError`](./QueryCompilationError.md).[`name`](./QueryCompilationError.md#name) *** @@ -92,7 +92,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stack`](../QueryCompilationError.md#stack) +[`QueryCompilationError`](./QueryCompilationError.md).[`stack`](./QueryCompilationError.md#stack) *** @@ -116,7 +116,7 @@ not capture any frames. #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stackTraceLimit`](../QueryCompilationError.md#stacktracelimit) +[`QueryCompilationError`](./QueryCompilationError.md).[`stackTraceLimit`](./QueryCompilationError.md#stacktracelimit) ## Methods @@ -188,7 +188,7 @@ a(); #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`captureStackTrace`](../QueryCompilationError.md#capturestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`captureStackTrace`](./QueryCompilationError.md#capturestacktrace) *** @@ -220,4 +220,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`prepareStackTrace`](../QueryCompilationError.md#preparestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`prepareStackTrace`](./QueryCompilationError.md#preparestacktrace) diff --git a/docs/reference/classes/MissingDeleteHandlerError.md b/docs/reference/classes/MissingDeleteHandlerError.md index 708d29cf9..6b22f4474 100644 --- a/docs/reference/classes/MissingDeleteHandlerError.md +++ b/docs/reference/classes/MissingDeleteHandlerError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:252](https://github.com/TanStack/db/blob/ ## Extends -- [`MissingHandlerError`](../MissingHandlerError.md) +- [`MissingHandlerError`](./MissingHandlerError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:253](https://github.com/TanStack/db/blob/ #### Overrides -[`MissingHandlerError`](../MissingHandlerError.md).[`constructor`](../MissingHandlerError.md#constructor) +[`MissingHandlerError`](./MissingHandlerError.md).[`constructor`](./MissingHandlerError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`cause`](../MissingHandlerError.md#cause) +[`MissingHandlerError`](./MissingHandlerError.md).[`cause`](./MissingHandlerError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`message`](../MissingHandlerError.md#message) +[`MissingHandlerError`](./MissingHandlerError.md).[`message`](./MissingHandlerError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`name`](../MissingHandlerError.md#name) +[`MissingHandlerError`](./MissingHandlerError.md).[`name`](./MissingHandlerError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`stack`](../MissingHandlerError.md#stack) +[`MissingHandlerError`](./MissingHandlerError.md).[`stack`](./MissingHandlerError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`stackTraceLimit`](../MissingHandlerError.md#stacktracelimit) +[`MissingHandlerError`](./MissingHandlerError.md).[`stackTraceLimit`](./MissingHandlerError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`captureStackTrace`](../MissingHandlerError.md#capturestacktrace) +[`MissingHandlerError`](./MissingHandlerError.md).[`captureStackTrace`](./MissingHandlerError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`prepareStackTrace`](../MissingHandlerError.md#preparestacktrace) +[`MissingHandlerError`](./MissingHandlerError.md).[`prepareStackTrace`](./MissingHandlerError.md#preparestacktrace) diff --git a/docs/reference/classes/MissingHandlerError.md b/docs/reference/classes/MissingHandlerError.md index 4f1b02439..cf5ed1c13 100644 --- a/docs/reference/classes/MissingHandlerError.md +++ b/docs/reference/classes/MissingHandlerError.md @@ -9,13 +9,13 @@ Defined in: [packages/db/src/errors.ts:229](https://github.com/TanStack/db/blob/ ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Extended by -- [`MissingInsertHandlerError`](../MissingInsertHandlerError.md) -- [`MissingUpdateHandlerError`](../MissingUpdateHandlerError.md) -- [`MissingDeleteHandlerError`](../MissingDeleteHandlerError.md) +- [`MissingInsertHandlerError`](./MissingInsertHandlerError.md) +- [`MissingUpdateHandlerError`](./MissingUpdateHandlerError.md) +- [`MissingDeleteHandlerError`](./MissingDeleteHandlerError.md) ## Constructors @@ -39,7 +39,7 @@ Defined in: [packages/db/src/errors.ts:230](https://github.com/TanStack/db/blob/ #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -53,7 +53,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -67,7 +67,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -81,7 +81,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -95,7 +95,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -119,7 +119,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -191,7 +191,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -223,4 +223,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/MissingInsertHandlerError.md b/docs/reference/classes/MissingInsertHandlerError.md index f2d1e932a..d2fc597f5 100644 --- a/docs/reference/classes/MissingInsertHandlerError.md +++ b/docs/reference/classes/MissingInsertHandlerError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:236](https://github.com/TanStack/db/blob/ ## Extends -- [`MissingHandlerError`](../MissingHandlerError.md) +- [`MissingHandlerError`](./MissingHandlerError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:237](https://github.com/TanStack/db/blob/ #### Overrides -[`MissingHandlerError`](../MissingHandlerError.md).[`constructor`](../MissingHandlerError.md#constructor) +[`MissingHandlerError`](./MissingHandlerError.md).[`constructor`](./MissingHandlerError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`cause`](../MissingHandlerError.md#cause) +[`MissingHandlerError`](./MissingHandlerError.md).[`cause`](./MissingHandlerError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`message`](../MissingHandlerError.md#message) +[`MissingHandlerError`](./MissingHandlerError.md).[`message`](./MissingHandlerError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`name`](../MissingHandlerError.md#name) +[`MissingHandlerError`](./MissingHandlerError.md).[`name`](./MissingHandlerError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`stack`](../MissingHandlerError.md#stack) +[`MissingHandlerError`](./MissingHandlerError.md).[`stack`](./MissingHandlerError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`stackTraceLimit`](../MissingHandlerError.md#stacktracelimit) +[`MissingHandlerError`](./MissingHandlerError.md).[`stackTraceLimit`](./MissingHandlerError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`captureStackTrace`](../MissingHandlerError.md#capturestacktrace) +[`MissingHandlerError`](./MissingHandlerError.md).[`captureStackTrace`](./MissingHandlerError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`prepareStackTrace`](../MissingHandlerError.md#preparestacktrace) +[`MissingHandlerError`](./MissingHandlerError.md).[`prepareStackTrace`](./MissingHandlerError.md#preparestacktrace) diff --git a/docs/reference/classes/MissingMutationFunctionError.md b/docs/reference/classes/MissingMutationFunctionError.md index 4d07a7939..73893a748 100644 --- a/docs/reference/classes/MissingMutationFunctionError.md +++ b/docs/reference/classes/MissingMutationFunctionError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:268](https://github.com/TanStack/db/blob/ ## Extends -- [`TransactionError`](../TransactionError.md) +- [`TransactionError`](./TransactionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:269](https://github.com/TanStack/db/blob/ #### Overrides -[`TransactionError`](../TransactionError.md).[`constructor`](../TransactionError.md#constructor) +[`TransactionError`](./TransactionError.md).[`constructor`](./TransactionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`cause`](../TransactionError.md#cause) +[`TransactionError`](./TransactionError.md).[`cause`](./TransactionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`message`](../TransactionError.md#message) +[`TransactionError`](./TransactionError.md).[`message`](./TransactionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`name`](../TransactionError.md#name) +[`TransactionError`](./TransactionError.md).[`name`](./TransactionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`stack`](../TransactionError.md#stack) +[`TransactionError`](./TransactionError.md).[`stack`](./TransactionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`TransactionError`](../TransactionError.md).[`stackTraceLimit`](../TransactionError.md#stacktracelimit) +[`TransactionError`](./TransactionError.md).[`stackTraceLimit`](./TransactionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`TransactionError`](../TransactionError.md).[`captureStackTrace`](../TransactionError.md#capturestacktrace) +[`TransactionError`](./TransactionError.md).[`captureStackTrace`](./TransactionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TransactionError`](../TransactionError.md).[`prepareStackTrace`](../TransactionError.md#preparestacktrace) +[`TransactionError`](./TransactionError.md).[`prepareStackTrace`](./TransactionError.md#preparestacktrace) diff --git a/docs/reference/classes/MissingUpdateArgumentError.md b/docs/reference/classes/MissingUpdateArgumentError.md index 86d4cfbda..ea4cf065a 100644 --- a/docs/reference/classes/MissingUpdateArgumentError.md +++ b/docs/reference/classes/MissingUpdateArgumentError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:186](https://github.com/TanStack/db/blob/ ## Extends -- [`CollectionOperationError`](../CollectionOperationError.md) +- [`CollectionOperationError`](./CollectionOperationError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:187](https://github.com/TanStack/db/blob/ #### Overrides -[`CollectionOperationError`](../CollectionOperationError.md).[`constructor`](../CollectionOperationError.md#constructor) +[`CollectionOperationError`](./CollectionOperationError.md).[`constructor`](./CollectionOperationError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`cause`](../CollectionOperationError.md#cause) +[`CollectionOperationError`](./CollectionOperationError.md).[`cause`](./CollectionOperationError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`message`](../CollectionOperationError.md#message) +[`CollectionOperationError`](./CollectionOperationError.md).[`message`](./CollectionOperationError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`name`](../CollectionOperationError.md#name) +[`CollectionOperationError`](./CollectionOperationError.md).[`name`](./CollectionOperationError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stack`](../CollectionOperationError.md#stack) +[`CollectionOperationError`](./CollectionOperationError.md).[`stack`](./CollectionOperationError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stackTraceLimit`](../CollectionOperationError.md#stacktracelimit) +[`CollectionOperationError`](./CollectionOperationError.md).[`stackTraceLimit`](./CollectionOperationError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`captureStackTrace`](../CollectionOperationError.md#capturestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`captureStackTrace`](./CollectionOperationError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`prepareStackTrace`](../CollectionOperationError.md#preparestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`prepareStackTrace`](./CollectionOperationError.md#preparestacktrace) diff --git a/docs/reference/classes/MissingUpdateHandlerError.md b/docs/reference/classes/MissingUpdateHandlerError.md index 627dbf336..b05ba85c7 100644 --- a/docs/reference/classes/MissingUpdateHandlerError.md +++ b/docs/reference/classes/MissingUpdateHandlerError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:244](https://github.com/TanStack/db/blob/ ## Extends -- [`MissingHandlerError`](../MissingHandlerError.md) +- [`MissingHandlerError`](./MissingHandlerError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:245](https://github.com/TanStack/db/blob/ #### Overrides -[`MissingHandlerError`](../MissingHandlerError.md).[`constructor`](../MissingHandlerError.md#constructor) +[`MissingHandlerError`](./MissingHandlerError.md).[`constructor`](./MissingHandlerError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`cause`](../MissingHandlerError.md#cause) +[`MissingHandlerError`](./MissingHandlerError.md).[`cause`](./MissingHandlerError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`message`](../MissingHandlerError.md#message) +[`MissingHandlerError`](./MissingHandlerError.md).[`message`](./MissingHandlerError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`name`](../MissingHandlerError.md#name) +[`MissingHandlerError`](./MissingHandlerError.md).[`name`](./MissingHandlerError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`stack`](../MissingHandlerError.md#stack) +[`MissingHandlerError`](./MissingHandlerError.md).[`stack`](./MissingHandlerError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`stackTraceLimit`](../MissingHandlerError.md#stacktracelimit) +[`MissingHandlerError`](./MissingHandlerError.md).[`stackTraceLimit`](./MissingHandlerError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`captureStackTrace`](../MissingHandlerError.md#capturestacktrace) +[`MissingHandlerError`](./MissingHandlerError.md).[`captureStackTrace`](./MissingHandlerError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`MissingHandlerError`](../MissingHandlerError.md).[`prepareStackTrace`](../MissingHandlerError.md#preparestacktrace) +[`MissingHandlerError`](./MissingHandlerError.md).[`prepareStackTrace`](./MissingHandlerError.md#preparestacktrace) diff --git a/docs/reference/classes/NegativeActiveSubscribersError.md b/docs/reference/classes/NegativeActiveSubscribersError.md index cd3b1cc36..462f31a85 100644 --- a/docs/reference/classes/NegativeActiveSubscribersError.md +++ b/docs/reference/classes/NegativeActiveSubscribersError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:132](https://github.com/TanStack/db/blob/ ## Extends -- [`CollectionStateError`](../CollectionStateError.md) +- [`CollectionStateError`](./CollectionStateError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:133](https://github.com/TanStack/db/blob/ #### Overrides -[`CollectionStateError`](../CollectionStateError.md).[`constructor`](../CollectionStateError.md#constructor) +[`CollectionStateError`](./CollectionStateError.md).[`constructor`](./CollectionStateError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`cause`](../CollectionStateError.md#cause) +[`CollectionStateError`](./CollectionStateError.md).[`cause`](./CollectionStateError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`message`](../CollectionStateError.md#message) +[`CollectionStateError`](./CollectionStateError.md).[`message`](./CollectionStateError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`name`](../CollectionStateError.md#name) +[`CollectionStateError`](./CollectionStateError.md).[`name`](./CollectionStateError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`stack`](../CollectionStateError.md#stack) +[`CollectionStateError`](./CollectionStateError.md).[`stack`](./CollectionStateError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`stackTraceLimit`](../CollectionStateError.md#stacktracelimit) +[`CollectionStateError`](./CollectionStateError.md).[`stackTraceLimit`](./CollectionStateError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`captureStackTrace`](../CollectionStateError.md#capturestacktrace) +[`CollectionStateError`](./CollectionStateError.md).[`captureStackTrace`](./CollectionStateError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionStateError`](../CollectionStateError.md).[`prepareStackTrace`](../CollectionStateError.md#preparestacktrace) +[`CollectionStateError`](./CollectionStateError.md).[`prepareStackTrace`](./CollectionStateError.md#preparestacktrace) diff --git a/docs/reference/classes/NoKeysPassedToDeleteError.md b/docs/reference/classes/NoKeysPassedToDeleteError.md index 6decc6337..0938ccb37 100644 --- a/docs/reference/classes/NoKeysPassedToDeleteError.md +++ b/docs/reference/classes/NoKeysPassedToDeleteError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:214](https://github.com/TanStack/db/blob/ ## Extends -- [`CollectionOperationError`](../CollectionOperationError.md) +- [`CollectionOperationError`](./CollectionOperationError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:215](https://github.com/TanStack/db/blob/ #### Overrides -[`CollectionOperationError`](../CollectionOperationError.md).[`constructor`](../CollectionOperationError.md#constructor) +[`CollectionOperationError`](./CollectionOperationError.md).[`constructor`](./CollectionOperationError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`cause`](../CollectionOperationError.md#cause) +[`CollectionOperationError`](./CollectionOperationError.md).[`cause`](./CollectionOperationError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`message`](../CollectionOperationError.md#message) +[`CollectionOperationError`](./CollectionOperationError.md).[`message`](./CollectionOperationError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`name`](../CollectionOperationError.md#name) +[`CollectionOperationError`](./CollectionOperationError.md).[`name`](./CollectionOperationError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stack`](../CollectionOperationError.md#stack) +[`CollectionOperationError`](./CollectionOperationError.md).[`stack`](./CollectionOperationError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stackTraceLimit`](../CollectionOperationError.md#stacktracelimit) +[`CollectionOperationError`](./CollectionOperationError.md).[`stackTraceLimit`](./CollectionOperationError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`captureStackTrace`](../CollectionOperationError.md#capturestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`captureStackTrace`](./CollectionOperationError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`prepareStackTrace`](../CollectionOperationError.md#preparestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`prepareStackTrace`](./CollectionOperationError.md#preparestacktrace) diff --git a/docs/reference/classes/NoKeysPassedToUpdateError.md b/docs/reference/classes/NoKeysPassedToUpdateError.md index e177fb8a5..7eb27a9d4 100644 --- a/docs/reference/classes/NoKeysPassedToUpdateError.md +++ b/docs/reference/classes/NoKeysPassedToUpdateError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:192](https://github.com/TanStack/db/blob/ ## Extends -- [`CollectionOperationError`](../CollectionOperationError.md) +- [`CollectionOperationError`](./CollectionOperationError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:193](https://github.com/TanStack/db/blob/ #### Overrides -[`CollectionOperationError`](../CollectionOperationError.md).[`constructor`](../CollectionOperationError.md#constructor) +[`CollectionOperationError`](./CollectionOperationError.md).[`constructor`](./CollectionOperationError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`cause`](../CollectionOperationError.md#cause) +[`CollectionOperationError`](./CollectionOperationError.md).[`cause`](./CollectionOperationError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`message`](../CollectionOperationError.md#message) +[`CollectionOperationError`](./CollectionOperationError.md).[`message`](./CollectionOperationError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`name`](../CollectionOperationError.md#name) +[`CollectionOperationError`](./CollectionOperationError.md).[`name`](./CollectionOperationError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stack`](../CollectionOperationError.md#stack) +[`CollectionOperationError`](./CollectionOperationError.md).[`stack`](./CollectionOperationError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stackTraceLimit`](../CollectionOperationError.md#stacktracelimit) +[`CollectionOperationError`](./CollectionOperationError.md).[`stackTraceLimit`](./CollectionOperationError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`captureStackTrace`](../CollectionOperationError.md#capturestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`captureStackTrace`](./CollectionOperationError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`prepareStackTrace`](../CollectionOperationError.md#preparestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`prepareStackTrace`](./CollectionOperationError.md#preparestacktrace) diff --git a/docs/reference/classes/NoPendingSyncTransactionCommitError.md b/docs/reference/classes/NoPendingSyncTransactionCommitError.md index 4451bf185..61b5e891d 100644 --- a/docs/reference/classes/NoPendingSyncTransactionCommitError.md +++ b/docs/reference/classes/NoPendingSyncTransactionCommitError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:321](https://github.com/TanStack/db/blob/ ## Extends -- [`TransactionError`](../TransactionError.md) +- [`TransactionError`](./TransactionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:322](https://github.com/TanStack/db/blob/ #### Overrides -[`TransactionError`](../TransactionError.md).[`constructor`](../TransactionError.md#constructor) +[`TransactionError`](./TransactionError.md).[`constructor`](./TransactionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`cause`](../TransactionError.md#cause) +[`TransactionError`](./TransactionError.md).[`cause`](./TransactionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`message`](../TransactionError.md#message) +[`TransactionError`](./TransactionError.md).[`message`](./TransactionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`name`](../TransactionError.md#name) +[`TransactionError`](./TransactionError.md).[`name`](./TransactionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`stack`](../TransactionError.md#stack) +[`TransactionError`](./TransactionError.md).[`stack`](./TransactionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`TransactionError`](../TransactionError.md).[`stackTraceLimit`](../TransactionError.md#stacktracelimit) +[`TransactionError`](./TransactionError.md).[`stackTraceLimit`](./TransactionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`TransactionError`](../TransactionError.md).[`captureStackTrace`](../TransactionError.md#capturestacktrace) +[`TransactionError`](./TransactionError.md).[`captureStackTrace`](./TransactionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TransactionError`](../TransactionError.md).[`prepareStackTrace`](../TransactionError.md#preparestacktrace) +[`TransactionError`](./TransactionError.md).[`prepareStackTrace`](./TransactionError.md#preparestacktrace) diff --git a/docs/reference/classes/NoPendingSyncTransactionWriteError.md b/docs/reference/classes/NoPendingSyncTransactionWriteError.md index 38d0ac384..1767bf9e1 100644 --- a/docs/reference/classes/NoPendingSyncTransactionWriteError.md +++ b/docs/reference/classes/NoPendingSyncTransactionWriteError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:307](https://github.com/TanStack/db/blob/ ## Extends -- [`TransactionError`](../TransactionError.md) +- [`TransactionError`](./TransactionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:308](https://github.com/TanStack/db/blob/ #### Overrides -[`TransactionError`](../TransactionError.md).[`constructor`](../TransactionError.md#constructor) +[`TransactionError`](./TransactionError.md).[`constructor`](./TransactionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`cause`](../TransactionError.md#cause) +[`TransactionError`](./TransactionError.md).[`cause`](./TransactionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`message`](../TransactionError.md#message) +[`TransactionError`](./TransactionError.md).[`message`](./TransactionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`name`](../TransactionError.md#name) +[`TransactionError`](./TransactionError.md).[`name`](./TransactionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`stack`](../TransactionError.md#stack) +[`TransactionError`](./TransactionError.md).[`stack`](./TransactionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`TransactionError`](../TransactionError.md).[`stackTraceLimit`](../TransactionError.md#stacktracelimit) +[`TransactionError`](./TransactionError.md).[`stackTraceLimit`](./TransactionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`TransactionError`](../TransactionError.md).[`captureStackTrace`](../TransactionError.md#capturestacktrace) +[`TransactionError`](./TransactionError.md).[`captureStackTrace`](./TransactionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TransactionError`](../TransactionError.md).[`prepareStackTrace`](../TransactionError.md#preparestacktrace) +[`TransactionError`](./TransactionError.md).[`prepareStackTrace`](./TransactionError.md#preparestacktrace) diff --git a/docs/reference/classes/NonAggregateExpressionNotInGroupByError.md b/docs/reference/classes/NonAggregateExpressionNotInGroupByError.md index 8a56a9c0b..56a3be824 100644 --- a/docs/reference/classes/NonAggregateExpressionNotInGroupByError.md +++ b/docs/reference/classes/NonAggregateExpressionNotInGroupByError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:542](https://github.com/TanStack/db/blob/ ## Extends -- [`GroupByError`](../GroupByError.md) +- [`GroupByError`](./GroupByError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:543](https://github.com/TanStack/db/blob/ #### Overrides -[`GroupByError`](../GroupByError.md).[`constructor`](../GroupByError.md#constructor) +[`GroupByError`](./GroupByError.md).[`constructor`](./GroupByError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`cause`](../GroupByError.md#cause) +[`GroupByError`](./GroupByError.md).[`cause`](./GroupByError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`message`](../GroupByError.md#message) +[`GroupByError`](./GroupByError.md).[`message`](./GroupByError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`name`](../GroupByError.md#name) +[`GroupByError`](./GroupByError.md).[`name`](./GroupByError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`stack`](../GroupByError.md#stack) +[`GroupByError`](./GroupByError.md).[`stack`](./GroupByError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`GroupByError`](../GroupByError.md).[`stackTraceLimit`](../GroupByError.md#stacktracelimit) +[`GroupByError`](./GroupByError.md).[`stackTraceLimit`](./GroupByError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`GroupByError`](../GroupByError.md).[`captureStackTrace`](../GroupByError.md#capturestacktrace) +[`GroupByError`](./GroupByError.md).[`captureStackTrace`](./GroupByError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`GroupByError`](../GroupByError.md).[`prepareStackTrace`](../GroupByError.md#preparestacktrace) +[`GroupByError`](./GroupByError.md).[`prepareStackTrace`](./GroupByError.md#preparestacktrace) diff --git a/docs/reference/classes/NonRetriableError.md b/docs/reference/classes/NonRetriableError.md index c048829fd..10ab4599a 100644 --- a/docs/reference/classes/NonRetriableError.md +++ b/docs/reference/classes/NonRetriableError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:10](https://github.com/TanStack/db/blob/m ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:11](https://github.com/TanStack/db/blob/m #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/OnMutateMustBeSynchronousError.md b/docs/reference/classes/OnMutateMustBeSynchronousError.md index 9294d8e4f..35516424f 100644 --- a/docs/reference/classes/OnMutateMustBeSynchronousError.md +++ b/docs/reference/classes/OnMutateMustBeSynchronousError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:274](https://github.com/TanStack/db/blob/ ## Extends -- [`TransactionError`](../TransactionError.md) +- [`TransactionError`](./TransactionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:275](https://github.com/TanStack/db/blob/ #### Overrides -[`TransactionError`](../TransactionError.md).[`constructor`](../TransactionError.md#constructor) +[`TransactionError`](./TransactionError.md).[`constructor`](./TransactionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`cause`](../TransactionError.md#cause) +[`TransactionError`](./TransactionError.md).[`cause`](./TransactionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`message`](../TransactionError.md#message) +[`TransactionError`](./TransactionError.md).[`message`](./TransactionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`name`](../TransactionError.md#name) +[`TransactionError`](./TransactionError.md).[`name`](./TransactionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`stack`](../TransactionError.md#stack) +[`TransactionError`](./TransactionError.md).[`stack`](./TransactionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`TransactionError`](../TransactionError.md).[`stackTraceLimit`](../TransactionError.md#stacktracelimit) +[`TransactionError`](./TransactionError.md).[`stackTraceLimit`](./TransactionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`TransactionError`](../TransactionError.md).[`captureStackTrace`](../TransactionError.md#capturestacktrace) +[`TransactionError`](./TransactionError.md).[`captureStackTrace`](./TransactionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TransactionError`](../TransactionError.md).[`prepareStackTrace`](../TransactionError.md#preparestacktrace) +[`TransactionError`](./TransactionError.md).[`prepareStackTrace`](./TransactionError.md#preparestacktrace) diff --git a/docs/reference/classes/OnlyOneSourceAllowedError.md b/docs/reference/classes/OnlyOneSourceAllowedError.md index 81ae7f6fd..9680bd28d 100644 --- a/docs/reference/classes/OnlyOneSourceAllowedError.md +++ b/docs/reference/classes/OnlyOneSourceAllowedError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:343](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryBuilderError`](../QueryBuilderError.md) +- [`QueryBuilderError`](./QueryBuilderError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:344](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryBuilderError`](../QueryBuilderError.md).[`constructor`](../QueryBuilderError.md#constructor) +[`QueryBuilderError`](./QueryBuilderError.md).[`constructor`](./QueryBuilderError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`cause`](../QueryBuilderError.md#cause) +[`QueryBuilderError`](./QueryBuilderError.md).[`cause`](./QueryBuilderError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`message`](../QueryBuilderError.md#message) +[`QueryBuilderError`](./QueryBuilderError.md).[`message`](./QueryBuilderError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`name`](../QueryBuilderError.md#name) +[`QueryBuilderError`](./QueryBuilderError.md).[`name`](./QueryBuilderError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`stack`](../QueryBuilderError.md#stack) +[`QueryBuilderError`](./QueryBuilderError.md).[`stack`](./QueryBuilderError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`stackTraceLimit`](../QueryBuilderError.md#stacktracelimit) +[`QueryBuilderError`](./QueryBuilderError.md).[`stackTraceLimit`](./QueryBuilderError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`captureStackTrace`](../QueryBuilderError.md#capturestacktrace) +[`QueryBuilderError`](./QueryBuilderError.md).[`captureStackTrace`](./QueryBuilderError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`prepareStackTrace`](../QueryBuilderError.md#preparestacktrace) +[`QueryBuilderError`](./QueryBuilderError.md).[`prepareStackTrace`](./QueryBuilderError.md#preparestacktrace) diff --git a/docs/reference/classes/QueryBuilderError.md b/docs/reference/classes/QueryBuilderError.md index 83c0a2bcc..4da102c94 100644 --- a/docs/reference/classes/QueryBuilderError.md +++ b/docs/reference/classes/QueryBuilderError.md @@ -9,16 +9,16 @@ Defined in: [packages/db/src/errors.ts:336](https://github.com/TanStack/db/blob/ ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Extended by -- [`OnlyOneSourceAllowedError`](../OnlyOneSourceAllowedError.md) -- [`SubQueryMustHaveFromClauseError`](../SubQueryMustHaveFromClauseError.md) -- [`InvalidSourceError`](../InvalidSourceError.md) -- [`InvalidSourceTypeError`](../InvalidSourceTypeError.md) -- [`JoinConditionMustBeEqualityError`](../JoinConditionMustBeEqualityError.md) -- [`QueryMustHaveFromClauseError`](../QueryMustHaveFromClauseError.md) +- [`OnlyOneSourceAllowedError`](./OnlyOneSourceAllowedError.md) +- [`SubQueryMustHaveFromClauseError`](./SubQueryMustHaveFromClauseError.md) +- [`InvalidSourceError`](./InvalidSourceError.md) +- [`InvalidSourceTypeError`](./InvalidSourceTypeError.md) +- [`JoinConditionMustBeEqualityError`](./JoinConditionMustBeEqualityError.md) +- [`QueryMustHaveFromClauseError`](./QueryMustHaveFromClauseError.md) ## Constructors @@ -42,7 +42,7 @@ Defined in: [packages/db/src/errors.ts:337](https://github.com/TanStack/db/blob/ #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -56,7 +56,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -70,7 +70,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -84,7 +84,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -98,7 +98,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -122,7 +122,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -194,7 +194,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -226,4 +226,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/QueryCompilationError.md b/docs/reference/classes/QueryCompilationError.md index 7628112a7..7cf913359 100644 --- a/docs/reference/classes/QueryCompilationError.md +++ b/docs/reference/classes/QueryCompilationError.md @@ -9,24 +9,24 @@ Defined in: [packages/db/src/errors.ts:385](https://github.com/TanStack/db/blob/ ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Extended by -- [`DistinctRequiresSelectError`](../DistinctRequiresSelectError.md) -- [`HavingRequiresGroupByError`](../HavingRequiresGroupByError.md) -- [`LimitOffsetRequireOrderByError`](../LimitOffsetRequireOrderByError.md) -- [`CollectionInputNotFoundError`](../CollectionInputNotFoundError.md) -- [`DuplicateAliasInSubqueryError`](../DuplicateAliasInSubqueryError.md) -- [`UnsupportedFromTypeError`](../UnsupportedFromTypeError.md) -- [`UnknownExpressionTypeError`](../UnknownExpressionTypeError.md) -- [`EmptyReferencePathError`](../EmptyReferencePathError.md) -- [`UnknownFunctionError`](../UnknownFunctionError.md) -- [`JoinCollectionNotFoundError`](../JoinCollectionNotFoundError.md) -- [`SubscriptionNotFoundError`](../SubscriptionNotFoundError.md) -- [`AggregateNotSupportedError`](../AggregateNotSupportedError.md) -- [`MissingAliasInputsError`](../MissingAliasInputsError.md) -- [`SetWindowRequiresOrderByError`](../SetWindowRequiresOrderByError.md) +- [`DistinctRequiresSelectError`](./DistinctRequiresSelectError.md) +- [`HavingRequiresGroupByError`](./HavingRequiresGroupByError.md) +- [`LimitOffsetRequireOrderByError`](./LimitOffsetRequireOrderByError.md) +- [`CollectionInputNotFoundError`](./CollectionInputNotFoundError.md) +- [`DuplicateAliasInSubqueryError`](./DuplicateAliasInSubqueryError.md) +- [`UnsupportedFromTypeError`](./UnsupportedFromTypeError.md) +- [`UnknownExpressionTypeError`](./UnknownExpressionTypeError.md) +- [`EmptyReferencePathError`](./EmptyReferencePathError.md) +- [`UnknownFunctionError`](./UnknownFunctionError.md) +- [`JoinCollectionNotFoundError`](./JoinCollectionNotFoundError.md) +- [`SubscriptionNotFoundError`](./SubscriptionNotFoundError.md) +- [`AggregateNotSupportedError`](./AggregateNotSupportedError.md) +- [`MissingAliasInputsError`](./MissingAliasInputsError.md) +- [`SetWindowRequiresOrderByError`](./SetWindowRequiresOrderByError.md) ## Constructors @@ -50,7 +50,7 @@ Defined in: [packages/db/src/errors.ts:386](https://github.com/TanStack/db/blob/ #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -64,7 +64,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -78,7 +78,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -92,7 +92,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -106,7 +106,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -130,7 +130,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -202,7 +202,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -234,4 +234,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/QueryMustHaveFromClauseError.md b/docs/reference/classes/QueryMustHaveFromClauseError.md index 07b085bc2..5f52fcf2b 100644 --- a/docs/reference/classes/QueryMustHaveFromClauseError.md +++ b/docs/reference/classes/QueryMustHaveFromClauseError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:378](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryBuilderError`](../QueryBuilderError.md) +- [`QueryBuilderError`](./QueryBuilderError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:379](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryBuilderError`](../QueryBuilderError.md).[`constructor`](../QueryBuilderError.md#constructor) +[`QueryBuilderError`](./QueryBuilderError.md).[`constructor`](./QueryBuilderError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`cause`](../QueryBuilderError.md#cause) +[`QueryBuilderError`](./QueryBuilderError.md).[`cause`](./QueryBuilderError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`message`](../QueryBuilderError.md#message) +[`QueryBuilderError`](./QueryBuilderError.md).[`message`](./QueryBuilderError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`name`](../QueryBuilderError.md#name) +[`QueryBuilderError`](./QueryBuilderError.md).[`name`](./QueryBuilderError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`stack`](../QueryBuilderError.md#stack) +[`QueryBuilderError`](./QueryBuilderError.md).[`stack`](./QueryBuilderError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`stackTraceLimit`](../QueryBuilderError.md#stacktracelimit) +[`QueryBuilderError`](./QueryBuilderError.md).[`stackTraceLimit`](./QueryBuilderError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`captureStackTrace`](../QueryBuilderError.md#capturestacktrace) +[`QueryBuilderError`](./QueryBuilderError.md).[`captureStackTrace`](./QueryBuilderError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`prepareStackTrace`](../QueryBuilderError.md#preparestacktrace) +[`QueryBuilderError`](./QueryBuilderError.md).[`prepareStackTrace`](./QueryBuilderError.md#preparestacktrace) diff --git a/docs/reference/classes/QueryOptimizerError.md b/docs/reference/classes/QueryOptimizerError.md index 310a308e3..280a4ac84 100644 --- a/docs/reference/classes/QueryOptimizerError.md +++ b/docs/reference/classes/QueryOptimizerError.md @@ -9,12 +9,12 @@ Defined in: [packages/db/src/errors.ts:628](https://github.com/TanStack/db/blob/ ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Extended by -- [`CannotCombineEmptyExpressionListError`](../CannotCombineEmptyExpressionListError.md) -- [`WhereClauseConversionError`](../WhereClauseConversionError.md) +- [`CannotCombineEmptyExpressionListError`](./CannotCombineEmptyExpressionListError.md) +- [`WhereClauseConversionError`](./WhereClauseConversionError.md) ## Constructors @@ -38,7 +38,7 @@ Defined in: [packages/db/src/errors.ts:629](https://github.com/TanStack/db/blob/ #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -52,7 +52,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -66,7 +66,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -80,7 +80,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -94,7 +94,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -118,7 +118,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -190,7 +190,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -222,4 +222,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/SchemaMustBeSynchronousError.md b/docs/reference/classes/SchemaMustBeSynchronousError.md index 85d06e5fa..2254c79d3 100644 --- a/docs/reference/classes/SchemaMustBeSynchronousError.md +++ b/docs/reference/classes/SchemaMustBeSynchronousError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:96](https://github.com/TanStack/db/blob/m ## Extends -- [`CollectionConfigurationError`](../CollectionConfigurationError.md) +- [`CollectionConfigurationError`](./CollectionConfigurationError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:97](https://github.com/TanStack/db/blob/m #### Overrides -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`constructor`](../CollectionConfigurationError.md#constructor) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`constructor`](./CollectionConfigurationError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`cause`](../CollectionConfigurationError.md#cause) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`cause`](./CollectionConfigurationError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`message`](../CollectionConfigurationError.md#message) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`message`](./CollectionConfigurationError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`name`](../CollectionConfigurationError.md#name) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`name`](./CollectionConfigurationError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`stack`](../CollectionConfigurationError.md#stack) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`stack`](./CollectionConfigurationError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`stackTraceLimit`](../CollectionConfigurationError.md#stacktracelimit) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`stackTraceLimit`](./CollectionConfigurationError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`captureStackTrace`](../CollectionConfigurationError.md#capturestacktrace) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`captureStackTrace`](./CollectionConfigurationError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionConfigurationError`](../CollectionConfigurationError.md).[`prepareStackTrace`](../CollectionConfigurationError.md#preparestacktrace) +[`CollectionConfigurationError`](./CollectionConfigurationError.md).[`prepareStackTrace`](./CollectionConfigurationError.md#preparestacktrace) diff --git a/docs/reference/classes/SchemaValidationError.md b/docs/reference/classes/SchemaValidationError.md index fecd17ffa..9fa013883 100644 --- a/docs/reference/classes/SchemaValidationError.md +++ b/docs/reference/classes/SchemaValidationError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:18](https://github.com/TanStack/db/blob/m ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Constructors @@ -44,7 +44,7 @@ readonly `object`[] #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -58,7 +58,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -82,7 +82,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -96,7 +96,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -110,7 +110,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -144,7 +144,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -216,7 +216,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -248,4 +248,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/SerializationError.md b/docs/reference/classes/SerializationError.md index ba8d0cd59..bc1b7bba2 100644 --- a/docs/reference/classes/SerializationError.md +++ b/docs/reference/classes/SerializationError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:578](https://github.com/TanStack/db/blob/ ## Extends -- [`StorageError`](../StorageError.md) +- [`StorageError`](./StorageError.md) ## Constructors @@ -37,7 +37,7 @@ Defined in: [packages/db/src/errors.ts:579](https://github.com/TanStack/db/blob/ #### Overrides -[`StorageError`](../StorageError.md).[`constructor`](../StorageError.md#constructor) +[`StorageError`](./StorageError.md).[`constructor`](./StorageError.md#constructor) ## Properties @@ -51,7 +51,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`StorageError`](../StorageError.md).[`cause`](../StorageError.md#cause) +[`StorageError`](./StorageError.md).[`cause`](./StorageError.md#cause) *** @@ -65,7 +65,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`StorageError`](../StorageError.md).[`message`](../StorageError.md#message) +[`StorageError`](./StorageError.md).[`message`](./StorageError.md#message) *** @@ -79,7 +79,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`StorageError`](../StorageError.md).[`name`](../StorageError.md#name) +[`StorageError`](./StorageError.md).[`name`](./StorageError.md#name) *** @@ -93,7 +93,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`StorageError`](../StorageError.md).[`stack`](../StorageError.md#stack) +[`StorageError`](./StorageError.md).[`stack`](./StorageError.md#stack) *** @@ -117,7 +117,7 @@ not capture any frames. #### Inherited from -[`StorageError`](../StorageError.md).[`stackTraceLimit`](../StorageError.md#stacktracelimit) +[`StorageError`](./StorageError.md).[`stackTraceLimit`](./StorageError.md#stacktracelimit) ## Methods @@ -189,7 +189,7 @@ a(); #### Inherited from -[`StorageError`](../StorageError.md).[`captureStackTrace`](../StorageError.md#capturestacktrace) +[`StorageError`](./StorageError.md).[`captureStackTrace`](./StorageError.md#capturestacktrace) *** @@ -221,4 +221,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`StorageError`](../StorageError.md).[`prepareStackTrace`](../StorageError.md#preparestacktrace) +[`StorageError`](./StorageError.md).[`prepareStackTrace`](./StorageError.md#preparestacktrace) diff --git a/docs/reference/classes/SetWindowRequiresOrderByError.md b/docs/reference/classes/SetWindowRequiresOrderByError.md index 68ae1e85e..ed067d69f 100644 --- a/docs/reference/classes/SetWindowRequiresOrderByError.md +++ b/docs/reference/classes/SetWindowRequiresOrderByError.md @@ -11,7 +11,7 @@ Error thrown when setWindow is called on a collection without an ORDER BY clause ## Extends -- [`QueryCompilationError`](../QueryCompilationError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) ## Constructors @@ -29,7 +29,7 @@ Defined in: [packages/db/src/errors.ts:697](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryCompilationError`](../QueryCompilationError.md).[`constructor`](../QueryCompilationError.md#constructor) +[`QueryCompilationError`](./QueryCompilationError.md).[`constructor`](./QueryCompilationError.md#constructor) ## Properties @@ -43,7 +43,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`cause`](../QueryCompilationError.md#cause) +[`QueryCompilationError`](./QueryCompilationError.md).[`cause`](./QueryCompilationError.md#cause) *** @@ -57,7 +57,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`message`](../QueryCompilationError.md#message) +[`QueryCompilationError`](./QueryCompilationError.md).[`message`](./QueryCompilationError.md#message) *** @@ -71,7 +71,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`name`](../QueryCompilationError.md#name) +[`QueryCompilationError`](./QueryCompilationError.md).[`name`](./QueryCompilationError.md#name) *** @@ -85,7 +85,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stack`](../QueryCompilationError.md#stack) +[`QueryCompilationError`](./QueryCompilationError.md).[`stack`](./QueryCompilationError.md#stack) *** @@ -109,7 +109,7 @@ not capture any frames. #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stackTraceLimit`](../QueryCompilationError.md#stacktracelimit) +[`QueryCompilationError`](./QueryCompilationError.md).[`stackTraceLimit`](./QueryCompilationError.md#stacktracelimit) ## Methods @@ -181,7 +181,7 @@ a(); #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`captureStackTrace`](../QueryCompilationError.md#capturestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`captureStackTrace`](./QueryCompilationError.md#capturestacktrace) *** @@ -213,4 +213,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`prepareStackTrace`](../QueryCompilationError.md#preparestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`prepareStackTrace`](./QueryCompilationError.md#preparestacktrace) diff --git a/docs/reference/classes/StorageError.md b/docs/reference/classes/StorageError.md index d8c4fc35b..1372f6851 100644 --- a/docs/reference/classes/StorageError.md +++ b/docs/reference/classes/StorageError.md @@ -9,12 +9,12 @@ Defined in: [packages/db/src/errors.ts:571](https://github.com/TanStack/db/blob/ ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Extended by -- [`SerializationError`](../SerializationError.md) -- [`LocalStorageCollectionError`](../LocalStorageCollectionError.md) +- [`SerializationError`](./SerializationError.md) +- [`LocalStorageCollectionError`](./LocalStorageCollectionError.md) ## Constructors @@ -38,7 +38,7 @@ Defined in: [packages/db/src/errors.ts:572](https://github.com/TanStack/db/blob/ #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -52,7 +52,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -66,7 +66,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -80,7 +80,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -94,7 +94,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -118,7 +118,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -190,7 +190,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -222,4 +222,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/StorageKeyRequiredError.md b/docs/reference/classes/StorageKeyRequiredError.md index ac825a752..bd8ad38b5 100644 --- a/docs/reference/classes/StorageKeyRequiredError.md +++ b/docs/reference/classes/StorageKeyRequiredError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:594](https://github.com/TanStack/db/blob/ ## Extends -- [`LocalStorageCollectionError`](../LocalStorageCollectionError.md) +- [`LocalStorageCollectionError`](./LocalStorageCollectionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:595](https://github.com/TanStack/db/blob/ #### Overrides -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`constructor`](../LocalStorageCollectionError.md#constructor) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`constructor`](./LocalStorageCollectionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`cause`](../LocalStorageCollectionError.md#cause) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`cause`](./LocalStorageCollectionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`message`](../LocalStorageCollectionError.md#message) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`message`](./LocalStorageCollectionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`name`](../LocalStorageCollectionError.md#name) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`name`](./LocalStorageCollectionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`stack`](../LocalStorageCollectionError.md#stack) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`stack`](./LocalStorageCollectionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`stackTraceLimit`](../LocalStorageCollectionError.md#stacktracelimit) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`stackTraceLimit`](./LocalStorageCollectionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`captureStackTrace`](../LocalStorageCollectionError.md#capturestacktrace) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`captureStackTrace`](./LocalStorageCollectionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`LocalStorageCollectionError`](../LocalStorageCollectionError.md).[`prepareStackTrace`](../LocalStorageCollectionError.md#preparestacktrace) +[`LocalStorageCollectionError`](./LocalStorageCollectionError.md).[`prepareStackTrace`](./LocalStorageCollectionError.md#preparestacktrace) diff --git a/docs/reference/classes/SubQueryMustHaveFromClauseError.md b/docs/reference/classes/SubQueryMustHaveFromClauseError.md index db02ceff9..7e1545ded 100644 --- a/docs/reference/classes/SubQueryMustHaveFromClauseError.md +++ b/docs/reference/classes/SubQueryMustHaveFromClauseError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:349](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryBuilderError`](../QueryBuilderError.md) +- [`QueryBuilderError`](./QueryBuilderError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:350](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryBuilderError`](../QueryBuilderError.md).[`constructor`](../QueryBuilderError.md#constructor) +[`QueryBuilderError`](./QueryBuilderError.md).[`constructor`](./QueryBuilderError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`cause`](../QueryBuilderError.md#cause) +[`QueryBuilderError`](./QueryBuilderError.md).[`cause`](./QueryBuilderError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`message`](../QueryBuilderError.md#message) +[`QueryBuilderError`](./QueryBuilderError.md).[`message`](./QueryBuilderError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`name`](../QueryBuilderError.md#name) +[`QueryBuilderError`](./QueryBuilderError.md).[`name`](./QueryBuilderError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`stack`](../QueryBuilderError.md#stack) +[`QueryBuilderError`](./QueryBuilderError.md).[`stack`](./QueryBuilderError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`stackTraceLimit`](../QueryBuilderError.md#stacktracelimit) +[`QueryBuilderError`](./QueryBuilderError.md).[`stackTraceLimit`](./QueryBuilderError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`captureStackTrace`](../QueryBuilderError.md#capturestacktrace) +[`QueryBuilderError`](./QueryBuilderError.md).[`captureStackTrace`](./QueryBuilderError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryBuilderError`](../QueryBuilderError.md).[`prepareStackTrace`](../QueryBuilderError.md#preparestacktrace) +[`QueryBuilderError`](./QueryBuilderError.md).[`prepareStackTrace`](./QueryBuilderError.md#preparestacktrace) diff --git a/docs/reference/classes/SubscriptionNotFoundError.md b/docs/reference/classes/SubscriptionNotFoundError.md index a42d9079f..60109b312 100644 --- a/docs/reference/classes/SubscriptionNotFoundError.md +++ b/docs/reference/classes/SubscriptionNotFoundError.md @@ -12,7 +12,7 @@ For subqueries, aliases may be remapped (e.g., 'activeUser' → 'user'). ## Extends -- [`QueryCompilationError`](../QueryCompilationError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) ## Constructors @@ -52,7 +52,7 @@ Defined in: [packages/db/src/errors.ts:657](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryCompilationError`](../QueryCompilationError.md).[`constructor`](../QueryCompilationError.md#constructor) +[`QueryCompilationError`](./QueryCompilationError.md).[`constructor`](./QueryCompilationError.md#constructor) ## Properties @@ -66,7 +66,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`cause`](../QueryCompilationError.md#cause) +[`QueryCompilationError`](./QueryCompilationError.md).[`cause`](./QueryCompilationError.md#cause) *** @@ -80,7 +80,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`message`](../QueryCompilationError.md#message) +[`QueryCompilationError`](./QueryCompilationError.md).[`message`](./QueryCompilationError.md#message) *** @@ -94,7 +94,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`name`](../QueryCompilationError.md#name) +[`QueryCompilationError`](./QueryCompilationError.md).[`name`](./QueryCompilationError.md#name) *** @@ -108,7 +108,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stack`](../QueryCompilationError.md#stack) +[`QueryCompilationError`](./QueryCompilationError.md).[`stack`](./QueryCompilationError.md#stack) *** @@ -132,7 +132,7 @@ not capture any frames. #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stackTraceLimit`](../QueryCompilationError.md#stacktracelimit) +[`QueryCompilationError`](./QueryCompilationError.md).[`stackTraceLimit`](./QueryCompilationError.md#stacktracelimit) ## Methods @@ -204,7 +204,7 @@ a(); #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`captureStackTrace`](../QueryCompilationError.md#capturestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`captureStackTrace`](./QueryCompilationError.md#capturestacktrace) *** @@ -236,4 +236,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`prepareStackTrace`](../QueryCompilationError.md#preparestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`prepareStackTrace`](./QueryCompilationError.md#preparestacktrace) diff --git a/docs/reference/classes/SyncCleanupError.md b/docs/reference/classes/SyncCleanupError.md index d8d7c3b7a..c76c6a69b 100644 --- a/docs/reference/classes/SyncCleanupError.md +++ b/docs/reference/classes/SyncCleanupError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:617](https://github.com/TanStack/db/blob/ ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Constructors @@ -37,7 +37,7 @@ Defined in: [packages/db/src/errors.ts:618](https://github.com/TanStack/db/blob/ #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -51,7 +51,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -65,7 +65,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -79,7 +79,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -93,7 +93,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -117,7 +117,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -189,7 +189,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -221,4 +221,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/SyncTransactionAlreadyCommittedError.md b/docs/reference/classes/SyncTransactionAlreadyCommittedError.md index 78daaf215..7a4a3afec 100644 --- a/docs/reference/classes/SyncTransactionAlreadyCommittedError.md +++ b/docs/reference/classes/SyncTransactionAlreadyCommittedError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:327](https://github.com/TanStack/db/blob/ ## Extends -- [`TransactionError`](../TransactionError.md) +- [`TransactionError`](./TransactionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:328](https://github.com/TanStack/db/blob/ #### Overrides -[`TransactionError`](../TransactionError.md).[`constructor`](../TransactionError.md#constructor) +[`TransactionError`](./TransactionError.md).[`constructor`](./TransactionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`cause`](../TransactionError.md#cause) +[`TransactionError`](./TransactionError.md).[`cause`](./TransactionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`message`](../TransactionError.md#message) +[`TransactionError`](./TransactionError.md).[`message`](./TransactionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`name`](../TransactionError.md#name) +[`TransactionError`](./TransactionError.md).[`name`](./TransactionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`stack`](../TransactionError.md#stack) +[`TransactionError`](./TransactionError.md).[`stack`](./TransactionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`TransactionError`](../TransactionError.md).[`stackTraceLimit`](../TransactionError.md#stacktracelimit) +[`TransactionError`](./TransactionError.md).[`stackTraceLimit`](./TransactionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`TransactionError`](../TransactionError.md).[`captureStackTrace`](../TransactionError.md#capturestacktrace) +[`TransactionError`](./TransactionError.md).[`captureStackTrace`](./TransactionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TransactionError`](../TransactionError.md).[`prepareStackTrace`](../TransactionError.md#preparestacktrace) +[`TransactionError`](./TransactionError.md).[`prepareStackTrace`](./TransactionError.md#preparestacktrace) diff --git a/docs/reference/classes/SyncTransactionAlreadyCommittedWriteError.md b/docs/reference/classes/SyncTransactionAlreadyCommittedWriteError.md index 1fa89e16b..5e68bd111 100644 --- a/docs/reference/classes/SyncTransactionAlreadyCommittedWriteError.md +++ b/docs/reference/classes/SyncTransactionAlreadyCommittedWriteError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:313](https://github.com/TanStack/db/blob/ ## Extends -- [`TransactionError`](../TransactionError.md) +- [`TransactionError`](./TransactionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:314](https://github.com/TanStack/db/blob/ #### Overrides -[`TransactionError`](../TransactionError.md).[`constructor`](../TransactionError.md#constructor) +[`TransactionError`](./TransactionError.md).[`constructor`](./TransactionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`cause`](../TransactionError.md#cause) +[`TransactionError`](./TransactionError.md).[`cause`](./TransactionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`message`](../TransactionError.md#message) +[`TransactionError`](./TransactionError.md).[`message`](./TransactionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`name`](../TransactionError.md#name) +[`TransactionError`](./TransactionError.md).[`name`](./TransactionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`stack`](../TransactionError.md#stack) +[`TransactionError`](./TransactionError.md).[`stack`](./TransactionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`TransactionError`](../TransactionError.md).[`stackTraceLimit`](../TransactionError.md#stacktracelimit) +[`TransactionError`](./TransactionError.md).[`stackTraceLimit`](./TransactionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`TransactionError`](../TransactionError.md).[`captureStackTrace`](../TransactionError.md#capturestacktrace) +[`TransactionError`](./TransactionError.md).[`captureStackTrace`](./TransactionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TransactionError`](../TransactionError.md).[`prepareStackTrace`](../TransactionError.md#preparestacktrace) +[`TransactionError`](./TransactionError.md).[`prepareStackTrace`](./TransactionError.md#preparestacktrace) diff --git a/docs/reference/classes/TanStackDBError.md b/docs/reference/classes/TanStackDBError.md index dabc7ccbd..124fac315 100644 --- a/docs/reference/classes/TanStackDBError.md +++ b/docs/reference/classes/TanStackDBError.md @@ -13,21 +13,21 @@ Defined in: [packages/db/src/errors.ts:2](https://github.com/TanStack/db/blob/ma ## Extended by -- [`NonRetriableError`](../NonRetriableError.md) -- [`SchemaValidationError`](../SchemaValidationError.md) -- [`DuplicateDbInstanceError`](../DuplicateDbInstanceError.md) -- [`CollectionConfigurationError`](../CollectionConfigurationError.md) -- [`CollectionStateError`](../CollectionStateError.md) -- [`CollectionOperationError`](../CollectionOperationError.md) -- [`MissingHandlerError`](../MissingHandlerError.md) -- [`TransactionError`](../TransactionError.md) -- [`QueryBuilderError`](../QueryBuilderError.md) -- [`QueryCompilationError`](../QueryCompilationError.md) -- [`JoinError`](../JoinError.md) -- [`GroupByError`](../GroupByError.md) -- [`StorageError`](../StorageError.md) -- [`SyncCleanupError`](../SyncCleanupError.md) -- [`QueryOptimizerError`](../QueryOptimizerError.md) +- [`NonRetriableError`](./NonRetriableError.md) +- [`SchemaValidationError`](./SchemaValidationError.md) +- [`DuplicateDbInstanceError`](./DuplicateDbInstanceError.md) +- [`CollectionConfigurationError`](./CollectionConfigurationError.md) +- [`CollectionStateError`](./CollectionStateError.md) +- [`CollectionOperationError`](./CollectionOperationError.md) +- [`MissingHandlerError`](./MissingHandlerError.md) +- [`TransactionError`](./TransactionError.md) +- [`QueryBuilderError`](./QueryBuilderError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) +- [`JoinError`](./JoinError.md) +- [`GroupByError`](./GroupByError.md) +- [`StorageError`](./StorageError.md) +- [`SyncCleanupError`](./SyncCleanupError.md) +- [`QueryOptimizerError`](./QueryOptimizerError.md) ## Constructors diff --git a/docs/reference/classes/TransactionAlreadyCompletedRollbackError.md b/docs/reference/classes/TransactionAlreadyCompletedRollbackError.md index 6469f7f0c..53e363ef3 100644 --- a/docs/reference/classes/TransactionAlreadyCompletedRollbackError.md +++ b/docs/reference/classes/TransactionAlreadyCompletedRollbackError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:291](https://github.com/TanStack/db/blob/ ## Extends -- [`TransactionError`](../TransactionError.md) +- [`TransactionError`](./TransactionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:292](https://github.com/TanStack/db/blob/ #### Overrides -[`TransactionError`](../TransactionError.md).[`constructor`](../TransactionError.md#constructor) +[`TransactionError`](./TransactionError.md).[`constructor`](./TransactionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`cause`](../TransactionError.md#cause) +[`TransactionError`](./TransactionError.md).[`cause`](./TransactionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`message`](../TransactionError.md#message) +[`TransactionError`](./TransactionError.md).[`message`](./TransactionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`name`](../TransactionError.md#name) +[`TransactionError`](./TransactionError.md).[`name`](./TransactionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`stack`](../TransactionError.md#stack) +[`TransactionError`](./TransactionError.md).[`stack`](./TransactionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`TransactionError`](../TransactionError.md).[`stackTraceLimit`](../TransactionError.md#stacktracelimit) +[`TransactionError`](./TransactionError.md).[`stackTraceLimit`](./TransactionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`TransactionError`](../TransactionError.md).[`captureStackTrace`](../TransactionError.md#capturestacktrace) +[`TransactionError`](./TransactionError.md).[`captureStackTrace`](./TransactionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TransactionError`](../TransactionError.md).[`prepareStackTrace`](../TransactionError.md#preparestacktrace) +[`TransactionError`](./TransactionError.md).[`prepareStackTrace`](./TransactionError.md#preparestacktrace) diff --git a/docs/reference/classes/TransactionError.md b/docs/reference/classes/TransactionError.md index 29381eeb0..fa530f58d 100644 --- a/docs/reference/classes/TransactionError.md +++ b/docs/reference/classes/TransactionError.md @@ -9,19 +9,19 @@ Defined in: [packages/db/src/errors.ts:261](https://github.com/TanStack/db/blob/ ## Extends -- [`TanStackDBError`](../TanStackDBError.md) +- [`TanStackDBError`](./TanStackDBError.md) ## Extended by -- [`MissingMutationFunctionError`](../MissingMutationFunctionError.md) -- [`OnMutateMustBeSynchronousError`](../OnMutateMustBeSynchronousError.md) -- [`TransactionNotPendingMutateError`](../TransactionNotPendingMutateError.md) -- [`TransactionAlreadyCompletedRollbackError`](../TransactionAlreadyCompletedRollbackError.md) -- [`TransactionNotPendingCommitError`](../TransactionNotPendingCommitError.md) -- [`NoPendingSyncTransactionWriteError`](../NoPendingSyncTransactionWriteError.md) -- [`SyncTransactionAlreadyCommittedWriteError`](../SyncTransactionAlreadyCommittedWriteError.md) -- [`NoPendingSyncTransactionCommitError`](../NoPendingSyncTransactionCommitError.md) -- [`SyncTransactionAlreadyCommittedError`](../SyncTransactionAlreadyCommittedError.md) +- [`MissingMutationFunctionError`](./MissingMutationFunctionError.md) +- [`OnMutateMustBeSynchronousError`](./OnMutateMustBeSynchronousError.md) +- [`TransactionNotPendingMutateError`](./TransactionNotPendingMutateError.md) +- [`TransactionAlreadyCompletedRollbackError`](./TransactionAlreadyCompletedRollbackError.md) +- [`TransactionNotPendingCommitError`](./TransactionNotPendingCommitError.md) +- [`NoPendingSyncTransactionWriteError`](./NoPendingSyncTransactionWriteError.md) +- [`SyncTransactionAlreadyCommittedWriteError`](./SyncTransactionAlreadyCommittedWriteError.md) +- [`NoPendingSyncTransactionCommitError`](./NoPendingSyncTransactionCommitError.md) +- [`SyncTransactionAlreadyCommittedError`](./SyncTransactionAlreadyCommittedError.md) ## Constructors @@ -45,7 +45,7 @@ Defined in: [packages/db/src/errors.ts:262](https://github.com/TanStack/db/blob/ #### Overrides -[`TanStackDBError`](../TanStackDBError.md).[`constructor`](../TanStackDBError.md#constructor) +[`TanStackDBError`](./TanStackDBError.md).[`constructor`](./TanStackDBError.md#constructor) ## Properties @@ -59,7 +59,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`cause`](../TanStackDBError.md#cause) +[`TanStackDBError`](./TanStackDBError.md).[`cause`](./TanStackDBError.md#cause) *** @@ -73,7 +73,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`message`](../TanStackDBError.md#message) +[`TanStackDBError`](./TanStackDBError.md).[`message`](./TanStackDBError.md#message) *** @@ -87,7 +87,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`name`](../TanStackDBError.md#name) +[`TanStackDBError`](./TanStackDBError.md).[`name`](./TanStackDBError.md#name) *** @@ -101,7 +101,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stack`](../TanStackDBError.md#stack) +[`TanStackDBError`](./TanStackDBError.md).[`stack`](./TanStackDBError.md#stack) *** @@ -125,7 +125,7 @@ not capture any frames. #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`stackTraceLimit`](../TanStackDBError.md#stacktracelimit) +[`TanStackDBError`](./TanStackDBError.md).[`stackTraceLimit`](./TanStackDBError.md#stacktracelimit) ## Methods @@ -197,7 +197,7 @@ a(); #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`captureStackTrace`](../TanStackDBError.md#capturestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`captureStackTrace`](./TanStackDBError.md#capturestacktrace) *** @@ -229,4 +229,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TanStackDBError`](../TanStackDBError.md).[`prepareStackTrace`](../TanStackDBError.md#preparestacktrace) +[`TanStackDBError`](./TanStackDBError.md).[`prepareStackTrace`](./TanStackDBError.md#preparestacktrace) diff --git a/docs/reference/classes/TransactionNotPendingCommitError.md b/docs/reference/classes/TransactionNotPendingCommitError.md index dc9705bb8..9a7bd1564 100644 --- a/docs/reference/classes/TransactionNotPendingCommitError.md +++ b/docs/reference/classes/TransactionNotPendingCommitError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:299](https://github.com/TanStack/db/blob/ ## Extends -- [`TransactionError`](../TransactionError.md) +- [`TransactionError`](./TransactionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:300](https://github.com/TanStack/db/blob/ #### Overrides -[`TransactionError`](../TransactionError.md).[`constructor`](../TransactionError.md#constructor) +[`TransactionError`](./TransactionError.md).[`constructor`](./TransactionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`cause`](../TransactionError.md#cause) +[`TransactionError`](./TransactionError.md).[`cause`](./TransactionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`message`](../TransactionError.md#message) +[`TransactionError`](./TransactionError.md).[`message`](./TransactionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`name`](../TransactionError.md#name) +[`TransactionError`](./TransactionError.md).[`name`](./TransactionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`stack`](../TransactionError.md#stack) +[`TransactionError`](./TransactionError.md).[`stack`](./TransactionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`TransactionError`](../TransactionError.md).[`stackTraceLimit`](../TransactionError.md#stacktracelimit) +[`TransactionError`](./TransactionError.md).[`stackTraceLimit`](./TransactionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`TransactionError`](../TransactionError.md).[`captureStackTrace`](../TransactionError.md#capturestacktrace) +[`TransactionError`](./TransactionError.md).[`captureStackTrace`](./TransactionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TransactionError`](../TransactionError.md).[`prepareStackTrace`](../TransactionError.md#preparestacktrace) +[`TransactionError`](./TransactionError.md).[`prepareStackTrace`](./TransactionError.md#preparestacktrace) diff --git a/docs/reference/classes/TransactionNotPendingMutateError.md b/docs/reference/classes/TransactionNotPendingMutateError.md index 57bf6eb32..34a98b299 100644 --- a/docs/reference/classes/TransactionNotPendingMutateError.md +++ b/docs/reference/classes/TransactionNotPendingMutateError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:283](https://github.com/TanStack/db/blob/ ## Extends -- [`TransactionError`](../TransactionError.md) +- [`TransactionError`](./TransactionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/db/src/errors.ts:284](https://github.com/TanStack/db/blob/ #### Overrides -[`TransactionError`](../TransactionError.md).[`constructor`](../TransactionError.md#constructor) +[`TransactionError`](./TransactionError.md).[`constructor`](./TransactionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`cause`](../TransactionError.md#cause) +[`TransactionError`](./TransactionError.md).[`cause`](./TransactionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`message`](../TransactionError.md#message) +[`TransactionError`](./TransactionError.md).[`message`](./TransactionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`name`](../TransactionError.md#name) +[`TransactionError`](./TransactionError.md).[`name`](./TransactionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`TransactionError`](../TransactionError.md).[`stack`](../TransactionError.md#stack) +[`TransactionError`](./TransactionError.md).[`stack`](./TransactionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`TransactionError`](../TransactionError.md).[`stackTraceLimit`](../TransactionError.md#stacktracelimit) +[`TransactionError`](./TransactionError.md).[`stackTraceLimit`](./TransactionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`TransactionError`](../TransactionError.md).[`captureStackTrace`](../TransactionError.md#capturestacktrace) +[`TransactionError`](./TransactionError.md).[`captureStackTrace`](./TransactionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`TransactionError`](../TransactionError.md).[`prepareStackTrace`](../TransactionError.md#preparestacktrace) +[`TransactionError`](./TransactionError.md).[`prepareStackTrace`](./TransactionError.md#preparestacktrace) diff --git a/docs/reference/classes/UndefinedKeyError.md b/docs/reference/classes/UndefinedKeyError.md index 24f075ab1..d80a0754e 100644 --- a/docs/reference/classes/UndefinedKeyError.md +++ b/docs/reference/classes/UndefinedKeyError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:146](https://github.com/TanStack/db/blob/ ## Extends -- [`CollectionOperationError`](../CollectionOperationError.md) +- [`CollectionOperationError`](./CollectionOperationError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:147](https://github.com/TanStack/db/blob/ #### Overrides -[`CollectionOperationError`](../CollectionOperationError.md).[`constructor`](../CollectionOperationError.md#constructor) +[`CollectionOperationError`](./CollectionOperationError.md).[`constructor`](./CollectionOperationError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`cause`](../CollectionOperationError.md#cause) +[`CollectionOperationError`](./CollectionOperationError.md).[`cause`](./CollectionOperationError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`message`](../CollectionOperationError.md#message) +[`CollectionOperationError`](./CollectionOperationError.md).[`message`](./CollectionOperationError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`name`](../CollectionOperationError.md#name) +[`CollectionOperationError`](./CollectionOperationError.md).[`name`](./CollectionOperationError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stack`](../CollectionOperationError.md#stack) +[`CollectionOperationError`](./CollectionOperationError.md).[`stack`](./CollectionOperationError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stackTraceLimit`](../CollectionOperationError.md#stacktracelimit) +[`CollectionOperationError`](./CollectionOperationError.md).[`stackTraceLimit`](./CollectionOperationError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`captureStackTrace`](../CollectionOperationError.md#capturestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`captureStackTrace`](./CollectionOperationError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`prepareStackTrace`](../CollectionOperationError.md#preparestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`prepareStackTrace`](./CollectionOperationError.md#preparestacktrace) diff --git a/docs/reference/classes/UnknownExpressionTypeError.md b/docs/reference/classes/UnknownExpressionTypeError.md index f4d74a8d2..6adba64e7 100644 --- a/docs/reference/classes/UnknownExpressionTypeError.md +++ b/docs/reference/classes/UnknownExpressionTypeError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:454](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryCompilationError`](../QueryCompilationError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:455](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryCompilationError`](../QueryCompilationError.md).[`constructor`](../QueryCompilationError.md#constructor) +[`QueryCompilationError`](./QueryCompilationError.md).[`constructor`](./QueryCompilationError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`cause`](../QueryCompilationError.md#cause) +[`QueryCompilationError`](./QueryCompilationError.md).[`cause`](./QueryCompilationError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`message`](../QueryCompilationError.md#message) +[`QueryCompilationError`](./QueryCompilationError.md).[`message`](./QueryCompilationError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`name`](../QueryCompilationError.md#name) +[`QueryCompilationError`](./QueryCompilationError.md).[`name`](./QueryCompilationError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stack`](../QueryCompilationError.md#stack) +[`QueryCompilationError`](./QueryCompilationError.md).[`stack`](./QueryCompilationError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stackTraceLimit`](../QueryCompilationError.md#stacktracelimit) +[`QueryCompilationError`](./QueryCompilationError.md).[`stackTraceLimit`](./QueryCompilationError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`captureStackTrace`](../QueryCompilationError.md#capturestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`captureStackTrace`](./QueryCompilationError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`prepareStackTrace`](../QueryCompilationError.md#preparestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`prepareStackTrace`](./QueryCompilationError.md#preparestacktrace) diff --git a/docs/reference/classes/UnknownFunctionError.md b/docs/reference/classes/UnknownFunctionError.md index 7b9c5cd10..4556ede94 100644 --- a/docs/reference/classes/UnknownFunctionError.md +++ b/docs/reference/classes/UnknownFunctionError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:466](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryCompilationError`](../QueryCompilationError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:467](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryCompilationError`](../QueryCompilationError.md).[`constructor`](../QueryCompilationError.md#constructor) +[`QueryCompilationError`](./QueryCompilationError.md).[`constructor`](./QueryCompilationError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`cause`](../QueryCompilationError.md#cause) +[`QueryCompilationError`](./QueryCompilationError.md).[`cause`](./QueryCompilationError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`message`](../QueryCompilationError.md#message) +[`QueryCompilationError`](./QueryCompilationError.md).[`message`](./QueryCompilationError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`name`](../QueryCompilationError.md#name) +[`QueryCompilationError`](./QueryCompilationError.md).[`name`](./QueryCompilationError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stack`](../QueryCompilationError.md#stack) +[`QueryCompilationError`](./QueryCompilationError.md).[`stack`](./QueryCompilationError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stackTraceLimit`](../QueryCompilationError.md#stacktracelimit) +[`QueryCompilationError`](./QueryCompilationError.md).[`stackTraceLimit`](./QueryCompilationError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`captureStackTrace`](../QueryCompilationError.md#capturestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`captureStackTrace`](./QueryCompilationError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`prepareStackTrace`](../QueryCompilationError.md#preparestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`prepareStackTrace`](./QueryCompilationError.md#preparestacktrace) diff --git a/docs/reference/classes/UnknownHavingExpressionTypeError.md b/docs/reference/classes/UnknownHavingExpressionTypeError.md index 802a4699c..93f0cf768 100644 --- a/docs/reference/classes/UnknownHavingExpressionTypeError.md +++ b/docs/reference/classes/UnknownHavingExpressionTypeError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:564](https://github.com/TanStack/db/blob/ ## Extends -- [`GroupByError`](../GroupByError.md) +- [`GroupByError`](./GroupByError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:565](https://github.com/TanStack/db/blob/ #### Overrides -[`GroupByError`](../GroupByError.md).[`constructor`](../GroupByError.md#constructor) +[`GroupByError`](./GroupByError.md).[`constructor`](./GroupByError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`cause`](../GroupByError.md#cause) +[`GroupByError`](./GroupByError.md).[`cause`](./GroupByError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`message`](../GroupByError.md#message) +[`GroupByError`](./GroupByError.md).[`message`](./GroupByError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`name`](../GroupByError.md#name) +[`GroupByError`](./GroupByError.md).[`name`](./GroupByError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`stack`](../GroupByError.md#stack) +[`GroupByError`](./GroupByError.md).[`stack`](./GroupByError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`GroupByError`](../GroupByError.md).[`stackTraceLimit`](../GroupByError.md#stacktracelimit) +[`GroupByError`](./GroupByError.md).[`stackTraceLimit`](./GroupByError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`GroupByError`](../GroupByError.md).[`captureStackTrace`](../GroupByError.md#capturestacktrace) +[`GroupByError`](./GroupByError.md).[`captureStackTrace`](./GroupByError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`GroupByError`](../GroupByError.md).[`prepareStackTrace`](../GroupByError.md#preparestacktrace) +[`GroupByError`](./GroupByError.md).[`prepareStackTrace`](./GroupByError.md#preparestacktrace) diff --git a/docs/reference/classes/UnsupportedAggregateFunctionError.md b/docs/reference/classes/UnsupportedAggregateFunctionError.md index 6f377c35f..009c369dc 100644 --- a/docs/reference/classes/UnsupportedAggregateFunctionError.md +++ b/docs/reference/classes/UnsupportedAggregateFunctionError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:550](https://github.com/TanStack/db/blob/ ## Extends -- [`GroupByError`](../GroupByError.md) +- [`GroupByError`](./GroupByError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:551](https://github.com/TanStack/db/blob/ #### Overrides -[`GroupByError`](../GroupByError.md).[`constructor`](../GroupByError.md#constructor) +[`GroupByError`](./GroupByError.md).[`constructor`](./GroupByError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`cause`](../GroupByError.md#cause) +[`GroupByError`](./GroupByError.md).[`cause`](./GroupByError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`message`](../GroupByError.md#message) +[`GroupByError`](./GroupByError.md).[`message`](./GroupByError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`name`](../GroupByError.md#name) +[`GroupByError`](./GroupByError.md).[`name`](./GroupByError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`GroupByError`](../GroupByError.md).[`stack`](../GroupByError.md#stack) +[`GroupByError`](./GroupByError.md).[`stack`](./GroupByError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`GroupByError`](../GroupByError.md).[`stackTraceLimit`](../GroupByError.md#stacktracelimit) +[`GroupByError`](./GroupByError.md).[`stackTraceLimit`](./GroupByError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`GroupByError`](../GroupByError.md).[`captureStackTrace`](../GroupByError.md#capturestacktrace) +[`GroupByError`](./GroupByError.md).[`captureStackTrace`](./GroupByError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`GroupByError`](../GroupByError.md).[`prepareStackTrace`](../GroupByError.md#preparestacktrace) +[`GroupByError`](./GroupByError.md).[`prepareStackTrace`](./GroupByError.md#preparestacktrace) diff --git a/docs/reference/classes/UnsupportedFromTypeError.md b/docs/reference/classes/UnsupportedFromTypeError.md index 5dd5b84cf..d181a9cd5 100644 --- a/docs/reference/classes/UnsupportedFromTypeError.md +++ b/docs/reference/classes/UnsupportedFromTypeError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:448](https://github.com/TanStack/db/blob/ ## Extends -- [`QueryCompilationError`](../QueryCompilationError.md) +- [`QueryCompilationError`](./QueryCompilationError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:449](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryCompilationError`](../QueryCompilationError.md).[`constructor`](../QueryCompilationError.md#constructor) +[`QueryCompilationError`](./QueryCompilationError.md).[`constructor`](./QueryCompilationError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`cause`](../QueryCompilationError.md#cause) +[`QueryCompilationError`](./QueryCompilationError.md).[`cause`](./QueryCompilationError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`message`](../QueryCompilationError.md#message) +[`QueryCompilationError`](./QueryCompilationError.md).[`message`](./QueryCompilationError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`name`](../QueryCompilationError.md#name) +[`QueryCompilationError`](./QueryCompilationError.md).[`name`](./QueryCompilationError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stack`](../QueryCompilationError.md#stack) +[`QueryCompilationError`](./QueryCompilationError.md).[`stack`](./QueryCompilationError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`stackTraceLimit`](../QueryCompilationError.md#stacktracelimit) +[`QueryCompilationError`](./QueryCompilationError.md).[`stackTraceLimit`](./QueryCompilationError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`captureStackTrace`](../QueryCompilationError.md#capturestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`captureStackTrace`](./QueryCompilationError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCompilationError`](../QueryCompilationError.md).[`prepareStackTrace`](../QueryCompilationError.md#preparestacktrace) +[`QueryCompilationError`](./QueryCompilationError.md).[`prepareStackTrace`](./QueryCompilationError.md#preparestacktrace) diff --git a/docs/reference/classes/UnsupportedJoinSourceTypeError.md b/docs/reference/classes/UnsupportedJoinSourceTypeError.md index 35282dcef..5784dde00 100644 --- a/docs/reference/classes/UnsupportedJoinSourceTypeError.md +++ b/docs/reference/classes/UnsupportedJoinSourceTypeError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:528](https://github.com/TanStack/db/blob/ ## Extends -- [`JoinError`](../JoinError.md) +- [`JoinError`](./JoinError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:529](https://github.com/TanStack/db/blob/ #### Overrides -[`JoinError`](../JoinError.md).[`constructor`](../JoinError.md#constructor) +[`JoinError`](./JoinError.md).[`constructor`](./JoinError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`cause`](../JoinError.md#cause) +[`JoinError`](./JoinError.md).[`cause`](./JoinError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`message`](../JoinError.md#message) +[`JoinError`](./JoinError.md).[`message`](./JoinError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`name`](../JoinError.md#name) +[`JoinError`](./JoinError.md).[`name`](./JoinError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`stack`](../JoinError.md#stack) +[`JoinError`](./JoinError.md).[`stack`](./JoinError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`JoinError`](../JoinError.md).[`stackTraceLimit`](../JoinError.md#stacktracelimit) +[`JoinError`](./JoinError.md).[`stackTraceLimit`](./JoinError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`JoinError`](../JoinError.md).[`captureStackTrace`](../JoinError.md#capturestacktrace) +[`JoinError`](./JoinError.md).[`captureStackTrace`](./JoinError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`JoinError`](../JoinError.md).[`prepareStackTrace`](../JoinError.md#preparestacktrace) +[`JoinError`](./JoinError.md).[`prepareStackTrace`](./JoinError.md#preparestacktrace) diff --git a/docs/reference/classes/UnsupportedJoinTypeError.md b/docs/reference/classes/UnsupportedJoinTypeError.md index 9ef53dc56..dedc332f5 100644 --- a/docs/reference/classes/UnsupportedJoinTypeError.md +++ b/docs/reference/classes/UnsupportedJoinTypeError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:486](https://github.com/TanStack/db/blob/ ## Extends -- [`JoinError`](../JoinError.md) +- [`JoinError`](./JoinError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:487](https://github.com/TanStack/db/blob/ #### Overrides -[`JoinError`](../JoinError.md).[`constructor`](../JoinError.md#constructor) +[`JoinError`](./JoinError.md).[`constructor`](./JoinError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`cause`](../JoinError.md#cause) +[`JoinError`](./JoinError.md).[`cause`](./JoinError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`message`](../JoinError.md#message) +[`JoinError`](./JoinError.md).[`message`](./JoinError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`name`](../JoinError.md#name) +[`JoinError`](./JoinError.md).[`name`](./JoinError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`JoinError`](../JoinError.md).[`stack`](../JoinError.md#stack) +[`JoinError`](./JoinError.md).[`stack`](./JoinError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`JoinError`](../JoinError.md).[`stackTraceLimit`](../JoinError.md#stacktracelimit) +[`JoinError`](./JoinError.md).[`stackTraceLimit`](./JoinError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`JoinError`](../JoinError.md).[`captureStackTrace`](../JoinError.md#capturestacktrace) +[`JoinError`](./JoinError.md).[`captureStackTrace`](./JoinError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`JoinError`](../JoinError.md).[`prepareStackTrace`](../JoinError.md#preparestacktrace) +[`JoinError`](./JoinError.md).[`prepareStackTrace`](./JoinError.md#preparestacktrace) diff --git a/docs/reference/classes/UpdateKeyNotFoundError.md b/docs/reference/classes/UpdateKeyNotFoundError.md index d029b874b..b455cde74 100644 --- a/docs/reference/classes/UpdateKeyNotFoundError.md +++ b/docs/reference/classes/UpdateKeyNotFoundError.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/errors.ts:198](https://github.com/TanStack/db/blob/ ## Extends -- [`CollectionOperationError`](../CollectionOperationError.md) +- [`CollectionOperationError`](./CollectionOperationError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/db/src/errors.ts:199](https://github.com/TanStack/db/blob/ #### Overrides -[`CollectionOperationError`](../CollectionOperationError.md).[`constructor`](../CollectionOperationError.md#constructor) +[`CollectionOperationError`](./CollectionOperationError.md).[`constructor`](./CollectionOperationError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`cause`](../CollectionOperationError.md#cause) +[`CollectionOperationError`](./CollectionOperationError.md).[`cause`](./CollectionOperationError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`message`](../CollectionOperationError.md#message) +[`CollectionOperationError`](./CollectionOperationError.md).[`message`](./CollectionOperationError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`name`](../CollectionOperationError.md#name) +[`CollectionOperationError`](./CollectionOperationError.md).[`name`](./CollectionOperationError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stack`](../CollectionOperationError.md#stack) +[`CollectionOperationError`](./CollectionOperationError.md).[`stack`](./CollectionOperationError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`stackTraceLimit`](../CollectionOperationError.md#stacktracelimit) +[`CollectionOperationError`](./CollectionOperationError.md).[`stackTraceLimit`](./CollectionOperationError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`captureStackTrace`](../CollectionOperationError.md#capturestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`captureStackTrace`](./CollectionOperationError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`CollectionOperationError`](../CollectionOperationError.md).[`prepareStackTrace`](../CollectionOperationError.md#preparestacktrace) +[`CollectionOperationError`](./CollectionOperationError.md).[`prepareStackTrace`](./CollectionOperationError.md#preparestacktrace) diff --git a/docs/reference/classes/WhereClauseConversionError.md b/docs/reference/classes/WhereClauseConversionError.md index 98fb6f2d7..4bf1448be 100644 --- a/docs/reference/classes/WhereClauseConversionError.md +++ b/docs/reference/classes/WhereClauseConversionError.md @@ -11,7 +11,7 @@ Internal error when the query optimizer fails to convert a WHERE clause to a col ## Extends -- [`QueryOptimizerError`](../QueryOptimizerError.md) +- [`QueryOptimizerError`](./QueryOptimizerError.md) ## Constructors @@ -39,7 +39,7 @@ Defined in: [packages/db/src/errors.ts:645](https://github.com/TanStack/db/blob/ #### Overrides -[`QueryOptimizerError`](../QueryOptimizerError.md).[`constructor`](../QueryOptimizerError.md#constructor) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`constructor`](./QueryOptimizerError.md#constructor) ## Properties @@ -53,7 +53,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryOptimizerError`](../QueryOptimizerError.md).[`cause`](../QueryOptimizerError.md#cause) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`cause`](./QueryOptimizerError.md#cause) *** @@ -67,7 +67,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryOptimizerError`](../QueryOptimizerError.md).[`message`](../QueryOptimizerError.md#message) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`message`](./QueryOptimizerError.md#message) *** @@ -81,7 +81,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryOptimizerError`](../QueryOptimizerError.md).[`name`](../QueryOptimizerError.md#name) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`name`](./QueryOptimizerError.md#name) *** @@ -95,7 +95,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryOptimizerError`](../QueryOptimizerError.md).[`stack`](../QueryOptimizerError.md#stack) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`stack`](./QueryOptimizerError.md#stack) *** @@ -119,7 +119,7 @@ not capture any frames. #### Inherited from -[`QueryOptimizerError`](../QueryOptimizerError.md).[`stackTraceLimit`](../QueryOptimizerError.md#stacktracelimit) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`stackTraceLimit`](./QueryOptimizerError.md#stacktracelimit) ## Methods @@ -191,7 +191,7 @@ a(); #### Inherited from -[`QueryOptimizerError`](../QueryOptimizerError.md).[`captureStackTrace`](../QueryOptimizerError.md#capturestacktrace) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`captureStackTrace`](./QueryOptimizerError.md#capturestacktrace) *** @@ -223,4 +223,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryOptimizerError`](../QueryOptimizerError.md).[`prepareStackTrace`](../QueryOptimizerError.md#preparestacktrace) +[`QueryOptimizerError`](./QueryOptimizerError.md).[`prepareStackTrace`](./QueryOptimizerError.md#preparestacktrace) diff --git a/docs/reference/electric-db-collection/classes/ElectricDBCollectionError.md b/docs/reference/electric-db-collection/classes/ElectricDBCollectionError.md index 8ec928746..59dcd9dfd 100644 --- a/docs/reference/electric-db-collection/classes/ElectricDBCollectionError.md +++ b/docs/reference/electric-db-collection/classes/ElectricDBCollectionError.md @@ -13,10 +13,10 @@ Defined in: [packages/electric-db-collection/src/errors.ts:4](https://github.com ## Extended by -- [`ExpectedNumberInAwaitTxIdError`](../ExpectedNumberInAwaitTxIdError.md) -- [`TimeoutWaitingForTxIdError`](../TimeoutWaitingForTxIdError.md) -- [`TimeoutWaitingForMatchError`](../TimeoutWaitingForMatchError.md) -- [`StreamAbortedError`](../StreamAbortedError.md) +- [`ExpectedNumberInAwaitTxIdError`](./ExpectedNumberInAwaitTxIdError.md) +- [`TimeoutWaitingForTxIdError`](./TimeoutWaitingForTxIdError.md) +- [`TimeoutWaitingForMatchError`](./TimeoutWaitingForMatchError.md) +- [`StreamAbortedError`](./StreamAbortedError.md) ## Constructors diff --git a/docs/reference/electric-db-collection/classes/ExpectedNumberInAwaitTxIdError.md b/docs/reference/electric-db-collection/classes/ExpectedNumberInAwaitTxIdError.md index a0c31569e..aff07346c 100644 --- a/docs/reference/electric-db-collection/classes/ExpectedNumberInAwaitTxIdError.md +++ b/docs/reference/electric-db-collection/classes/ExpectedNumberInAwaitTxIdError.md @@ -9,7 +9,7 @@ Defined in: [packages/electric-db-collection/src/errors.ts:11](https://github.co ## Extends -- [`ElectricDBCollectionError`](../ElectricDBCollectionError.md) +- [`ElectricDBCollectionError`](./ElectricDBCollectionError.md) ## Constructors @@ -37,7 +37,7 @@ Defined in: [packages/electric-db-collection/src/errors.ts:12](https://github.co #### Overrides -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`constructor`](../ElectricDBCollectionError.md#constructor) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`constructor`](./ElectricDBCollectionError.md#constructor) ## Properties @@ -51,7 +51,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`cause`](../ElectricDBCollectionError.md#cause) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`cause`](./ElectricDBCollectionError.md#cause) *** @@ -65,7 +65,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`message`](../ElectricDBCollectionError.md#message) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`message`](./ElectricDBCollectionError.md#message) *** @@ -79,7 +79,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`name`](../ElectricDBCollectionError.md#name) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`name`](./ElectricDBCollectionError.md#name) *** @@ -93,7 +93,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`stack`](../ElectricDBCollectionError.md#stack) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`stack`](./ElectricDBCollectionError.md#stack) *** @@ -117,7 +117,7 @@ not capture any frames. #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`stackTraceLimit`](../ElectricDBCollectionError.md#stacktracelimit) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`stackTraceLimit`](./ElectricDBCollectionError.md#stacktracelimit) ## Methods @@ -189,7 +189,7 @@ a(); #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`captureStackTrace`](../ElectricDBCollectionError.md#capturestacktrace) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`captureStackTrace`](./ElectricDBCollectionError.md#capturestacktrace) *** @@ -221,4 +221,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`prepareStackTrace`](../ElectricDBCollectionError.md#preparestacktrace) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`prepareStackTrace`](./ElectricDBCollectionError.md#preparestacktrace) diff --git a/docs/reference/electric-db-collection/classes/StreamAbortedError.md b/docs/reference/electric-db-collection/classes/StreamAbortedError.md index d08f6639f..c4df05bf4 100644 --- a/docs/reference/electric-db-collection/classes/StreamAbortedError.md +++ b/docs/reference/electric-db-collection/classes/StreamAbortedError.md @@ -9,7 +9,7 @@ Defined in: [packages/electric-db-collection/src/errors.ts:32](https://github.co ## Extends -- [`ElectricDBCollectionError`](../ElectricDBCollectionError.md) +- [`ElectricDBCollectionError`](./ElectricDBCollectionError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/electric-db-collection/src/errors.ts:33](https://github.co #### Overrides -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`constructor`](../ElectricDBCollectionError.md#constructor) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`constructor`](./ElectricDBCollectionError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`cause`](../ElectricDBCollectionError.md#cause) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`cause`](./ElectricDBCollectionError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`message`](../ElectricDBCollectionError.md#message) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`message`](./ElectricDBCollectionError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`name`](../ElectricDBCollectionError.md#name) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`name`](./ElectricDBCollectionError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`stack`](../ElectricDBCollectionError.md#stack) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`stack`](./ElectricDBCollectionError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`stackTraceLimit`](../ElectricDBCollectionError.md#stacktracelimit) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`stackTraceLimit`](./ElectricDBCollectionError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`captureStackTrace`](../ElectricDBCollectionError.md#capturestacktrace) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`captureStackTrace`](./ElectricDBCollectionError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`prepareStackTrace`](../ElectricDBCollectionError.md#preparestacktrace) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`prepareStackTrace`](./ElectricDBCollectionError.md#preparestacktrace) diff --git a/docs/reference/electric-db-collection/classes/TimeoutWaitingForMatchError.md b/docs/reference/electric-db-collection/classes/TimeoutWaitingForMatchError.md index 2cfd78e55..52bc618ea 100644 --- a/docs/reference/electric-db-collection/classes/TimeoutWaitingForMatchError.md +++ b/docs/reference/electric-db-collection/classes/TimeoutWaitingForMatchError.md @@ -9,7 +9,7 @@ Defined in: [packages/electric-db-collection/src/errors.ts:25](https://github.co ## Extends -- [`ElectricDBCollectionError`](../ElectricDBCollectionError.md) +- [`ElectricDBCollectionError`](./ElectricDBCollectionError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/electric-db-collection/src/errors.ts:26](https://github.co #### Overrides -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`constructor`](../ElectricDBCollectionError.md#constructor) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`constructor`](./ElectricDBCollectionError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`cause`](../ElectricDBCollectionError.md#cause) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`cause`](./ElectricDBCollectionError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`message`](../ElectricDBCollectionError.md#message) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`message`](./ElectricDBCollectionError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`name`](../ElectricDBCollectionError.md#name) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`name`](./ElectricDBCollectionError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`stack`](../ElectricDBCollectionError.md#stack) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`stack`](./ElectricDBCollectionError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`stackTraceLimit`](../ElectricDBCollectionError.md#stacktracelimit) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`stackTraceLimit`](./ElectricDBCollectionError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`captureStackTrace`](../ElectricDBCollectionError.md#capturestacktrace) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`captureStackTrace`](./ElectricDBCollectionError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`prepareStackTrace`](../ElectricDBCollectionError.md#preparestacktrace) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`prepareStackTrace`](./ElectricDBCollectionError.md#preparestacktrace) diff --git a/docs/reference/electric-db-collection/classes/TimeoutWaitingForTxIdError.md b/docs/reference/electric-db-collection/classes/TimeoutWaitingForTxIdError.md index 5f7f76187..2fb976a3c 100644 --- a/docs/reference/electric-db-collection/classes/TimeoutWaitingForTxIdError.md +++ b/docs/reference/electric-db-collection/classes/TimeoutWaitingForTxIdError.md @@ -9,7 +9,7 @@ Defined in: [packages/electric-db-collection/src/errors.ts:18](https://github.co ## Extends -- [`ElectricDBCollectionError`](../ElectricDBCollectionError.md) +- [`ElectricDBCollectionError`](./ElectricDBCollectionError.md) ## Constructors @@ -37,7 +37,7 @@ Defined in: [packages/electric-db-collection/src/errors.ts:19](https://github.co #### Overrides -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`constructor`](../ElectricDBCollectionError.md#constructor) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`constructor`](./ElectricDBCollectionError.md#constructor) ## Properties @@ -51,7 +51,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`cause`](../ElectricDBCollectionError.md#cause) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`cause`](./ElectricDBCollectionError.md#cause) *** @@ -65,7 +65,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`message`](../ElectricDBCollectionError.md#message) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`message`](./ElectricDBCollectionError.md#message) *** @@ -79,7 +79,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`name`](../ElectricDBCollectionError.md#name) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`name`](./ElectricDBCollectionError.md#name) *** @@ -93,7 +93,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`stack`](../ElectricDBCollectionError.md#stack) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`stack`](./ElectricDBCollectionError.md#stack) *** @@ -117,7 +117,7 @@ not capture any frames. #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`stackTraceLimit`](../ElectricDBCollectionError.md#stacktracelimit) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`stackTraceLimit`](./ElectricDBCollectionError.md#stacktracelimit) ## Methods @@ -189,7 +189,7 @@ a(); #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`captureStackTrace`](../ElectricDBCollectionError.md#capturestacktrace) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`captureStackTrace`](./ElectricDBCollectionError.md#capturestacktrace) *** @@ -221,4 +221,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`ElectricDBCollectionError`](../ElectricDBCollectionError.md).[`prepareStackTrace`](../ElectricDBCollectionError.md#preparestacktrace) +[`ElectricDBCollectionError`](./ElectricDBCollectionError.md).[`prepareStackTrace`](./ElectricDBCollectionError.md#preparestacktrace) diff --git a/docs/reference/electric-db-collection/functions/electricCollectionOptions.md b/docs/reference/electric-db-collection/functions/electricCollectionOptions.md index b4dc3df4e..e1a038990 100644 --- a/docs/reference/electric-db-collection/functions/electricCollectionOptions.md +++ b/docs/reference/electric-db-collection/functions/electricCollectionOptions.md @@ -27,7 +27,7 @@ The explicit type of items in the collection (highest priority) #### config -[`ElectricCollectionConfig`](../../interfaces/ElectricCollectionConfig.md)\<`InferSchemaOutput`\<`T`\>, `T`\> & `object` +[`ElectricCollectionConfig`](../interfaces/ElectricCollectionConfig.md)\<`InferSchemaOutput`\<`T`\>, `T`\> & `object` Configuration options for the Electric collection @@ -59,7 +59,7 @@ The explicit type of items in the collection (highest priority) #### config -[`ElectricCollectionConfig`](../../interfaces/ElectricCollectionConfig.md)\<`T`, `never`\> & `object` +[`ElectricCollectionConfig`](../interfaces/ElectricCollectionConfig.md)\<`T`, `never`\> & `object` Configuration options for the Electric collection diff --git a/docs/reference/electric-db-collection/index.md b/docs/reference/electric-db-collection/index.md index be4322541..b2092536a 100644 --- a/docs/reference/electric-db-collection/index.md +++ b/docs/reference/electric-db-collection/index.md @@ -7,22 +7,22 @@ title: "@tanstack/electric-db-collection" ## Classes -- [ElectricDBCollectionError](../classes/ElectricDBCollectionError.md) -- [ExpectedNumberInAwaitTxIdError](../classes/ExpectedNumberInAwaitTxIdError.md) -- [StreamAbortedError](../classes/StreamAbortedError.md) -- [TimeoutWaitingForMatchError](../classes/TimeoutWaitingForMatchError.md) -- [TimeoutWaitingForTxIdError](../classes/TimeoutWaitingForTxIdError.md) +- [ElectricDBCollectionError](./classes/ElectricDBCollectionError.md) +- [ExpectedNumberInAwaitTxIdError](./classes/ExpectedNumberInAwaitTxIdError.md) +- [StreamAbortedError](./classes/StreamAbortedError.md) +- [TimeoutWaitingForMatchError](./classes/TimeoutWaitingForMatchError.md) +- [TimeoutWaitingForTxIdError](./classes/TimeoutWaitingForTxIdError.md) ## Interfaces -- [ElectricCollectionConfig](../interfaces/ElectricCollectionConfig.md) -- [ElectricCollectionUtils](../interfaces/ElectricCollectionUtils.md) +- [ElectricCollectionConfig](./interfaces/ElectricCollectionConfig.md) +- [ElectricCollectionUtils](./interfaces/ElectricCollectionUtils.md) ## Type Aliases -- [AwaitTxIdFn](../type-aliases/AwaitTxIdFn.md) -- [Txid](../type-aliases/Txid.md) +- [AwaitTxIdFn](./type-aliases/AwaitTxIdFn.md) +- [Txid](./type-aliases/Txid.md) ## Functions -- [electricCollectionOptions](../functions/electricCollectionOptions.md) +- [electricCollectionOptions](./functions/electricCollectionOptions.md) diff --git a/docs/reference/electric-db-collection/interfaces/ElectricCollectionConfig.md b/docs/reference/electric-db-collection/interfaces/ElectricCollectionConfig.md index b096292e3..b3e92ca58 100644 --- a/docs/reference/electric-db-collection/interfaces/ElectricCollectionConfig.md +++ b/docs/reference/electric-db-collection/interfaces/ElectricCollectionConfig.md @@ -11,7 +11,7 @@ Configuration interface for Electric collection options ## Extends -- `Omit`\<`BaseCollectionConfig`\<`T`, `string` \| `number`, `TSchema`, [`ElectricCollectionUtils`](../ElectricCollectionUtils.md)\<`T`\>, `any`\>, `"onInsert"` \| `"onUpdate"` \| `"onDelete"` \| `"syncMode"`\> +- `Omit`\<`BaseCollectionConfig`\<`T`, `string` \| `number`, `TSchema`, [`ElectricCollectionUtils`](./ElectricCollectionUtils.md)\<`T`\>, `any`\>, `"onInsert"` \| `"onUpdate"` \| `"onDelete"` \| `"syncMode"`\> ## Type Parameters @@ -56,7 +56,7 @@ Optional asynchronous handler function called before a delete operation ##### params -`DeleteMutationFnParams`\<`T`, `string` \| `number`, [`ElectricCollectionUtils`](../ElectricCollectionUtils.md)\<`T`\>\> +`DeleteMutationFnParams`\<`T`, `string` \| `number`, [`ElectricCollectionUtils`](./ElectricCollectionUtils.md)\<`T`\>\> Object containing transaction and collection information @@ -108,7 +108,7 @@ Optional asynchronous handler function called before an insert operation ##### params -`InsertMutationFnParams`\<`T`, `string` \| `number`, [`ElectricCollectionUtils`](../ElectricCollectionUtils.md)\<`T`\>\> +`InsertMutationFnParams`\<`T`, `string` \| `number`, [`ElectricCollectionUtils`](./ElectricCollectionUtils.md)\<`T`\>\> Object containing transaction and collection information @@ -182,7 +182,7 @@ Optional asynchronous handler function called before an update operation ##### params -`UpdateMutationFnParams`\<`T`, `string` \| `number`, [`ElectricCollectionUtils`](../ElectricCollectionUtils.md)\<`T`\>\> +`UpdateMutationFnParams`\<`T`, `string` \| `number`, [`ElectricCollectionUtils`](./ElectricCollectionUtils.md)\<`T`\>\> Object containing transaction and collection information diff --git a/docs/reference/electric-db-collection/type-aliases/AwaitTxIdFn.md b/docs/reference/electric-db-collection/type-aliases/AwaitTxIdFn.md index 8dd0d67e9..18e55bbcc 100644 --- a/docs/reference/electric-db-collection/type-aliases/AwaitTxIdFn.md +++ b/docs/reference/electric-db-collection/type-aliases/AwaitTxIdFn.md @@ -17,7 +17,7 @@ Type for the awaitTxId utility function ### txId -[`Txid`](../Txid.md) +[`Txid`](./Txid.md) ### timeout? diff --git a/docs/reference/functions/and.md b/docs/reference/functions/and.md index b48e66633..85a7304a1 100644 --- a/docs/reference/functions/and.md +++ b/docs/reference/functions/and.md @@ -25,7 +25,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:181](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> ## Call Signature @@ -54,4 +54,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:185](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> diff --git a/docs/reference/functions/coalesce.md b/docs/reference/functions/coalesce.md index db59fc945..2849b63e8 100644 --- a/docs/reference/functions/coalesce.md +++ b/docs/reference/functions/coalesce.md @@ -19,4 +19,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:288](https://github.com/ ## Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`any`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`any`\> diff --git a/docs/reference/functions/compileQuery.md b/docs/reference/functions/compileQuery.md index 729b5ae39..ae1e2e08a 100644 --- a/docs/reference/functions/compileQuery.md +++ b/docs/reference/functions/compileQuery.md @@ -27,19 +27,19 @@ Compiles a query IR into a D2 pipeline ### rawQuery -[`QueryIR`](../../@tanstack/namespaces/IR/interfaces/QueryIR.md) +[`QueryIR`](../@tanstack/namespaces/IR/interfaces/QueryIR.md) The query IR to compile ### inputs -`Record`\<`string`, [`KeyedStream`](../../type-aliases/KeyedStream.md)\> +`Record`\<`string`, [`KeyedStream`](../type-aliases/KeyedStream.md)\> Mapping of source aliases to input streams (e.g., `{ employee: input1, manager: input2 }`) ### collections -`Record`\<`string`, [`Collection`](../../interfaces/Collection.md)\<`any`, `any`, `any`, `any`, `any`\>\> +`Record`\<`string`, [`Collection`](../interfaces/Collection.md)\<`any`, `any`, `any`, `any`, `any`\>\> Mapping of collection IDs to Collection instances diff --git a/docs/reference/functions/concat.md b/docs/reference/functions/concat.md index 9c8edfbd6..1da806bc5 100644 --- a/docs/reference/functions/concat.md +++ b/docs/reference/functions/concat.md @@ -19,4 +19,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:279](https://github.com/ ## Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`string`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`string`\> diff --git a/docs/reference/functions/count.md b/docs/reference/functions/count.md index bc82fcf79..ef1a990e9 100644 --- a/docs/reference/functions/count.md +++ b/docs/reference/functions/count.md @@ -19,4 +19,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:307](https://github.com/ ## Returns -[`Aggregate`](../../@tanstack/namespaces/IR/classes/Aggregate.md)\<`number`\> +[`Aggregate`](../@tanstack/namespaces/IR/classes/Aggregate.md)\<`number`\> diff --git a/docs/reference/functions/createCollection.md b/docs/reference/functions/createCollection.md index 5c71455d2..556471744 100644 --- a/docs/reference/functions/createCollection.md +++ b/docs/reference/functions/createCollection.md @@ -31,7 +31,7 @@ The type of the key for the collection #### TUtils -`TUtils` *extends* [`UtilsRecord`](../../type-aliases/UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) The utilities record type @@ -39,13 +39,13 @@ The utilities record type #### options -`Omit`\<[`CollectionConfig`](../../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\>, `"utils"`\> & `object` & [`NonSingleResult`](../../type-aliases/NonSingleResult.md) +`Omit`\<[`CollectionConfig`](../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\>, `"utils"`\> & `object` & [`NonSingleResult`](../type-aliases/NonSingleResult.md) Collection options with optional utilities ### Returns -[`Collection`](../../interfaces/Collection.md)\<[`InferSchemaOutput`](../../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `TUtils`, `T`, [`InferSchemaInput`](../../type-aliases/InferSchemaInput.md)\<`T`\>\> & [`NonSingleResult`](../../type-aliases/NonSingleResult.md) +[`Collection`](../interfaces/Collection.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `TUtils`, `T`, [`InferSchemaInput`](../type-aliases/InferSchemaInput.md)\<`T`\>\> & [`NonSingleResult`](../type-aliases/NonSingleResult.md) A new Collection with utilities exposed both at top level and under .utils @@ -140,7 +140,7 @@ The type of the key for the collection #### TUtils -`TUtils` *extends* [`UtilsRecord`](../../type-aliases/UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) The utilities record type @@ -148,13 +148,13 @@ The utilities record type #### options -[`CollectionConfig`](../../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\> & `object` & [`NonSingleResult`](../../type-aliases/NonSingleResult.md) +[`CollectionConfig`](../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\> & `object` & [`NonSingleResult`](../type-aliases/NonSingleResult.md) Collection options with optional utilities ### Returns -[`Collection`](../../interfaces/Collection.md)\<[`InferSchemaOutput`](../../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `Exclude`\<`TUtils`, `undefined`\>, `T`, [`InferSchemaInput`](../../type-aliases/InferSchemaInput.md)\<`T`\>\> & [`NonSingleResult`](../../type-aliases/NonSingleResult.md) +[`Collection`](../interfaces/Collection.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `Exclude`\<`TUtils`, `undefined`\>, `T`, [`InferSchemaInput`](../type-aliases/InferSchemaInput.md)\<`T`\>\> & [`NonSingleResult`](../type-aliases/NonSingleResult.md) A new Collection with utilities exposed both at top level and under .utils @@ -249,7 +249,7 @@ The type of the key for the collection #### TUtils -`TUtils` *extends* [`UtilsRecord`](../../type-aliases/UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) The utilities record type @@ -257,13 +257,13 @@ The utilities record type #### options -`Omit`\<[`CollectionConfig`](../../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\>, `"utils"`\> & `object` & [`SingleResult`](../../type-aliases/SingleResult.md) +`Omit`\<[`CollectionConfig`](../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\>, `"utils"`\> & `object` & [`SingleResult`](../type-aliases/SingleResult.md) Collection options with optional utilities ### Returns -[`Collection`](../../interfaces/Collection.md)\<[`InferSchemaOutput`](../../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `TUtils`, `T`, [`InferSchemaInput`](../../type-aliases/InferSchemaInput.md)\<`T`\>\> & [`SingleResult`](../../type-aliases/SingleResult.md) +[`Collection`](../interfaces/Collection.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `TUtils`, `T`, [`InferSchemaInput`](../type-aliases/InferSchemaInput.md)\<`T`\>\> & [`SingleResult`](../type-aliases/SingleResult.md) A new Collection with utilities exposed both at top level and under .utils @@ -358,7 +358,7 @@ The type of the key for the collection #### TUtils -`TUtils` *extends* [`UtilsRecord`](../../type-aliases/UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) The utilities record type @@ -366,13 +366,13 @@ The utilities record type #### options -[`CollectionConfig`](../../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\> & `object` & [`SingleResult`](../../type-aliases/SingleResult.md) +[`CollectionConfig`](../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\> & `object` & [`SingleResult`](../type-aliases/SingleResult.md) Collection options with optional utilities ### Returns -[`Collection`](../../interfaces/Collection.md)\<[`InferSchemaOutput`](../../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `TUtils`, `T`, [`InferSchemaInput`](../../type-aliases/InferSchemaInput.md)\<`T`\>\> & [`SingleResult`](../../type-aliases/SingleResult.md) +[`Collection`](../interfaces/Collection.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `TUtils`, `T`, [`InferSchemaInput`](../type-aliases/InferSchemaInput.md)\<`T`\>\> & [`SingleResult`](../type-aliases/SingleResult.md) A new Collection with utilities exposed both at top level and under .utils @@ -467,7 +467,7 @@ The type of the key for the collection #### TUtils -`TUtils` *extends* [`UtilsRecord`](../../type-aliases/UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) The utilities record type @@ -475,13 +475,13 @@ The utilities record type #### options -`Omit`\<[`CollectionConfig`](../../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, `TUtils`\>, `"utils"`\> & `object` & [`NonSingleResult`](../../type-aliases/NonSingleResult.md) +`Omit`\<[`CollectionConfig`](../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, `TUtils`\>, `"utils"`\> & `object` & [`NonSingleResult`](../type-aliases/NonSingleResult.md) Collection options with optional utilities ### Returns -[`Collection`](../../interfaces/Collection.md)\<`T`, `TKey`, `TUtils`, `never`, `T`\> & [`NonSingleResult`](../../type-aliases/NonSingleResult.md) +[`Collection`](../interfaces/Collection.md)\<`T`, `TKey`, `TUtils`, `never`, `T`\> & [`NonSingleResult`](../type-aliases/NonSingleResult.md) A new Collection with utilities exposed both at top level and under .utils @@ -576,7 +576,7 @@ The type of the key for the collection #### TUtils -`TUtils` *extends* [`UtilsRecord`](../../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../../type-aliases/UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../type-aliases/UtilsRecord.md) The utilities record type @@ -584,13 +584,13 @@ The utilities record type #### options -[`CollectionConfig`](../../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, `TUtils`\> & `object` & [`NonSingleResult`](../../type-aliases/NonSingleResult.md) +[`CollectionConfig`](../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, `TUtils`\> & `object` & [`NonSingleResult`](../type-aliases/NonSingleResult.md) Collection options with optional utilities ### Returns -[`Collection`](../../interfaces/Collection.md)\<`T`, `TKey`, `TUtils`, `never`, `T`\> & [`NonSingleResult`](../../type-aliases/NonSingleResult.md) +[`Collection`](../interfaces/Collection.md)\<`T`, `TKey`, `TUtils`, `never`, `T`\> & [`NonSingleResult`](../type-aliases/NonSingleResult.md) A new Collection with utilities exposed both at top level and under .utils @@ -685,7 +685,7 @@ The type of the key for the collection #### TUtils -`TUtils` *extends* [`UtilsRecord`](../../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../../type-aliases/UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../type-aliases/UtilsRecord.md) The utilities record type @@ -693,13 +693,13 @@ The utilities record type #### options -`Omit`\<[`CollectionConfig`](../../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, `TUtils`\>, `"utils"`\> & `object` & [`SingleResult`](../../type-aliases/SingleResult.md) +`Omit`\<[`CollectionConfig`](../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, `TUtils`\>, `"utils"`\> & `object` & [`SingleResult`](../type-aliases/SingleResult.md) Collection options with optional utilities ### Returns -[`Collection`](../../interfaces/Collection.md)\<`T`, `TKey`, `TUtils`, `never`, `T`\> & [`SingleResult`](../../type-aliases/SingleResult.md) +[`Collection`](../interfaces/Collection.md)\<`T`, `TKey`, `TUtils`, `never`, `T`\> & [`SingleResult`](../type-aliases/SingleResult.md) A new Collection with utilities exposed both at top level and under .utils @@ -794,7 +794,7 @@ The type of the key for the collection #### TUtils -`TUtils` *extends* [`UtilsRecord`](../../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../../type-aliases/UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../type-aliases/UtilsRecord.md) The utilities record type @@ -802,13 +802,13 @@ The utilities record type #### options -[`CollectionConfig`](../../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, `TUtils`\> & `object` & [`SingleResult`](../../type-aliases/SingleResult.md) +[`CollectionConfig`](../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, `TUtils`\> & `object` & [`SingleResult`](../type-aliases/SingleResult.md) Collection options with optional utilities ### Returns -[`Collection`](../../interfaces/Collection.md)\<`T`, `TKey`, `TUtils`, `never`, `T`\> & [`SingleResult`](../../type-aliases/SingleResult.md) +[`Collection`](../interfaces/Collection.md)\<`T`, `TKey`, `TUtils`, `never`, `T`\> & [`SingleResult`](../type-aliases/SingleResult.md) A new Collection with utilities exposed both at top level and under .utils diff --git a/docs/reference/functions/createLiveQueryCollection.md b/docs/reference/functions/createLiveQueryCollection.md index b35008dc4..55db713f5 100644 --- a/docs/reference/functions/createLiveQueryCollection.md +++ b/docs/reference/functions/createLiveQueryCollection.md @@ -20,7 +20,7 @@ Creates a live query collection directly #### TContext -`TContext` *extends* [`Context`](../../interfaces/Context.md) +`TContext` *extends* [`Context`](../interfaces/Context.md) #### TResult @@ -30,7 +30,7 @@ Creates a live query collection directly #### query -(`q`) => [`QueryBuilder`](../../type-aliases/QueryBuilder.md)\<`TContext`\> +(`q`) => [`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`TContext`\> ### Returns @@ -83,7 +83,7 @@ Creates a live query collection directly #### TContext -`TContext` *extends* [`Context`](../../interfaces/Context.md) +`TContext` *extends* [`Context`](../interfaces/Context.md) #### TResult @@ -91,14 +91,14 @@ Creates a live query collection directly #### TUtils -`TUtils` *extends* [`UtilsRecord`](../../type-aliases/UtilsRecord.md) = \{ +`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) = \{ \} ### Parameters #### config -[`LiveQueryCollectionConfig`](../../interfaces/LiveQueryCollectionConfig.md)\<`TContext`, `TResult`\> & `object` +[`LiveQueryCollectionConfig`](../interfaces/LiveQueryCollectionConfig.md)\<`TContext`, `TResult`\> & `object` ### Returns diff --git a/docs/reference/functions/createOptimisticAction.md b/docs/reference/functions/createOptimisticAction.md index bb19c9432..f01ae27db 100644 --- a/docs/reference/functions/createOptimisticAction.md +++ b/docs/reference/functions/createOptimisticAction.md @@ -35,7 +35,7 @@ The type of variables that will be passed to the action function ### options -[`CreateOptimisticActionsOptions`](../../interfaces/CreateOptimisticActionsOptions.md)\<`TVariables`\> +[`CreateOptimisticActionsOptions`](../interfaces/CreateOptimisticActionsOptions.md)\<`TVariables`\> Configuration options for the optimistic action @@ -55,7 +55,7 @@ A function that accepts variables of type TVariables and returns a Transaction ### Returns -[`Transaction`](../../interfaces/Transaction.md) +[`Transaction`](../interfaces/Transaction.md) ## Example diff --git a/docs/reference/functions/createPacedMutations.md b/docs/reference/functions/createPacedMutations.md index 7418b828e..a51bd3a51 100644 --- a/docs/reference/functions/createPacedMutations.md +++ b/docs/reference/functions/createPacedMutations.md @@ -36,7 +36,7 @@ or to handle errors. ### config -[`PacedMutationsConfig`](../../interfaces/PacedMutationsConfig.md)\<`TVariables`, `T`\> +[`PacedMutationsConfig`](../interfaces/PacedMutationsConfig.md)\<`TVariables`, `T`\> Configuration including onMutate, mutationFn and strategy @@ -56,7 +56,7 @@ A function that accepts variables and returns a Transaction ### Returns -[`Transaction`](../../interfaces/Transaction.md)\<`T`\> +[`Transaction`](../interfaces/Transaction.md)\<`T`\> ## Examples diff --git a/docs/reference/functions/createTransaction.md b/docs/reference/functions/createTransaction.md index 5309fffcf..e1207af82 100644 --- a/docs/reference/functions/createTransaction.md +++ b/docs/reference/functions/createTransaction.md @@ -23,13 +23,13 @@ Creates a new transaction for grouping multiple collection operations ### config -[`TransactionConfig`](../../interfaces/TransactionConfig.md)\<`T`\> +[`TransactionConfig`](../interfaces/TransactionConfig.md)\<`T`\> Transaction configuration with mutation function ## Returns -[`Transaction`](../../interfaces/Transaction.md)\<`T`\> +[`Transaction`](../interfaces/Transaction.md)\<`T`\> A new Transaction instance diff --git a/docs/reference/functions/debounceStrategy.md b/docs/reference/functions/debounceStrategy.md index 44e016bee..cb38e9688 100644 --- a/docs/reference/functions/debounceStrategy.md +++ b/docs/reference/functions/debounceStrategy.md @@ -21,13 +21,13 @@ to wait for the user to stop typing before persisting changes. ### options -[`DebounceStrategyOptions`](../../interfaces/DebounceStrategyOptions.md) +[`DebounceStrategyOptions`](../interfaces/DebounceStrategyOptions.md) Configuration for the debounce behavior ## Returns -[`DebounceStrategy`](../../interfaces/DebounceStrategy.md) +[`DebounceStrategy`](../interfaces/DebounceStrategy.md) A debounce strategy instance diff --git a/docs/reference/functions/eq.md b/docs/reference/functions/eq.md index 0199b5da1..8890c3eac 100644 --- a/docs/reference/functions/eq.md +++ b/docs/reference/functions/eq.md @@ -31,7 +31,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:115](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> ## Call Signature @@ -59,7 +59,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:119](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> ## Call Signature @@ -79,7 +79,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:123](https://github.com/ #### left -[`Aggregate`](../../@tanstack/namespaces/IR/classes/Aggregate.md)\<`T`\> +[`Aggregate`](../@tanstack/namespaces/IR/classes/Aggregate.md)\<`T`\> #### right @@ -87,4 +87,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:123](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> diff --git a/docs/reference/functions/extractFieldPath.md b/docs/reference/functions/extractFieldPath.md index 4e12e218e..1738e66db 100644 --- a/docs/reference/functions/extractFieldPath.md +++ b/docs/reference/functions/extractFieldPath.md @@ -24,7 +24,7 @@ The expression to extract from ## Returns -[`FieldPath`](../../type-aliases/FieldPath.md) \| `null` +[`FieldPath`](../type-aliases/FieldPath.md) \| `null` The field path array, or null diff --git a/docs/reference/functions/extractSimpleComparisons.md b/docs/reference/functions/extractSimpleComparisons.md index 282214367..39c3ff0db 100644 --- a/docs/reference/functions/extractSimpleComparisons.md +++ b/docs/reference/functions/extractSimpleComparisons.md @@ -29,7 +29,7 @@ The WHERE expression to parse ## Returns -[`SimpleComparison`](../../interfaces/SimpleComparison.md)[] +[`SimpleComparison`](../interfaces/SimpleComparison.md)[] Array of simple comparisons diff --git a/docs/reference/functions/getActiveTransaction.md b/docs/reference/functions/getActiveTransaction.md index 31ac09e1c..b1488c8d0 100644 --- a/docs/reference/functions/getActiveTransaction.md +++ b/docs/reference/functions/getActiveTransaction.md @@ -18,7 +18,7 @@ Used internally by collection operations to join existing transactions ## Returns - \| [`Transaction`](../../interfaces/Transaction.md)\<`Record`\<`string`, `unknown`\>\> + \| [`Transaction`](../interfaces/Transaction.md)\<`Record`\<`string`, `unknown`\>\> \| `undefined` The active transaction or undefined if none is active diff --git a/docs/reference/functions/gt.md b/docs/reference/functions/gt.md index 050c7712c..7a6cb1589 100644 --- a/docs/reference/functions/gt.md +++ b/docs/reference/functions/gt.md @@ -31,7 +31,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:128](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> ## Call Signature @@ -59,7 +59,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:132](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> ## Call Signature @@ -79,7 +79,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:136](https://github.com/ #### left -[`Aggregate`](../../@tanstack/namespaces/IR/classes/Aggregate.md)\<`T`\> +[`Aggregate`](../@tanstack/namespaces/IR/classes/Aggregate.md)\<`T`\> #### right @@ -87,4 +87,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:136](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> diff --git a/docs/reference/functions/gte.md b/docs/reference/functions/gte.md index 7a6798a69..6a5f0c6e8 100644 --- a/docs/reference/functions/gte.md +++ b/docs/reference/functions/gte.md @@ -31,7 +31,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:141](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> ## Call Signature @@ -59,7 +59,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:145](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> ## Call Signature @@ -79,7 +79,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:149](https://github.com/ #### left -[`Aggregate`](../../@tanstack/namespaces/IR/classes/Aggregate.md)\<`T`\> +[`Aggregate`](../@tanstack/namespaces/IR/classes/Aggregate.md)\<`T`\> #### right @@ -87,4 +87,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:149](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> diff --git a/docs/reference/functions/ilike.md b/docs/reference/functions/ilike.md index 989b7e9f5..7f422aa0c 100644 --- a/docs/reference/functions/ilike.md +++ b/docs/reference/functions/ilike.md @@ -23,4 +23,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:252](https://github.com/ ## Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> diff --git a/docs/reference/functions/inArray.md b/docs/reference/functions/inArray.md index c48e33a81..5f93c467b 100644 --- a/docs/reference/functions/inArray.md +++ b/docs/reference/functions/inArray.md @@ -23,4 +23,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:237](https://github.com/ ## Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> diff --git a/docs/reference/functions/isNull.md b/docs/reference/functions/isNull.md index 704ae7f33..3b7576a6f 100644 --- a/docs/reference/functions/isNull.md +++ b/docs/reference/functions/isNull.md @@ -19,4 +19,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:233](https://github.com/ ## Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> diff --git a/docs/reference/functions/isOrderBySubset.md b/docs/reference/functions/isOrderBySubset.md index 0a23a6505..525dbacc9 100644 --- a/docs/reference/functions/isOrderBySubset.md +++ b/docs/reference/functions/isOrderBySubset.md @@ -20,13 +20,13 @@ Returns true if the subset ordering requirements are satisfied by the superset o The ordering requirements to check -[`OrderBy`](../../@tanstack/namespaces/IR/type-aliases/OrderBy.md) | `undefined` +[`OrderBy`](../@tanstack/namespaces/IR/type-aliases/OrderBy.md) | `undefined` ### superset The ordering that might satisfy the requirements -[`OrderBy`](../../@tanstack/namespaces/IR/type-aliases/OrderBy.md) | `undefined` +[`OrderBy`](../@tanstack/namespaces/IR/type-aliases/OrderBy.md) | `undefined` ## Returns diff --git a/docs/reference/functions/isPredicateSubset.md b/docs/reference/functions/isPredicateSubset.md index d898b144d..5270fba39 100644 --- a/docs/reference/functions/isPredicateSubset.md +++ b/docs/reference/functions/isPredicateSubset.md @@ -18,13 +18,13 @@ Returns true if all aspects of the subset predicate are satisfied by the superse ### subset -[`LoadSubsetOptions`](../../type-aliases/LoadSubsetOptions.md) +[`LoadSubsetOptions`](../type-aliases/LoadSubsetOptions.md) The predicate requirements to check ### superset -[`LoadSubsetOptions`](../../type-aliases/LoadSubsetOptions.md) +[`LoadSubsetOptions`](../type-aliases/LoadSubsetOptions.md) The predicate that might satisfy the requirements diff --git a/docs/reference/functions/isUndefined.md b/docs/reference/functions/isUndefined.md index 0862c3cc9..8924d9cd1 100644 --- a/docs/reference/functions/isUndefined.md +++ b/docs/reference/functions/isUndefined.md @@ -19,4 +19,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:229](https://github.com/ ## Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> diff --git a/docs/reference/functions/isWhereSubset.md b/docs/reference/functions/isWhereSubset.md index 3c68dc250..4817c778e 100644 --- a/docs/reference/functions/isWhereSubset.md +++ b/docs/reference/functions/isWhereSubset.md @@ -20,13 +20,13 @@ Returns true if the subset predicate is more restrictive than (or equal to) the The potentially more restrictive predicate -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> | `undefined` +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> | `undefined` ### superset The potentially less restrictive predicate -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> | `undefined` +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> | `undefined` ## Returns diff --git a/docs/reference/functions/like.md b/docs/reference/functions/like.md index d94a428d4..fdaa7fc93 100644 --- a/docs/reference/functions/like.md +++ b/docs/reference/functions/like.md @@ -23,4 +23,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:244](https://github.com/ ## Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> diff --git a/docs/reference/functions/liveQueryCollectionOptions.md b/docs/reference/functions/liveQueryCollectionOptions.md index 20b266568..43427f374 100644 --- a/docs/reference/functions/liveQueryCollectionOptions.md +++ b/docs/reference/functions/liveQueryCollectionOptions.md @@ -18,7 +18,7 @@ Creates live query collection options for use with createCollection ### TContext -`TContext` *extends* [`Context`](../../interfaces/Context.md) +`TContext` *extends* [`Context`](../interfaces/Context.md) ### TResult @@ -28,7 +28,7 @@ Creates live query collection options for use with createCollection ### config -[`LiveQueryCollectionConfig`](../../interfaces/LiveQueryCollectionConfig.md)\<`TContext`, `TResult`\> +[`LiveQueryCollectionConfig`](../interfaces/LiveQueryCollectionConfig.md)\<`TContext`, `TResult`\> Configuration options for the live query collection diff --git a/docs/reference/functions/localOnlyCollectionOptions.md b/docs/reference/functions/localOnlyCollectionOptions.md index f473f9599..06ea87aff 100644 --- a/docs/reference/functions/localOnlyCollectionOptions.md +++ b/docs/reference/functions/localOnlyCollectionOptions.md @@ -43,13 +43,13 @@ The type of the key returned by getKey #### config -[`LocalOnlyCollectionConfig`](../../interfaces/LocalOnlyCollectionConfig.md)\<[`InferSchemaOutput`](../../type-aliases/InferSchemaOutput.md)\<`T`\>, `T`, `TKey`\> & `object` +[`LocalOnlyCollectionConfig`](../interfaces/LocalOnlyCollectionConfig.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `T`, `TKey`\> & `object` Configuration options for the Local-only collection ### Returns -[`CollectionConfig`](../../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, [`UtilsRecord`](../../type-aliases/UtilsRecord.md)\> & `object` & `object` +[`CollectionConfig`](../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, [`UtilsRecord`](../type-aliases/UtilsRecord.md)\> & `object` & `object` Collection options with utilities including acceptMutations @@ -155,13 +155,13 @@ The type of the key returned by getKey #### config -[`LocalOnlyCollectionConfig`](../../interfaces/LocalOnlyCollectionConfig.md)\<`T`, `never`, `TKey`\> & `object` +[`LocalOnlyCollectionConfig`](../interfaces/LocalOnlyCollectionConfig.md)\<`T`, `never`, `TKey`\> & `object` Configuration options for the Local-only collection ### Returns -[`CollectionConfig`](../../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, [`UtilsRecord`](../../type-aliases/UtilsRecord.md)\> & `object` & `object` +[`CollectionConfig`](../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, [`UtilsRecord`](../type-aliases/UtilsRecord.md)\> & `object` & `object` Collection options with utilities including acceptMutations diff --git a/docs/reference/functions/localStorageCollectionOptions.md b/docs/reference/functions/localStorageCollectionOptions.md index 48e42965d..6ea5ecad0 100644 --- a/docs/reference/functions/localStorageCollectionOptions.md +++ b/docs/reference/functions/localStorageCollectionOptions.md @@ -46,13 +46,13 @@ don't participate in the standard mutation handler flow for manual transactions. #### config -[`LocalStorageCollectionConfig`](../../interfaces/LocalStorageCollectionConfig.md)\<[`InferSchemaOutput`](../../type-aliases/InferSchemaOutput.md)\<`T`\>, `T`, `TKey`\> & `object` +[`LocalStorageCollectionConfig`](../interfaces/LocalStorageCollectionConfig.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `T`, `TKey`\> & `object` Configuration options for the localStorage collection ### Returns -[`CollectionConfig`](../../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, [`LocalStorageCollectionUtils`](../../interfaces/LocalStorageCollectionUtils.md)\> & `object` +[`CollectionConfig`](../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, [`LocalStorageCollectionUtils`](../interfaces/LocalStorageCollectionUtils.md)\> & `object` Collection options with utilities including clearStorage, getStorageSize, and acceptMutations @@ -161,13 +161,13 @@ don't participate in the standard mutation handler flow for manual transactions. #### config -[`LocalStorageCollectionConfig`](../../interfaces/LocalStorageCollectionConfig.md)\<`T`, `never`, `TKey`\> & `object` +[`LocalStorageCollectionConfig`](../interfaces/LocalStorageCollectionConfig.md)\<`T`, `never`, `TKey`\> & `object` Configuration options for the localStorage collection ### Returns -[`CollectionConfig`](../../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, [`LocalStorageCollectionUtils`](../../interfaces/LocalStorageCollectionUtils.md)\> & `object` +[`CollectionConfig`](../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, [`LocalStorageCollectionUtils`](../interfaces/LocalStorageCollectionUtils.md)\> & `object` Collection options with utilities including clearStorage, getStorageSize, and acceptMutations diff --git a/docs/reference/functions/lt.md b/docs/reference/functions/lt.md index b7cbe7e61..b7c95cdf7 100644 --- a/docs/reference/functions/lt.md +++ b/docs/reference/functions/lt.md @@ -31,7 +31,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:154](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> ## Call Signature @@ -59,7 +59,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:158](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> ## Call Signature @@ -79,7 +79,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:162](https://github.com/ #### left -[`Aggregate`](../../@tanstack/namespaces/IR/classes/Aggregate.md)\<`T`\> +[`Aggregate`](../@tanstack/namespaces/IR/classes/Aggregate.md)\<`T`\> #### right @@ -87,4 +87,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:162](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> diff --git a/docs/reference/functions/lte.md b/docs/reference/functions/lte.md index 25db4b12f..d71cacef0 100644 --- a/docs/reference/functions/lte.md +++ b/docs/reference/functions/lte.md @@ -31,7 +31,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:167](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> ## Call Signature @@ -59,7 +59,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:171](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> ## Call Signature @@ -79,7 +79,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:175](https://github.com/ #### left -[`Aggregate`](../../@tanstack/namespaces/IR/classes/Aggregate.md)\<`T`\> +[`Aggregate`](../@tanstack/namespaces/IR/classes/Aggregate.md)\<`T`\> #### right @@ -87,4 +87,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:175](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> diff --git a/docs/reference/functions/minusWherePredicates.md b/docs/reference/functions/minusWherePredicates.md index e5e33e6c7..d86b411df 100644 --- a/docs/reference/functions/minusWherePredicates.md +++ b/docs/reference/functions/minusWherePredicates.md @@ -23,17 +23,17 @@ Returns the simplified predicate, or null if the difference cannot be simplified The predicate to subtract from -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> | `undefined` +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> | `undefined` ### subtractPredicate The predicate to subtract -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> | `undefined` +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> | `undefined` ## Returns - \| [`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> + \| [`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> \| `null` The simplified difference, or null if cannot be simplified diff --git a/docs/reference/functions/not.md b/docs/reference/functions/not.md index d0bab9aff..3a5214236 100644 --- a/docs/reference/functions/not.md +++ b/docs/reference/functions/not.md @@ -19,4 +19,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:224](https://github.com/ ## Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> diff --git a/docs/reference/functions/or.md b/docs/reference/functions/or.md index 11e471f9e..351e72ce8 100644 --- a/docs/reference/functions/or.md +++ b/docs/reference/functions/or.md @@ -25,7 +25,7 @@ Defined in: [packages/db/src/query/builder/functions.ts:203](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> ## Call Signature @@ -54,4 +54,4 @@ Defined in: [packages/db/src/query/builder/functions.ts:207](https://github.com/ ### Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> diff --git a/docs/reference/functions/parseLoadSubsetOptions.md b/docs/reference/functions/parseLoadSubsetOptions.md index 880c34177..40e850e7f 100644 --- a/docs/reference/functions/parseLoadSubsetOptions.md +++ b/docs/reference/functions/parseLoadSubsetOptions.md @@ -22,7 +22,7 @@ The LoadSubsetOptions from ctx.meta \{ `limit?`: `number`; -`orderBy?`: [`OrderBy`](../../@tanstack/namespaces/IR/type-aliases/OrderBy.md); +`orderBy?`: [`OrderBy`](../@tanstack/namespaces/IR/type-aliases/OrderBy.md); `where?`: `BasicExpression`\<`boolean`\>; \} | `null` | `undefined` diff --git a/docs/reference/functions/parseOrderByExpression.md b/docs/reference/functions/parseOrderByExpression.md index 13e2d77f0..2df1508c5 100644 --- a/docs/reference/functions/parseOrderByExpression.md +++ b/docs/reference/functions/parseOrderByExpression.md @@ -19,11 +19,11 @@ Parses an ORDER BY expression into a simple array of sort specifications. The ORDER BY expression array -[`OrderBy`](../../@tanstack/namespaces/IR/type-aliases/OrderBy.md) | `null` | `undefined` +[`OrderBy`](../@tanstack/namespaces/IR/type-aliases/OrderBy.md) | `null` | `undefined` ## Returns -[`ParsedOrderBy`](../../interfaces/ParsedOrderBy.md)[] +[`ParsedOrderBy`](../interfaces/ParsedOrderBy.md)[] Array of parsed order by specifications diff --git a/docs/reference/functions/parseWhereExpression.md b/docs/reference/functions/parseWhereExpression.md index a15a8f7e3..792773811 100644 --- a/docs/reference/functions/parseWhereExpression.md +++ b/docs/reference/functions/parseWhereExpression.md @@ -33,7 +33,7 @@ The WHERE expression to parse ### options -[`ParseWhereOptions`](../../interfaces/ParseWhereOptions.md)\<`T`\> +[`ParseWhereOptions`](../interfaces/ParseWhereOptions.md)\<`T`\> Configuration with handler functions for each operator diff --git a/docs/reference/functions/queueStrategy.md b/docs/reference/functions/queueStrategy.md index 8752c1746..524ca194f 100644 --- a/docs/reference/functions/queueStrategy.md +++ b/docs/reference/functions/queueStrategy.md @@ -22,13 +22,13 @@ every operation must complete in order. ### options? -[`QueueStrategyOptions`](../../interfaces/QueueStrategyOptions.md) +[`QueueStrategyOptions`](../interfaces/QueueStrategyOptions.md) Configuration for queue behavior (FIFO/LIFO, timing, size limits) ## Returns -[`QueueStrategy`](../../interfaces/QueueStrategy.md) +[`QueueStrategy`](../interfaces/QueueStrategy.md) A queue strategy instance diff --git a/docs/reference/functions/throttleStrategy.md b/docs/reference/functions/throttleStrategy.md index b9ac28644..35c7aa07e 100644 --- a/docs/reference/functions/throttleStrategy.md +++ b/docs/reference/functions/throttleStrategy.md @@ -22,13 +22,13 @@ execution timing. ### options -[`ThrottleStrategyOptions`](../../interfaces/ThrottleStrategyOptions.md) +[`ThrottleStrategyOptions`](../interfaces/ThrottleStrategyOptions.md) Configuration for throttle behavior ## Returns -[`ThrottleStrategy`](../../interfaces/ThrottleStrategy.md) +[`ThrottleStrategy`](../interfaces/ThrottleStrategy.md) A throttle strategy instance diff --git a/docs/reference/functions/unionWherePredicates.md b/docs/reference/functions/unionWherePredicates.md index eb34b9775..ffd244a1c 100644 --- a/docs/reference/functions/unionWherePredicates.md +++ b/docs/reference/functions/unionWherePredicates.md @@ -19,13 +19,13 @@ Simplifies when possible (e.g., age > 10 OR age > 20 → age > 10). ### predicates -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\>[] +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\>[] Array of where predicates to union ## Returns -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)\<`boolean`\> Combined predicate representing the union diff --git a/docs/reference/index.md b/docs/reference/index.md index fa0ec0312..85e77759f 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -7,272 +7,272 @@ title: "@tanstack/db" ## Namespaces -- [IR](../@tanstack/namespaces/IR/index.md) +- [IR](./@tanstack/namespaces/IR/index.md) ## Classes -- [AggregateFunctionNotInSelectError](../classes/AggregateFunctionNotInSelectError.md) -- [AggregateNotSupportedError](../classes/AggregateNotSupportedError.md) -- [BaseIndex](../classes/BaseIndex.md) -- [BaseQueryBuilder](../classes/BaseQueryBuilder.md) -- [BTreeIndex](../classes/BTreeIndex.md) -- [CannotCombineEmptyExpressionListError](../classes/CannotCombineEmptyExpressionListError.md) -- [CollectionConfigurationError](../classes/CollectionConfigurationError.md) -- [CollectionImpl](../classes/CollectionImpl.md) -- [CollectionInErrorStateError](../classes/CollectionInErrorStateError.md) -- [CollectionInputNotFoundError](../classes/CollectionInputNotFoundError.md) -- [CollectionIsInErrorStateError](../classes/CollectionIsInErrorStateError.md) -- [CollectionOperationError](../classes/CollectionOperationError.md) -- [CollectionRequiresConfigError](../classes/CollectionRequiresConfigError.md) -- [CollectionRequiresSyncConfigError](../classes/CollectionRequiresSyncConfigError.md) -- [CollectionStateError](../classes/CollectionStateError.md) -- [DeduplicatedLoadSubset](../classes/DeduplicatedLoadSubset.md) -- [DeleteKeyNotFoundError](../classes/DeleteKeyNotFoundError.md) -- [DistinctRequiresSelectError](../classes/DistinctRequiresSelectError.md) -- [DuplicateAliasInSubqueryError](../classes/DuplicateAliasInSubqueryError.md) -- [DuplicateDbInstanceError](../classes/DuplicateDbInstanceError.md) -- [DuplicateKeyError](../classes/DuplicateKeyError.md) -- [DuplicateKeySyncError](../classes/DuplicateKeySyncError.md) -- [EmptyReferencePathError](../classes/EmptyReferencePathError.md) -- [GroupByError](../classes/GroupByError.md) -- [HavingRequiresGroupByError](../classes/HavingRequiresGroupByError.md) -- [IndexProxy](../classes/IndexProxy.md) -- [InvalidCollectionStatusTransitionError](../classes/InvalidCollectionStatusTransitionError.md) -- [InvalidJoinCondition](../classes/InvalidJoinCondition.md) -- [InvalidJoinConditionLeftSourceError](../classes/InvalidJoinConditionLeftSourceError.md) -- [InvalidJoinConditionRightSourceError](../classes/InvalidJoinConditionRightSourceError.md) -- [InvalidJoinConditionSameSourceError](../classes/InvalidJoinConditionSameSourceError.md) -- [InvalidJoinConditionSourceMismatchError](../classes/InvalidJoinConditionSourceMismatchError.md) -- [InvalidSchemaError](../classes/InvalidSchemaError.md) -- [InvalidSourceError](../classes/InvalidSourceError.md) -- [InvalidSourceTypeError](../classes/InvalidSourceTypeError.md) -- [InvalidStorageDataFormatError](../classes/InvalidStorageDataFormatError.md) -- [InvalidStorageObjectFormatError](../classes/InvalidStorageObjectFormatError.md) -- [JoinCollectionNotFoundError](../classes/JoinCollectionNotFoundError.md) -- [JoinConditionMustBeEqualityError](../classes/JoinConditionMustBeEqualityError.md) -- [JoinError](../classes/JoinError.md) -- [KeyUpdateNotAllowedError](../classes/KeyUpdateNotAllowedError.md) -- [LazyIndexWrapper](../classes/LazyIndexWrapper.md) -- [LimitOffsetRequireOrderByError](../classes/LimitOffsetRequireOrderByError.md) -- [LocalStorageCollectionError](../classes/LocalStorageCollectionError.md) -- [MissingAliasInputsError](../classes/MissingAliasInputsError.md) -- [MissingDeleteHandlerError](../classes/MissingDeleteHandlerError.md) -- [MissingHandlerError](../classes/MissingHandlerError.md) -- [MissingInsertHandlerError](../classes/MissingInsertHandlerError.md) -- [MissingMutationFunctionError](../classes/MissingMutationFunctionError.md) -- [MissingUpdateArgumentError](../classes/MissingUpdateArgumentError.md) -- [MissingUpdateHandlerError](../classes/MissingUpdateHandlerError.md) -- [NegativeActiveSubscribersError](../classes/NegativeActiveSubscribersError.md) -- [NoKeysPassedToDeleteError](../classes/NoKeysPassedToDeleteError.md) -- [NoKeysPassedToUpdateError](../classes/NoKeysPassedToUpdateError.md) -- [NonAggregateExpressionNotInGroupByError](../classes/NonAggregateExpressionNotInGroupByError.md) -- [NonRetriableError](../classes/NonRetriableError.md) -- [NoPendingSyncTransactionCommitError](../classes/NoPendingSyncTransactionCommitError.md) -- [NoPendingSyncTransactionWriteError](../classes/NoPendingSyncTransactionWriteError.md) -- [OnlyOneSourceAllowedError](../classes/OnlyOneSourceAllowedError.md) -- [OnMutateMustBeSynchronousError](../classes/OnMutateMustBeSynchronousError.md) -- [QueryBuilderError](../classes/QueryBuilderError.md) -- [QueryCompilationError](../classes/QueryCompilationError.md) -- [QueryMustHaveFromClauseError](../classes/QueryMustHaveFromClauseError.md) -- [QueryOptimizerError](../classes/QueryOptimizerError.md) -- [SchemaMustBeSynchronousError](../classes/SchemaMustBeSynchronousError.md) -- [SchemaValidationError](../classes/SchemaValidationError.md) -- [SerializationError](../classes/SerializationError.md) -- [SetWindowRequiresOrderByError](../classes/SetWindowRequiresOrderByError.md) -- [SortedMap](../classes/SortedMap.md) -- [StorageError](../classes/StorageError.md) -- [StorageKeyRequiredError](../classes/StorageKeyRequiredError.md) -- [SubQueryMustHaveFromClauseError](../classes/SubQueryMustHaveFromClauseError.md) -- [SubscriptionNotFoundError](../classes/SubscriptionNotFoundError.md) -- [SyncCleanupError](../classes/SyncCleanupError.md) -- [SyncTransactionAlreadyCommittedError](../classes/SyncTransactionAlreadyCommittedError.md) -- [SyncTransactionAlreadyCommittedWriteError](../classes/SyncTransactionAlreadyCommittedWriteError.md) -- [TanStackDBError](../classes/TanStackDBError.md) -- [TransactionAlreadyCompletedRollbackError](../classes/TransactionAlreadyCompletedRollbackError.md) -- [TransactionError](../classes/TransactionError.md) -- [TransactionNotPendingCommitError](../classes/TransactionNotPendingCommitError.md) -- [TransactionNotPendingMutateError](../classes/TransactionNotPendingMutateError.md) -- [UndefinedKeyError](../classes/UndefinedKeyError.md) -- [UnknownExpressionTypeError](../classes/UnknownExpressionTypeError.md) -- [UnknownFunctionError](../classes/UnknownFunctionError.md) -- [UnknownHavingExpressionTypeError](../classes/UnknownHavingExpressionTypeError.md) -- [UnsupportedAggregateFunctionError](../classes/UnsupportedAggregateFunctionError.md) -- [UnsupportedFromTypeError](../classes/UnsupportedFromTypeError.md) -- [UnsupportedJoinSourceTypeError](../classes/UnsupportedJoinSourceTypeError.md) -- [UnsupportedJoinTypeError](../classes/UnsupportedJoinTypeError.md) -- [UpdateKeyNotFoundError](../classes/UpdateKeyNotFoundError.md) -- [WhereClauseConversionError](../classes/WhereClauseConversionError.md) +- [AggregateFunctionNotInSelectError](./classes/AggregateFunctionNotInSelectError.md) +- [AggregateNotSupportedError](./classes/AggregateNotSupportedError.md) +- [BaseIndex](./classes/BaseIndex.md) +- [BaseQueryBuilder](./classes/BaseQueryBuilder.md) +- [BTreeIndex](./classes/BTreeIndex.md) +- [CannotCombineEmptyExpressionListError](./classes/CannotCombineEmptyExpressionListError.md) +- [CollectionConfigurationError](./classes/CollectionConfigurationError.md) +- [CollectionImpl](./classes/CollectionImpl.md) +- [CollectionInErrorStateError](./classes/CollectionInErrorStateError.md) +- [CollectionInputNotFoundError](./classes/CollectionInputNotFoundError.md) +- [CollectionIsInErrorStateError](./classes/CollectionIsInErrorStateError.md) +- [CollectionOperationError](./classes/CollectionOperationError.md) +- [CollectionRequiresConfigError](./classes/CollectionRequiresConfigError.md) +- [CollectionRequiresSyncConfigError](./classes/CollectionRequiresSyncConfigError.md) +- [CollectionStateError](./classes/CollectionStateError.md) +- [DeduplicatedLoadSubset](./classes/DeduplicatedLoadSubset.md) +- [DeleteKeyNotFoundError](./classes/DeleteKeyNotFoundError.md) +- [DistinctRequiresSelectError](./classes/DistinctRequiresSelectError.md) +- [DuplicateAliasInSubqueryError](./classes/DuplicateAliasInSubqueryError.md) +- [DuplicateDbInstanceError](./classes/DuplicateDbInstanceError.md) +- [DuplicateKeyError](./classes/DuplicateKeyError.md) +- [DuplicateKeySyncError](./classes/DuplicateKeySyncError.md) +- [EmptyReferencePathError](./classes/EmptyReferencePathError.md) +- [GroupByError](./classes/GroupByError.md) +- [HavingRequiresGroupByError](./classes/HavingRequiresGroupByError.md) +- [IndexProxy](./classes/IndexProxy.md) +- [InvalidCollectionStatusTransitionError](./classes/InvalidCollectionStatusTransitionError.md) +- [InvalidJoinCondition](./classes/InvalidJoinCondition.md) +- [InvalidJoinConditionLeftSourceError](./classes/InvalidJoinConditionLeftSourceError.md) +- [InvalidJoinConditionRightSourceError](./classes/InvalidJoinConditionRightSourceError.md) +- [InvalidJoinConditionSameSourceError](./classes/InvalidJoinConditionSameSourceError.md) +- [InvalidJoinConditionSourceMismatchError](./classes/InvalidJoinConditionSourceMismatchError.md) +- [InvalidSchemaError](./classes/InvalidSchemaError.md) +- [InvalidSourceError](./classes/InvalidSourceError.md) +- [InvalidSourceTypeError](./classes/InvalidSourceTypeError.md) +- [InvalidStorageDataFormatError](./classes/InvalidStorageDataFormatError.md) +- [InvalidStorageObjectFormatError](./classes/InvalidStorageObjectFormatError.md) +- [JoinCollectionNotFoundError](./classes/JoinCollectionNotFoundError.md) +- [JoinConditionMustBeEqualityError](./classes/JoinConditionMustBeEqualityError.md) +- [JoinError](./classes/JoinError.md) +- [KeyUpdateNotAllowedError](./classes/KeyUpdateNotAllowedError.md) +- [LazyIndexWrapper](./classes/LazyIndexWrapper.md) +- [LimitOffsetRequireOrderByError](./classes/LimitOffsetRequireOrderByError.md) +- [LocalStorageCollectionError](./classes/LocalStorageCollectionError.md) +- [MissingAliasInputsError](./classes/MissingAliasInputsError.md) +- [MissingDeleteHandlerError](./classes/MissingDeleteHandlerError.md) +- [MissingHandlerError](./classes/MissingHandlerError.md) +- [MissingInsertHandlerError](./classes/MissingInsertHandlerError.md) +- [MissingMutationFunctionError](./classes/MissingMutationFunctionError.md) +- [MissingUpdateArgumentError](./classes/MissingUpdateArgumentError.md) +- [MissingUpdateHandlerError](./classes/MissingUpdateHandlerError.md) +- [NegativeActiveSubscribersError](./classes/NegativeActiveSubscribersError.md) +- [NoKeysPassedToDeleteError](./classes/NoKeysPassedToDeleteError.md) +- [NoKeysPassedToUpdateError](./classes/NoKeysPassedToUpdateError.md) +- [NonAggregateExpressionNotInGroupByError](./classes/NonAggregateExpressionNotInGroupByError.md) +- [NonRetriableError](./classes/NonRetriableError.md) +- [NoPendingSyncTransactionCommitError](./classes/NoPendingSyncTransactionCommitError.md) +- [NoPendingSyncTransactionWriteError](./classes/NoPendingSyncTransactionWriteError.md) +- [OnlyOneSourceAllowedError](./classes/OnlyOneSourceAllowedError.md) +- [OnMutateMustBeSynchronousError](./classes/OnMutateMustBeSynchronousError.md) +- [QueryBuilderError](./classes/QueryBuilderError.md) +- [QueryCompilationError](./classes/QueryCompilationError.md) +- [QueryMustHaveFromClauseError](./classes/QueryMustHaveFromClauseError.md) +- [QueryOptimizerError](./classes/QueryOptimizerError.md) +- [SchemaMustBeSynchronousError](./classes/SchemaMustBeSynchronousError.md) +- [SchemaValidationError](./classes/SchemaValidationError.md) +- [SerializationError](./classes/SerializationError.md) +- [SetWindowRequiresOrderByError](./classes/SetWindowRequiresOrderByError.md) +- [SortedMap](./classes/SortedMap.md) +- [StorageError](./classes/StorageError.md) +- [StorageKeyRequiredError](./classes/StorageKeyRequiredError.md) +- [SubQueryMustHaveFromClauseError](./classes/SubQueryMustHaveFromClauseError.md) +- [SubscriptionNotFoundError](./classes/SubscriptionNotFoundError.md) +- [SyncCleanupError](./classes/SyncCleanupError.md) +- [SyncTransactionAlreadyCommittedError](./classes/SyncTransactionAlreadyCommittedError.md) +- [SyncTransactionAlreadyCommittedWriteError](./classes/SyncTransactionAlreadyCommittedWriteError.md) +- [TanStackDBError](./classes/TanStackDBError.md) +- [TransactionAlreadyCompletedRollbackError](./classes/TransactionAlreadyCompletedRollbackError.md) +- [TransactionError](./classes/TransactionError.md) +- [TransactionNotPendingCommitError](./classes/TransactionNotPendingCommitError.md) +- [TransactionNotPendingMutateError](./classes/TransactionNotPendingMutateError.md) +- [UndefinedKeyError](./classes/UndefinedKeyError.md) +- [UnknownExpressionTypeError](./classes/UnknownExpressionTypeError.md) +- [UnknownFunctionError](./classes/UnknownFunctionError.md) +- [UnknownHavingExpressionTypeError](./classes/UnknownHavingExpressionTypeError.md) +- [UnsupportedAggregateFunctionError](./classes/UnsupportedAggregateFunctionError.md) +- [UnsupportedFromTypeError](./classes/UnsupportedFromTypeError.md) +- [UnsupportedJoinSourceTypeError](./classes/UnsupportedJoinSourceTypeError.md) +- [UnsupportedJoinTypeError](./classes/UnsupportedJoinTypeError.md) +- [UpdateKeyNotFoundError](./classes/UpdateKeyNotFoundError.md) +- [WhereClauseConversionError](./classes/WhereClauseConversionError.md) ## Interfaces -- [BaseCollectionConfig](../interfaces/BaseCollectionConfig.md) -- [BaseStrategy](../interfaces/BaseStrategy.md) -- [BTreeIndexOptions](../interfaces/BTreeIndexOptions.md) -- [ChangeMessage](../interfaces/ChangeMessage.md) -- [Collection](../interfaces/Collection.md) -- [CollectionConfig](../interfaces/CollectionConfig.md) -- [CollectionLike](../interfaces/CollectionLike.md) -- [Context](../interfaces/Context.md) -- [CreateOptimisticActionsOptions](../interfaces/CreateOptimisticActionsOptions.md) -- [CurrentStateAsChangesOptions](../interfaces/CurrentStateAsChangesOptions.md) -- [DebounceStrategy](../interfaces/DebounceStrategy.md) -- [DebounceStrategyOptions](../interfaces/DebounceStrategyOptions.md) -- [IndexInterface](../interfaces/IndexInterface.md) -- [IndexOptions](../interfaces/IndexOptions.md) -- [IndexStats](../interfaces/IndexStats.md) -- [InsertConfig](../interfaces/InsertConfig.md) -- [LiveQueryCollectionConfig](../interfaces/LiveQueryCollectionConfig.md) -- [LocalOnlyCollectionConfig](../interfaces/LocalOnlyCollectionConfig.md) -- [LocalOnlyCollectionUtils](../interfaces/LocalOnlyCollectionUtils.md) -- [LocalStorageCollectionConfig](../interfaces/LocalStorageCollectionConfig.md) -- [LocalStorageCollectionUtils](../interfaces/LocalStorageCollectionUtils.md) -- [OperationConfig](../interfaces/OperationConfig.md) -- [OptimisticChangeMessage](../interfaces/OptimisticChangeMessage.md) -- [PacedMutationsConfig](../interfaces/PacedMutationsConfig.md) -- [ParsedOrderBy](../interfaces/ParsedOrderBy.md) -- [Parser](../interfaces/Parser.md) -- [ParseWhereOptions](../interfaces/ParseWhereOptions.md) -- [PendingMutation](../interfaces/PendingMutation.md) -- [QueueStrategy](../interfaces/QueueStrategy.md) -- [QueueStrategyOptions](../interfaces/QueueStrategyOptions.md) -- [RangeQueryOptions](../interfaces/RangeQueryOptions.md) -- [SimpleComparison](../interfaces/SimpleComparison.md) -- [SubscribeChangesOptions](../interfaces/SubscribeChangesOptions.md) -- [SubscribeChangesSnapshotOptions](../interfaces/SubscribeChangesSnapshotOptions.md) -- [Subscription](../interfaces/Subscription.md) -- [SubscriptionStatusChangeEvent](../interfaces/SubscriptionStatusChangeEvent.md) -- [SubscriptionStatusEvent](../interfaces/SubscriptionStatusEvent.md) -- [SubscriptionUnsubscribedEvent](../interfaces/SubscriptionUnsubscribedEvent.md) -- [SyncConfig](../interfaces/SyncConfig.md) -- [ThrottleStrategy](../interfaces/ThrottleStrategy.md) -- [ThrottleStrategyOptions](../interfaces/ThrottleStrategyOptions.md) -- [Transaction](../interfaces/Transaction.md) -- [TransactionConfig](../interfaces/TransactionConfig.md) +- [BaseCollectionConfig](./interfaces/BaseCollectionConfig.md) +- [BaseStrategy](./interfaces/BaseStrategy.md) +- [BTreeIndexOptions](./interfaces/BTreeIndexOptions.md) +- [ChangeMessage](./interfaces/ChangeMessage.md) +- [Collection](./interfaces/Collection.md) +- [CollectionConfig](./interfaces/CollectionConfig.md) +- [CollectionLike](./interfaces/CollectionLike.md) +- [Context](./interfaces/Context.md) +- [CreateOptimisticActionsOptions](./interfaces/CreateOptimisticActionsOptions.md) +- [CurrentStateAsChangesOptions](./interfaces/CurrentStateAsChangesOptions.md) +- [DebounceStrategy](./interfaces/DebounceStrategy.md) +- [DebounceStrategyOptions](./interfaces/DebounceStrategyOptions.md) +- [IndexInterface](./interfaces/IndexInterface.md) +- [IndexOptions](./interfaces/IndexOptions.md) +- [IndexStats](./interfaces/IndexStats.md) +- [InsertConfig](./interfaces/InsertConfig.md) +- [LiveQueryCollectionConfig](./interfaces/LiveQueryCollectionConfig.md) +- [LocalOnlyCollectionConfig](./interfaces/LocalOnlyCollectionConfig.md) +- [LocalOnlyCollectionUtils](./interfaces/LocalOnlyCollectionUtils.md) +- [LocalStorageCollectionConfig](./interfaces/LocalStorageCollectionConfig.md) +- [LocalStorageCollectionUtils](./interfaces/LocalStorageCollectionUtils.md) +- [OperationConfig](./interfaces/OperationConfig.md) +- [OptimisticChangeMessage](./interfaces/OptimisticChangeMessage.md) +- [PacedMutationsConfig](./interfaces/PacedMutationsConfig.md) +- [ParsedOrderBy](./interfaces/ParsedOrderBy.md) +- [Parser](./interfaces/Parser.md) +- [ParseWhereOptions](./interfaces/ParseWhereOptions.md) +- [PendingMutation](./interfaces/PendingMutation.md) +- [QueueStrategy](./interfaces/QueueStrategy.md) +- [QueueStrategyOptions](./interfaces/QueueStrategyOptions.md) +- [RangeQueryOptions](./interfaces/RangeQueryOptions.md) +- [SimpleComparison](./interfaces/SimpleComparison.md) +- [SubscribeChangesOptions](./interfaces/SubscribeChangesOptions.md) +- [SubscribeChangesSnapshotOptions](./interfaces/SubscribeChangesSnapshotOptions.md) +- [Subscription](./interfaces/Subscription.md) +- [SubscriptionStatusChangeEvent](./interfaces/SubscriptionStatusChangeEvent.md) +- [SubscriptionStatusEvent](./interfaces/SubscriptionStatusEvent.md) +- [SubscriptionUnsubscribedEvent](./interfaces/SubscriptionUnsubscribedEvent.md) +- [SyncConfig](./interfaces/SyncConfig.md) +- [ThrottleStrategy](./interfaces/ThrottleStrategy.md) +- [ThrottleStrategyOptions](./interfaces/ThrottleStrategyOptions.md) +- [Transaction](./interfaces/Transaction.md) +- [TransactionConfig](./interfaces/TransactionConfig.md) ## Type Aliases -- [ChangeListener](../type-aliases/ChangeListener.md) -- [ChangesPayload](../type-aliases/ChangesPayload.md) -- [CleanupFn](../type-aliases/CleanupFn.md) -- [ClearStorageFn](../type-aliases/ClearStorageFn.md) -- [CollectionConfigSingleRowOption](../type-aliases/CollectionConfigSingleRowOption.md) -- [CollectionStatus](../type-aliases/CollectionStatus.md) -- [DeleteMutationFn](../type-aliases/DeleteMutationFn.md) -- [DeleteMutationFnParams](../type-aliases/DeleteMutationFnParams.md) -- [FieldPath](../type-aliases/FieldPath.md) -- [Fn](../type-aliases/Fn.md) -- [GetResult](../type-aliases/GetResult.md) -- [GetStorageSizeFn](../type-aliases/GetStorageSizeFn.md) -- [IndexConstructor](../type-aliases/IndexConstructor.md) -- [IndexOperation](../type-aliases/IndexOperation.md) -- [IndexResolver](../type-aliases/IndexResolver.md) -- [InferResultType](../type-aliases/InferResultType.md) -- [InferSchemaInput](../type-aliases/InferSchemaInput.md) -- [InferSchemaOutput](../type-aliases/InferSchemaOutput.md) -- [InitialQueryBuilder](../type-aliases/InitialQueryBuilder.md) -- [InputRow](../type-aliases/InputRow.md) -- [InsertMutationFn](../type-aliases/InsertMutationFn.md) -- [InsertMutationFnParams](../type-aliases/InsertMutationFnParams.md) -- [KeyedNamespacedRow](../type-aliases/KeyedNamespacedRow.md) -- [KeyedStream](../type-aliases/KeyedStream.md) -- [LiveQueryCollectionUtils](../type-aliases/LiveQueryCollectionUtils.md) -- [LoadSubsetFn](../type-aliases/LoadSubsetFn.md) -- [LoadSubsetOptions](../type-aliases/LoadSubsetOptions.md) -- [MaybeSingleResult](../type-aliases/MaybeSingleResult.md) -- [MutationFn](../type-aliases/MutationFn.md) -- [MutationFnParams](../type-aliases/MutationFnParams.md) -- [NamespacedAndKeyedStream](../type-aliases/NamespacedAndKeyedStream.md) -- [NamespacedRow](../type-aliases/NamespacedRow.md) -- [NonEmptyArray](../type-aliases/NonEmptyArray.md) -- [NonSingleResult](../type-aliases/NonSingleResult.md) -- [OperationType](../type-aliases/OperationType.md) -- [OperatorName](../type-aliases/OperatorName.md) -- [QueryBuilder](../type-aliases/QueryBuilder.md) -- [Ref](../type-aliases/Ref.md) -- [ResolveTransactionChanges](../type-aliases/ResolveTransactionChanges.md) -- [ResultStream](../type-aliases/ResultStream.md) -- [Row](../type-aliases/Row.md) -- [SingleResult](../type-aliases/SingleResult.md) -- [Source](../type-aliases/Source.md) -- [StandardSchema](../type-aliases/StandardSchema.md) -- [StandardSchemaAlias](../type-aliases/StandardSchemaAlias.md) -- [StorageApi](../type-aliases/StorageApi.md) -- [StorageEventApi](../type-aliases/StorageEventApi.md) -- [Strategy](../type-aliases/Strategy.md) -- [StrategyOptions](../type-aliases/StrategyOptions.md) -- [StringCollationConfig](../type-aliases/StringCollationConfig.md) -- [SubscriptionEvents](../type-aliases/SubscriptionEvents.md) -- [SubscriptionStatus](../type-aliases/SubscriptionStatus.md) -- [SyncConfigRes](../type-aliases/SyncConfigRes.md) -- [SyncMode](../type-aliases/SyncMode.md) -- [TransactionState](../type-aliases/TransactionState.md) -- [TransactionWithMutations](../type-aliases/TransactionWithMutations.md) -- [UnloadSubsetFn](../type-aliases/UnloadSubsetFn.md) -- [UpdateMutationFn](../type-aliases/UpdateMutationFn.md) -- [UpdateMutationFnParams](../type-aliases/UpdateMutationFnParams.md) -- [UtilsRecord](../type-aliases/UtilsRecord.md) -- [WritableDeep](../type-aliases/WritableDeep.md) +- [ChangeListener](./type-aliases/ChangeListener.md) +- [ChangesPayload](./type-aliases/ChangesPayload.md) +- [CleanupFn](./type-aliases/CleanupFn.md) +- [ClearStorageFn](./type-aliases/ClearStorageFn.md) +- [CollectionConfigSingleRowOption](./type-aliases/CollectionConfigSingleRowOption.md) +- [CollectionStatus](./type-aliases/CollectionStatus.md) +- [DeleteMutationFn](./type-aliases/DeleteMutationFn.md) +- [DeleteMutationFnParams](./type-aliases/DeleteMutationFnParams.md) +- [FieldPath](./type-aliases/FieldPath.md) +- [Fn](./type-aliases/Fn.md) +- [GetResult](./type-aliases/GetResult.md) +- [GetStorageSizeFn](./type-aliases/GetStorageSizeFn.md) +- [IndexConstructor](./type-aliases/IndexConstructor.md) +- [IndexOperation](./type-aliases/IndexOperation.md) +- [IndexResolver](./type-aliases/IndexResolver.md) +- [InferResultType](./type-aliases/InferResultType.md) +- [InferSchemaInput](./type-aliases/InferSchemaInput.md) +- [InferSchemaOutput](./type-aliases/InferSchemaOutput.md) +- [InitialQueryBuilder](./type-aliases/InitialQueryBuilder.md) +- [InputRow](./type-aliases/InputRow.md) +- [InsertMutationFn](./type-aliases/InsertMutationFn.md) +- [InsertMutationFnParams](./type-aliases/InsertMutationFnParams.md) +- [KeyedNamespacedRow](./type-aliases/KeyedNamespacedRow.md) +- [KeyedStream](./type-aliases/KeyedStream.md) +- [LiveQueryCollectionUtils](./type-aliases/LiveQueryCollectionUtils.md) +- [LoadSubsetFn](./type-aliases/LoadSubsetFn.md) +- [LoadSubsetOptions](./type-aliases/LoadSubsetOptions.md) +- [MaybeSingleResult](./type-aliases/MaybeSingleResult.md) +- [MutationFn](./type-aliases/MutationFn.md) +- [MutationFnParams](./type-aliases/MutationFnParams.md) +- [NamespacedAndKeyedStream](./type-aliases/NamespacedAndKeyedStream.md) +- [NamespacedRow](./type-aliases/NamespacedRow.md) +- [NonEmptyArray](./type-aliases/NonEmptyArray.md) +- [NonSingleResult](./type-aliases/NonSingleResult.md) +- [OperationType](./type-aliases/OperationType.md) +- [OperatorName](./type-aliases/OperatorName.md) +- [QueryBuilder](./type-aliases/QueryBuilder.md) +- [Ref](./type-aliases/Ref.md) +- [ResolveTransactionChanges](./type-aliases/ResolveTransactionChanges.md) +- [ResultStream](./type-aliases/ResultStream.md) +- [Row](./type-aliases/Row.md) +- [SingleResult](./type-aliases/SingleResult.md) +- [Source](./type-aliases/Source.md) +- [StandardSchema](./type-aliases/StandardSchema.md) +- [StandardSchemaAlias](./type-aliases/StandardSchemaAlias.md) +- [StorageApi](./type-aliases/StorageApi.md) +- [StorageEventApi](./type-aliases/StorageEventApi.md) +- [Strategy](./type-aliases/Strategy.md) +- [StrategyOptions](./type-aliases/StrategyOptions.md) +- [StringCollationConfig](./type-aliases/StringCollationConfig.md) +- [SubscriptionEvents](./type-aliases/SubscriptionEvents.md) +- [SubscriptionStatus](./type-aliases/SubscriptionStatus.md) +- [SyncConfigRes](./type-aliases/SyncConfigRes.md) +- [SyncMode](./type-aliases/SyncMode.md) +- [TransactionState](./type-aliases/TransactionState.md) +- [TransactionWithMutations](./type-aliases/TransactionWithMutations.md) +- [UnloadSubsetFn](./type-aliases/UnloadSubsetFn.md) +- [UpdateMutationFn](./type-aliases/UpdateMutationFn.md) +- [UpdateMutationFnParams](./type-aliases/UpdateMutationFnParams.md) +- [UtilsRecord](./type-aliases/UtilsRecord.md) +- [WritableDeep](./type-aliases/WritableDeep.md) ## Variables -- [IndexOperation](../variables/IndexOperation.md) -- [operators](../variables/operators.md) -- [Query](../variables/Query.md) +- [IndexOperation](./variables/IndexOperation.md) +- [operators](./variables/operators.md) +- [Query](./variables/Query.md) ## Functions -- [add](../functions/add.md) -- [and](../functions/and.md) -- [avg](../functions/avg.md) -- [coalesce](../functions/coalesce.md) -- [compileQuery](../functions/compileQuery.md) -- [concat](../functions/concat.md) -- [count](../functions/count.md) -- [createArrayChangeProxy](../functions/createArrayChangeProxy.md) -- [createChangeProxy](../functions/createChangeProxy.md) -- [createCollection](../functions/createCollection.md) -- [createLiveQueryCollection](../functions/createLiveQueryCollection.md) -- [createOptimisticAction](../functions/createOptimisticAction.md) -- [createPacedMutations](../functions/createPacedMutations.md) -- [createTransaction](../functions/createTransaction.md) -- [debounceStrategy](../functions/debounceStrategy.md) -- [deepEquals](../functions/deepEquals.md) -- [eq](../functions/eq.md) -- [extractFieldPath](../functions/extractFieldPath.md) -- [extractSimpleComparisons](../functions/extractSimpleComparisons.md) -- [extractValue](../functions/extractValue.md) -- [getActiveTransaction](../functions/getActiveTransaction.md) -- [gt](../functions/gt.md) -- [gte](../functions/gte.md) -- [ilike](../functions/ilike.md) -- [inArray](../functions/inArray.md) -- [isLimitSubset](../functions/isLimitSubset.md) -- [isNull](../functions/isNull.md) -- [isOrderBySubset](../functions/isOrderBySubset.md) -- [isPredicateSubset](../functions/isPredicateSubset.md) -- [isUndefined](../functions/isUndefined.md) -- [isWhereSubset](../functions/isWhereSubset.md) -- [length](../functions/length.md) -- [like](../functions/like.md) -- [liveQueryCollectionOptions](../functions/liveQueryCollectionOptions.md) -- [localOnlyCollectionOptions](../functions/localOnlyCollectionOptions.md) -- [localStorageCollectionOptions](../functions/localStorageCollectionOptions.md) -- [lower](../functions/lower.md) -- [lt](../functions/lt.md) -- [lte](../functions/lte.md) -- [max](../functions/max.md) -- [min](../functions/min.md) -- [minusWherePredicates](../functions/minusWherePredicates.md) -- [not](../functions/not.md) -- [or](../functions/or.md) -- [parseLoadSubsetOptions](../functions/parseLoadSubsetOptions.md) -- [parseOrderByExpression](../functions/parseOrderByExpression.md) -- [parseWhereExpression](../functions/parseWhereExpression.md) -- [queueStrategy](../functions/queueStrategy.md) -- [sum](../functions/sum.md) -- [throttleStrategy](../functions/throttleStrategy.md) -- [unionWherePredicates](../functions/unionWherePredicates.md) -- [upper](../functions/upper.md) -- [walkExpression](../functions/walkExpression.md) -- [withArrayChangeTracking](../functions/withArrayChangeTracking.md) -- [withChangeTracking](../functions/withChangeTracking.md) +- [add](./functions/add.md) +- [and](./functions/and.md) +- [avg](./functions/avg.md) +- [coalesce](./functions/coalesce.md) +- [compileQuery](./functions/compileQuery.md) +- [concat](./functions/concat.md) +- [count](./functions/count.md) +- [createArrayChangeProxy](./functions/createArrayChangeProxy.md) +- [createChangeProxy](./functions/createChangeProxy.md) +- [createCollection](./functions/createCollection.md) +- [createLiveQueryCollection](./functions/createLiveQueryCollection.md) +- [createOptimisticAction](./functions/createOptimisticAction.md) +- [createPacedMutations](./functions/createPacedMutations.md) +- [createTransaction](./functions/createTransaction.md) +- [debounceStrategy](./functions/debounceStrategy.md) +- [deepEquals](./functions/deepEquals.md) +- [eq](./functions/eq.md) +- [extractFieldPath](./functions/extractFieldPath.md) +- [extractSimpleComparisons](./functions/extractSimpleComparisons.md) +- [extractValue](./functions/extractValue.md) +- [getActiveTransaction](./functions/getActiveTransaction.md) +- [gt](./functions/gt.md) +- [gte](./functions/gte.md) +- [ilike](./functions/ilike.md) +- [inArray](./functions/inArray.md) +- [isLimitSubset](./functions/isLimitSubset.md) +- [isNull](./functions/isNull.md) +- [isOrderBySubset](./functions/isOrderBySubset.md) +- [isPredicateSubset](./functions/isPredicateSubset.md) +- [isUndefined](./functions/isUndefined.md) +- [isWhereSubset](./functions/isWhereSubset.md) +- [length](./functions/length.md) +- [like](./functions/like.md) +- [liveQueryCollectionOptions](./functions/liveQueryCollectionOptions.md) +- [localOnlyCollectionOptions](./functions/localOnlyCollectionOptions.md) +- [localStorageCollectionOptions](./functions/localStorageCollectionOptions.md) +- [lower](./functions/lower.md) +- [lt](./functions/lt.md) +- [lte](./functions/lte.md) +- [max](./functions/max.md) +- [min](./functions/min.md) +- [minusWherePredicates](./functions/minusWherePredicates.md) +- [not](./functions/not.md) +- [or](./functions/or.md) +- [parseLoadSubsetOptions](./functions/parseLoadSubsetOptions.md) +- [parseOrderByExpression](./functions/parseOrderByExpression.md) +- [parseWhereExpression](./functions/parseWhereExpression.md) +- [queueStrategy](./functions/queueStrategy.md) +- [sum](./functions/sum.md) +- [throttleStrategy](./functions/throttleStrategy.md) +- [unionWherePredicates](./functions/unionWherePredicates.md) +- [upper](./functions/upper.md) +- [walkExpression](./functions/walkExpression.md) +- [withArrayChangeTracking](./functions/withArrayChangeTracking.md) +- [withChangeTracking](./functions/withChangeTracking.md) diff --git a/docs/reference/interfaces/BaseCollectionConfig.md b/docs/reference/interfaces/BaseCollectionConfig.md index df59ed52a..ff3e0d26a 100644 --- a/docs/reference/interfaces/BaseCollectionConfig.md +++ b/docs/reference/interfaces/BaseCollectionConfig.md @@ -9,8 +9,8 @@ Defined in: [packages/db/src/types.ts:438](https://github.com/TanStack/db/blob/m ## Extended by -- [`CollectionConfig`](../CollectionConfig.md) -- [`LocalStorageCollectionConfig`](../LocalStorageCollectionConfig.md) +- [`CollectionConfig`](./CollectionConfig.md) +- [`LocalStorageCollectionConfig`](./LocalStorageCollectionConfig.md) ## Type Parameters @@ -28,7 +28,7 @@ Defined in: [packages/db/src/types.ts:438](https://github.com/TanStack/db/blob/m ### TUtils -`TUtils` *extends* [`UtilsRecord`](../../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../../type-aliases/UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../type-aliases/UtilsRecord.md) ### TReturn diff --git a/docs/reference/interfaces/BaseStrategy.md b/docs/reference/interfaces/BaseStrategy.md index fdfb8354c..74a111788 100644 --- a/docs/reference/interfaces/BaseStrategy.md +++ b/docs/reference/interfaces/BaseStrategy.md @@ -11,9 +11,9 @@ Base strategy interface that all strategy implementations must conform to ## Extended by -- [`DebounceStrategy`](../DebounceStrategy.md) -- [`QueueStrategy`](../QueueStrategy.md) -- [`ThrottleStrategy`](../ThrottleStrategy.md) +- [`DebounceStrategy`](./DebounceStrategy.md) +- [`QueueStrategy`](./QueueStrategy.md) +- [`ThrottleStrategy`](./ThrottleStrategy.md) ## Type Parameters @@ -72,7 +72,7 @@ Execute a function according to the strategy's timing rules ##### fn -() => [`Transaction`](../Transaction.md)\<`T`\> +() => [`Transaction`](./Transaction.md)\<`T`\> The function to execute diff --git a/docs/reference/interfaces/ChangeMessage.md b/docs/reference/interfaces/ChangeMessage.md index d8b61bf5c..fc18e33a1 100644 --- a/docs/reference/interfaces/ChangeMessage.md +++ b/docs/reference/interfaces/ChangeMessage.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/types.ts:314](https://github.com/TanStack/db/blob/m ## Extended by -- [`OptimisticChangeMessage`](../OptimisticChangeMessage.md) +- [`OptimisticChangeMessage`](./OptimisticChangeMessage.md) ## Type Parameters diff --git a/docs/reference/interfaces/Collection.md b/docs/reference/interfaces/Collection.md index 9b57df6ba..9cebcdecf 100644 --- a/docs/reference/interfaces/Collection.md +++ b/docs/reference/interfaces/Collection.md @@ -11,7 +11,7 @@ Enhanced Collection interface that includes both data type T and utilities TUtil ## Extends -- [`CollectionImpl`](../../classes/CollectionImpl.md)\<`T`, `TKey`, `TUtils`, `TSchema`, `TInsertInput`\> +- [`CollectionImpl`](../classes/CollectionImpl.md)\<`T`, `TKey`, `TUtils`, `TSchema`, `TInsertInput`\> ## Type Parameters @@ -29,7 +29,7 @@ The type of the key for the collection ### TUtils -`TUtils` *extends* [`UtilsRecord`](../../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../../type-aliases/UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../type-aliases/UtilsRecord.md) The utilities record type @@ -55,7 +55,7 @@ Defined in: [packages/db/src/collection/index.ts:283](https://github.com/TanStac #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`_lifecycle`](../../classes/CollectionImpl.md#_lifecycle) +[`CollectionImpl`](../classes/CollectionImpl.md).[`_lifecycle`](../classes/CollectionImpl.md#_lifecycle) *** @@ -69,7 +69,7 @@ Defined in: [packages/db/src/collection/index.ts:295](https://github.com/TanStac #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`_state`](../../classes/CollectionImpl.md#_state) +[`CollectionImpl`](../classes/CollectionImpl.md).[`_state`](../classes/CollectionImpl.md#_state) *** @@ -83,7 +83,7 @@ Defined in: [packages/db/src/collection/index.ts:284](https://github.com/TanStac #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`_sync`](../../classes/CollectionImpl.md#_sync) +[`CollectionImpl`](../classes/CollectionImpl.md).[`_sync`](../classes/CollectionImpl.md#_sync) *** @@ -97,7 +97,7 @@ Defined in: [packages/db/src/collection/index.ts:274](https://github.com/TanStac #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`config`](../../classes/CollectionImpl.md#config) +[`CollectionImpl`](../classes/CollectionImpl.md).[`config`](../classes/CollectionImpl.md#config) *** @@ -111,7 +111,7 @@ Defined in: [packages/db/src/collection/index.ts:273](https://github.com/TanStac #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`id`](../../classes/CollectionImpl.md#id) +[`CollectionImpl`](../classes/CollectionImpl.md).[`id`](../classes/CollectionImpl.md#id) *** @@ -135,7 +135,7 @@ Defined in: [packages/db/src/collection/index.ts:55](https://github.com/TanStack #### Overrides -[`CollectionImpl`](../../classes/CollectionImpl.md).[`utils`](../../classes/CollectionImpl.md#utils) +[`CollectionImpl`](../classes/CollectionImpl.md).[`utils`](../classes/CollectionImpl.md#utils) ## Accessors @@ -151,11 +151,11 @@ Defined in: [packages/db/src/collection/index.ts:579](https://github.com/TanStac ##### Returns -[`StringCollationConfig`](../../type-aliases/StringCollationConfig.md) +[`StringCollationConfig`](../type-aliases/StringCollationConfig.md) #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`compareOptions`](../../classes/CollectionImpl.md#compareoptions) +[`CollectionImpl`](../classes/CollectionImpl.md).[`compareOptions`](../classes/CollectionImpl.md#compareoptions) *** @@ -173,11 +173,11 @@ Get resolved indexes for query optimization ##### Returns -`Map`\<`number`, [`BaseIndex`](../../classes/BaseIndex.md)\<`TKey`\>\> +`Map`\<`number`, [`BaseIndex`](../classes/BaseIndex.md)\<`TKey`\>\> #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`indexes`](../../classes/CollectionImpl.md#indexes) +[`CollectionImpl`](../classes/CollectionImpl.md).[`indexes`](../classes/CollectionImpl.md#indexes) *** @@ -201,7 +201,7 @@ true if the collection has pending load more operations, false otherwise #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`isLoadingSubset`](../../classes/CollectionImpl.md#isloadingsubset) +[`CollectionImpl`](../classes/CollectionImpl.md).[`isLoadingSubset`](../classes/CollectionImpl.md#isloadingsubset) *** @@ -223,7 +223,7 @@ Get the current size of the collection (cached) #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`size`](../../classes/CollectionImpl.md#size) +[`CollectionImpl`](../classes/CollectionImpl.md).[`size`](../classes/CollectionImpl.md#size) *** @@ -263,7 +263,7 @@ Map containing all items in the collection, with keys as identifiers #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`state`](../../classes/CollectionImpl.md#state) +[`CollectionImpl`](../classes/CollectionImpl.md).[`state`](../classes/CollectionImpl.md#state) *** @@ -281,11 +281,11 @@ Gets the current status of the collection ##### Returns -[`CollectionStatus`](../../type-aliases/CollectionStatus.md) +[`CollectionStatus`](../type-aliases/CollectionStatus.md) #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`status`](../../classes/CollectionImpl.md#status) +[`CollectionImpl`](../classes/CollectionImpl.md).[`status`](../classes/CollectionImpl.md#status) *** @@ -307,7 +307,7 @@ Get the number of subscribers to the collection #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`subscriberCount`](../../classes/CollectionImpl.md#subscribercount) +[`CollectionImpl`](../classes/CollectionImpl.md).[`subscriberCount`](../classes/CollectionImpl.md#subscribercount) *** @@ -331,7 +331,7 @@ An Array containing all items in the collection #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`toArray`](../../classes/CollectionImpl.md#toarray) +[`CollectionImpl`](../classes/CollectionImpl.md).[`toArray`](../classes/CollectionImpl.md#toarray) ## Methods @@ -351,7 +351,7 @@ Get all entries (virtual derived state) #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`[iterator]`](../../classes/CollectionImpl.md#iterator) +[`CollectionImpl`](../classes/CollectionImpl.md).[`[iterator]`](../classes/CollectionImpl.md#iterator) *** @@ -372,7 +372,7 @@ This can be called manually or automatically by garbage collection #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`cleanup`](../../classes/CollectionImpl.md#cleanup) +[`CollectionImpl`](../classes/CollectionImpl.md).[`cleanup`](../classes/CollectionImpl.md#cleanup) *** @@ -392,7 +392,7 @@ and logarithmic time range queries instead of full scans. ##### TResolver -`TResolver` *extends* [`IndexResolver`](../../type-aliases/IndexResolver.md)\<`TKey`\> = *typeof* [`BTreeIndex`](../../classes/BTreeIndex.md) +`TResolver` *extends* [`IndexResolver`](../type-aliases/IndexResolver.md)\<`TKey`\> = *typeof* [`BTreeIndex`](../classes/BTreeIndex.md) The type of the index resolver (constructor or async loader) @@ -406,13 +406,13 @@ Function that extracts the indexed value from each item ##### config -[`IndexOptions`](../IndexOptions.md)\<`TResolver`\> = `{}` +[`IndexOptions`](./IndexOptions.md)\<`TResolver`\> = `{}` Configuration including index type and type-specific options #### Returns -[`IndexProxy`](../../classes/IndexProxy.md)\<`TKey`\> +[`IndexProxy`](../classes/IndexProxy.md)\<`TKey`\> An index proxy that provides access to the index when ready @@ -444,7 +444,7 @@ const textIndex = collection.createIndex((row) => row.content, { #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`createIndex`](../../classes/CollectionImpl.md#createindex) +[`CollectionImpl`](../classes/CollectionImpl.md).[`createIndex`](../classes/CollectionImpl.md#createindex) *** @@ -464,14 +464,14 @@ Returns the current state of the collection as an array of changes ##### options -[`CurrentStateAsChangesOptions`](../CurrentStateAsChangesOptions.md) = `{}` +[`CurrentStateAsChangesOptions`](./CurrentStateAsChangesOptions.md) = `{}` Options including optional where filter #### Returns \| `void` - \| [`ChangeMessage`](../ChangeMessage.md)\<`T`, `string` \| `number`\>[] + \| [`ChangeMessage`](./ChangeMessage.md)\<`T`, `string` \| `number`\>[] An array of changes @@ -494,7 +494,7 @@ const activeChanges = collection.currentStateAsChanges({ #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`currentStateAsChanges`](../../classes/CollectionImpl.md#currentstateaschanges) +[`CollectionImpl`](../classes/CollectionImpl.md).[`currentStateAsChanges`](../classes/CollectionImpl.md#currentstateaschanges) *** @@ -518,13 +518,13 @@ Single key or array of keys to delete ##### config? -[`OperationConfig`](../OperationConfig.md) +[`OperationConfig`](./OperationConfig.md) Optional configuration including metadata #### Returns -[`Transaction`](../Transaction.md)\<`any`\> +[`Transaction`](./Transaction.md)\<`any`\> A Transaction object representing the delete operation(s) @@ -561,7 +561,7 @@ try { #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`delete`](../../classes/CollectionImpl.md#delete) +[`CollectionImpl`](../classes/CollectionImpl.md).[`delete`](../classes/CollectionImpl.md#delete) *** @@ -581,7 +581,7 @@ Get all entries (virtual derived state) #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`entries`](../../classes/CollectionImpl.md#entries) +[`CollectionImpl`](../classes/CollectionImpl.md).[`entries`](../classes/CollectionImpl.md#entries) *** @@ -607,7 +607,7 @@ Execute a callback for each entry in the collection #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`forEach`](../../classes/CollectionImpl.md#foreach) +[`CollectionImpl`](../classes/CollectionImpl.md).[`forEach`](../classes/CollectionImpl.md#foreach) *** @@ -633,7 +633,7 @@ Get the current value for a key (virtual derived state) #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`get`](../../classes/CollectionImpl.md#get) +[`CollectionImpl`](../classes/CollectionImpl.md).[`get`](../classes/CollectionImpl.md#get) *** @@ -657,7 +657,7 @@ Defined in: [packages/db/src/collection/index.ts:517](https://github.com/TanStac #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`getKeyFromItem`](../../classes/CollectionImpl.md#getkeyfromitem) +[`CollectionImpl`](../classes/CollectionImpl.md).[`getKeyFromItem`](../classes/CollectionImpl.md#getkeyfromitem) *** @@ -683,7 +683,7 @@ Check if a key exists in the collection (virtual derived state) #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`has`](../../classes/CollectionImpl.md#has) +[`CollectionImpl`](../classes/CollectionImpl.md).[`has`](../classes/CollectionImpl.md#has) *** @@ -707,14 +707,14 @@ Inserts one or more items into the collection ##### config? -[`InsertConfig`](../InsertConfig.md) +[`InsertConfig`](./InsertConfig.md) Optional configuration including metadata #### Returns - \| [`Transaction`](../Transaction.md)\<`Record`\<`string`, `unknown`\>\> - \| [`Transaction`](../Transaction.md)\<`T`\> + \| [`Transaction`](./Transaction.md)\<`Record`\<`string`, `unknown`\>\> + \| [`Transaction`](./Transaction.md)\<`T`\> A Transaction object representing the insert operation(s) @@ -760,7 +760,7 @@ try { #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`insert`](../../classes/CollectionImpl.md#insert) +[`CollectionImpl`](../classes/CollectionImpl.md).[`insert`](../classes/CollectionImpl.md#insert) *** @@ -794,7 +794,7 @@ if (collection.isReady()) { #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`isReady`](../../classes/CollectionImpl.md#isready) +[`CollectionImpl`](../classes/CollectionImpl.md).[`isReady`](../classes/CollectionImpl.md#isready) *** @@ -814,7 +814,7 @@ Get all keys (virtual derived state) #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`keys`](../../classes/CollectionImpl.md#keys) +[`CollectionImpl`](../classes/CollectionImpl.md).[`keys`](../classes/CollectionImpl.md#keys) *** @@ -846,7 +846,7 @@ Create a new array with the results of calling a function for each entry in the #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`map`](../../classes/CollectionImpl.md#map) +[`CollectionImpl`](../classes/CollectionImpl.md).[`map`](../classes/CollectionImpl.md#map) *** @@ -890,7 +890,7 @@ Unsubscribe from a collection event #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`off`](../../classes/CollectionImpl.md#off) +[`CollectionImpl`](../classes/CollectionImpl.md).[`off`](../classes/CollectionImpl.md#off) *** @@ -940,7 +940,7 @@ Subscribe to a collection event #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`on`](../../classes/CollectionImpl.md#on) +[`CollectionImpl`](../classes/CollectionImpl.md).[`on`](../classes/CollectionImpl.md#on) *** @@ -990,7 +990,7 @@ Subscribe to a collection event once #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`once`](../../classes/CollectionImpl.md#once) +[`CollectionImpl`](../classes/CollectionImpl.md).[`once`](../classes/CollectionImpl.md#once) *** @@ -1028,7 +1028,7 @@ collection.onFirstReady(() => { #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`onFirstReady`](../../classes/CollectionImpl.md#onfirstready) +[`CollectionImpl`](../classes/CollectionImpl.md).[`onFirstReady`](../classes/CollectionImpl.md#onfirstready) *** @@ -1049,7 +1049,7 @@ Multiple concurrent calls will share the same promise #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`preload`](../../classes/CollectionImpl.md#preload) +[`CollectionImpl`](../classes/CollectionImpl.md).[`preload`](../classes/CollectionImpl.md#preload) *** @@ -1070,7 +1070,7 @@ This bypasses lazy loading for special cases like live query results #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`startSyncImmediate`](../../classes/CollectionImpl.md#startsyncimmediate) +[`CollectionImpl`](../classes/CollectionImpl.md).[`startSyncImmediate`](../classes/CollectionImpl.md#startsyncimmediate) *** @@ -1093,7 +1093,7 @@ Promise that resolves to a Map containing all items in the collection #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`stateWhenReady`](../../classes/CollectionImpl.md#statewhenready) +[`CollectionImpl`](../classes/CollectionImpl.md).[`stateWhenReady`](../classes/CollectionImpl.md#statewhenready) *** @@ -1117,7 +1117,7 @@ Function called when items change ##### options -[`SubscribeChangesOptions`](../SubscribeChangesOptions.md) = `{}` +[`SubscribeChangesOptions`](./SubscribeChangesOptions.md) = `{}` Subscription options including includeInitialState and where filter @@ -1169,7 +1169,7 @@ const subscription = collection.subscribeChanges((changes) => { #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`subscribeChanges`](../../classes/CollectionImpl.md#subscribechanges) +[`CollectionImpl`](../classes/CollectionImpl.md).[`subscribeChanges`](../classes/CollectionImpl.md#subscribechanges) *** @@ -1192,7 +1192,7 @@ Promise that resolves to an Array containing all items in the collection #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`toArrayWhenReady`](../../classes/CollectionImpl.md#toarraywhenready) +[`CollectionImpl`](../classes/CollectionImpl.md).[`toArrayWhenReady`](../classes/CollectionImpl.md#toarraywhenready) *** @@ -1220,7 +1220,7 @@ Updates one or more items in the collection using a callback function ##### Returns -[`Transaction`](../Transaction.md) +[`Transaction`](./Transaction.md) A Transaction object representing the update operation(s) @@ -1268,7 +1268,7 @@ try { ##### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`update`](../../classes/CollectionImpl.md#update) +[`CollectionImpl`](../classes/CollectionImpl.md).[`update`](../classes/CollectionImpl.md#update) #### Call Signature @@ -1293,7 +1293,7 @@ Single key or array of keys to update ###### config -[`OperationConfig`](../OperationConfig.md) +[`OperationConfig`](./OperationConfig.md) ###### callback @@ -1301,7 +1301,7 @@ Single key or array of keys to update ##### Returns -[`Transaction`](../Transaction.md) +[`Transaction`](./Transaction.md) A Transaction object representing the update operation(s) @@ -1349,7 +1349,7 @@ try { ##### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`update`](../../classes/CollectionImpl.md#update) +[`CollectionImpl`](../classes/CollectionImpl.md).[`update`](../classes/CollectionImpl.md#update) #### Call Signature @@ -1373,7 +1373,7 @@ Updates one or more items in the collection using a callback function ##### Returns -[`Transaction`](../Transaction.md) +[`Transaction`](./Transaction.md) A Transaction object representing the update operation(s) @@ -1421,7 +1421,7 @@ try { ##### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`update`](../../classes/CollectionImpl.md#update) +[`CollectionImpl`](../classes/CollectionImpl.md).[`update`](../classes/CollectionImpl.md#update) #### Call Signature @@ -1444,7 +1444,7 @@ Updates one or more items in the collection using a callback function ###### config -[`OperationConfig`](../OperationConfig.md) +[`OperationConfig`](./OperationConfig.md) ###### callback @@ -1452,7 +1452,7 @@ Updates one or more items in the collection using a callback function ##### Returns -[`Transaction`](../Transaction.md) +[`Transaction`](./Transaction.md) A Transaction object representing the update operation(s) @@ -1500,7 +1500,7 @@ try { ##### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`update`](../../classes/CollectionImpl.md#update) +[`CollectionImpl`](../classes/CollectionImpl.md).[`update`](../classes/CollectionImpl.md#update) *** @@ -1537,7 +1537,7 @@ Validates the data against the schema #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`validateData`](../../classes/CollectionImpl.md#validatedata) +[`CollectionImpl`](../classes/CollectionImpl.md).[`validateData`](../classes/CollectionImpl.md#validatedata) *** @@ -1557,7 +1557,7 @@ Get all values (virtual derived state) #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`values`](../../classes/CollectionImpl.md#values) +[`CollectionImpl`](../classes/CollectionImpl.md).[`values`](../classes/CollectionImpl.md#values) *** @@ -1601,4 +1601,4 @@ Wait for a collection event #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`waitFor`](../../classes/CollectionImpl.md#waitfor) +[`CollectionImpl`](../classes/CollectionImpl.md).[`waitFor`](../classes/CollectionImpl.md#waitfor) diff --git a/docs/reference/interfaces/CollectionConfig.md b/docs/reference/interfaces/CollectionConfig.md index e3ce87cd6..6bb4f4199 100644 --- a/docs/reference/interfaces/CollectionConfig.md +++ b/docs/reference/interfaces/CollectionConfig.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/types.ts:649](https://github.com/TanStack/db/blob/m ## Extends -- [`BaseCollectionConfig`](../BaseCollectionConfig.md)\<`T`, `TKey`, `TSchema`, `TUtils`\> +- [`BaseCollectionConfig`](./BaseCollectionConfig.md)\<`T`, `TKey`, `TSchema`, `TUtils`\> ## Type Parameters @@ -27,7 +27,7 @@ Defined in: [packages/db/src/types.ts:649](https://github.com/TanStack/db/blob/m ### TUtils -`TUtils` *extends* [`UtilsRecord`](../../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../../type-aliases/UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../type-aliases/UtilsRecord.md) ## Properties @@ -55,7 +55,7 @@ When enabled, indexes will be automatically created for simple where expressions #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`autoIndex`](../BaseCollectionConfig.md#autoindex) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`autoIndex`](./BaseCollectionConfig.md#autoindex) *** @@ -99,7 +99,7 @@ compare: (x, y) => x.createdAt.getTime() - y.createdAt.getTime() #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`compare`](../BaseCollectionConfig.md#compare) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`compare`](./BaseCollectionConfig.md#compare) *** @@ -118,7 +118,7 @@ E.g., when using the Electric DB collection these options #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`defaultStringCollation`](../BaseCollectionConfig.md#defaultstringcollation) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`defaultStringCollation`](./BaseCollectionConfig.md#defaultstringcollation) *** @@ -135,7 +135,7 @@ when it has no active subscribers. Defaults to 5 minutes (300000ms). #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`gcTime`](../BaseCollectionConfig.md#gctime) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`gcTime`](./BaseCollectionConfig.md#gctime) *** @@ -173,7 +173,7 @@ getKey: (item) => item.uuid #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`getKey`](../BaseCollectionConfig.md#getkey) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`getKey`](./BaseCollectionConfig.md#getkey) *** @@ -187,7 +187,7 @@ Defined in: [packages/db/src/types.ts:451](https://github.com/TanStack/db/blob/m #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`id`](../BaseCollectionConfig.md#id) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`id`](./BaseCollectionConfig.md#id) *** @@ -255,7 +255,7 @@ onDelete: async ({ transaction, collection }) => { #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`onDelete`](../BaseCollectionConfig.md#ondelete) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`onDelete`](./BaseCollectionConfig.md#ondelete) *** @@ -322,7 +322,7 @@ onInsert: async ({ transaction, collection }) => { #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`onInsert`](../BaseCollectionConfig.md#oninsert) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`onInsert`](./BaseCollectionConfig.md#oninsert) *** @@ -390,7 +390,7 @@ onUpdate: async ({ transaction, collection }) => { #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`onUpdate`](../BaseCollectionConfig.md#onupdate) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`onUpdate`](./BaseCollectionConfig.md#onupdate) *** @@ -404,7 +404,7 @@ Defined in: [packages/db/src/types.ts:452](https://github.com/TanStack/db/blob/m #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`schema`](../BaseCollectionConfig.md#schema) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`schema`](./BaseCollectionConfig.md#schema) *** @@ -431,7 +431,7 @@ false #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`startSync`](../BaseCollectionConfig.md#startsync) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`startSync`](./BaseCollectionConfig.md#startsync) *** @@ -467,7 +467,7 @@ The exact implementation of the sync mode is up to the sync implementation. #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`syncMode`](../BaseCollectionConfig.md#syncmode) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`syncMode`](./BaseCollectionConfig.md#syncmode) *** @@ -481,4 +481,4 @@ Defined in: [packages/db/src/types.ts:646](https://github.com/TanStack/db/blob/m #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`utils`](../BaseCollectionConfig.md#utils) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`utils`](./BaseCollectionConfig.md#utils) diff --git a/docs/reference/interfaces/CollectionLike.md b/docs/reference/interfaces/CollectionLike.md index 05679c1ad..eba548443 100644 --- a/docs/reference/interfaces/CollectionLike.md +++ b/docs/reference/interfaces/CollectionLike.md @@ -12,7 +12,7 @@ for the change events system to work ## Extends -- `Pick`\<[`Collection`](../Collection.md)\<`T`, `TKey`\>, `"get"` \| `"has"` \| `"entries"` \| `"indexes"` \| `"id"` \| `"compareOptions"`\> +- `Pick`\<[`Collection`](./Collection.md)\<`T`, `TKey`\>, `"get"` \| `"has"` \| `"entries"` \| `"indexes"` \| `"id"` \| `"compareOptions"`\> ## Type Parameters @@ -36,7 +36,7 @@ Defined in: [packages/db/src/collection/index.ts:579](https://github.com/TanStac #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`compareOptions`](../../classes/CollectionImpl.md#compareoptions) +[`CollectionImpl`](../classes/CollectionImpl.md).[`compareOptions`](../classes/CollectionImpl.md#compareoptions) *** @@ -50,7 +50,7 @@ Defined in: [packages/db/src/collection/index.ts:273](https://github.com/TanStac #### Inherited from -[`CollectionImpl`](../../classes/CollectionImpl.md).[`id`](../../classes/CollectionImpl.md#id) +[`CollectionImpl`](../classes/CollectionImpl.md).[`id`](../classes/CollectionImpl.md#id) *** diff --git a/docs/reference/interfaces/CreateOptimisticActionsOptions.md b/docs/reference/interfaces/CreateOptimisticActionsOptions.md index 166e135dc..b8c99b1ad 100644 --- a/docs/reference/interfaces/CreateOptimisticActionsOptions.md +++ b/docs/reference/interfaces/CreateOptimisticActionsOptions.md @@ -11,7 +11,7 @@ Options for the createOptimisticAction helper ## Extends -- `Omit`\<[`TransactionConfig`](../TransactionConfig.md)\<`T`\>, `"mutationFn"`\> +- `Omit`\<[`TransactionConfig`](./TransactionConfig.md)\<`T`\>, `"mutationFn"`\> ## Type Parameters @@ -35,7 +35,7 @@ Defined in: [packages/db/src/types.ts:169](https://github.com/TanStack/db/blob/m #### Inherited from -[`TransactionConfig`](../TransactionConfig.md).[`autoCommit`](../TransactionConfig.md#autocommit) +[`TransactionConfig`](./TransactionConfig.md).[`autoCommit`](./TransactionConfig.md#autocommit) *** @@ -93,7 +93,7 @@ Function to execute the mutation on the server ##### params -[`MutationFnParams`](../../type-aliases/MutationFnParams.md)\<`T`\> +[`MutationFnParams`](../type-aliases/MutationFnParams.md)\<`T`\> #### Returns diff --git a/docs/reference/interfaces/DebounceStrategy.md b/docs/reference/interfaces/DebounceStrategy.md index f0418edc7..6e659bc0e 100644 --- a/docs/reference/interfaces/DebounceStrategy.md +++ b/docs/reference/interfaces/DebounceStrategy.md @@ -11,7 +11,7 @@ Debounce strategy that delays execution until activity stops ## Extends -- [`BaseStrategy`](../BaseStrategy.md)\<`"debounce"`\> +- [`BaseStrategy`](./BaseStrategy.md)\<`"debounce"`\> ## Properties @@ -27,7 +27,7 @@ Type discriminator for strategy identification #### Inherited from -[`BaseStrategy`](../BaseStrategy.md).[`_type`](../BaseStrategy.md#_type) +[`BaseStrategy`](./BaseStrategy.md).[`_type`](./BaseStrategy.md#_type) *** @@ -48,7 +48,7 @@ Should be called when the strategy is no longer needed #### Inherited from -[`BaseStrategy`](../BaseStrategy.md).[`cleanup`](../BaseStrategy.md#cleanup) +[`BaseStrategy`](./BaseStrategy.md).[`cleanup`](./BaseStrategy.md#cleanup) *** @@ -72,7 +72,7 @@ Execute a function according to the strategy's timing rules ##### fn -() => [`Transaction`](../Transaction.md)\<`T`\> +() => [`Transaction`](./Transaction.md)\<`T`\> The function to execute @@ -84,7 +84,7 @@ The result of the function execution (if applicable) #### Inherited from -[`BaseStrategy`](../BaseStrategy.md).[`execute`](../BaseStrategy.md#execute) +[`BaseStrategy`](./BaseStrategy.md).[`execute`](./BaseStrategy.md#execute) *** diff --git a/docs/reference/interfaces/IndexInterface.md b/docs/reference/interfaces/IndexInterface.md index ebb33b416..5a495613f 100644 --- a/docs/reference/interfaces/IndexInterface.md +++ b/docs/reference/interfaces/IndexInterface.md @@ -103,7 +103,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:70](https://github.com/TanSta #### Returns -[`IndexStats`](../IndexStats.md) +[`IndexStats`](./IndexStats.md) *** @@ -183,7 +183,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:68](https://github.com/TanSta ##### direction -[`OrderByDirection`](../../@tanstack/namespaces/IR/type-aliases/OrderByDirection.md) +[`OrderByDirection`](../@tanstack/namespaces/IR/type-aliases/OrderByDirection.md) #### Returns @@ -223,7 +223,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:43](https://github.com/TanSta ##### options -[`RangeQueryOptions`](../RangeQueryOptions.md) +[`RangeQueryOptions`](./RangeQueryOptions.md) #### Returns @@ -243,7 +243,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:44](https://github.com/TanSta ##### options -[`RangeQueryOptions`](../RangeQueryOptions.md) +[`RangeQueryOptions`](./RangeQueryOptions.md) #### Returns diff --git a/docs/reference/interfaces/IndexOptions.md b/docs/reference/interfaces/IndexOptions.md index 8a99a578a..3ca169871 100644 --- a/docs/reference/interfaces/IndexOptions.md +++ b/docs/reference/interfaces/IndexOptions.md @@ -13,7 +13,7 @@ Enhanced index options that support both sync and async resolvers ### TResolver -`TResolver` *extends* [`IndexResolver`](../../type-aliases/IndexResolver.md) = [`IndexResolver`](../../type-aliases/IndexResolver.md) +`TResolver` *extends* [`IndexResolver`](../type-aliases/IndexResolver.md) = [`IndexResolver`](../type-aliases/IndexResolver.md) ## Properties diff --git a/docs/reference/interfaces/LiveQueryCollectionConfig.md b/docs/reference/interfaces/LiveQueryCollectionConfig.md index 1c3a8ed77..d17f76708 100644 --- a/docs/reference/interfaces/LiveQueryCollectionConfig.md +++ b/docs/reference/interfaces/LiveQueryCollectionConfig.md @@ -35,11 +35,11 @@ const config: LiveQueryCollectionConfig = { ### TContext -`TContext` *extends* [`Context`](../Context.md) +`TContext` *extends* [`Context`](./Context.md) ### TResult -`TResult` *extends* `object` = [`GetResult`](../../type-aliases/GetResult.md)\<`TContext`\> & `object` +`TResult` *extends* `object` = [`GetResult`](../type-aliases/GetResult.md)\<`TContext`\> & `object` ## Properties diff --git a/docs/reference/interfaces/LocalOnlyCollectionConfig.md b/docs/reference/interfaces/LocalOnlyCollectionConfig.md index 5174a1e32..4cbeb05d6 100644 --- a/docs/reference/interfaces/LocalOnlyCollectionConfig.md +++ b/docs/reference/interfaces/LocalOnlyCollectionConfig.md @@ -11,7 +11,7 @@ Configuration interface for Local-only collection options ## Extends -- `Omit`\<[`BaseCollectionConfig`](../BaseCollectionConfig.md)\<`T`, `TKey`, `TSchema`, [`LocalOnlyCollectionUtils`](../LocalOnlyCollectionUtils.md)\>, `"gcTime"` \| `"startSync"`\> +- `Omit`\<[`BaseCollectionConfig`](./BaseCollectionConfig.md)\<`T`, `TKey`, `TSchema`, [`LocalOnlyCollectionUtils`](./LocalOnlyCollectionUtils.md)\>, `"gcTime"` \| `"startSync"`\> ## Type Parameters @@ -59,7 +59,7 @@ When enabled, indexes will be automatically created for simple where expressions #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`autoIndex`](../BaseCollectionConfig.md#autoindex) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`autoIndex`](./BaseCollectionConfig.md#autoindex) *** @@ -180,7 +180,7 @@ Defined in: [packages/db/src/types.ts:451](https://github.com/TanStack/db/blob/m #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`id`](../BaseCollectionConfig.md#id) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`id`](./BaseCollectionConfig.md#id) *** @@ -444,7 +444,7 @@ The exact implementation of the sync mode is up to the sync implementation. #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`syncMode`](../BaseCollectionConfig.md#syncmode) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`syncMode`](./BaseCollectionConfig.md#syncmode) *** diff --git a/docs/reference/interfaces/LocalOnlyCollectionUtils.md b/docs/reference/interfaces/LocalOnlyCollectionUtils.md index 75d3e41ce..c0f03283d 100644 --- a/docs/reference/interfaces/LocalOnlyCollectionUtils.md +++ b/docs/reference/interfaces/LocalOnlyCollectionUtils.md @@ -11,7 +11,7 @@ Local-only collection utilities type ## Extends -- [`UtilsRecord`](../../type-aliases/UtilsRecord.md) +- [`UtilsRecord`](../type-aliases/UtilsRecord.md) ## Indexable @@ -40,7 +40,7 @@ The transaction containing mutations to accept ###### mutations -[`PendingMutation`](../PendingMutation.md)\<`Record`\<`string`, `unknown`\>, [`OperationType`](../../type-aliases/OperationType.md), [`Collection`](../Collection.md)\<`Record`\<`string`, `unknown`\>, `any`, `any`, `any`, `any`\>\>[] +[`PendingMutation`](./PendingMutation.md)\<`Record`\<`string`, `unknown`\>, [`OperationType`](../type-aliases/OperationType.md), [`Collection`](./Collection.md)\<`Record`\<`string`, `unknown`\>, `any`, `any`, `any`, `any`\>\>[] #### Returns diff --git a/docs/reference/interfaces/LocalStorageCollectionConfig.md b/docs/reference/interfaces/LocalStorageCollectionConfig.md index 358d4e72f..1d9641c76 100644 --- a/docs/reference/interfaces/LocalStorageCollectionConfig.md +++ b/docs/reference/interfaces/LocalStorageCollectionConfig.md @@ -11,7 +11,7 @@ Configuration interface for localStorage collection options ## Extends -- [`BaseCollectionConfig`](../BaseCollectionConfig.md)\<`T`, `TKey`, `TSchema`\> +- [`BaseCollectionConfig`](./BaseCollectionConfig.md)\<`T`, `TKey`, `TSchema`\> ## Type Parameters @@ -59,7 +59,7 @@ When enabled, indexes will be automatically created for simple where expressions #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`autoIndex`](../BaseCollectionConfig.md#autoindex) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`autoIndex`](./BaseCollectionConfig.md#autoindex) *** @@ -103,7 +103,7 @@ compare: (x, y) => x.createdAt.getTime() - y.createdAt.getTime() #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`compare`](../BaseCollectionConfig.md#compare) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`compare`](./BaseCollectionConfig.md#compare) *** @@ -122,7 +122,7 @@ E.g., when using the Electric DB collection these options #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`defaultStringCollation`](../BaseCollectionConfig.md#defaultstringcollation) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`defaultStringCollation`](./BaseCollectionConfig.md#defaultstringcollation) *** @@ -139,7 +139,7 @@ when it has no active subscribers. Defaults to 5 minutes (300000ms). #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`gcTime`](../BaseCollectionConfig.md#gctime) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`gcTime`](./BaseCollectionConfig.md#gctime) *** @@ -177,7 +177,7 @@ getKey: (item) => item.uuid #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`getKey`](../BaseCollectionConfig.md#getkey) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`getKey`](./BaseCollectionConfig.md#getkey) *** @@ -191,7 +191,7 @@ Defined in: [packages/db/src/types.ts:451](https://github.com/TanStack/db/blob/m #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`id`](../BaseCollectionConfig.md#id) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`id`](./BaseCollectionConfig.md#id) *** @@ -259,7 +259,7 @@ onDelete: async ({ transaction, collection }) => { #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`onDelete`](../BaseCollectionConfig.md#ondelete) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`onDelete`](./BaseCollectionConfig.md#ondelete) *** @@ -326,7 +326,7 @@ onInsert: async ({ transaction, collection }) => { #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`onInsert`](../BaseCollectionConfig.md#oninsert) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`onInsert`](./BaseCollectionConfig.md#oninsert) *** @@ -394,7 +394,7 @@ onUpdate: async ({ transaction, collection }) => { #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`onUpdate`](../BaseCollectionConfig.md#onupdate) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`onUpdate`](./BaseCollectionConfig.md#onupdate) *** @@ -421,7 +421,7 @@ Defined in: [packages/db/src/types.ts:452](https://github.com/TanStack/db/blob/m #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`schema`](../BaseCollectionConfig.md#schema) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`schema`](./BaseCollectionConfig.md#schema) *** @@ -448,7 +448,7 @@ false #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`startSync`](../BaseCollectionConfig.md#startsync) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`startSync`](./BaseCollectionConfig.md#startsync) *** @@ -512,7 +512,7 @@ The exact implementation of the sync mode is up to the sync implementation. #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`syncMode`](../BaseCollectionConfig.md#syncmode) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`syncMode`](./BaseCollectionConfig.md#syncmode) *** @@ -526,4 +526,4 @@ Defined in: [packages/db/src/types.ts:646](https://github.com/TanStack/db/blob/m #### Inherited from -[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`utils`](../BaseCollectionConfig.md#utils) +[`BaseCollectionConfig`](./BaseCollectionConfig.md).[`utils`](./BaseCollectionConfig.md#utils) diff --git a/docs/reference/interfaces/LocalStorageCollectionUtils.md b/docs/reference/interfaces/LocalStorageCollectionUtils.md index 9b35e540d..74ca57c06 100644 --- a/docs/reference/interfaces/LocalStorageCollectionUtils.md +++ b/docs/reference/interfaces/LocalStorageCollectionUtils.md @@ -11,7 +11,7 @@ LocalStorage collection utilities type ## Extends -- [`UtilsRecord`](../../type-aliases/UtilsRecord.md) +- [`UtilsRecord`](../type-aliases/UtilsRecord.md) ## Indexable @@ -40,7 +40,7 @@ The transaction containing mutations to accept ###### mutations -[`PendingMutation`](../PendingMutation.md)\<`Record`\<`string`, `unknown`\>, [`OperationType`](../../type-aliases/OperationType.md), [`Collection`](../Collection.md)\<`Record`\<`string`, `unknown`\>, `any`, `any`, `any`, `any`\>\>[] +[`PendingMutation`](./PendingMutation.md)\<`Record`\<`string`, `unknown`\>, [`OperationType`](../type-aliases/OperationType.md), [`Collection`](./Collection.md)\<`Record`\<`string`, `unknown`\>, `any`, `any`, `any`, `any`\>\>[] #### Returns diff --git a/docs/reference/interfaces/OptimisticChangeMessage.md b/docs/reference/interfaces/OptimisticChangeMessage.md index cda28f0f3..59ae447d8 100644 --- a/docs/reference/interfaces/OptimisticChangeMessage.md +++ b/docs/reference/interfaces/OptimisticChangeMessage.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/types.ts:325](https://github.com/TanStack/db/blob/m ## Extends -- [`ChangeMessage`](../ChangeMessage.md)\<`T`\> +- [`ChangeMessage`](./ChangeMessage.md)\<`T`\> ## Type Parameters @@ -39,7 +39,7 @@ Defined in: [packages/db/src/types.ts:318](https://github.com/TanStack/db/blob/m #### Inherited from -[`ChangeMessage`](../ChangeMessage.md).[`key`](../ChangeMessage.md#key) +[`ChangeMessage`](./ChangeMessage.md).[`key`](./ChangeMessage.md#key) *** @@ -53,7 +53,7 @@ Defined in: [packages/db/src/types.ts:322](https://github.com/TanStack/db/blob/m #### Inherited from -[`ChangeMessage`](../ChangeMessage.md).[`metadata`](../ChangeMessage.md#metadata) +[`ChangeMessage`](./ChangeMessage.md).[`metadata`](./ChangeMessage.md#metadata) *** @@ -67,7 +67,7 @@ Defined in: [packages/db/src/types.ts:320](https://github.com/TanStack/db/blob/m #### Inherited from -[`ChangeMessage`](../ChangeMessage.md).[`previousValue`](../ChangeMessage.md#previousvalue) +[`ChangeMessage`](./ChangeMessage.md).[`previousValue`](./ChangeMessage.md#previousvalue) *** @@ -81,7 +81,7 @@ Defined in: [packages/db/src/types.ts:321](https://github.com/TanStack/db/blob/m #### Inherited from -[`ChangeMessage`](../ChangeMessage.md).[`type`](../ChangeMessage.md#type) +[`ChangeMessage`](./ChangeMessage.md).[`type`](./ChangeMessage.md#type) *** @@ -95,4 +95,4 @@ Defined in: [packages/db/src/types.ts:319](https://github.com/TanStack/db/blob/m #### Inherited from -[`ChangeMessage`](../ChangeMessage.md).[`value`](../ChangeMessage.md#value) +[`ChangeMessage`](./ChangeMessage.md).[`value`](./ChangeMessage.md#value) diff --git a/docs/reference/interfaces/PendingMutation.md b/docs/reference/interfaces/PendingMutation.md index 2a5264f25..cbf3c615e 100644 --- a/docs/reference/interfaces/PendingMutation.md +++ b/docs/reference/interfaces/PendingMutation.md @@ -18,11 +18,11 @@ Contains information about the original and modified data, as well as metadata ### TOperation -`TOperation` *extends* [`OperationType`](../../type-aliases/OperationType.md) = [`OperationType`](../../type-aliases/OperationType.md) +`TOperation` *extends* [`OperationType`](../type-aliases/OperationType.md) = [`OperationType`](../type-aliases/OperationType.md) ### TCollection -`TCollection` *extends* [`Collection`](../Collection.md)\<`T`, `any`, `any`, `any`, `any`\> = [`Collection`](../Collection.md)\<`T`, `any`, `any`, `any`, `any`\> +`TCollection` *extends* [`Collection`](./Collection.md)\<`T`, `any`, `any`, `any`, `any`\> = [`Collection`](./Collection.md)\<`T`, `any`, `any`, `any`, `any`\> ## Properties diff --git a/docs/reference/interfaces/QueueStrategy.md b/docs/reference/interfaces/QueueStrategy.md index d22576848..f220cefb9 100644 --- a/docs/reference/interfaces/QueueStrategy.md +++ b/docs/reference/interfaces/QueueStrategy.md @@ -13,7 +13,7 @@ LIFO: { addItemsTo: 'back', getItemsFrom: 'back' } ## Extends -- [`BaseStrategy`](../BaseStrategy.md)\<`"queue"`\> +- [`BaseStrategy`](./BaseStrategy.md)\<`"queue"`\> ## Properties @@ -29,7 +29,7 @@ Type discriminator for strategy identification #### Inherited from -[`BaseStrategy`](../BaseStrategy.md).[`_type`](../BaseStrategy.md#_type) +[`BaseStrategy`](./BaseStrategy.md).[`_type`](./BaseStrategy.md#_type) *** @@ -50,7 +50,7 @@ Should be called when the strategy is no longer needed #### Inherited from -[`BaseStrategy`](../BaseStrategy.md).[`cleanup`](../BaseStrategy.md#cleanup) +[`BaseStrategy`](./BaseStrategy.md).[`cleanup`](./BaseStrategy.md#cleanup) *** @@ -74,7 +74,7 @@ Execute a function according to the strategy's timing rules ##### fn -() => [`Transaction`](../Transaction.md)\<`T`\> +() => [`Transaction`](./Transaction.md)\<`T`\> The function to execute @@ -86,7 +86,7 @@ The result of the function execution (if applicable) #### Inherited from -[`BaseStrategy`](../BaseStrategy.md).[`execute`](../BaseStrategy.md#execute) +[`BaseStrategy`](./BaseStrategy.md).[`execute`](./BaseStrategy.md#execute) *** diff --git a/docs/reference/interfaces/SubscribeChangesSnapshotOptions.md b/docs/reference/interfaces/SubscribeChangesSnapshotOptions.md index 34d59c8ad..538b5b8eb 100644 --- a/docs/reference/interfaces/SubscribeChangesSnapshotOptions.md +++ b/docs/reference/interfaces/SubscribeChangesSnapshotOptions.md @@ -9,7 +9,7 @@ Defined in: [packages/db/src/types.ts:730](https://github.com/TanStack/db/blob/m ## Extends -- `Omit`\<[`SubscribeChangesOptions`](../SubscribeChangesOptions.md), `"includeInitialState"`\> +- `Omit`\<[`SubscribeChangesOptions`](./SubscribeChangesOptions.md), `"includeInitialState"`\> ## Properties @@ -45,4 +45,4 @@ Pre-compiled expression for filtering changes #### Inherited from -[`SubscribeChangesOptions`](../SubscribeChangesOptions.md).[`whereExpression`](../SubscribeChangesOptions.md#whereexpression) +[`SubscribeChangesOptions`](./SubscribeChangesOptions.md).[`whereExpression`](./SubscribeChangesOptions.md#whereexpression) diff --git a/docs/reference/interfaces/Subscription.md b/docs/reference/interfaces/Subscription.md index 7c7e38148..c8cb4a790 100644 --- a/docs/reference/interfaces/Subscription.md +++ b/docs/reference/interfaces/Subscription.md @@ -12,7 +12,7 @@ Used by sync implementations to track subscription lifecycle ## Extends -- `EventEmitter`\<[`SubscriptionEvents`](../../type-aliases/SubscriptionEvents.md)\> +- `EventEmitter`\<[`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md)\> ## Properties @@ -66,7 +66,7 @@ Emit an event to all listeners ##### T -`T` *extends* keyof [`SubscriptionEvents`](../../type-aliases/SubscriptionEvents.md) +`T` *extends* keyof [`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md) #### Parameters @@ -78,7 +78,7 @@ Event name to emit ##### eventPayload -[`SubscriptionEvents`](../../type-aliases/SubscriptionEvents.md)\[`T`\] +[`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md)\[`T`\] Event payload For use by subclasses - subclasses should wrap this with a public emit if needed @@ -109,7 +109,7 @@ Unsubscribe from an event ##### T -`T` *extends* keyof [`SubscriptionEvents`](../../type-aliases/SubscriptionEvents.md) +`T` *extends* keyof [`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md) #### Parameters @@ -151,7 +151,7 @@ Subscribe to an event ##### T -`T` *extends* keyof [`SubscriptionEvents`](../../type-aliases/SubscriptionEvents.md) +`T` *extends* keyof [`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md) #### Parameters @@ -201,7 +201,7 @@ Subscribe to an event once (automatically unsubscribes after first emission) ##### T -`T` *extends* keyof [`SubscriptionEvents`](../../type-aliases/SubscriptionEvents.md) +`T` *extends* keyof [`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md) #### Parameters @@ -251,7 +251,7 @@ Wait for an event to be emitted ##### T -`T` *extends* keyof [`SubscriptionEvents`](../../type-aliases/SubscriptionEvents.md) +`T` *extends* keyof [`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md) #### Parameters @@ -269,7 +269,7 @@ Optional timeout in milliseconds #### Returns -`Promise`\<[`SubscriptionEvents`](../../type-aliases/SubscriptionEvents.md)\[`T`\]\> +`Promise`\<[`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md)\[`T`\]\> Promise that resolves with the event payload diff --git a/docs/reference/interfaces/SubscriptionStatusEvent.md b/docs/reference/interfaces/SubscriptionStatusEvent.md index 4e9b14f26..a84679586 100644 --- a/docs/reference/interfaces/SubscriptionStatusEvent.md +++ b/docs/reference/interfaces/SubscriptionStatusEvent.md @@ -13,7 +13,7 @@ Event emitted when subscription status changes to a specific status ### T -`T` *extends* [`SubscriptionStatus`](../../type-aliases/SubscriptionStatus.md) +`T` *extends* [`SubscriptionStatus`](../type-aliases/SubscriptionStatus.md) ## Properties diff --git a/docs/reference/interfaces/SyncConfig.md b/docs/reference/interfaces/SyncConfig.md index d49cfbb86..4435cb981 100644 --- a/docs/reference/interfaces/SyncConfig.md +++ b/docs/reference/interfaces/SyncConfig.md @@ -79,7 +79,7 @@ Defined in: [packages/db/src/types.ts:289](https://github.com/TanStack/db/blob/m ###### collection -[`Collection`](../Collection.md)\<`T`, `TKey`, `any`, `any`, `any`\> +[`Collection`](./Collection.md)\<`T`, `TKey`, `any`, `any`, `any`\> ###### commit @@ -100,5 +100,5 @@ Defined in: [packages/db/src/types.ts:289](https://github.com/TanStack/db/blob/m #### Returns \| `void` - \| [`CleanupFn`](../../type-aliases/CleanupFn.md) - \| [`SyncConfigRes`](../../type-aliases/SyncConfigRes.md) + \| [`CleanupFn`](../type-aliases/CleanupFn.md) + \| [`SyncConfigRes`](../type-aliases/SyncConfigRes.md) diff --git a/docs/reference/interfaces/ThrottleStrategy.md b/docs/reference/interfaces/ThrottleStrategy.md index e21a6f88e..021b995a3 100644 --- a/docs/reference/interfaces/ThrottleStrategy.md +++ b/docs/reference/interfaces/ThrottleStrategy.md @@ -11,7 +11,7 @@ Throttle strategy that spaces executions evenly over time ## Extends -- [`BaseStrategy`](../BaseStrategy.md)\<`"throttle"`\> +- [`BaseStrategy`](./BaseStrategy.md)\<`"throttle"`\> ## Properties @@ -27,7 +27,7 @@ Type discriminator for strategy identification #### Inherited from -[`BaseStrategy`](../BaseStrategy.md).[`_type`](../BaseStrategy.md#_type) +[`BaseStrategy`](./BaseStrategy.md).[`_type`](./BaseStrategy.md#_type) *** @@ -48,7 +48,7 @@ Should be called when the strategy is no longer needed #### Inherited from -[`BaseStrategy`](../BaseStrategy.md).[`cleanup`](../BaseStrategy.md#cleanup) +[`BaseStrategy`](./BaseStrategy.md).[`cleanup`](./BaseStrategy.md#cleanup) *** @@ -72,7 +72,7 @@ Execute a function according to the strategy's timing rules ##### fn -() => [`Transaction`](../Transaction.md)\<`T`\> +() => [`Transaction`](./Transaction.md)\<`T`\> The function to execute @@ -84,7 +84,7 @@ The result of the function execution (if applicable) #### Inherited from -[`BaseStrategy`](../BaseStrategy.md).[`execute`](../BaseStrategy.md#execute) +[`BaseStrategy`](./BaseStrategy.md).[`execute`](./BaseStrategy.md#execute) *** diff --git a/docs/reference/interfaces/Transaction.md b/docs/reference/interfaces/Transaction.md index 5ad434341..54a72db64 100644 --- a/docs/reference/interfaces/Transaction.md +++ b/docs/reference/interfaces/Transaction.md @@ -153,7 +153,7 @@ aligned with user intent. ##### mutations -[`PendingMutation`](../PendingMutation.md)\<`any`, [`OperationType`](../../type-aliases/OperationType.md), [`Collection`](../Collection.md)\<`any`, `any`, `any`, `any`, `any`\>\>[] +[`PendingMutation`](./PendingMutation.md)\<`any`, [`OperationType`](../type-aliases/OperationType.md), [`Collection`](./Collection.md)\<`any`, `any`, `any`, `any`, `any`\>\>[] Array of new mutations to apply @@ -396,7 +396,7 @@ Defined in: [packages/db/src/transactions.ts:238](https://github.com/TanStack/db ##### newState -[`TransactionState`](../../type-aliases/TransactionState.md) +[`TransactionState`](../type-aliases/TransactionState.md) #### Returns diff --git a/docs/reference/powersync-db-collection/classes/PowerSyncTransactor.md b/docs/reference/powersync-db-collection/classes/PowerSyncTransactor.md index e06450b40..b13c77ec4 100644 --- a/docs/reference/powersync-db-collection/classes/PowerSyncTransactor.md +++ b/docs/reference/powersync-db-collection/classes/PowerSyncTransactor.md @@ -57,7 +57,7 @@ Defined in: [PowerSyncTransactor.ts:55](https://github.com/TanStack/db/blob/main ##### options -[`TransactorOptions`](../../type-aliases/TransactorOptions.md) +[`TransactorOptions`](../type-aliases/TransactorOptions.md) #### Returns diff --git a/docs/reference/powersync-db-collection/functions/powerSyncCollectionOptions.md b/docs/reference/powersync-db-collection/functions/powerSyncCollectionOptions.md index e18eebcb9..a6dba45f7 100644 --- a/docs/reference/powersync-db-collection/functions/powerSyncCollectionOptions.md +++ b/docs/reference/powersync-db-collection/functions/powerSyncCollectionOptions.md @@ -32,7 +32,7 @@ Input and Output types are the SQLite column types. ### Returns -[`EnhancedPowerSyncCollectionConfig`](../../type-aliases/EnhancedPowerSyncCollectionConfig.md)\<`TTable`, `OptionalExtractedTable`\<`TTable`\>, `never`\> +[`EnhancedPowerSyncCollectionConfig`](../type-aliases/EnhancedPowerSyncCollectionConfig.md)\<`TTable`, `OptionalExtractedTable`\<`TTable`\>, `never`\> ### Example @@ -92,11 +92,11 @@ serializer specifications. Partial column overrides can be supplied to `serializ #### config -`Omit`\<`BaseCollectionConfig`\<`ExtractedTable`\<`TTable`\>, `string`, `TSchema`, `UtilsRecord`, `any`\>, `"onInsert"` \| `"onUpdate"` \| `"onDelete"` \| `"getKey"`\> & `object` & [`SerializerConfig`](../../type-aliases/SerializerConfig.md)\<`InferOutput`\<`TSchema`\>, `ExtractedTable`\<`TTable`\>\> & `object` +`Omit`\<`BaseCollectionConfig`\<`ExtractedTable`\<`TTable`\>, `string`, `TSchema`, `UtilsRecord`, `any`\>, `"onInsert"` \| `"onUpdate"` \| `"onDelete"` \| `"getKey"`\> & `object` & [`SerializerConfig`](../type-aliases/SerializerConfig.md)\<`InferOutput`\<`TSchema`\>, `ExtractedTable`\<`TTable`\>\> & `object` ### Returns -`CollectionConfig`\<[`InferPowerSyncOutputType`](../../type-aliases/InferPowerSyncOutputType.md)\<`TTable`, `TSchema`\>, `string`, `TSchema`, `UtilsRecord`\> & `object` & `object` +`CollectionConfig`\<[`InferPowerSyncOutputType`](../type-aliases/InferPowerSyncOutputType.md)\<`TTable`, `TSchema`\>, `string`, `TSchema`, `UtilsRecord`\> & `object` & `object` ### Example @@ -169,11 +169,11 @@ serializer specifications. Partial column overrides can be supplied to `serializ #### config -`Omit`\<`BaseCollectionConfig`\<`ExtractedTable`\<`TTable`\>, `string`, `TSchema`, `UtilsRecord`, `any`\>, `"onInsert"` \| `"onUpdate"` \| `"onDelete"` \| `"getKey"`\> & `object` & [`SerializerConfig`](../../type-aliases/SerializerConfig.md)\<`InferOutput`\<`TSchema`\>, `ExtractedTable`\<`TTable`\>\> & `object` +`Omit`\<`BaseCollectionConfig`\<`ExtractedTable`\<`TTable`\>, `string`, `TSchema`, `UtilsRecord`, `any`\>, `"onInsert"` \| `"onUpdate"` \| `"onDelete"` \| `"getKey"`\> & `object` & [`SerializerConfig`](../type-aliases/SerializerConfig.md)\<`InferOutput`\<`TSchema`\>, `ExtractedTable`\<`TTable`\>\> & `object` ### Returns -`CollectionConfig`\<[`InferPowerSyncOutputType`](../../type-aliases/InferPowerSyncOutputType.md)\<`TTable`, `TSchema`\>, `string`, `TSchema`, `UtilsRecord`\> & `object` & `object` +`CollectionConfig`\<[`InferPowerSyncOutputType`](../type-aliases/InferPowerSyncOutputType.md)\<`TTable`, `TSchema`\>, `string`, `TSchema`, `UtilsRecord`\> & `object` & `object` ### Example diff --git a/docs/reference/powersync-db-collection/index.md b/docs/reference/powersync-db-collection/index.md index c0894dac0..f0ccfa5f9 100644 --- a/docs/reference/powersync-db-collection/index.md +++ b/docs/reference/powersync-db-collection/index.md @@ -7,27 +7,27 @@ title: "@tanstack/powersync-db-collection" ## Classes -- [PowerSyncTransactor](../classes/PowerSyncTransactor.md) +- [PowerSyncTransactor](./classes/PowerSyncTransactor.md) ## Type Aliases -- [BasePowerSyncCollectionConfig](../type-aliases/BasePowerSyncCollectionConfig.md) -- [ConfigWithArbitraryCollectionTypes](../type-aliases/ConfigWithArbitraryCollectionTypes.md) -- [ConfigWithSQLiteInputType](../type-aliases/ConfigWithSQLiteInputType.md) -- [ConfigWithSQLiteTypes](../type-aliases/ConfigWithSQLiteTypes.md) -- [CustomSQLiteSerializer](../type-aliases/CustomSQLiteSerializer.md) -- [EnhancedPowerSyncCollectionConfig](../type-aliases/EnhancedPowerSyncCollectionConfig.md) -- [InferPowerSyncOutputType](../type-aliases/InferPowerSyncOutputType.md) -- [PowerSyncCollectionConfig](../type-aliases/PowerSyncCollectionConfig.md) -- [PowerSyncCollectionMeta](../type-aliases/PowerSyncCollectionMeta.md) -- [PowerSyncCollectionUtils](../type-aliases/PowerSyncCollectionUtils.md) -- [SerializerConfig](../type-aliases/SerializerConfig.md) -- [TransactorOptions](../type-aliases/TransactorOptions.md) +- [BasePowerSyncCollectionConfig](./type-aliases/BasePowerSyncCollectionConfig.md) +- [ConfigWithArbitraryCollectionTypes](./type-aliases/ConfigWithArbitraryCollectionTypes.md) +- [ConfigWithSQLiteInputType](./type-aliases/ConfigWithSQLiteInputType.md) +- [ConfigWithSQLiteTypes](./type-aliases/ConfigWithSQLiteTypes.md) +- [CustomSQLiteSerializer](./type-aliases/CustomSQLiteSerializer.md) +- [EnhancedPowerSyncCollectionConfig](./type-aliases/EnhancedPowerSyncCollectionConfig.md) +- [InferPowerSyncOutputType](./type-aliases/InferPowerSyncOutputType.md) +- [PowerSyncCollectionConfig](./type-aliases/PowerSyncCollectionConfig.md) +- [PowerSyncCollectionMeta](./type-aliases/PowerSyncCollectionMeta.md) +- [PowerSyncCollectionUtils](./type-aliases/PowerSyncCollectionUtils.md) +- [SerializerConfig](./type-aliases/SerializerConfig.md) +- [TransactorOptions](./type-aliases/TransactorOptions.md) ## Variables -- [DEFAULT\_BATCH\_SIZE](../variables/DEFAULT_BATCH_SIZE.md) +- [DEFAULT\_BATCH\_SIZE](./variables/DEFAULT_BATCH_SIZE.md) ## Functions -- [powerSyncCollectionOptions](../functions/powerSyncCollectionOptions.md) +- [powerSyncCollectionOptions](./functions/powerSyncCollectionOptions.md) diff --git a/docs/reference/powersync-db-collection/type-aliases/BasePowerSyncCollectionConfig.md b/docs/reference/powersync-db-collection/type-aliases/BasePowerSyncCollectionConfig.md index ab1d26dcc..4966c6574 100644 --- a/docs/reference/powersync-db-collection/type-aliases/BasePowerSyncCollectionConfig.md +++ b/docs/reference/powersync-db-collection/type-aliases/BasePowerSyncCollectionConfig.md @@ -33,7 +33,7 @@ in-memory TanStack DB collection. #### Remarks -- Defaults to [DEFAULT\_BATCH\_SIZE](../../variables/DEFAULT_BATCH_SIZE.md) if not specified. +- Defaults to [DEFAULT\_BATCH\_SIZE](../variables/DEFAULT_BATCH_SIZE.md) if not specified. - Larger values reduce the number of round trips to the storage engine but increase memory usage per batch. - Smaller values may lower memory usage and allow earlier diff --git a/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionUtils.md b/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionUtils.md index 28ab62975..7707d9cc2 100644 --- a/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionUtils.md +++ b/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionUtils.md @@ -31,4 +31,4 @@ Defined in: [definitions.ts:268](https://github.com/TanStack/db/blob/main/packag #### Returns -[`PowerSyncCollectionMeta`](../PowerSyncCollectionMeta.md)\<`TTable`\> +[`PowerSyncCollectionMeta`](./PowerSyncCollectionMeta.md)\<`TTable`\> diff --git a/docs/reference/powersync-db-collection/type-aliases/SerializerConfig.md b/docs/reference/powersync-db-collection/type-aliases/SerializerConfig.md index f437cdbf2..296cfbba7 100644 --- a/docs/reference/powersync-db-collection/type-aliases/SerializerConfig.md +++ b/docs/reference/powersync-db-collection/type-aliases/SerializerConfig.md @@ -58,7 +58,7 @@ Defined in: [definitions.ts:87](https://github.com/TanStack/db/blob/main/package Optional partial serializer object for customizing how individual columns are serialized for SQLite. This should be a partial map of column keys to serialization functions, following the -[CustomSQLiteSerializer](../CustomSQLiteSerializer.md) type. Each function receives the column value and returns a value +[CustomSQLiteSerializer](./CustomSQLiteSerializer.md) type. Each function receives the column value and returns a value compatible with SQLite storage. If not provided for a column, the default behavior is used: 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..16054c0b3 100644 --- a/docs/reference/powersync-db-collection/variables/DEFAULT_BATCH_SIZE.md +++ b/docs/reference/powersync-db-collection/variables/DEFAULT_BATCH_SIZE.md @@ -11,4 +11,4 @@ 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) -Default value for [PowerSyncCollectionConfig#syncBatchSize](../../type-aliases/BasePowerSyncCollectionConfig.md). +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..42c8651ec 100644 --- a/docs/reference/query-db-collection/classes/DeleteOperationItemNotFoundError.md +++ b/docs/reference/query-db-collection/classes/DeleteOperationItemNotFoundError.md @@ -9,7 +9,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:76](https://github.com/T ## Extends -- [`QueryCollectionError`](../QueryCollectionError.md) +- [`QueryCollectionError`](./QueryCollectionError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:77](https://github.com/T #### Overrides -[`QueryCollectionError`](../QueryCollectionError.md).[`constructor`](../QueryCollectionError.md#constructor) +[`QueryCollectionError`](./QueryCollectionError.md).[`constructor`](./QueryCollectionError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`cause`](../QueryCollectionError.md#cause) +[`QueryCollectionError`](./QueryCollectionError.md).[`cause`](./QueryCollectionError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`message`](../QueryCollectionError.md#message) +[`QueryCollectionError`](./QueryCollectionError.md).[`message`](./QueryCollectionError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`name`](../QueryCollectionError.md#name) +[`QueryCollectionError`](./QueryCollectionError.md).[`name`](./QueryCollectionError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stack`](../QueryCollectionError.md#stack) +[`QueryCollectionError`](./QueryCollectionError.md).[`stack`](./QueryCollectionError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stackTraceLimit`](../QueryCollectionError.md#stacktracelimit) +[`QueryCollectionError`](./QueryCollectionError.md).[`stackTraceLimit`](./QueryCollectionError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`captureStackTrace`](../QueryCollectionError.md#capturestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`captureStackTrace`](./QueryCollectionError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`prepareStackTrace`](../QueryCollectionError.md#preparestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`prepareStackTrace`](./QueryCollectionError.md#preparestacktrace) diff --git a/docs/reference/query-db-collection/classes/DuplicateKeyInBatchError.md b/docs/reference/query-db-collection/classes/DuplicateKeyInBatchError.md index 7e04fe138..c16216a59 100644 --- a/docs/reference/query-db-collection/classes/DuplicateKeyInBatchError.md +++ b/docs/reference/query-db-collection/classes/DuplicateKeyInBatchError.md @@ -9,7 +9,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:62](https://github.com/T ## Extends -- [`QueryCollectionError`](../QueryCollectionError.md) +- [`QueryCollectionError`](./QueryCollectionError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:63](https://github.com/T #### Overrides -[`QueryCollectionError`](../QueryCollectionError.md).[`constructor`](../QueryCollectionError.md#constructor) +[`QueryCollectionError`](./QueryCollectionError.md).[`constructor`](./QueryCollectionError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`cause`](../QueryCollectionError.md#cause) +[`QueryCollectionError`](./QueryCollectionError.md).[`cause`](./QueryCollectionError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`message`](../QueryCollectionError.md#message) +[`QueryCollectionError`](./QueryCollectionError.md).[`message`](./QueryCollectionError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`name`](../QueryCollectionError.md#name) +[`QueryCollectionError`](./QueryCollectionError.md).[`name`](./QueryCollectionError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stack`](../QueryCollectionError.md#stack) +[`QueryCollectionError`](./QueryCollectionError.md).[`stack`](./QueryCollectionError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stackTraceLimit`](../QueryCollectionError.md#stacktracelimit) +[`QueryCollectionError`](./QueryCollectionError.md).[`stackTraceLimit`](./QueryCollectionError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`captureStackTrace`](../QueryCollectionError.md#capturestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`captureStackTrace`](./QueryCollectionError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`prepareStackTrace`](../QueryCollectionError.md#preparestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`prepareStackTrace`](./QueryCollectionError.md#preparestacktrace) diff --git a/docs/reference/query-db-collection/classes/GetKeyRequiredError.md b/docs/reference/query-db-collection/classes/GetKeyRequiredError.md index 6a02f66e5..8247b446e 100644 --- a/docs/reference/query-db-collection/classes/GetKeyRequiredError.md +++ b/docs/reference/query-db-collection/classes/GetKeyRequiredError.md @@ -9,7 +9,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:32](https://github.com/T ## Extends -- [`QueryCollectionError`](../QueryCollectionError.md) +- [`QueryCollectionError`](./QueryCollectionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:33](https://github.com/T #### Overrides -[`QueryCollectionError`](../QueryCollectionError.md).[`constructor`](../QueryCollectionError.md#constructor) +[`QueryCollectionError`](./QueryCollectionError.md).[`constructor`](./QueryCollectionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`cause`](../QueryCollectionError.md#cause) +[`QueryCollectionError`](./QueryCollectionError.md).[`cause`](./QueryCollectionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`message`](../QueryCollectionError.md#message) +[`QueryCollectionError`](./QueryCollectionError.md).[`message`](./QueryCollectionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`name`](../QueryCollectionError.md#name) +[`QueryCollectionError`](./QueryCollectionError.md).[`name`](./QueryCollectionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stack`](../QueryCollectionError.md#stack) +[`QueryCollectionError`](./QueryCollectionError.md).[`stack`](./QueryCollectionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stackTraceLimit`](../QueryCollectionError.md#stacktracelimit) +[`QueryCollectionError`](./QueryCollectionError.md).[`stackTraceLimit`](./QueryCollectionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`captureStackTrace`](../QueryCollectionError.md#capturestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`captureStackTrace`](./QueryCollectionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`prepareStackTrace`](../QueryCollectionError.md#preparestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`prepareStackTrace`](./QueryCollectionError.md#preparestacktrace) diff --git a/docs/reference/query-db-collection/classes/InvalidItemStructureError.md b/docs/reference/query-db-collection/classes/InvalidItemStructureError.md index be43e7c39..9352db37d 100644 --- a/docs/reference/query-db-collection/classes/InvalidItemStructureError.md +++ b/docs/reference/query-db-collection/classes/InvalidItemStructureError.md @@ -9,7 +9,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:48](https://github.com/T ## Extends -- [`QueryCollectionError`](../QueryCollectionError.md) +- [`QueryCollectionError`](./QueryCollectionError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:49](https://github.com/T #### Overrides -[`QueryCollectionError`](../QueryCollectionError.md).[`constructor`](../QueryCollectionError.md#constructor) +[`QueryCollectionError`](./QueryCollectionError.md).[`constructor`](./QueryCollectionError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`cause`](../QueryCollectionError.md#cause) +[`QueryCollectionError`](./QueryCollectionError.md).[`cause`](./QueryCollectionError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`message`](../QueryCollectionError.md#message) +[`QueryCollectionError`](./QueryCollectionError.md).[`message`](./QueryCollectionError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`name`](../QueryCollectionError.md#name) +[`QueryCollectionError`](./QueryCollectionError.md).[`name`](./QueryCollectionError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stack`](../QueryCollectionError.md#stack) +[`QueryCollectionError`](./QueryCollectionError.md).[`stack`](./QueryCollectionError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stackTraceLimit`](../QueryCollectionError.md#stacktracelimit) +[`QueryCollectionError`](./QueryCollectionError.md).[`stackTraceLimit`](./QueryCollectionError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`captureStackTrace`](../QueryCollectionError.md#capturestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`captureStackTrace`](./QueryCollectionError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`prepareStackTrace`](../QueryCollectionError.md#preparestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`prepareStackTrace`](./QueryCollectionError.md#preparestacktrace) diff --git a/docs/reference/query-db-collection/classes/InvalidSyncOperationError.md b/docs/reference/query-db-collection/classes/InvalidSyncOperationError.md index 12f97f90f..66397ac56 100644 --- a/docs/reference/query-db-collection/classes/InvalidSyncOperationError.md +++ b/docs/reference/query-db-collection/classes/InvalidSyncOperationError.md @@ -9,7 +9,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:83](https://github.com/T ## Extends -- [`QueryCollectionError`](../QueryCollectionError.md) +- [`QueryCollectionError`](./QueryCollectionError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:84](https://github.com/T #### Overrides -[`QueryCollectionError`](../QueryCollectionError.md).[`constructor`](../QueryCollectionError.md#constructor) +[`QueryCollectionError`](./QueryCollectionError.md).[`constructor`](./QueryCollectionError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`cause`](../QueryCollectionError.md#cause) +[`QueryCollectionError`](./QueryCollectionError.md).[`cause`](./QueryCollectionError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`message`](../QueryCollectionError.md#message) +[`QueryCollectionError`](./QueryCollectionError.md).[`message`](./QueryCollectionError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`name`](../QueryCollectionError.md#name) +[`QueryCollectionError`](./QueryCollectionError.md).[`name`](./QueryCollectionError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stack`](../QueryCollectionError.md#stack) +[`QueryCollectionError`](./QueryCollectionError.md).[`stack`](./QueryCollectionError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stackTraceLimit`](../QueryCollectionError.md#stacktracelimit) +[`QueryCollectionError`](./QueryCollectionError.md).[`stackTraceLimit`](./QueryCollectionError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`captureStackTrace`](../QueryCollectionError.md#capturestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`captureStackTrace`](./QueryCollectionError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`prepareStackTrace`](../QueryCollectionError.md#preparestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`prepareStackTrace`](./QueryCollectionError.md#preparestacktrace) diff --git a/docs/reference/query-db-collection/classes/ItemNotFoundError.md b/docs/reference/query-db-collection/classes/ItemNotFoundError.md index 682e70337..42734e4e8 100644 --- a/docs/reference/query-db-collection/classes/ItemNotFoundError.md +++ b/docs/reference/query-db-collection/classes/ItemNotFoundError.md @@ -9,7 +9,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:55](https://github.com/T ## Extends -- [`QueryCollectionError`](../QueryCollectionError.md) +- [`QueryCollectionError`](./QueryCollectionError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:56](https://github.com/T #### Overrides -[`QueryCollectionError`](../QueryCollectionError.md).[`constructor`](../QueryCollectionError.md#constructor) +[`QueryCollectionError`](./QueryCollectionError.md).[`constructor`](./QueryCollectionError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`cause`](../QueryCollectionError.md#cause) +[`QueryCollectionError`](./QueryCollectionError.md).[`cause`](./QueryCollectionError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`message`](../QueryCollectionError.md#message) +[`QueryCollectionError`](./QueryCollectionError.md).[`message`](./QueryCollectionError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`name`](../QueryCollectionError.md#name) +[`QueryCollectionError`](./QueryCollectionError.md).[`name`](./QueryCollectionError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stack`](../QueryCollectionError.md#stack) +[`QueryCollectionError`](./QueryCollectionError.md).[`stack`](./QueryCollectionError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stackTraceLimit`](../QueryCollectionError.md#stacktracelimit) +[`QueryCollectionError`](./QueryCollectionError.md).[`stackTraceLimit`](./QueryCollectionError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`captureStackTrace`](../QueryCollectionError.md#capturestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`captureStackTrace`](./QueryCollectionError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`prepareStackTrace`](../QueryCollectionError.md#preparestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`prepareStackTrace`](./QueryCollectionError.md#preparestacktrace) diff --git a/docs/reference/query-db-collection/classes/MissingKeyFieldError.md b/docs/reference/query-db-collection/classes/MissingKeyFieldError.md index 6a0e666f3..c157cf4e7 100644 --- a/docs/reference/query-db-collection/classes/MissingKeyFieldError.md +++ b/docs/reference/query-db-collection/classes/MissingKeyFieldError.md @@ -9,7 +9,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:97](https://github.com/T ## Extends -- [`QueryCollectionError`](../QueryCollectionError.md) +- [`QueryCollectionError`](./QueryCollectionError.md) ## Constructors @@ -37,7 +37,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:98](https://github.com/T #### Overrides -[`QueryCollectionError`](../QueryCollectionError.md).[`constructor`](../QueryCollectionError.md#constructor) +[`QueryCollectionError`](./QueryCollectionError.md).[`constructor`](./QueryCollectionError.md#constructor) ## Properties @@ -51,7 +51,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`cause`](../QueryCollectionError.md#cause) +[`QueryCollectionError`](./QueryCollectionError.md).[`cause`](./QueryCollectionError.md#cause) *** @@ -65,7 +65,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`message`](../QueryCollectionError.md#message) +[`QueryCollectionError`](./QueryCollectionError.md).[`message`](./QueryCollectionError.md#message) *** @@ -79,7 +79,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`name`](../QueryCollectionError.md#name) +[`QueryCollectionError`](./QueryCollectionError.md).[`name`](./QueryCollectionError.md#name) *** @@ -93,7 +93,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stack`](../QueryCollectionError.md#stack) +[`QueryCollectionError`](./QueryCollectionError.md).[`stack`](./QueryCollectionError.md#stack) *** @@ -117,7 +117,7 @@ not capture any frames. #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stackTraceLimit`](../QueryCollectionError.md#stacktracelimit) +[`QueryCollectionError`](./QueryCollectionError.md).[`stackTraceLimit`](./QueryCollectionError.md#stacktracelimit) ## Methods @@ -189,7 +189,7 @@ a(); #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`captureStackTrace`](../QueryCollectionError.md#capturestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`captureStackTrace`](./QueryCollectionError.md#capturestacktrace) *** @@ -221,4 +221,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`prepareStackTrace`](../QueryCollectionError.md#preparestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`prepareStackTrace`](./QueryCollectionError.md#preparestacktrace) diff --git a/docs/reference/query-db-collection/classes/QueryClientRequiredError.md b/docs/reference/query-db-collection/classes/QueryClientRequiredError.md index bfd900f4b..7530e3545 100644 --- a/docs/reference/query-db-collection/classes/QueryClientRequiredError.md +++ b/docs/reference/query-db-collection/classes/QueryClientRequiredError.md @@ -9,7 +9,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:25](https://github.com/T ## Extends -- [`QueryCollectionError`](../QueryCollectionError.md) +- [`QueryCollectionError`](./QueryCollectionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:26](https://github.com/T #### Overrides -[`QueryCollectionError`](../QueryCollectionError.md).[`constructor`](../QueryCollectionError.md#constructor) +[`QueryCollectionError`](./QueryCollectionError.md).[`constructor`](./QueryCollectionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`cause`](../QueryCollectionError.md#cause) +[`QueryCollectionError`](./QueryCollectionError.md).[`cause`](./QueryCollectionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`message`](../QueryCollectionError.md#message) +[`QueryCollectionError`](./QueryCollectionError.md).[`message`](./QueryCollectionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`name`](../QueryCollectionError.md#name) +[`QueryCollectionError`](./QueryCollectionError.md).[`name`](./QueryCollectionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stack`](../QueryCollectionError.md#stack) +[`QueryCollectionError`](./QueryCollectionError.md).[`stack`](./QueryCollectionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stackTraceLimit`](../QueryCollectionError.md#stacktracelimit) +[`QueryCollectionError`](./QueryCollectionError.md).[`stackTraceLimit`](./QueryCollectionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`captureStackTrace`](../QueryCollectionError.md#capturestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`captureStackTrace`](./QueryCollectionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`prepareStackTrace`](../QueryCollectionError.md#preparestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`prepareStackTrace`](./QueryCollectionError.md#preparestacktrace) diff --git a/docs/reference/query-db-collection/classes/QueryCollectionError.md b/docs/reference/query-db-collection/classes/QueryCollectionError.md index 83b6c2d31..8013b6450 100644 --- a/docs/reference/query-db-collection/classes/QueryCollectionError.md +++ b/docs/reference/query-db-collection/classes/QueryCollectionError.md @@ -13,19 +13,19 @@ Defined in: [packages/query-db-collection/src/errors.ts:4](https://github.com/Ta ## Extended by -- [`QueryKeyRequiredError`](../QueryKeyRequiredError.md) -- [`QueryFnRequiredError`](../QueryFnRequiredError.md) -- [`QueryClientRequiredError`](../QueryClientRequiredError.md) -- [`GetKeyRequiredError`](../GetKeyRequiredError.md) -- [`SyncNotInitializedError`](../SyncNotInitializedError.md) -- [`InvalidItemStructureError`](../InvalidItemStructureError.md) -- [`ItemNotFoundError`](../ItemNotFoundError.md) -- [`DuplicateKeyInBatchError`](../DuplicateKeyInBatchError.md) -- [`UpdateOperationItemNotFoundError`](../UpdateOperationItemNotFoundError.md) -- [`DeleteOperationItemNotFoundError`](../DeleteOperationItemNotFoundError.md) -- [`InvalidSyncOperationError`](../InvalidSyncOperationError.md) -- [`UnknownOperationTypeError`](../UnknownOperationTypeError.md) -- [`MissingKeyFieldError`](../MissingKeyFieldError.md) +- [`QueryKeyRequiredError`](./QueryKeyRequiredError.md) +- [`QueryFnRequiredError`](./QueryFnRequiredError.md) +- [`QueryClientRequiredError`](./QueryClientRequiredError.md) +- [`GetKeyRequiredError`](./GetKeyRequiredError.md) +- [`SyncNotInitializedError`](./SyncNotInitializedError.md) +- [`InvalidItemStructureError`](./InvalidItemStructureError.md) +- [`ItemNotFoundError`](./ItemNotFoundError.md) +- [`DuplicateKeyInBatchError`](./DuplicateKeyInBatchError.md) +- [`UpdateOperationItemNotFoundError`](./UpdateOperationItemNotFoundError.md) +- [`DeleteOperationItemNotFoundError`](./DeleteOperationItemNotFoundError.md) +- [`InvalidSyncOperationError`](./InvalidSyncOperationError.md) +- [`UnknownOperationTypeError`](./UnknownOperationTypeError.md) +- [`MissingKeyFieldError`](./MissingKeyFieldError.md) ## Constructors diff --git a/docs/reference/query-db-collection/classes/QueryFnRequiredError.md b/docs/reference/query-db-collection/classes/QueryFnRequiredError.md index 4ba61732f..b3c3c6a3e 100644 --- a/docs/reference/query-db-collection/classes/QueryFnRequiredError.md +++ b/docs/reference/query-db-collection/classes/QueryFnRequiredError.md @@ -9,7 +9,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:18](https://github.com/T ## Extends -- [`QueryCollectionError`](../QueryCollectionError.md) +- [`QueryCollectionError`](./QueryCollectionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:19](https://github.com/T #### Overrides -[`QueryCollectionError`](../QueryCollectionError.md).[`constructor`](../QueryCollectionError.md#constructor) +[`QueryCollectionError`](./QueryCollectionError.md).[`constructor`](./QueryCollectionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`cause`](../QueryCollectionError.md#cause) +[`QueryCollectionError`](./QueryCollectionError.md).[`cause`](./QueryCollectionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`message`](../QueryCollectionError.md#message) +[`QueryCollectionError`](./QueryCollectionError.md).[`message`](./QueryCollectionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`name`](../QueryCollectionError.md#name) +[`QueryCollectionError`](./QueryCollectionError.md).[`name`](./QueryCollectionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stack`](../QueryCollectionError.md#stack) +[`QueryCollectionError`](./QueryCollectionError.md).[`stack`](./QueryCollectionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stackTraceLimit`](../QueryCollectionError.md#stacktracelimit) +[`QueryCollectionError`](./QueryCollectionError.md).[`stackTraceLimit`](./QueryCollectionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`captureStackTrace`](../QueryCollectionError.md#capturestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`captureStackTrace`](./QueryCollectionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`prepareStackTrace`](../QueryCollectionError.md#preparestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`prepareStackTrace`](./QueryCollectionError.md#preparestacktrace) diff --git a/docs/reference/query-db-collection/classes/QueryKeyRequiredError.md b/docs/reference/query-db-collection/classes/QueryKeyRequiredError.md index 3988a0acb..5efa4a6b7 100644 --- a/docs/reference/query-db-collection/classes/QueryKeyRequiredError.md +++ b/docs/reference/query-db-collection/classes/QueryKeyRequiredError.md @@ -9,7 +9,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:11](https://github.com/T ## Extends -- [`QueryCollectionError`](../QueryCollectionError.md) +- [`QueryCollectionError`](./QueryCollectionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:12](https://github.com/T #### Overrides -[`QueryCollectionError`](../QueryCollectionError.md).[`constructor`](../QueryCollectionError.md#constructor) +[`QueryCollectionError`](./QueryCollectionError.md).[`constructor`](./QueryCollectionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`cause`](../QueryCollectionError.md#cause) +[`QueryCollectionError`](./QueryCollectionError.md).[`cause`](./QueryCollectionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`message`](../QueryCollectionError.md#message) +[`QueryCollectionError`](./QueryCollectionError.md).[`message`](./QueryCollectionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`name`](../QueryCollectionError.md#name) +[`QueryCollectionError`](./QueryCollectionError.md).[`name`](./QueryCollectionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stack`](../QueryCollectionError.md#stack) +[`QueryCollectionError`](./QueryCollectionError.md).[`stack`](./QueryCollectionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stackTraceLimit`](../QueryCollectionError.md#stacktracelimit) +[`QueryCollectionError`](./QueryCollectionError.md).[`stackTraceLimit`](./QueryCollectionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`captureStackTrace`](../QueryCollectionError.md#capturestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`captureStackTrace`](./QueryCollectionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`prepareStackTrace`](../QueryCollectionError.md#preparestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`prepareStackTrace`](./QueryCollectionError.md#preparestacktrace) diff --git a/docs/reference/query-db-collection/classes/SyncNotInitializedError.md b/docs/reference/query-db-collection/classes/SyncNotInitializedError.md index 8adee5e9a..e3b0b4829 100644 --- a/docs/reference/query-db-collection/classes/SyncNotInitializedError.md +++ b/docs/reference/query-db-collection/classes/SyncNotInitializedError.md @@ -9,7 +9,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:39](https://github.com/T ## Extends -- [`QueryCollectionError`](../QueryCollectionError.md) +- [`QueryCollectionError`](./QueryCollectionError.md) ## Constructors @@ -27,7 +27,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:40](https://github.com/T #### Overrides -[`QueryCollectionError`](../QueryCollectionError.md).[`constructor`](../QueryCollectionError.md#constructor) +[`QueryCollectionError`](./QueryCollectionError.md).[`constructor`](./QueryCollectionError.md#constructor) ## Properties @@ -41,7 +41,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`cause`](../QueryCollectionError.md#cause) +[`QueryCollectionError`](./QueryCollectionError.md).[`cause`](./QueryCollectionError.md#cause) *** @@ -55,7 +55,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`message`](../QueryCollectionError.md#message) +[`QueryCollectionError`](./QueryCollectionError.md).[`message`](./QueryCollectionError.md#message) *** @@ -69,7 +69,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`name`](../QueryCollectionError.md#name) +[`QueryCollectionError`](./QueryCollectionError.md).[`name`](./QueryCollectionError.md#name) *** @@ -83,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stack`](../QueryCollectionError.md#stack) +[`QueryCollectionError`](./QueryCollectionError.md).[`stack`](./QueryCollectionError.md#stack) *** @@ -107,7 +107,7 @@ not capture any frames. #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stackTraceLimit`](../QueryCollectionError.md#stacktracelimit) +[`QueryCollectionError`](./QueryCollectionError.md).[`stackTraceLimit`](./QueryCollectionError.md#stacktracelimit) ## Methods @@ -179,7 +179,7 @@ a(); #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`captureStackTrace`](../QueryCollectionError.md#capturestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`captureStackTrace`](./QueryCollectionError.md#capturestacktrace) *** @@ -211,4 +211,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`prepareStackTrace`](../QueryCollectionError.md#preparestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`prepareStackTrace`](./QueryCollectionError.md#preparestacktrace) diff --git a/docs/reference/query-db-collection/classes/UnknownOperationTypeError.md b/docs/reference/query-db-collection/classes/UnknownOperationTypeError.md index f3bb18fdd..5575b2a5c 100644 --- a/docs/reference/query-db-collection/classes/UnknownOperationTypeError.md +++ b/docs/reference/query-db-collection/classes/UnknownOperationTypeError.md @@ -9,7 +9,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:90](https://github.com/T ## Extends -- [`QueryCollectionError`](../QueryCollectionError.md) +- [`QueryCollectionError`](./QueryCollectionError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:91](https://github.com/T #### Overrides -[`QueryCollectionError`](../QueryCollectionError.md).[`constructor`](../QueryCollectionError.md#constructor) +[`QueryCollectionError`](./QueryCollectionError.md).[`constructor`](./QueryCollectionError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`cause`](../QueryCollectionError.md#cause) +[`QueryCollectionError`](./QueryCollectionError.md).[`cause`](./QueryCollectionError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`message`](../QueryCollectionError.md#message) +[`QueryCollectionError`](./QueryCollectionError.md).[`message`](./QueryCollectionError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`name`](../QueryCollectionError.md#name) +[`QueryCollectionError`](./QueryCollectionError.md).[`name`](./QueryCollectionError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stack`](../QueryCollectionError.md#stack) +[`QueryCollectionError`](./QueryCollectionError.md).[`stack`](./QueryCollectionError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stackTraceLimit`](../QueryCollectionError.md#stacktracelimit) +[`QueryCollectionError`](./QueryCollectionError.md).[`stackTraceLimit`](./QueryCollectionError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`captureStackTrace`](../QueryCollectionError.md#capturestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`captureStackTrace`](./QueryCollectionError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`prepareStackTrace`](../QueryCollectionError.md#preparestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`prepareStackTrace`](./QueryCollectionError.md#preparestacktrace) diff --git a/docs/reference/query-db-collection/classes/UpdateOperationItemNotFoundError.md b/docs/reference/query-db-collection/classes/UpdateOperationItemNotFoundError.md index 2745b0a98..a5ce2ea4c 100644 --- a/docs/reference/query-db-collection/classes/UpdateOperationItemNotFoundError.md +++ b/docs/reference/query-db-collection/classes/UpdateOperationItemNotFoundError.md @@ -9,7 +9,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:69](https://github.com/T ## Extends -- [`QueryCollectionError`](../QueryCollectionError.md) +- [`QueryCollectionError`](./QueryCollectionError.md) ## Constructors @@ -33,7 +33,7 @@ Defined in: [packages/query-db-collection/src/errors.ts:70](https://github.com/T #### Overrides -[`QueryCollectionError`](../QueryCollectionError.md).[`constructor`](../QueryCollectionError.md#constructor) +[`QueryCollectionError`](./QueryCollectionError.md).[`constructor`](./QueryCollectionError.md#constructor) ## Properties @@ -47,7 +47,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`cause`](../QueryCollectionError.md#cause) +[`QueryCollectionError`](./QueryCollectionError.md).[`cause`](./QueryCollectionError.md#cause) *** @@ -61,7 +61,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`message`](../QueryCollectionError.md#message) +[`QueryCollectionError`](./QueryCollectionError.md).[`message`](./QueryCollectionError.md#message) *** @@ -75,7 +75,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`name`](../QueryCollectionError.md#name) +[`QueryCollectionError`](./QueryCollectionError.md).[`name`](./QueryCollectionError.md#name) *** @@ -89,7 +89,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stack`](../QueryCollectionError.md#stack) +[`QueryCollectionError`](./QueryCollectionError.md).[`stack`](./QueryCollectionError.md#stack) *** @@ -113,7 +113,7 @@ not capture any frames. #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`stackTraceLimit`](../QueryCollectionError.md#stacktracelimit) +[`QueryCollectionError`](./QueryCollectionError.md).[`stackTraceLimit`](./QueryCollectionError.md#stacktracelimit) ## Methods @@ -185,7 +185,7 @@ a(); #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`captureStackTrace`](../QueryCollectionError.md#capturestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`captureStackTrace`](./QueryCollectionError.md#capturestacktrace) *** @@ -217,4 +217,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -[`QueryCollectionError`](../QueryCollectionError.md).[`prepareStackTrace`](../QueryCollectionError.md#preparestacktrace) +[`QueryCollectionError`](./QueryCollectionError.md).[`prepareStackTrace`](./QueryCollectionError.md#preparestacktrace) diff --git a/docs/reference/query-db-collection/functions/queryCollectionOptions.md b/docs/reference/query-db-collection/functions/queryCollectionOptions.md index b8a20f242..3aab0096f 100644 --- a/docs/reference/query-db-collection/functions/queryCollectionOptions.md +++ b/docs/reference/query-db-collection/functions/queryCollectionOptions.md @@ -58,13 +58,13 @@ The type of the item keys #### config -[`QueryCollectionConfig`](../../interfaces/QueryCollectionConfig.md)\<`InferSchemaOutput`\<`T`\>, `TQueryFn`, `TError`, `TQueryKey`, `TKey`, `T`, `Awaited`\<`ReturnType`\<`TQueryFn`\>\>\> & `object` +[`QueryCollectionConfig`](../interfaces/QueryCollectionConfig.md)\<`InferSchemaOutput`\<`T`\>, `TQueryFn`, `TError`, `TQueryKey`, `TKey`, `T`, `Awaited`\<`ReturnType`\<`TQueryFn`\>\>\> & `object` Configuration options for the Query collection ### Returns -`CollectionConfig`\<`InferSchemaOutput`\<`T`\>, `TKey`, `T`, [`QueryCollectionUtils`](../../interfaces/QueryCollectionUtils.md)\<`InferSchemaOutput`\<`T`\>, `TKey`, `InferSchemaInput`\<`T`\>, `TError`\>\> & `object` +`CollectionConfig`\<`InferSchemaOutput`\<`T`\>, `TKey`, `T`, [`QueryCollectionUtils`](../interfaces/QueryCollectionUtils.md)\<`InferSchemaOutput`\<`T`\>, `TKey`, `InferSchemaInput`\<`T`\>, `TError`\>\> & `object` Collection options with utilities for direct writes and manual operations @@ -198,13 +198,13 @@ The type of the item keys #### config -[`QueryCollectionConfig`](../../interfaces/QueryCollectionConfig.md)\<`T`, `TQueryFn`, `TError`, `TQueryKey`, `TKey`, `never`, `TQueryData`\> & `object` +[`QueryCollectionConfig`](../interfaces/QueryCollectionConfig.md)\<`T`, `TQueryFn`, `TError`, `TQueryKey`, `TKey`, `never`, `TQueryData`\> & `object` Configuration options for the Query collection ### Returns -`CollectionConfig`\<`T`, `TKey`, `never`, [`QueryCollectionUtils`](../../interfaces/QueryCollectionUtils.md)\<`T`, `TKey`, `T`, `TError`\>\> & `object` +`CollectionConfig`\<`T`, `TKey`, `never`, [`QueryCollectionUtils`](../interfaces/QueryCollectionUtils.md)\<`T`, `TKey`, `T`, `TError`\>\> & `object` Collection options with utilities for direct writes and manual operations @@ -330,13 +330,13 @@ The type of the item keys #### config -[`QueryCollectionConfig`](../../interfaces/QueryCollectionConfig.md)\<`InferSchemaOutput`\<`T`\>, (`context`) => `Promise`\<`InferSchemaOutput`\<`T`\>[]\>, `TError`, `TQueryKey`, `TKey`, `T`, `InferSchemaOutput`\<`T`\>[]\> & `object` +[`QueryCollectionConfig`](../interfaces/QueryCollectionConfig.md)\<`InferSchemaOutput`\<`T`\>, (`context`) => `Promise`\<`InferSchemaOutput`\<`T`\>[]\>, `TError`, `TQueryKey`, `TKey`, `T`, `InferSchemaOutput`\<`T`\>[]\> & `object` Configuration options for the Query collection ### Returns -`CollectionConfig`\<`InferSchemaOutput`\<`T`\>, `TKey`, `T`, [`QueryCollectionUtils`](../../interfaces/QueryCollectionUtils.md)\<`InferSchemaOutput`\<`T`\>, `TKey`, `InferSchemaInput`\<`T`\>, `TError`\>\> & `object` +`CollectionConfig`\<`InferSchemaOutput`\<`T`\>, `TKey`, `T`, [`QueryCollectionUtils`](../interfaces/QueryCollectionUtils.md)\<`InferSchemaOutput`\<`T`\>, `TKey`, `InferSchemaInput`\<`T`\>, `TError`\>\> & `object` Collection options with utilities for direct writes and manual operations @@ -462,13 +462,13 @@ The type of the item keys #### config -[`QueryCollectionConfig`](../../interfaces/QueryCollectionConfig.md)\<`T`, (`context`) => `Promise`\<`T`[]\>, `TError`, `TQueryKey`, `TKey`, `never`, `T`[]\> & `object` +[`QueryCollectionConfig`](../interfaces/QueryCollectionConfig.md)\<`T`, (`context`) => `Promise`\<`T`[]\>, `TError`, `TQueryKey`, `TKey`, `never`, `T`[]\> & `object` Configuration options for the Query collection ### Returns -`CollectionConfig`\<`T`, `TKey`, `never`, [`QueryCollectionUtils`](../../interfaces/QueryCollectionUtils.md)\<`T`, `TKey`, `T`, `TError`\>\> & `object` +`CollectionConfig`\<`T`, `TKey`, `never`, [`QueryCollectionUtils`](../interfaces/QueryCollectionUtils.md)\<`T`, `TKey`, `T`, `TError`\>\> & `object` Collection options with utilities for direct writes and manual operations diff --git a/docs/reference/query-db-collection/index.md b/docs/reference/query-db-collection/index.md index c75c60703..7449dd1d1 100644 --- a/docs/reference/query-db-collection/index.md +++ b/docs/reference/query-db-collection/index.md @@ -7,31 +7,31 @@ title: "@tanstack/query-db-collection" ## Classes -- [DeleteOperationItemNotFoundError](../classes/DeleteOperationItemNotFoundError.md) -- [DuplicateKeyInBatchError](../classes/DuplicateKeyInBatchError.md) -- [GetKeyRequiredError](../classes/GetKeyRequiredError.md) -- [InvalidItemStructureError](../classes/InvalidItemStructureError.md) -- [InvalidSyncOperationError](../classes/InvalidSyncOperationError.md) -- [ItemNotFoundError](../classes/ItemNotFoundError.md) -- [MissingKeyFieldError](../classes/MissingKeyFieldError.md) -- [QueryClientRequiredError](../classes/QueryClientRequiredError.md) -- [QueryCollectionError](../classes/QueryCollectionError.md) -- [QueryFnRequiredError](../classes/QueryFnRequiredError.md) -- [QueryKeyRequiredError](../classes/QueryKeyRequiredError.md) -- [SyncNotInitializedError](../classes/SyncNotInitializedError.md) -- [UnknownOperationTypeError](../classes/UnknownOperationTypeError.md) -- [UpdateOperationItemNotFoundError](../classes/UpdateOperationItemNotFoundError.md) +- [DeleteOperationItemNotFoundError](./classes/DeleteOperationItemNotFoundError.md) +- [DuplicateKeyInBatchError](./classes/DuplicateKeyInBatchError.md) +- [GetKeyRequiredError](./classes/GetKeyRequiredError.md) +- [InvalidItemStructureError](./classes/InvalidItemStructureError.md) +- [InvalidSyncOperationError](./classes/InvalidSyncOperationError.md) +- [ItemNotFoundError](./classes/ItemNotFoundError.md) +- [MissingKeyFieldError](./classes/MissingKeyFieldError.md) +- [QueryClientRequiredError](./classes/QueryClientRequiredError.md) +- [QueryCollectionError](./classes/QueryCollectionError.md) +- [QueryFnRequiredError](./classes/QueryFnRequiredError.md) +- [QueryKeyRequiredError](./classes/QueryKeyRequiredError.md) +- [SyncNotInitializedError](./classes/SyncNotInitializedError.md) +- [UnknownOperationTypeError](./classes/UnknownOperationTypeError.md) +- [UpdateOperationItemNotFoundError](./classes/UpdateOperationItemNotFoundError.md) ## Interfaces -- [QueryCollectionConfig](../interfaces/QueryCollectionConfig.md) -- [QueryCollectionMeta](../interfaces/QueryCollectionMeta.md) -- [QueryCollectionUtils](../interfaces/QueryCollectionUtils.md) +- [QueryCollectionConfig](./interfaces/QueryCollectionConfig.md) +- [QueryCollectionMeta](./interfaces/QueryCollectionMeta.md) +- [QueryCollectionUtils](./interfaces/QueryCollectionUtils.md) ## Type Aliases -- [SyncOperation](../type-aliases/SyncOperation.md) +- [SyncOperation](./type-aliases/SyncOperation.md) ## Functions -- [queryCollectionOptions](../functions/queryCollectionOptions.md) +- [queryCollectionOptions](./functions/queryCollectionOptions.md) diff --git a/docs/reference/type-aliases/ChangeListener.md b/docs/reference/type-aliases/ChangeListener.md index 5c5950806..2c6c931b2 100644 --- a/docs/reference/type-aliases/ChangeListener.md +++ b/docs/reference/type-aliases/ChangeListener.md @@ -27,7 +27,7 @@ Function type for listening to collection changes ### changes -[`ChangeMessage`](../../interfaces/ChangeMessage.md)\<`T`, `TKey`\>[] +[`ChangeMessage`](../interfaces/ChangeMessage.md)\<`T`, `TKey`\>[] Array of change messages describing what happened diff --git a/docs/reference/type-aliases/CollectionConfigSingleRowOption.md b/docs/reference/type-aliases/CollectionConfigSingleRowOption.md index 950a98e3f..550b4bd16 100644 --- a/docs/reference/type-aliases/CollectionConfigSingleRowOption.md +++ b/docs/reference/type-aliases/CollectionConfigSingleRowOption.md @@ -27,5 +27,5 @@ Defined in: [packages/db/src/types.ts:674](https://github.com/TanStack/db/blob/m ### TUtils -`TUtils` *extends* [`UtilsRecord`](../UtilsRecord.md) = \{ +`TUtils` *extends* [`UtilsRecord`](./UtilsRecord.md) = \{ \} diff --git a/docs/reference/type-aliases/DeleteMutationFn.md b/docs/reference/type-aliases/DeleteMutationFn.md index 5f48caad8..7c5c1ada1 100644 --- a/docs/reference/type-aliases/DeleteMutationFn.md +++ b/docs/reference/type-aliases/DeleteMutationFn.md @@ -23,7 +23,7 @@ Defined in: [packages/db/src/types.ts:402](https://github.com/TanStack/db/blob/m ### TUtils -`TUtils` *extends* [`UtilsRecord`](../UtilsRecord.md) = [`UtilsRecord`](../UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](./UtilsRecord.md) = [`UtilsRecord`](./UtilsRecord.md) ### TReturn @@ -33,7 +33,7 @@ Defined in: [packages/db/src/types.ts:402](https://github.com/TanStack/db/blob/m ### params -[`DeleteMutationFnParams`](../DeleteMutationFnParams.md)\<`T`, `TKey`, `TUtils`\> +[`DeleteMutationFnParams`](./DeleteMutationFnParams.md)\<`T`, `TKey`, `TUtils`\> ## Returns diff --git a/docs/reference/type-aliases/DeleteMutationFnParams.md b/docs/reference/type-aliases/DeleteMutationFnParams.md index 872eccd9b..fa1cf399c 100644 --- a/docs/reference/type-aliases/DeleteMutationFnParams.md +++ b/docs/reference/type-aliases/DeleteMutationFnParams.md @@ -23,7 +23,7 @@ Defined in: [packages/db/src/types.ts:379](https://github.com/TanStack/db/blob/m ### TUtils -`TUtils` *extends* [`UtilsRecord`](../UtilsRecord.md) = [`UtilsRecord`](../UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](./UtilsRecord.md) = [`UtilsRecord`](./UtilsRecord.md) ## Properties diff --git a/docs/reference/type-aliases/GetResult.md b/docs/reference/type-aliases/GetResult.md index fde3475a2..8a311ca9d 100644 --- a/docs/reference/type-aliases/GetResult.md +++ b/docs/reference/type-aliases/GetResult.md @@ -39,4 +39,4 @@ complex intersection types into readable object types. ### TContext -`TContext` *extends* [`Context`](../../interfaces/Context.md) +`TContext` *extends* [`Context`](../interfaces/Context.md) diff --git a/docs/reference/type-aliases/IndexConstructor.md b/docs/reference/type-aliases/IndexConstructor.md index fa3e2d37b..37b7a182a 100644 --- a/docs/reference/type-aliases/IndexConstructor.md +++ b/docs/reference/type-aliases/IndexConstructor.md @@ -27,7 +27,7 @@ Type for index constructor ### expression -[`BasicExpression`](../../@tanstack/namespaces/IR/type-aliases/BasicExpression.md) +[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md) ### name? @@ -39,4 +39,4 @@ Type for index constructor ## Returns -[`BaseIndex`](../../classes/BaseIndex.md)\<`TKey`\> +[`BaseIndex`](../classes/BaseIndex.md)\<`TKey`\> diff --git a/docs/reference/type-aliases/InferResultType.md b/docs/reference/type-aliases/InferResultType.md index 851862eee..76e19e763 100644 --- a/docs/reference/type-aliases/InferResultType.md +++ b/docs/reference/type-aliases/InferResultType.md @@ -17,4 +17,4 @@ Utility type to infer the query result size (single row or an array) ### TContext -`TContext` *extends* [`Context`](../../interfaces/Context.md) +`TContext` *extends* [`Context`](../interfaces/Context.md) diff --git a/docs/reference/type-aliases/InsertMutationFn.md b/docs/reference/type-aliases/InsertMutationFn.md index 573a31414..458c76219 100644 --- a/docs/reference/type-aliases/InsertMutationFn.md +++ b/docs/reference/type-aliases/InsertMutationFn.md @@ -23,7 +23,7 @@ Defined in: [packages/db/src/types.ts:388](https://github.com/TanStack/db/blob/m ### TUtils -`TUtils` *extends* [`UtilsRecord`](../UtilsRecord.md) = [`UtilsRecord`](../UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](./UtilsRecord.md) = [`UtilsRecord`](./UtilsRecord.md) ### TReturn @@ -33,7 +33,7 @@ Defined in: [packages/db/src/types.ts:388](https://github.com/TanStack/db/blob/m ### params -[`InsertMutationFnParams`](../InsertMutationFnParams.md)\<`T`, `TKey`, `TUtils`\> +[`InsertMutationFnParams`](./InsertMutationFnParams.md)\<`T`, `TKey`, `TUtils`\> ## Returns diff --git a/docs/reference/type-aliases/InsertMutationFnParams.md b/docs/reference/type-aliases/InsertMutationFnParams.md index 6080b4a33..69258624b 100644 --- a/docs/reference/type-aliases/InsertMutationFnParams.md +++ b/docs/reference/type-aliases/InsertMutationFnParams.md @@ -23,7 +23,7 @@ Defined in: [packages/db/src/types.ts:371](https://github.com/TanStack/db/blob/m ### TUtils -`TUtils` *extends* [`UtilsRecord`](../UtilsRecord.md) = [`UtilsRecord`](../UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](./UtilsRecord.md) = [`UtilsRecord`](./UtilsRecord.md) ## Properties diff --git a/docs/reference/type-aliases/LoadSubsetFn.md b/docs/reference/type-aliases/LoadSubsetFn.md index 9c6d796e5..0872eaefc 100644 --- a/docs/reference/type-aliases/LoadSubsetFn.md +++ b/docs/reference/type-aliases/LoadSubsetFn.md @@ -15,7 +15,7 @@ Defined in: [packages/db/src/types.ts:274](https://github.com/TanStack/db/blob/m ### options -[`LoadSubsetOptions`](../LoadSubsetOptions.md) +[`LoadSubsetOptions`](./LoadSubsetOptions.md) ## Returns diff --git a/docs/reference/type-aliases/MutationFn.md b/docs/reference/type-aliases/MutationFn.md index 146de19e0..1bf4373d6 100644 --- a/docs/reference/type-aliases/MutationFn.md +++ b/docs/reference/type-aliases/MutationFn.md @@ -21,7 +21,7 @@ Defined in: [packages/db/src/types.ts:126](https://github.com/TanStack/db/blob/m ### params -[`MutationFnParams`](../MutationFnParams.md)\<`T`\> +[`MutationFnParams`](./MutationFnParams.md)\<`T`\> ## Returns diff --git a/docs/reference/type-aliases/QueryBuilder.md b/docs/reference/type-aliases/QueryBuilder.md index 63ca2622f..314c04f38 100644 --- a/docs/reference/type-aliases/QueryBuilder.md +++ b/docs/reference/type-aliases/QueryBuilder.md @@ -15,4 +15,4 @@ Defined in: [packages/db/src/query/builder/index.ts:850](https://github.com/TanS ### TContext -`TContext` *extends* [`Context`](../../interfaces/Context.md) +`TContext` *extends* [`Context`](../interfaces/Context.md) diff --git a/docs/reference/type-aliases/ResolveTransactionChanges.md b/docs/reference/type-aliases/ResolveTransactionChanges.md index d8349caab..89af36e85 100644 --- a/docs/reference/type-aliases/ResolveTransactionChanges.md +++ b/docs/reference/type-aliases/ResolveTransactionChanges.md @@ -19,7 +19,7 @@ Defined in: [packages/db/src/types.ts:79](https://github.com/TanStack/db/blob/ma ### TOperation -`TOperation` *extends* [`OperationType`](../OperationType.md) = [`OperationType`](../OperationType.md) +`TOperation` *extends* [`OperationType`](./OperationType.md) = [`OperationType`](./OperationType.md) ## Remarks diff --git a/docs/reference/type-aliases/StrategyOptions.md b/docs/reference/type-aliases/StrategyOptions.md index e4b212030..b6eacb4bf 100644 --- a/docs/reference/type-aliases/StrategyOptions.md +++ b/docs/reference/type-aliases/StrategyOptions.md @@ -17,4 +17,4 @@ Extract the options type from a strategy ### T -`T` *extends* [`Strategy`](../Strategy.md) +`T` *extends* [`Strategy`](./Strategy.md) diff --git a/docs/reference/type-aliases/TransactionWithMutations.md b/docs/reference/type-aliases/TransactionWithMutations.md index 493335cd9..417a0df00 100644 --- a/docs/reference/type-aliases/TransactionWithMutations.md +++ b/docs/reference/type-aliases/TransactionWithMutations.md @@ -48,4 +48,4 @@ With `Omit`: ### TOperation -`TOperation` *extends* [`OperationType`](../OperationType.md) = [`OperationType`](../OperationType.md) +`TOperation` *extends* [`OperationType`](./OperationType.md) = [`OperationType`](./OperationType.md) diff --git a/docs/reference/type-aliases/UnloadSubsetFn.md b/docs/reference/type-aliases/UnloadSubsetFn.md index 3a8eb3d37..abeb57229 100644 --- a/docs/reference/type-aliases/UnloadSubsetFn.md +++ b/docs/reference/type-aliases/UnloadSubsetFn.md @@ -15,7 +15,7 @@ Defined in: [packages/db/src/types.ts:276](https://github.com/TanStack/db/blob/m ### options -[`LoadSubsetOptions`](../LoadSubsetOptions.md) +[`LoadSubsetOptions`](./LoadSubsetOptions.md) ## Returns diff --git a/docs/reference/type-aliases/UpdateMutationFn.md b/docs/reference/type-aliases/UpdateMutationFn.md index cda049813..712ace30b 100644 --- a/docs/reference/type-aliases/UpdateMutationFn.md +++ b/docs/reference/type-aliases/UpdateMutationFn.md @@ -23,7 +23,7 @@ Defined in: [packages/db/src/types.ts:395](https://github.com/TanStack/db/blob/m ### TUtils -`TUtils` *extends* [`UtilsRecord`](../UtilsRecord.md) = [`UtilsRecord`](../UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](./UtilsRecord.md) = [`UtilsRecord`](./UtilsRecord.md) ### TReturn @@ -33,7 +33,7 @@ Defined in: [packages/db/src/types.ts:395](https://github.com/TanStack/db/blob/m ### params -[`UpdateMutationFnParams`](../UpdateMutationFnParams.md)\<`T`, `TKey`, `TUtils`\> +[`UpdateMutationFnParams`](./UpdateMutationFnParams.md)\<`T`, `TKey`, `TUtils`\> ## Returns diff --git a/docs/reference/type-aliases/UpdateMutationFnParams.md b/docs/reference/type-aliases/UpdateMutationFnParams.md index 56e33c0e0..38a77e83b 100644 --- a/docs/reference/type-aliases/UpdateMutationFnParams.md +++ b/docs/reference/type-aliases/UpdateMutationFnParams.md @@ -23,7 +23,7 @@ Defined in: [packages/db/src/types.ts:362](https://github.com/TanStack/db/blob/m ### TUtils -`TUtils` *extends* [`UtilsRecord`](../UtilsRecord.md) = [`UtilsRecord`](../UtilsRecord.md) +`TUtils` *extends* [`UtilsRecord`](./UtilsRecord.md) = [`UtilsRecord`](./UtilsRecord.md) ## Properties diff --git a/eslint.config.js b/eslint.config.js index 02e6c5438..5c4455420 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -1,4 +1,4 @@ -import { tanstackConfig } from '@tanstack/config/eslint' +import { tanstackConfig } from '@tanstack/eslint-config' export default [ ...tanstackConfig, diff --git a/package.json b/package.json index dfdca1007..c22c1f672 100644 --- a/package.json +++ b/package.json @@ -25,7 +25,9 @@ "@changesets/cli": "^2.29.8", "@eslint/js": "^9.39.1", "@svitejs/changesets-changelog-github-compact": "^1.2.0", - "@tanstack/config": "^0.22.2", + "@tanstack/eslint-config": "0.3.3", + "@tanstack/typedoc-config": "0.3.2", + "@tanstack/vite-config": "0.4.1", "@testing-library/jest-dom": "^6.9.1", "@types/node": "^24.6.2", "@types/react": "^19.2.7", diff --git a/packages/angular-db/vite.config.ts b/packages/angular-db/vite.config.ts index 1f06ceeef..2ae761c92 100644 --- a/packages/angular-db/vite.config.ts +++ b/packages/angular-db/vite.config.ts @@ -1,5 +1,5 @@ import { defineConfig, mergeConfig } from 'vitest/config' -import { tanstackViteConfig } from '@tanstack/config/vite' +import { tanstackViteConfig } from '@tanstack/vite-config' import packageJson from './package.json' const config = defineConfig({ diff --git a/packages/db-ivm/vite.config.ts b/packages/db-ivm/vite.config.ts index fe5e1f6dc..aa589f666 100644 --- a/packages/db-ivm/vite.config.ts +++ b/packages/db-ivm/vite.config.ts @@ -1,5 +1,5 @@ import { defineConfig, mergeConfig } from 'vitest/config' -import { tanstackViteConfig } from '@tanstack/config/vite' +import { tanstackViteConfig } from '@tanstack/vite-config' import packageJson from './package.json' const config = defineConfig({ diff --git a/packages/db/vite.config.ts b/packages/db/vite.config.ts index 5824697c9..62e1a9df2 100644 --- a/packages/db/vite.config.ts +++ b/packages/db/vite.config.ts @@ -1,5 +1,5 @@ import { defineConfig, mergeConfig } from 'vitest/config' -import { tanstackViteConfig } from '@tanstack/config/vite' +import { tanstackViteConfig } from '@tanstack/vite-config' import packageJson from './package.json' const config = defineConfig({ diff --git a/packages/electric-db-collection/vite.config.ts b/packages/electric-db-collection/vite.config.ts index c47f4708f..b8c7930f0 100644 --- a/packages/electric-db-collection/vite.config.ts +++ b/packages/electric-db-collection/vite.config.ts @@ -1,5 +1,5 @@ import { defineConfig, mergeConfig } from 'vitest/config' -import { tanstackViteConfig } from '@tanstack/config/vite' +import { tanstackViteConfig } from '@tanstack/vite-config' import packageJson from './package.json' const config = defineConfig({ diff --git a/packages/offline-transactions/vite.config.ts b/packages/offline-transactions/vite.config.ts index fe5e1f6dc..aa589f666 100644 --- a/packages/offline-transactions/vite.config.ts +++ b/packages/offline-transactions/vite.config.ts @@ -1,5 +1,5 @@ import { defineConfig, mergeConfig } from 'vitest/config' -import { tanstackViteConfig } from '@tanstack/config/vite' +import { tanstackViteConfig } from '@tanstack/vite-config' import packageJson from './package.json' const config = defineConfig({ diff --git a/packages/powersync-db-collection/vite.config.ts b/packages/powersync-db-collection/vite.config.ts index 1628bbeee..8f43b798f 100644 --- a/packages/powersync-db-collection/vite.config.ts +++ b/packages/powersync-db-collection/vite.config.ts @@ -1,4 +1,4 @@ -import { tanstackViteConfig } from '@tanstack/config/vite' +import { tanstackViteConfig } from '@tanstack/vite-config' import { defineConfig, mergeConfig } from 'vitest/config' import packageJson from './package.json' diff --git a/packages/query-db-collection/vite.config.ts b/packages/query-db-collection/vite.config.ts index c47f4708f..b8c7930f0 100644 --- a/packages/query-db-collection/vite.config.ts +++ b/packages/query-db-collection/vite.config.ts @@ -1,5 +1,5 @@ import { defineConfig, mergeConfig } from 'vitest/config' -import { tanstackViteConfig } from '@tanstack/config/vite' +import { tanstackViteConfig } from '@tanstack/vite-config' import packageJson from './package.json' const config = defineConfig({ diff --git a/packages/react-db/vite.config.ts b/packages/react-db/vite.config.ts index f5948f583..1e193ca2f 100644 --- a/packages/react-db/vite.config.ts +++ b/packages/react-db/vite.config.ts @@ -1,5 +1,5 @@ import { defineConfig, mergeConfig } from 'vitest/config' -import { tanstackViteConfig } from '@tanstack/config/vite' +import { tanstackViteConfig } from '@tanstack/vite-config' import react from '@vitejs/plugin-react' import packageJson from './package.json' diff --git a/packages/rxdb-db-collection/vite.config.ts b/packages/rxdb-db-collection/vite.config.ts index fe5e1f6dc..aa589f666 100644 --- a/packages/rxdb-db-collection/vite.config.ts +++ b/packages/rxdb-db-collection/vite.config.ts @@ -1,5 +1,5 @@ import { defineConfig, mergeConfig } from 'vitest/config' -import { tanstackViteConfig } from '@tanstack/config/vite' +import { tanstackViteConfig } from '@tanstack/vite-config' import packageJson from './package.json' const config = defineConfig({ diff --git a/packages/solid-db/vite.config.ts b/packages/solid-db/vite.config.ts index 1b0ad7717..aa8d1d9f3 100644 --- a/packages/solid-db/vite.config.ts +++ b/packages/solid-db/vite.config.ts @@ -1,5 +1,5 @@ import { defineConfig, mergeConfig } from 'vitest/config' -import { tanstackViteConfig } from '@tanstack/config/vite' +import { tanstackViteConfig } from '@tanstack/vite-config' import solidPlugin from 'vite-plugin-solid' import packageJson from './package.json' diff --git a/packages/trailbase-db-collection/vite.config.ts b/packages/trailbase-db-collection/vite.config.ts index fe5e1f6dc..aa589f666 100644 --- a/packages/trailbase-db-collection/vite.config.ts +++ b/packages/trailbase-db-collection/vite.config.ts @@ -1,5 +1,5 @@ import { defineConfig, mergeConfig } from 'vitest/config' -import { tanstackViteConfig } from '@tanstack/config/vite' +import { tanstackViteConfig } from '@tanstack/vite-config' import packageJson from './package.json' const config = defineConfig({ diff --git a/packages/vue-db/vite.config.ts b/packages/vue-db/vite.config.ts index 2a8e8ff1b..7fffa40fc 100644 --- a/packages/vue-db/vite.config.ts +++ b/packages/vue-db/vite.config.ts @@ -1,5 +1,5 @@ import { defineConfig, mergeConfig } from 'vitest/config' -import { tanstackViteConfig } from '@tanstack/config/vite' +import { tanstackViteConfig } from '@tanstack/vite-config' import vue from '@vitejs/plugin-vue' import packageJson from './package.json' diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 6433912ff..90539221a 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -38,9 +38,15 @@ importers: '@svitejs/changesets-changelog-github-compact': specifier: ^1.2.0 version: 1.2.0(encoding@0.1.13) - '@tanstack/config': - specifier: ^0.22.2 - version: 0.22.2(@types/node@24.7.0)(@typescript-eslint/utils@8.48.0(eslint@9.39.1(jiti@2.6.1))(typescript@5.9.3))(eslint@9.39.1(jiti@2.6.1))(rollup@4.52.5)(typescript@5.9.3)(vite@7.2.6(@types/node@24.7.0)(jiti@2.6.1)(lightningcss@1.30.2)(sass@1.90.0)(terser@5.44.0)(tsx@4.21.0)(yaml@2.8.1)) + '@tanstack/eslint-config': + specifier: 0.3.3 + version: 0.3.3(@typescript-eslint/utils@8.48.0(eslint@9.39.1(jiti@2.6.1))(typescript@5.9.3))(eslint@9.39.1(jiti@2.6.1))(typescript@5.9.3) + '@tanstack/typedoc-config': + specifier: 0.3.2 + version: 0.3.2(typescript@5.9.3) + '@tanstack/vite-config': + specifier: 0.4.1 + version: 0.4.1(@types/node@24.7.0)(rollup@4.52.5)(typescript@5.9.3)(vite@7.2.6(@types/node@24.7.0)(jiti@2.6.1)(lightningcss@1.30.2)(sass@1.90.0)(terser@5.44.0)(tsx@4.21.0)(yaml@2.8.1)) '@testing-library/jest-dom': specifier: ^6.9.1 version: 6.9.1 @@ -1531,14 +1537,6 @@ packages: resolution: {integrity: sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==} engines: {node: '>=0.1.90'} - '@commitlint/parse@20.0.0': - resolution: {integrity: sha512-j/PHCDX2bGM5xGcWObOvpOc54cXjn9g6xScXzAeOLwTsScaL4Y+qd0pFC6HBwTtrH92NvJQc+2Lx9HFkVi48cg==} - engines: {node: '>=v18'} - - '@commitlint/types@20.0.0': - resolution: {integrity: sha512-bVUNBqG6aznYcYjTjnc3+Cat/iBgbgpflxbIBTnsHTX0YVpnmINPEkSRWymT2Q8aSH3Y7aKnEbunilkYe8TybA==} - engines: {node: '>=v18'} - '@csstools/color-helpers@5.1.0': resolution: {integrity: sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==} engines: {node: '>=18'} @@ -2679,12 +2677,6 @@ packages: '@jridgewell/trace-mapping@0.3.31': resolution: {integrity: sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw==} - '@kwsites/file-exists@1.1.1': - resolution: {integrity: sha512-m9/5YGR18lIwxSFDwfE3oA7bWuq9kdau6ugN4H2rJeyhFQZcG9AgSHkQtSD15a8WvTgfz9aikZMrKPHvbpqFiw==} - - '@kwsites/promise-deferred@1.1.1': - resolution: {integrity: sha512-GaHYm+c0O9MjZRu0ongGBRbinu8gVAMd2UZjji6jVmqKtZluZnptXGWhz1E8j8D2HJ3f/yMxKAUC0b+57wncIw==} - '@levischuck/tiny-cbor@0.2.11': resolution: {integrity: sha512-llBRm4dT4Z89aRsm6u2oEZ8tfwL/2l6BwpZ7JcyieouniDECM5AqNgr/y08zalEIvW3RSK4upYyybDcmjXqAow==} @@ -3796,10 +3788,6 @@ packages: peerDependencies: vite: ^5.2.0 || ^6 || ^7 - '@tanstack/config@0.22.2': - resolution: {integrity: sha512-zP1b6xd864AOOJQ7u6r+kicohRc8dAyql6sBbQh2f2RjoEynAfn0GrMHGeqhl1LN8JThokCkcjfGnXbPEz3q3A==} - engines: {node: '>=18'} - '@tanstack/directive-functions-plugin@1.139.0': resolution: {integrity: sha512-qLGxldnWa0pp/siZEFEYDU+eB/j40bd1V3IuTzP0sFnrYi11Ldx1yVkOruDKUbO1WM0o+OlPhp22Q1h+LMdDMA==} engines: {node: '>=12'} @@ -3818,10 +3806,6 @@ packages: resolution: {integrity: sha512-a5A0PI0H4npUy7u3VOjOhdynXnRBna+mDvpt8ghDCVzS3Tgn8DlGzHlRqS2rKJP8ZcLuVO2qxlIIblhcoaiv8Q==} engines: {node: '>=18'} - '@tanstack/publish-config@0.2.2': - resolution: {integrity: sha512-hTW2rLeZLBMmpwVzWmUJ5L50hPlf4Ea74rZtecbT6qQYCT16JEAbryfHm1u07KIICI2vEArsm2YguckjODqx0w==} - engines: {node: '>=18'} - '@tanstack/query-core@5.90.11': resolution: {integrity: sha512-f9z/nXhCgWDF4lHqgIE30jxLe4sYv15QodfdPDKYAk7nAEjNcndy4dHz3ezhdUaR23BpWa4I2EH4/DZ0//Uf8A==} @@ -4076,9 +4060,6 @@ packages: '@types/connect@3.4.38': resolution: {integrity: sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug==} - '@types/conventional-commits-parser@5.0.1': - resolution: {integrity: sha512-7uz5EHdzz2TqoMfV7ee61Egf5y6NkcO4FB/1iCCQnbeiI1F3xzv3vK5dBCXUCLQgGYS+mUeigK1iKQzvED+QnQ==} - '@types/cors@2.8.19': resolution: {integrity: sha512-mFNylyeyqN93lfe/9CSxOGREz8cpzAhH+E93xJ4xWQf62V8sQ/24reV2nyzUWM6H6Xji+GGHpkbLe7pVoUEskg==} @@ -4523,10 +4504,6 @@ packages: '@yarnpkg/lockfile@1.1.0': resolution: {integrity: sha512-GpSwvyXOcOOlV70vbnzjj4fW5xW/FdUF6nQEt1ENy7m4ZCczi1+/buVUPAqmGfqznsORNFzUMjctTIp8a9tuCQ==} - JSONStream@1.3.5: - resolution: {integrity: sha512-E+iruNOY8VV9s4JEbe1aNEm6MiszPRr/UfcHMz0TQh1BXSxHK+ASV1R6W4HpjBhSeS+54PIsAMCBmwD06LLsqQ==} - hasBin: true - abbrev@3.0.1: resolution: {integrity: sha512-AO2ac6pjRB3SJmGJo+v5/aK6Omggp6fsLrs6wN9bd35ulu4cCwaAU9+7ZhXjeqHVkaHThLuzH0nZr0YpCDhygg==} engines: {node: ^18.17.0 || >=20.5.0} @@ -4657,9 +4634,6 @@ packages: array-flatten@1.1.1: resolution: {integrity: sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==} - array-ify@1.0.0: - resolution: {integrity: sha512-c5AMf34bKdvPhQ7tBGhqkgKNUzMr4WUs+WDtC2ZUGOUncbxKMTvqxYctiseW3+L4bA8ec+GcZ6/A/FW4m8ukng==} - array-includes@3.1.9: resolution: {integrity: sha512-FmeCCAenzH0KH381SPT5FZmiA/TmpndpcaShhfgEN9eCVjnFBqq3l1xrI42y8+PPLI6hypzou4GXw00WHmPBLQ==} engines: {node: '>= 0.4'} @@ -5001,9 +4975,6 @@ packages: resolution: {integrity: sha512-gk/Z852D2Wtb//0I+kRFNKKE9dIIVirjoqPoA1wJU+XePVXZfGeBpk45+A1rKO4Q43prqWBNY/MiIeRLbPWUaA==} engines: {node: '>=4.0.0'} - compare-func@2.0.0: - resolution: {integrity: sha512-zHig5N+tPWARooBnb0Zx1MFcdfpyJrfTJ3Y5L+IFvUm8rM74hHz66z0gw0x4tijh5CorKkKUCnW82R2vmpeCRA==} - compare-versions@6.1.1: resolution: {integrity: sha512-4hm4VPpIecmlg59CHXnRDnqGplJFrbLG4aFEl5vl6cK1u76ws3LLvX7ikFnTDl5vo39sjWD6AaDPYodJp/NNHg==} @@ -5037,15 +5008,6 @@ packages: resolution: {integrity: sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==} engines: {node: '>= 0.6'} - conventional-changelog-angular@7.0.0: - resolution: {integrity: sha512-ROjNchA9LgfNMTTFSIWPzebCwOGFdgkEq45EnvvrmSLvCtAw0HSmrCs7/ty+wAeYUZyNay0YMUNYFTRL72PkBQ==} - engines: {node: '>=16'} - - conventional-commits-parser@5.0.0: - resolution: {integrity: sha512-ZPMl0ZJbw74iS9LuX9YIAiW8pfM5p3yh2o/NbXHbkFuZzY5jvdi5jFycEOkmBW5H5I7nA+D6f3UcsCLP2vvSEA==} - engines: {node: '>=16'} - hasBin: true - convert-source-map@1.9.0: resolution: {integrity: sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A==} @@ -5290,10 +5252,6 @@ packages: domutils@3.2.2: resolution: {integrity: sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw==} - dot-prop@5.3.0: - resolution: {integrity: sha512-QM8q3zDe58hqUqjraQOmzZ1LIH9SWQJTlEKCH4kJ2oQvLZk7RbQXvtDM2XEq3fwkV9CCvvH4LA0AV+ogFsBM2Q==} - engines: {node: '>=8'} - dotenv@16.6.1: resolution: {integrity: sha512-uBq4egWHTcTt33a72vpSG0z3HnPuIl6NqYcTrKEg2azoEyl2hpW0zqlxysq2pK9HlDIHyHyakeYaYnSAwd8bow==} engines: {node: '>=12'} @@ -6365,10 +6323,6 @@ packages: resolution: {integrity: sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==} engines: {node: '>=0.12.0'} - is-obj@2.0.0: - resolution: {integrity: sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==} - engines: {node: '>=8'} - is-path-inside@3.0.3: resolution: {integrity: sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==} engines: {node: '>=8'} @@ -6417,10 +6371,6 @@ packages: resolution: {integrity: sha512-9gGx6GTtCQM73BgmHQXfDmLtfjjTUDSyoxTCbp5WtoixAhfgsDirWIcVQ/IHpvI5Vgd5i/J5F7B9cN/WlVbC/w==} engines: {node: '>= 0.4'} - is-text-path@2.0.0: - resolution: {integrity: sha512-+oDTluR6WEjdXEJMnC2z6A4FRwFoYuvShVVEGsS7ewc0UTi2QtAKMDJuL4BDEVt+5T7MjFo12RP8ghOM75oKJw==} - engines: {node: '>=8'} - is-typed-array@1.1.15: resolution: {integrity: sha512-p3EcsicXjit7SaskXHs1hA91QxgTw46Fv6EFKKGS5DRFLD8yKnohjF3hxoju94b/OcMZoQukzpPpBE9uLVKzgQ==} engines: {node: '>= 0.4'} @@ -6593,9 +6543,6 @@ packages: jsonfile@4.0.0: resolution: {integrity: sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==} - jsonfile@6.2.0: - resolution: {integrity: sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg==} - jsonparse@1.3.1: resolution: {integrity: sha512-POQXvpdL69+CluYsillJ7SUhKvytYjW9vG/GKpnf+xP8UWgYEM/RaMzHHofbALDiKbbP1W8UEYmgGl39WkPZsg==} engines: {'0': node >= 0.2.0} @@ -6900,10 +6847,6 @@ packages: memory-pager@1.5.0: resolution: {integrity: sha512-ZS4Bp4r/Zoeq6+NLJpP+0Zzm0pR8whtGPf1XExKLJBAczGMnSi3It14OiNCStjQjM6NU1okjQGSxgEZN8eBYKg==} - meow@12.1.1: - resolution: {integrity: sha512-BhXM0Au22RwUneMPwSCnyhTOizdWoIEPU9sp0Aqa1PnDMR5Wv2FGXYDjuzJEIX+Eo2Rb8xuYe5jrnm5QowQFkw==} - engines: {node: '>=16.10'} - merge-anything@5.1.7: resolution: {integrity: sha512-eRtbOb1N5iyH0tkQDAoQ4Ipsp/5qSR79Dzrz8hEPxRX10RWWR/iQXdoKmBSRCThY1Fh5EhISDtpSc93fpxUniQ==} engines: {node: '>=12.13'} @@ -8072,9 +8015,6 @@ packages: resolution: {integrity: sha512-ZpzWAFHIFqyFE56dXqgX/DkDRZdz+rRcjoIk/RQU4IX0wiCv1l8S7ZrXDHcCc+uaf+6o7w3h2l3g6GYG5TKN9Q==} engines: {node: ^18.17.0 || >=20.5.0} - simple-git@3.30.0: - resolution: {integrity: sha512-q6lxyDsCmEal/MEGhP1aVyQ3oxnagGlBDOVSIB4XUVLl1iZh0Pah6ebC9V4xBap/RfgP2WlI8EKs0WS0rMEJHg==} - simple-peer@9.11.1: resolution: {integrity: sha512-D1SaWpOW8afq1CZGWB8xTfrT3FekjQmPValrqncJMX7QFl8YwhrPTZvMCANLtgBwwdS+7zURyqxDDEmY558tTw==} @@ -8379,10 +8319,6 @@ packages: resolution: {integrity: sha512-pFYqmTw68LXVjeWJMST4+borgQP2AyMNbg1BpZh9LbyhUeNkeaPF9gzfPGUAnSMV3qPYdWUwDIjjCLiSDOl7vg==} engines: {node: '>=18'} - text-extensions@2.4.0: - resolution: {integrity: sha512-te/NtwBwfiNRLf9Ijqx3T0nlqZiQ2XrrtBvu+cLL8ZRrGkO0NHTug8MYFKyoSrv/sHTaSKfilUkizV6XhxMJ3g==} - engines: {node: '>=8'} - text-table@0.2.0: resolution: {integrity: sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==} @@ -8393,9 +8329,6 @@ packages: thenify@3.3.1: resolution: {integrity: sha512-RVZSIV5IG10Hk3enotrhvz0T9em6cyHBLkH/YAZuKqd8hRkKhSfCGIcP2KUY0EPxndzANBmNllzWPwak+bheSw==} - through@2.3.8: - resolution: {integrity: sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==} - tiny-invariant@1.3.3: resolution: {integrity: sha512-+FbBPE1o9QAYvviau/qC5SE3caw21q3xkvWKBtja5vgqOWIHHJ3ioaq1VPfn/Szqctz2bU/oYeKd9/z5BL+PVg==} @@ -8634,10 +8567,6 @@ packages: resolution: {integrity: sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==} engines: {node: '>= 4.0.0'} - universalify@2.0.1: - resolution: {integrity: sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==} - engines: {node: '>= 10.0.0'} - unload@2.4.1: resolution: {integrity: sha512-IViSAm8Z3sRBYA+9wc0fLQmU9Nrxb16rcDmIiR6Y9LJSZzI7QY5QsDhqPpKOjAn0O9/kfK1TfNEMMAGPTIraPw==} @@ -9862,17 +9791,6 @@ snapshots: '@colors/colors@1.5.0': {} - '@commitlint/parse@20.0.0': - dependencies: - '@commitlint/types': 20.0.0 - conventional-changelog-angular: 7.0.0 - conventional-commits-parser: 5.0.0 - - '@commitlint/types@20.0.0': - dependencies: - '@types/conventional-commits-parser': 5.0.1 - chalk: 5.6.2 - '@csstools/color-helpers@5.1.0': {} '@csstools/css-calc@2.1.4(@csstools/css-parser-algorithms@3.0.5(@csstools/css-tokenizer@3.0.4))(@csstools/css-tokenizer@3.0.4)': @@ -10841,14 +10759,6 @@ snapshots: '@jridgewell/resolve-uri': 3.1.2 '@jridgewell/sourcemap-codec': 1.5.5 - '@kwsites/file-exists@1.1.1': - dependencies: - debug: 4.4.3 - transitivePeerDependencies: - - supports-color - - '@kwsites/promise-deferred@1.1.1': {} - '@levischuck/tiny-cbor@0.2.11': {} '@listr2/prompt-adapter-inquirer@3.0.1(@inquirer/prompts@7.8.2(@types/node@24.7.0))(@types/node@24.7.0)(listr2@9.0.1)': @@ -11924,22 +11834,6 @@ snapshots: tailwindcss: 4.1.17 vite: 7.2.6(@types/node@22.18.1)(jiti@2.6.1)(lightningcss@1.30.2)(sass@1.90.0)(terser@5.44.0)(tsx@4.21.0)(yaml@2.8.1) - '@tanstack/config@0.22.2(@types/node@24.7.0)(@typescript-eslint/utils@8.48.0(eslint@9.39.1(jiti@2.6.1))(typescript@5.9.3))(eslint@9.39.1(jiti@2.6.1))(rollup@4.52.5)(typescript@5.9.3)(vite@7.2.6(@types/node@24.7.0)(jiti@2.6.1)(lightningcss@1.30.2)(sass@1.90.0)(terser@5.44.0)(tsx@4.21.0)(yaml@2.8.1))': - dependencies: - '@tanstack/eslint-config': 0.3.3(@typescript-eslint/utils@8.48.0(eslint@9.39.1(jiti@2.6.1))(typescript@5.9.3))(eslint@9.39.1(jiti@2.6.1))(typescript@5.9.3) - '@tanstack/publish-config': 0.2.2 - '@tanstack/typedoc-config': 0.3.2(typescript@5.9.3) - '@tanstack/vite-config': 0.4.1(@types/node@24.7.0)(rollup@4.52.5)(typescript@5.9.3)(vite@7.2.6(@types/node@24.7.0)(jiti@2.6.1)(lightningcss@1.30.2)(sass@1.90.0)(terser@5.44.0)(tsx@4.21.0)(yaml@2.8.1)) - transitivePeerDependencies: - - '@types/node' - - '@typescript-eslint/utils' - - eslint - - eslint-import-resolver-node - - rollup - - supports-color - - typescript - - vite - '@tanstack/directive-functions-plugin@1.139.0(vite@6.4.1(@types/node@24.7.0)(jiti@2.6.1)(lightningcss@1.30.2)(sass@1.90.0)(terser@5.44.0)(tsx@4.21.0)(yaml@2.8.1))': dependencies: '@babel/code-frame': 7.27.1 @@ -11988,15 +11882,6 @@ snapshots: '@tanstack/pacer-lite@0.1.0': {} - '@tanstack/publish-config@0.2.2': - dependencies: - '@commitlint/parse': 20.0.0 - jsonfile: 6.2.0 - semver: 7.7.3 - simple-git: 3.30.0 - transitivePeerDependencies: - - supports-color - '@tanstack/query-core@5.90.11': {} '@tanstack/react-query@5.90.11(react@19.2.0)': @@ -12564,10 +12449,6 @@ snapshots: dependencies: '@types/node': 24.7.0 - '@types/conventional-commits-parser@5.0.1': - dependencies: - '@types/node': 24.7.0 - '@types/cors@2.8.19': dependencies: '@types/node': 24.7.0 @@ -13164,11 +13045,6 @@ snapshots: '@yarnpkg/lockfile@1.1.0': {} - JSONStream@1.3.5: - dependencies: - jsonparse: 1.3.1 - through: 2.3.8 - abbrev@3.0.1: {} accepts@1.3.8: @@ -13308,8 +13184,6 @@ snapshots: array-flatten@1.1.1: {} - array-ify@1.0.0: {} - array-includes@3.1.9: dependencies: call-bind: 1.0.8 @@ -13724,11 +13598,6 @@ snapshots: common-tags@1.8.2: {} - compare-func@2.0.0: - dependencies: - array-ify: 1.0.0 - dot-prop: 5.3.0 - compare-versions@6.1.1: {} computeds@0.0.1: {} @@ -13765,17 +13634,6 @@ snapshots: content-type@1.0.5: {} - conventional-changelog-angular@7.0.0: - dependencies: - compare-func: 2.0.0 - - conventional-commits-parser@5.0.0: - dependencies: - JSONStream: 1.3.5 - is-text-path: 2.0.0 - meow: 12.1.1 - split2: 4.2.0 - convert-source-map@1.9.0: {} convert-source-map@2.0.0: {} @@ -13991,10 +13849,6 @@ snapshots: domelementtype: 2.3.0 domhandler: 5.0.3 - dot-prop@5.3.0: - dependencies: - is-obj: 2.0.0 - dotenv@16.6.1: {} dotenv@17.2.3: {} @@ -15325,8 +15179,6 @@ snapshots: is-number@7.0.0: {} - is-obj@2.0.0: {} - is-path-inside@3.0.3: {} is-potential-custom-element-name@1.0.1: {} @@ -15371,10 +15223,6 @@ snapshots: has-symbols: 1.1.0 safe-regex-test: 1.1.0 - is-text-path@2.0.0: - dependencies: - text-extensions: 2.4.0 - is-typed-array@1.1.15: dependencies: which-typed-array: 1.1.19 @@ -15553,12 +15401,6 @@ snapshots: optionalDependencies: graceful-fs: 4.2.11 - jsonfile@6.2.0: - dependencies: - universalify: 2.0.1 - optionalDependencies: - graceful-fs: 4.2.11 - jsonparse@1.3.1: {} jsonpointer@5.0.1: {} @@ -15915,8 +15757,6 @@ snapshots: memory-pager@1.5.0: {} - meow@12.1.1: {} - merge-anything@5.1.7: dependencies: is-what: 4.1.16 @@ -17199,14 +17039,6 @@ snapshots: transitivePeerDependencies: - supports-color - simple-git@3.30.0: - dependencies: - '@kwsites/file-exists': 1.1.1 - '@kwsites/promise-deferred': 1.1.1 - debug: 4.4.3 - transitivePeerDependencies: - - supports-color - simple-peer@9.11.1: dependencies: buffer: 6.0.3 @@ -17609,8 +17441,6 @@ snapshots: glob: 10.4.5 minimatch: 9.0.5 - text-extensions@2.4.0: {} - text-table@0.2.0: {} thenify-all@1.6.0: @@ -17621,8 +17451,6 @@ snapshots: dependencies: any-promise: 1.3.0 - through@2.3.8: {} - tiny-invariant@1.3.3: {} tiny-warning@1.0.3: {} @@ -17843,8 +17671,6 @@ snapshots: universalify@0.1.2: {} - universalify@2.0.1: {} - unload@2.4.1: {} unpipe@1.0.0: {} diff --git a/scripts/generate-docs.ts b/scripts/generate-docs.ts index 4424241c4..e9a6da6c5 100644 --- a/scripts/generate-docs.ts +++ b/scripts/generate-docs.ts @@ -1,8 +1,6 @@ -import { readFileSync, writeFileSync } from 'node:fs' import { resolve } from 'node:path' import { fileURLToPath } from 'node:url' -import { generateReferenceDocs } from '@tanstack/config/typedoc' -import { glob } from 'tinyglobby' +import { generateReferenceDocs } from '@tanstack/typedoc-config' const __dirname = fileURLToPath(new URL(`.`, import.meta.url)) @@ -106,32 +104,6 @@ await generateReferenceDocs({ ], }) -// Find all markdown files matching the pattern -const markdownFiles = [ - ...(await glob(`docs/reference/**/*.md`)), - ...(await glob(`docs/framework/*/reference/**/*.md`)), -] - -console.log(`Found ${markdownFiles.length} markdown files to process\n`) - -// Process each markdown file -markdownFiles.forEach((file) => { - const content = readFileSync(file, `utf-8`) - let updatedContent = content - updatedContent = updatedContent.replaceAll(/\]\(\.\.\//gm, `](../../`) - // updatedContent = content.replaceAll(/\]\(\.\//gm, '](../') - updatedContent = updatedContent.replaceAll( - /\]\((?!https?:\/\/|\/\/|\/|\.\/|\.\.\/|#)([^)]+)\)/gm, - (match, p1) => `](../${p1})`, - ) - - // Write the updated content back to the file - if (updatedContent !== content) { - writeFileSync(file, updatedContent, `utf-8`) - console.log(`Processed file: ${file}`) - } -}) - console.log(`\n✅ All markdown files have been processed!`) process.exit(0) diff --git a/scripts/verify-links.ts b/scripts/verify-links.ts index c1119daac..8a1c40ddc 100644 --- a/scripts/verify-links.ts +++ b/scripts/verify-links.ts @@ -1,60 +1,60 @@ import { existsSync, readFileSync, statSync } from 'node:fs' -import path, { resolve } from 'node:path' +import { extname, resolve } from 'node:path' import { glob } from 'tinyglobby' -// @ts-ignore - markdown-link-extractor is not typed +// @ts-ignore Could not find a declaration file for module 'markdown-link-extractor'. import markdownLinkExtractor from 'markdown-link-extractor' +const errors: Array<{ + file: string + link: string + resolvedPath: string + reason: string +}> = [] + function isRelativeLink(link: string) { return ( - link && - !link.startsWith(`/`) && - !link.startsWith(`http://`) && - !link.startsWith(`https://`) && - !link.startsWith(`//`) && - !link.startsWith(`#`) && - !link.startsWith(`mailto:`) + !link.startsWith('/') && + !link.startsWith('http://') && + !link.startsWith('https://') && + !link.startsWith('//') && + !link.startsWith('#') && + !link.startsWith('mailto:') ) } -function normalizePath(p: string): string { - // Remove any trailing .md - p = p.replace(`${path.extname(p)}`, ``) - return p +/** Remove any trailing .md */ +function stripExtension(p: string): string { + return p.replace(`${extname(p)}`, '') } -function fileExistsForLink( - link: string, - markdownFile: string, - errors: Array, -): boolean { +function relativeLinkExists(link: string, file: string): boolean { // Remove hash if present - const filePart = link.split(`#`)[0] + const linkWithoutHash = link.split('#')[0] // If the link is empty after removing hash, it's not a file - if (!filePart) return false - - // Normalize the markdown file path - markdownFile = normalizePath(markdownFile) + if (!linkWithoutHash) return false - // Normalize the path - const normalizedPath = normalizePath(filePart) + // Strip the file/link extensions + const filePath = stripExtension(file) + const linkPath = stripExtension(linkWithoutHash) // Resolve the path relative to the markdown file's directory - let absPath = resolve(markdownFile, normalizedPath) + // Nav up a level to simulate how links are resolved on the web + let absPath = resolve(filePath, '..', linkPath) // Ensure the resolved path is within /docs - const docsRoot = resolve(`docs`) + const docsRoot = resolve('docs') if (!absPath.startsWith(docsRoot)) { errors.push({ link, - markdownFile, + file, resolvedPath: absPath, - reason: `navigates above /docs, invalid`, + reason: 'Path outside /docs', }) return false } // Check if this is an example path - const isExample = absPath.includes(`/examples/`) + const isExample = absPath.includes('/examples/') let exists = false @@ -62,13 +62,13 @@ function fileExistsForLink( // Transform /docs/framework/{framework}/examples/ to /examples/{framework}/ absPath = absPath.replace( /\/docs\/framework\/([^/]+)\/examples\//, - `/examples/$1/`, + '/examples/$1/', ) // For examples, we want to check if the directory exists exists = existsSync(absPath) && statSync(absPath).isDirectory() } else { // For non-examples, we want to check if the .md file exists - if (!absPath.endsWith(`.md`)) { + if (!absPath.endsWith('.md')) { absPath = `${absPath}.md` } exists = existsSync(absPath) @@ -77,42 +77,34 @@ function fileExistsForLink( if (!exists) { errors.push({ link, - markdownFile, + file, resolvedPath: absPath, - reason: `not found`, + reason: 'Not found', }) } return exists } -async function findMarkdownLinks() { +async function verifyMarkdownLinks() { // Find all markdown files in docs directory - const markdownFiles = await glob(`docs/**/*.md`, { - ignore: [`**/node_modules/**`], + const markdownFiles = await glob('docs/**/*.md', { + ignore: ['**/node_modules/**'], }) console.log(`Found ${markdownFiles.length} markdown files\n`) - const errors: Array = [] - // Process each file for (const file of markdownFiles) { - const content = readFileSync(file, `utf-8`) - const links: Array = markdownLinkExtractor(content) - - const filteredLinks = links.filter((link: any) => { - if (typeof link === `string`) { - return isRelativeLink(link) - } else if (link && typeof link.href === `string`) { - return isRelativeLink(link.href) - } - return false + const content = readFileSync(file, 'utf-8') + const links: Array = markdownLinkExtractor(content) + + const relativeLinks = links.filter((link: string) => { + return isRelativeLink(link) }) - if (filteredLinks.length > 0) { - filteredLinks.forEach((link: any) => { - const href = typeof link === `string` ? link : link.href - fileExistsForLink(href, file, errors) + if (relativeLinks.length > 0) { + relativeLinks.forEach((link) => { + relativeLinkExists(link, file) }) } } @@ -121,13 +113,13 @@ async function findMarkdownLinks() { console.log(`\n❌ Found ${errors.length} broken links:`) errors.forEach((err) => { console.log( - `${err.link}\n in: ${err.markdownFile}\n path: ${err.resolvedPath}\n why: ${err.reason}\n`, + `${err.file}\n link: ${err.link}\n resolved: ${err.resolvedPath}\n why: ${err.reason}\n`, ) }) process.exit(1) } else { - console.log(`\n✅ No broken links found!`) + console.log('\n✅ No broken links found!') } } -findMarkdownLinks().catch(console.error) +verifyMarkdownLinks().catch(console.error)