diff --git a/.github/workflows/autofix.yml b/.github/workflows/autofix.yml index 554769b60..65fc3ffea 100644 --- a/.github/workflows/autofix.yml +++ b/.github/workflows/autofix.yml @@ -18,13 +18,15 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v5.0.1 + uses: actions/checkout@v6.0.1 with: fetch-depth: 0 - name: Setup Tools uses: tanstack/config/.github/setup@main - name: Fix formatting run: pnpm format + - name: Regenerate docs + run: pnpm build && pnpm generate-docs - name: Apply fixes uses: autofix-ci/action@635ffb0c9798bd160680f18fd73371e355b85f27 with: diff --git a/.github/workflows/claude.yml b/.github/workflows/claude.yml index 72623ed4d..c4bb5e220 100644 --- a/.github/workflows/claude.yml +++ b/.github/workflows/claude.yml @@ -18,7 +18,7 @@ jobs: actions: read # Required for Claude to read CI results on PRs steps: - name: Checkout code - uses: actions/checkout@v4 + uses: actions/checkout@v6.0.1 with: fetch-depth: 0 # required for Claude Code - uses: anthropics/claude-code-action@v1 diff --git a/.github/workflows/docs-sync.yml b/.github/workflows/docs-sync.yml deleted file mode 100644 index c62819baa..000000000 --- a/.github/workflows/docs-sync.yml +++ /dev/null @@ -1,104 +0,0 @@ -name: Sync Generated Docs - -on: - schedule: - # Run daily at 2 AM UTC - - cron: '0 2 * * *' - - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -permissions: - contents: write - pull-requests: write - -jobs: - sync-docs: - name: Generate and Sync Docs - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v5.0.1 - with: - fetch-depth: 0 - - - name: Setup Tools - uses: tanstack/config/.github/setup@main - - - name: Build Packages - run: pnpm run build - - - name: Generate Docs - run: pnpm generate-docs - - - name: Check for changes - id: check_changes - run: | - if [ -n "$(git status --porcelain)" ]; then - echo "has_changes=true" >> $GITHUB_OUTPUT - echo "Changes detected in generated docs" - else - echo "has_changes=false" >> $GITHUB_OUTPUT - echo "No changes in generated docs" - fi - - - name: Configure Git - if: steps.check_changes.outputs.has_changes == 'true' - run: | - git config user.name "github-actions[bot]" - git config user.email "github-actions[bot]@users.noreply.github.com" - - - name: Commit and Push Changes - if: steps.check_changes.outputs.has_changes == 'true' - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: | - BRANCH_NAME="docs/auto-generate" - - # Check if branch exists remotely - if git ls-remote --exit-code --heads origin $BRANCH_NAME; then - echo "Branch exists, checking out and updating" - git fetch origin $BRANCH_NAME - git checkout $BRANCH_NAME - git pull origin $BRANCH_NAME - else - echo "Creating new branch" - git checkout -b $BRANCH_NAME - fi - - # Stage and commit changes - git add docs/ - git commit -m "docs: regenerate API documentation - - Auto-generated by daily docs sync workflow" - - # Push changes - git push origin $BRANCH_NAME - - - name: Create or Update PR - if: steps.check_changes.outputs.has_changes == 'true' - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: | - BRANCH_NAME="docs/auto-generate" - - # Check if PR already exists - existing_pr=$(gh pr list --head $BRANCH_NAME --json number --jq '.[0].number') - - if [ -n "$existing_pr" ]; then - echo "PR #$existing_pr already exists, it has been updated with the latest changes" - gh pr comment $existing_pr --body "Updated with latest generated docs from scheduled workflow run." - else - echo "Creating new PR" - gh pr create \ - --title "docs: sync generated API documentation" \ - --body "This PR was automatically created by the daily docs sync workflow. - - The generated API documentation has been updated to reflect the latest changes in the codebase. - - **Generated by**: [Docs Sync Workflow](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - Please review and merge if the changes look correct." \ - --head $BRANCH_NAME \ - --base main - fi diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml index 781738da4..e1442c739 100644 --- a/.github/workflows/e2e-tests.yml +++ b/.github/workflows/e2e-tests.yml @@ -13,7 +13,7 @@ jobs: steps: - name: Checkout code - uses: actions/checkout@v4 + uses: actions/checkout@v6.0.1 - name: Setup pnpm uses: pnpm/action-setup@v4 diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index 21fee0463..7f3a77189 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -23,7 +23,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v5.0.1 + uses: actions/checkout@v6.0.1 with: fetch-depth: 0 - name: Setup Tools @@ -39,7 +39,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v5.0.1 + uses: actions/checkout@v6.0.1 with: fetch-depth: 0 - name: Setup Tools @@ -67,7 +67,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v5.0.1 + uses: actions/checkout@v6.0.1 - name: Setup Tools uses: tanstack/config/.github/setup@main - name: Build Packages @@ -81,7 +81,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v5.0.1 + uses: actions/checkout@v6.0.1 - name: Setup Tools uses: tanstack/config/.github/setup@main - name: Build Packages diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 3c863554f..421c37e54 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -23,7 +23,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v5.0.1 + uses: actions/checkout@v6.0.1 with: fetch-depth: 0 - name: Setup Tools @@ -40,33 +40,6 @@ jobs: title: 'ci: Version Packages' env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - NPM_TOKEN: ${{ secrets.NPM_TOKEN }} - - name: Generate Docs - if: steps.changesets.outputs.published == 'true' - run: pnpm generate-docs - - name: Commit Generated Docs - if: steps.changesets.outputs.published == 'true' - run: | - if [ -n "$(git status --porcelain)" ]; then - git config user.name "github-actions[bot]" - git config user.email "github-actions[bot]@users.noreply.github.com" - - BRANCH="docs/auto-update-$(date +%s)" - git checkout -b "$BRANCH" - git add docs/ - git commit -m "docs: regenerate API documentation" - git push origin "$BRANCH" - - gh pr create \ - --title "docs: regenerate API documentation" \ - --body "Automated documentation update from release" \ - --base main \ - --head "$BRANCH" - else - echo "No changes in generated docs" - fi - env: - GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} - name: Comment on PRs about release if: steps.changesets.outputs.published == 'true' uses: tanstack/config/.github/comment-on-release@main diff --git a/.husky/pre-commit b/.husky/pre-commit deleted file mode 100755 index a5a29d9f7..000000000 --- a/.husky/pre-commit +++ /dev/null @@ -1,4 +0,0 @@ -#!/usr/bin/env sh -. "$(dirname -- "$0")/_/husky.sh" - -pnpm lint-staged diff --git a/docs/framework/angular/overview.md b/docs/framework/angular/overview.md index 0d6740b49..916262313 100644 --- a/docs/framework/angular/overview.md +++ b/docs/framework/angular/overview.md @@ -13,7 +13,7 @@ npm install @tanstack/angular-db 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 46660544b..46a9a35fb 100644 --- a/docs/framework/angular/reference/functions/injectLiveQuery.md +++ b/docs/framework/angular/reference/functions/injectLiveQuery.md @@ -127,7 +127,7 @@ Defined in: [index.ts:74](https://github.com/TanStack/db/blob/main/packages/angu function injectLiveQuery(config): InjectLiveQueryResult<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>; ``` -Defined in: [index.ts:77](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L77) +Defined in: [index.ts:79](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L79) ### Type Parameters @@ -151,7 +151,7 @@ Defined in: [index.ts:77](https://github.com/TanStack/db/blob/main/packages/angu function injectLiveQuery(liveQueryCollection): InjectLiveQueryResult; ``` -Defined in: [index.ts:80](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L80) +Defined in: [index.ts:82](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L82) ### Type Parameters diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index 28f54dc29..1321a5528 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 69dbff6cf..ed96a7506 100644 --- a/docs/framework/react/overview.md +++ b/docs/framework/react/overview.md @@ -13,7 +13,7 @@ npm install @tanstack/react-db 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/index.md b/docs/framework/react/reference/index.md index cb80c9a2e..a35d6af9f 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 3f2c5e6fa..d69a75b75 100644 --- a/docs/framework/solid/overview.md +++ b/docs/framework/solid/overview.md @@ -13,7 +13,7 @@ npm install @tanstack/solid-db 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/functions/useLiveQuery.md b/docs/framework/solid/reference/functions/useLiveQuery.md index 4de59fe3f..a1261ff4b 100644 --- a/docs/framework/solid/reference/functions/useLiveQuery.md +++ b/docs/framework/solid/reference/functions/useLiveQuery.md @@ -297,7 +297,7 @@ return ( function useLiveQuery(config): object; ``` -Defined in: [useLiveQuery.ts:158](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L158) +Defined in: [useLiveQuery.ts:160](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L160) Create a live query using configuration object @@ -423,7 +423,7 @@ return ( function useLiveQuery(liveQueryCollection): object; ``` -Defined in: [useLiveQuery.ts:208](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L208) +Defined in: [useLiveQuery.ts:210](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L210) Subscribe to an existing live query collection diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index dccd217f5..da2d0de79 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/reference/functions/useLiveQuery.md b/docs/framework/svelte/reference/functions/useLiveQuery.md new file mode 100644 index 000000000..835bd781b --- /dev/null +++ b/docs/framework/svelte/reference/functions/useLiveQuery.md @@ -0,0 +1,414 @@ +--- +id: useLiveQuery +title: useLiveQuery +--- + +# Function: useLiveQuery() + +## Call Signature + +```ts +function useLiveQuery(queryFn, deps?): UseLiveQueryReturn<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>; +``` + +Defined in: [useLiveQuery.svelte.ts:155](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L155) + +Create a live query using a query function + +### Type Parameters + +#### TContext + +`TContext` *extends* `Context` + +### Parameters + +#### queryFn + +(`q`) => `QueryBuilder`\<`TContext`\> + +Query function that defines what data to fetch + +#### deps? + +() => `unknown`[] + +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\] \}\> + +Reactive object with query data, state, and status information + +### Remarks + +**IMPORTANT - Destructuring in Svelte 5:** +Direct destructuring breaks reactivity. To destructure, wrap with `$derived`: + +❌ **Incorrect** - Loses reactivity: +```ts +const { data, isLoading } = useLiveQuery(...) +``` + +✅ **Correct** - Maintains reactivity: +```ts +// Option 1: Use dot notation (recommended) +const query = useLiveQuery(...) +// Access: query.data, query.isLoading + +// Option 2: Wrap with $derived for destructuring +const query = useLiveQuery(...) +const { data, isLoading } = $derived(query) +``` + +This is a fundamental Svelte 5 limitation, not a library bug. See: +https://github.com/sveltejs/svelte/issues/11002 + +### Examples + +```ts +// Basic query with object syntax (recommended pattern) +const todosQuery = useLiveQuery((q) => + q.from({ todos: todosCollection }) + .where(({ todos }) => eq(todos.completed, false)) + .select(({ todos }) => ({ id: todos.id, text: todos.text })) +) +// Access via: todosQuery.data, todosQuery.isLoading, etc. +``` + +```ts +// With reactive dependencies +let minPriority = $state(5) +const todosQuery = useLiveQuery( + (q) => q.from({ todos: todosCollection }) + .where(({ todos }) => gt(todos.priority, minPriority)), + [() => minPriority] // Re-run when minPriority changes +) +``` + +```ts +// Destructuring with $derived (if needed) +const query = useLiveQuery((q) => + q.from({ todos: todosCollection }) +) +const { data, isLoading, isError } = $derived(query) +// Now data, isLoading, and isError maintain reactivity +``` + +```ts +// Join pattern +const issuesQuery = useLiveQuery((q) => + q.from({ issues: issueCollection }) + .join({ persons: personCollection }, ({ issues, persons }) => + eq(issues.userId, persons.id) + ) + .select(({ issues, persons }) => ({ + id: issues.id, + title: issues.title, + userName: persons.name + })) +) +``` + +```ts +// Handle loading and error states in template +const todosQuery = useLiveQuery((q) => + q.from({ todos: todoCollection }) +) + +// In template: +// {#if todosQuery.isLoading} +//
Loading...
+// {:else if todosQuery.isError} +//
Error: {todosQuery.status}
+// {:else} +//
    +// {#each todosQuery.data as todo (todo.id)} +//
  • {todo.text}
  • +// {/each} +//
+// {/if} +``` + +## Call Signature + +```ts +function useLiveQuery(queryFn, deps?): UseLiveQueryReturn<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>; +``` + +Defined in: [useLiveQuery.svelte.ts:161](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L161) + +Create a live query using a query function + +### Type Parameters + +#### TContext + +`TContext` *extends* `Context` + +### Parameters + +#### queryFn + +(`q`) => `QueryBuilder`\<`TContext`\> \| `null` \| `undefined` + +Query function that defines what data to fetch + +#### deps? + +() => `unknown`[] + +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\] \}\> + +Reactive object with query data, state, and status information + +### Remarks + +**IMPORTANT - Destructuring in Svelte 5:** +Direct destructuring breaks reactivity. To destructure, wrap with `$derived`: + +❌ **Incorrect** - Loses reactivity: +```ts +const { data, isLoading } = useLiveQuery(...) +``` + +✅ **Correct** - Maintains reactivity: +```ts +// Option 1: Use dot notation (recommended) +const query = useLiveQuery(...) +// Access: query.data, query.isLoading + +// Option 2: Wrap with $derived for destructuring +const query = useLiveQuery(...) +const { data, isLoading } = $derived(query) +``` + +This is a fundamental Svelte 5 limitation, not a library bug. See: +https://github.com/sveltejs/svelte/issues/11002 + +### Examples + +```ts +// Basic query with object syntax (recommended pattern) +const todosQuery = useLiveQuery((q) => + q.from({ todos: todosCollection }) + .where(({ todos }) => eq(todos.completed, false)) + .select(({ todos }) => ({ id: todos.id, text: todos.text })) +) +// Access via: todosQuery.data, todosQuery.isLoading, etc. +``` + +```ts +// With reactive dependencies +let minPriority = $state(5) +const todosQuery = useLiveQuery( + (q) => q.from({ todos: todosCollection }) + .where(({ todos }) => gt(todos.priority, minPriority)), + [() => minPriority] // Re-run when minPriority changes +) +``` + +```ts +// Destructuring with $derived (if needed) +const query = useLiveQuery((q) => + q.from({ todos: todosCollection }) +) +const { data, isLoading, isError } = $derived(query) +// Now data, isLoading, and isError maintain reactivity +``` + +```ts +// Join pattern +const issuesQuery = useLiveQuery((q) => + q.from({ issues: issueCollection }) + .join({ persons: personCollection }, ({ issues, persons }) => + eq(issues.userId, persons.id) + ) + .select(({ issues, persons }) => ({ + id: issues.id, + title: issues.title, + userName: persons.name + })) +) +``` + +```ts +// Handle loading and error states in template +const todosQuery = useLiveQuery((q) => + q.from({ todos: todoCollection }) +) + +// In template: +// {#if todosQuery.isLoading} +//
Loading...
+// {:else if todosQuery.isError} +//
Error: {todosQuery.status}
+// {:else} +//
    +// {#each todosQuery.data as todo (todo.id)} +//
  • {todo.text}
  • +// {/each} +//
+// {/if} +``` + +## Call Signature + +```ts +function useLiveQuery(config, deps?): UseLiveQueryReturn<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>; +``` + +Defined in: [useLiveQuery.svelte.ts:206](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L206) + +Create a live query using configuration object + +### Type Parameters + +#### TContext + +`TContext` *extends* `Context` + +### Parameters + +#### config + +`LiveQueryCollectionConfig`\<`TContext`\> + +Configuration object with query and options + +#### deps? + +() => `unknown`[] + +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\] \}\> + +Reactive object with query data, state, and status information + +### Examples + +```ts +// Basic config object usage +const todosQuery = useLiveQuery({ + query: (q) => q.from({ todos: todosCollection }), + gcTime: 60000 +}) +``` + +```ts +// With reactive dependencies +let filter = $state('active') +const todosQuery = useLiveQuery({ + query: (q) => q.from({ todos: todosCollection }) + .where(({ todos }) => eq(todos.status, filter)) +}, [() => filter]) +``` + +```ts +// Handle all states uniformly +const itemsQuery = useLiveQuery({ + query: (q) => q.from({ items: itemCollection }) +}) + +// In template: +// {#if itemsQuery.isLoading} +//
Loading...
+// {:else if itemsQuery.isError} +//
Something went wrong
+// {:else if !itemsQuery.isReady} +//
Preparing...
+// {:else} +//
{itemsQuery.data.length} items loaded
+// {/if} +``` + +## Call Signature + +```ts +function useLiveQuery(liveQueryCollection): UseLiveQueryReturnWithCollection; +``` + +Defined in: [useLiveQuery.svelte.ts:255](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L255) + +Subscribe to an existing query collection (can be reactive) + +### Type Parameters + +#### TResult + +`TResult` *extends* `object` + +#### TKey + +`TKey` *extends* `string` \| `number` + +#### TUtils + +`TUtils` *extends* `Record`\<`string`, `any`\> + +### Parameters + +#### liveQueryCollection + +`MaybeGetter`\<`Collection`\<`TResult`, `TKey`, `TUtils`, `StandardSchemaV1`\<`unknown`, `unknown`\>, `TResult`\>\> + +Pre-created query collection to subscribe to (can be a getter) + +### Returns + +[`UseLiveQueryReturnWithCollection`](../interfaces/UseLiveQueryReturnWithCollection.md)\<`TResult`, `TKey`, `TUtils`\> + +Reactive object with query data, state, and status information + +### Examples + +```ts +// Using pre-created query collection +const myLiveQuery = createLiveQueryCollection((q) => + q.from({ todos: todosCollection }).where(({ todos }) => eq(todos.active, true)) +) +const queryResult = useLiveQuery(myLiveQuery) +``` + +```ts +// Reactive query collection reference +let selectedQuery = $state(todosQuery) +const queryResult = useLiveQuery(() => selectedQuery) + +// Switch queries reactively +selectedQuery = archiveQuery +``` + +```ts +// Access query collection methods directly +const queryResult = useLiveQuery(existingQuery) + +// Use underlying collection for mutations +const handleToggle = (id) => { + queryResult.collection.update(id, draft => { draft.completed = !draft.completed }) +} +``` + +```ts +// Handle states consistently +const queryResult = useLiveQuery(sharedQuery) + +// In template: +// {#if queryResult.isLoading} +//
Loading...
+// {:else if queryResult.isError} +//
Error loading data
+// {:else} +// {#each queryResult.data as item (item.id)} +// +// {/each} +// {/if} +``` diff --git a/docs/framework/svelte/reference/index.md b/docs/framework/svelte/reference/index.md new file mode 100644 index 000000000..152862d59 --- /dev/null +++ b/docs/framework/svelte/reference/index.md @@ -0,0 +1,15 @@ +--- +id: "@tanstack/svelte-db" +title: "@tanstack/svelte-db" +--- + +# @tanstack/svelte-db + +## Interfaces + +- [UseLiveQueryReturn](interfaces/UseLiveQueryReturn.md) +- [UseLiveQueryReturnWithCollection](interfaces/UseLiveQueryReturnWithCollection.md) + +## Functions + +- [useLiveQuery](functions/useLiveQuery.md) diff --git a/docs/framework/svelte/reference/interfaces/UseLiveQueryReturn.md b/docs/framework/svelte/reference/interfaces/UseLiveQueryReturn.md new file mode 100644 index 000000000..ee969a2eb --- /dev/null +++ b/docs/framework/svelte/reference/interfaces/UseLiveQueryReturn.md @@ -0,0 +1,125 @@ +--- +id: UseLiveQueryReturn +title: UseLiveQueryReturn +--- + +# Interface: UseLiveQueryReturn\ + +Defined in: [useLiveQuery.svelte.ts:29](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L29) + +Return type for useLiveQuery hook + +## Type Parameters + +### T + +`T` *extends* `object` + +## Properties + +### collection + +```ts +collection: Collection; +``` + +Defined in: [useLiveQuery.svelte.ts:32](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L32) + +The underlying query collection instance + +*** + +### data + +```ts +data: T[]; +``` + +Defined in: [useLiveQuery.svelte.ts:31](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L31) + +Reactive array of query results in order + +*** + +### isCleanedUp + +```ts +isCleanedUp: boolean; +``` + +Defined in: [useLiveQuery.svelte.ts:38](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L38) + +True when query has been cleaned up + +*** + +### isError + +```ts +isError: boolean; +``` + +Defined in: [useLiveQuery.svelte.ts:37](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L37) + +True when query encountered an error + +*** + +### isIdle + +```ts +isIdle: boolean; +``` + +Defined in: [useLiveQuery.svelte.ts:36](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L36) + +True when query hasn't started yet + +*** + +### isLoading + +```ts +isLoading: boolean; +``` + +Defined in: [useLiveQuery.svelte.ts:34](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L34) + +True while initial query data is loading + +*** + +### isReady + +```ts +isReady: boolean; +``` + +Defined in: [useLiveQuery.svelte.ts:35](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L35) + +True when query has received first data and is ready + +*** + +### state + +```ts +state: Map; +``` + +Defined in: [useLiveQuery.svelte.ts:30](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L30) + +Reactive Map of query results (key → item) + +*** + +### status + +```ts +status: CollectionStatus; +``` + +Defined in: [useLiveQuery.svelte.ts:33](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L33) + +Current query status diff --git a/docs/framework/svelte/reference/interfaces/UseLiveQueryReturnWithCollection.md b/docs/framework/svelte/reference/interfaces/UseLiveQueryReturnWithCollection.md new file mode 100644 index 000000000..9d921fcf9 --- /dev/null +++ b/docs/framework/svelte/reference/interfaces/UseLiveQueryReturnWithCollection.md @@ -0,0 +1,112 @@ +--- +id: UseLiveQueryReturnWithCollection +title: UseLiveQueryReturnWithCollection +--- + +# Interface: UseLiveQueryReturnWithCollection\ + +Defined in: [useLiveQuery.svelte.ts:41](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L41) + +## Type Parameters + +### T + +`T` *extends* `object` + +### TKey + +`TKey` *extends* `string` \| `number` + +### TUtils + +`TUtils` *extends* `Record`\<`string`, `any`\> + +## Properties + +### collection + +```ts +collection: Collection; +``` + +Defined in: [useLiveQuery.svelte.ts:48](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L48) + +*** + +### data + +```ts +data: T[]; +``` + +Defined in: [useLiveQuery.svelte.ts:47](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L47) + +*** + +### isCleanedUp + +```ts +isCleanedUp: boolean; +``` + +Defined in: [useLiveQuery.svelte.ts:54](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L54) + +*** + +### isError + +```ts +isError: boolean; +``` + +Defined in: [useLiveQuery.svelte.ts:53](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L53) + +*** + +### isIdle + +```ts +isIdle: boolean; +``` + +Defined in: [useLiveQuery.svelte.ts:52](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L52) + +*** + +### isLoading + +```ts +isLoading: boolean; +``` + +Defined in: [useLiveQuery.svelte.ts:50](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L50) + +*** + +### isReady + +```ts +isReady: boolean; +``` + +Defined in: [useLiveQuery.svelte.ts:51](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L51) + +*** + +### state + +```ts +state: Map; +``` + +Defined in: [useLiveQuery.svelte.ts:46](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L46) + +*** + +### status + +```ts +status: CollectionStatus; +``` + +Defined in: [useLiveQuery.svelte.ts:49](https://github.com/TanStack/db/blob/main/packages/svelte-db/src/useLiveQuery.svelte.ts#L49) diff --git a/docs/framework/vue/overview.md b/docs/framework/vue/overview.md index 2e42cf8a1..eb78d370f 100644 --- a/docs/framework/vue/overview.md +++ b/docs/framework/vue/overview.md @@ -13,7 +13,7 @@ npm install @tanstack/vue-db 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/index.md b/docs/framework/vue/reference/index.md index 6a731310e..65af759fc 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/live-queries.md b/docs/guides/live-queries.md index 1c83fec5a..409b87cac 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/overview#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/overview), [Vue](../framework/vue/overview), and [Angular](../framework/angular/overview) adapter documentation. ### Using with React Suspense diff --git a/docs/reference/@tanstack/namespaces/IR/index.md b/docs/reference/@tanstack/namespaces/IR/index.md index cda593313..2e6b180ed 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/classes/AggregateFunctionNotInSelectError.md b/docs/reference/classes/AggregateFunctionNotInSelectError.md index e1835482d..087b3f6f1 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 3ac7f904a..5f54d5547 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 53777dfff..68054f1c3 100644 --- a/docs/reference/classes/BTreeIndex.md +++ b/docs/reference/classes/BTreeIndex.md @@ -5,14 +5,14 @@ title: BTreeIndex # Class: BTreeIndex\ -Defined in: [packages/db/src/indexes/btree-index.ts:30](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L30) +Defined in: [packages/db/src/indexes/btree-index.ts:31](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L31) B+Tree index for sorted data with range queries This maintains items in sorted order and provides efficient range operations ## Extends -- [`BaseIndex`](./BaseIndex.md)\<`TKey`\> +- [`BaseIndex`](BaseIndex.md)\<`TKey`\> ## Type Parameters @@ -32,7 +32,7 @@ new BTreeIndex( options?): BTreeIndex; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:50](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L50) +Defined in: [packages/db/src/indexes/btree-index.ts:51](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L51) #### Parameters @@ -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) *** @@ -152,11 +152,11 @@ Defined in: [packages/db/src/indexes/base-index.ts:80](https://github.com/TanSta readonly supportedOperations: Set<"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike">; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:33](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L33) +Defined in: [packages/db/src/indexes/btree-index.ts:34](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L34) #### 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 @@ -182,7 +182,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:85](https://github.com/TanSta get indexedKeysSet(): Set; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:333](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L333) +Defined in: [packages/db/src/indexes/btree-index.ts:337](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L337) ##### Returns @@ -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) *** @@ -202,7 +202,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:333](https://github.com/TanS get keyCount(): number; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:199](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L199) +Defined in: [packages/db/src/indexes/btree-index.ts:200](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L200) Gets the number of indexed keys @@ -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) *** @@ -224,7 +224,7 @@ Gets the number of indexed keys get orderedEntriesArray(): [any, Set][]; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:337](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L337) +Defined in: [packages/db/src/indexes/btree-index.ts:341](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L341) ##### Returns @@ -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) *** @@ -244,7 +244,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:337](https://github.com/TanS get orderedEntriesArrayReversed(): [any, Set][]; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:343](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L343) +Defined in: [packages/db/src/indexes/btree-index.ts:347](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L347) ##### Returns @@ -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) *** @@ -264,7 +264,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:343](https://github.com/TanS get valueMapData(): Map>; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:350](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L350) +Defined in: [packages/db/src/indexes/btree-index.ts:354](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L354) ##### Returns @@ -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 @@ -282,7 +282,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:350](https://github.com/TanS add(key, item): void; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:69](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L69) +Defined in: [packages/db/src/indexes/btree-index.ts:70](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L70) Adds a value to the index @@ -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) *** @@ -312,7 +312,7 @@ Adds a value to the index build(entries): void; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:143](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L143) +Defined in: [packages/db/src/indexes/btree-index.ts:144](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L144) Builds the index from a collection of entries @@ -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) *** @@ -338,7 +338,7 @@ Builds the index from a collection of entries clear(): void; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:154](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L154) +Defined in: [packages/db/src/indexes/btree-index.ts:155](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L155) Clears all data from the index @@ -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) *** @@ -358,7 +358,7 @@ Clears all data from the index equalityLookup(value): Set; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:208](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L208) +Defined in: [packages/db/src/indexes/btree-index.ts:209](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L209) Performs an equality lookup @@ -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) *** @@ -416,7 +416,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:169](https://github.com/TanSt #### Inherited from -[`BaseIndex`](./BaseIndex.md).[`getStats`](./BaseIndex.md#getstats) +[`BaseIndex`](BaseIndex.md).[`getStats`](BaseIndex.md#getstats) *** @@ -426,7 +426,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:169](https://github.com/TanSt inArrayLookup(values): Set; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:318](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L318) +Defined in: [packages/db/src/indexes/btree-index.ts:322](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L322) Performs an IN array lookup @@ -442,7 +442,7 @@ Performs an IN array lookup #### Overrides -[`BaseIndex`](./BaseIndex.md).[`inArrayLookup`](./BaseIndex.md#inarraylookup) +[`BaseIndex`](BaseIndex.md).[`inArrayLookup`](BaseIndex.md#inarraylookup) *** @@ -452,7 +452,7 @@ Performs an IN array lookup protected initialize(_options?): void; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:64](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L64) +Defined in: [packages/db/src/indexes/btree-index.ts:65](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L65) #### Parameters @@ -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) *** @@ -476,7 +476,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:64](https://github.com/TanSt lookup(operation, value): Set; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:164](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L164) +Defined in: [packages/db/src/indexes/btree-index.ts:165](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L165) Performs a lookup operation @@ -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) *** @@ -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) *** @@ -583,7 +583,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:134](https://github.com/TanSt rangeQuery(options): Set; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:217](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L217) +Defined in: [packages/db/src/indexes/btree-index.ts:218](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L218) Performs a range query with options This is more efficient for compound queries like "WHERE a > 5 AND a < 10" @@ -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) *** @@ -610,7 +610,7 @@ This is more efficient for compound queries like "WHERE a > 5 AND a < 10" rangeQueryReversed(options): Set; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:250](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L250) +Defined in: [packages/db/src/indexes/btree-index.ts:251](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L251) Performs a reversed range query @@ -626,7 +626,7 @@ Performs a reversed range query #### Overrides -[`BaseIndex`](./BaseIndex.md).[`rangeQueryReversed`](./BaseIndex.md#rangequeryreversed) +[`BaseIndex`](BaseIndex.md).[`rangeQueryReversed`](BaseIndex.md#rangequeryreversed) *** @@ -636,7 +636,7 @@ Performs a reversed range query remove(key, item): void; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:100](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L100) +Defined in: [packages/db/src/indexes/btree-index.ts:101](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L101) Removes a value from the index @@ -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) *** @@ -693,7 +693,7 @@ take( filterFn?): TKey[]; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:295](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L295) +Defined in: [packages/db/src/indexes/btree-index.ts:299](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L299) Returns the next n items after the provided item or the first n items if no from item is provided. @@ -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) *** @@ -736,7 +736,7 @@ takeReversed( filterFn?): TKey[]; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:306](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L306) +Defined in: [packages/db/src/indexes/btree-index.ts:310](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L310) Returns the next n items **before** the provided item (in descending order) or the last n items if no from item is provided. @@ -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) *** @@ -803,7 +803,7 @@ update( newItem): void; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:135](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L135) +Defined in: [packages/db/src/indexes/btree-index.ts:136](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L136) Updates a value in the index @@ -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 820142565..0327f8674 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 diff --git a/docs/reference/classes/CannotCombineEmptyExpressionListError.md b/docs/reference/classes/CannotCombineEmptyExpressionListError.md index 39ff798c2..904b9c0fa 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 eab7850f0..e71badeba 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 dd8ff69cb..de13b7c48 100644 --- a/docs/reference/classes/CollectionImpl.md +++ b/docs/reference/classes/CollectionImpl.md @@ -154,7 +154,7 @@ Get resolved indexes for query optimization ##### Returns -`Map`\<`number`, [`BaseIndex`](./BaseIndex.md)\<`TKey`\>\> +`Map`\<`number`, [`BaseIndex`](BaseIndex.md)\<`TKey`\>\> *** @@ -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) @@ -357,7 +357,7 @@ 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 diff --git a/docs/reference/classes/CollectionInErrorStateError.md b/docs/reference/classes/CollectionInErrorStateError.md index e743dd0a7..8c83cc03a 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 6e97c8473..ce64c2270 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 95d4726e7..86a1813a2 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 66121a26b..4830e9adf 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 7bc9412eb..6e1ac161f 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 6d9ecb4fd..99e4d12ce 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 f6e390cfe..5848428b0 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/DeleteKeyNotFoundError.md b/docs/reference/classes/DeleteKeyNotFoundError.md index 15009dbbf..29f723c09 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 f853341bf..c326301a5 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 8ce621514..40d2e4d7e 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 2738d9636..2251277f2 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 7d682f570..f718ead0b 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 e0b80b1f7..993af6c07 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 a432a5eff..8aa58628c 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 bdd553bbc..4f502c153 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 5fdb1b76c..dd1909048 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 01a4c2a02..203620ae0 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 @@ -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`\> *** @@ -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 6bc071e75..8881268af 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 3af1cda59..2ccaf7b47 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 04d96c5a2..8af9c6442 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 ff39de6f9..35feb6bfe 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 e4e8e6149..5516bcb5e 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 12c8af374..f667574a5 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 74ffa2a0e..b50d2cff0 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 127cdd968..42c7a4853 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 0696dc54b..6d8a04f86 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 b077c8583..49acd2286 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 c330556c4..34d62ba23 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 fde33fac0..dbd955f89 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 436ee8fb1..394e58e8f 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 0975a4057..721537756 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 1533cdb37..bd44f33fb 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 f824daf42..703809366 100644 --- a/docs/reference/classes/LazyIndexWrapper.md +++ b/docs/reference/classes/LazyIndexWrapper.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 15263b0cc..2a46c6793 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 3f31a2412..496008f3a 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 fb5ae91c2..f64707d3a 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 6b22f4474..aaa1a59f7 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 cf5ed1c13..85d4b3463 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 d2fc597f5..877a9bc6f 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 73893a748..4763e7f4c 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 ea4cf065a..1fd607f3c 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 b05ba85c7..b9b813530 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 462f31a85..d94047c24 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 0938ccb37..07052b4b7 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 7eb27a9d4..ff311f00b 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 61b5e891d..27a790451 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 1767bf9e1..9fb38b9de 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 56a3be824..e842bf141 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 10ab4599a..f7c35f700 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 35516424f..5deb8c661 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 9680bd28d..256bd0d49 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 4da102c94..202f69fe0 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 7cf913359..9920eca3b 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 5f52fcf2b..98175328f 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 280a4ac84..363820b5e 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 2254c79d3..875b79afd 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 9fa013883..8c7f1d436 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 bc1b7bba2..81b016f06 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 ed067d69f..a9cd66b93 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/SortedMap.md b/docs/reference/classes/SortedMap.md index 9b81f77cf..b61e5adcb 100644 --- a/docs/reference/classes/SortedMap.md +++ b/docs/reference/classes/SortedMap.md @@ -5,7 +5,7 @@ title: SortedMap # Class: SortedMap\ -Defined in: [packages/db/src/SortedMap.ts:6](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L6) +Defined in: [packages/db/src/SortedMap.ts:8](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L8) A Map implementation that keeps its entries sorted based on a comparator function @@ -13,9 +13,9 @@ A Map implementation that keeps its entries sorted based on a comparator functio ### TKey -`TKey` +`TKey` *extends* `string` \| `number` -The type of keys in the map +The type of keys in the map (must be string | number) ### TValue @@ -31,7 +31,7 @@ The type of values in the map new SortedMap(comparator?): SortedMap; ``` -Defined in: [packages/db/src/SortedMap.ts:16](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L16) +Defined in: [packages/db/src/SortedMap.ts:19](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L19) Creates a new SortedMap instance @@ -41,7 +41,8 @@ Creates a new SortedMap instance (`a`, `b`) => `number` -Optional function to compare values for sorting +Optional function to compare values for sorting. + If not provided, entries are sorted by key only. #### Returns @@ -57,7 +58,7 @@ Optional function to compare values for sorting get size(): number; ``` -Defined in: [packages/db/src/SortedMap.ts:138](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L138) +Defined in: [packages/db/src/SortedMap.ts:157](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L157) Gets the number of key-value pairs in the map @@ -73,7 +74,7 @@ Gets the number of key-value pairs in the map iterator: IterableIterator<[TKey, TValue]>; ``` -Defined in: [packages/db/src/SortedMap.ts:147](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L147) +Defined in: [packages/db/src/SortedMap.ts:166](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L166) Default iterator that returns entries in sorted order @@ -91,7 +92,7 @@ An iterator for the map's entries clear(): void; ``` -Defined in: [packages/db/src/SortedMap.ts:130](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L130) +Defined in: [packages/db/src/SortedMap.ts:149](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L149) Removes all key-value pairs from the map @@ -107,7 +108,7 @@ Removes all key-value pairs from the map delete(key): boolean; ``` -Defined in: [packages/db/src/SortedMap.ts:106](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L106) +Defined in: [packages/db/src/SortedMap.ts:125](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L125) Removes a key-value pair from the map @@ -133,7 +134,7 @@ True if the key was found and removed, false otherwise entries(): IterableIterator<[TKey, TValue]>; ``` -Defined in: [packages/db/src/SortedMap.ts:158](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L158) +Defined in: [packages/db/src/SortedMap.ts:177](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L177) Returns an iterator for the map's entries in sorted order @@ -151,7 +152,7 @@ An iterator for the map's entries forEach(callbackfn): void; ``` -Defined in: [packages/db/src/SortedMap.ts:189](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L189) +Defined in: [packages/db/src/SortedMap.ts:208](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L208) Executes a callback function for each key-value pair in the map in sorted order @@ -175,7 +176,7 @@ Function to execute for each entry get(key): TValue | undefined; ``` -Defined in: [packages/db/src/SortedMap.ts:96](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L96) +Defined in: [packages/db/src/SortedMap.ts:115](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L115) Gets a value by its key @@ -201,7 +202,7 @@ The value associated with the key, or undefined if not found has(key): boolean; ``` -Defined in: [packages/db/src/SortedMap.ts:123](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L123) +Defined in: [packages/db/src/SortedMap.ts:142](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L142) Checks if a key exists in the map @@ -227,7 +228,7 @@ True if the key exists, false otherwise keys(): IterableIterator; ``` -Defined in: [packages/db/src/SortedMap.ts:167](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L167) +Defined in: [packages/db/src/SortedMap.ts:186](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L186) Returns an iterator for the map's keys in sorted order @@ -245,7 +246,7 @@ An iterator for the map's keys set(key, value): this; ``` -Defined in: [packages/db/src/SortedMap.ts:73](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L73) +Defined in: [packages/db/src/SortedMap.ts:92](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L92) Sets a key-value pair in the map and maintains sort order @@ -277,7 +278,7 @@ This SortedMap instance for chaining values(): IterableIterator; ``` -Defined in: [packages/db/src/SortedMap.ts:176](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L176) +Defined in: [packages/db/src/SortedMap.ts:195](https://github.com/TanStack/db/blob/main/packages/db/src/SortedMap.ts#L195) Returns an iterator for the map's values in sorted order diff --git a/docs/reference/classes/StorageError.md b/docs/reference/classes/StorageError.md index 1372f6851..75be4120d 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 bd8ad38b5..dbe3ed6aa 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 7e1545ded..3aed30b50 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 60109b312..54952f7f5 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 c76c6a69b..18e2c7776 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 7a4a3afec..029fa1477 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 5e68bd111..2fad8074e 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 124fac315..f0566cbf1 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 53e363ef3..4e02acbf3 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 fa530f58d..2096ab5a4 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 9a7bd1564..771f46d4f 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 34a98b299..e71baa46e 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 d80a0754e..57fa5d9a1 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 6adba64e7..56005ab12 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 4556ede94..af7ead4aa 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 93f0cf768..e96c0e498 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 009c369dc..2c35f4527 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 d181a9cd5..b769eecec 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 5784dde00..a7ceca36d 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 dedc332f5..1d2833933 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 b455cde74..69fd0e656 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 4bf1448be..3816c8db2 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 59dcd9dfd..a7ee69f1d 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 aff07346c..9b2a3317b 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 c4df05bf4..6b2a5c286 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 52bc618ea..8d6383e1d 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 2fb976a3c..ec39c57d4 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/index.md b/docs/reference/electric-db-collection/index.md index b2092536a..6580bd74f 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 b3e92ca58..5f2b37cd8 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 18e55bbcc..9b04e6263 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/index.md b/docs/reference/index.md index 85e77759f..e2be7f11f 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/BTreeIndexOptions.md b/docs/reference/interfaces/BTreeIndexOptions.md index 6e6b27aa2..95e568924 100644 --- a/docs/reference/interfaces/BTreeIndexOptions.md +++ b/docs/reference/interfaces/BTreeIndexOptions.md @@ -5,7 +5,7 @@ title: BTreeIndexOptions # Interface: BTreeIndexOptions -Defined in: [packages/db/src/indexes/btree-index.ts:11](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L11) +Defined in: [packages/db/src/indexes/btree-index.ts:12](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L12) Options for Ordered index @@ -17,7 +17,7 @@ Options for Ordered index optional compareFn: (a, b) => number; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:12](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L12) +Defined in: [packages/db/src/indexes/btree-index.ts:13](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L13) #### Parameters @@ -41,4 +41,4 @@ Defined in: [packages/db/src/indexes/btree-index.ts:12](https://github.com/TanSt optional compareOptions: CompareOptions; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:13](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L13) +Defined in: [packages/db/src/indexes/btree-index.ts:14](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L14) diff --git a/docs/reference/interfaces/BaseCollectionConfig.md b/docs/reference/interfaces/BaseCollectionConfig.md index ff3e0d26a..a9e36c7a1 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 diff --git a/docs/reference/interfaces/BaseStrategy.md b/docs/reference/interfaces/BaseStrategy.md index 74a111788..af8c9a5aa 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 fc18e33a1..dd5b3fb49 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 9cebcdecf..a11199f06 100644 --- a/docs/reference/interfaces/Collection.md +++ b/docs/reference/interfaces/Collection.md @@ -406,7 +406,7 @@ 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 @@ -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 @@ -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) @@ -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) @@ -1117,7 +1117,7 @@ Function called when items change ##### options -[`SubscribeChangesOptions`](./SubscribeChangesOptions.md) = `{}` +[`SubscribeChangesOptions`](SubscribeChangesOptions.md) = `{}` Subscription options including includeInitialState and where filter @@ -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) @@ -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) @@ -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) @@ -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) diff --git a/docs/reference/interfaces/CollectionConfig.md b/docs/reference/interfaces/CollectionConfig.md index 6bb4f4199..f4a8dbc89 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 @@ -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 eba548443..dd00a15d6 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 diff --git a/docs/reference/interfaces/CreateOptimisticActionsOptions.md b/docs/reference/interfaces/CreateOptimisticActionsOptions.md index b8c99b1ad..3e20fe56d 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) *** diff --git a/docs/reference/interfaces/DebounceStrategy.md b/docs/reference/interfaces/DebounceStrategy.md index 6e659bc0e..9ca361705 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 5a495613f..5a649aa31 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) *** @@ -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/LiveQueryCollectionConfig.md b/docs/reference/interfaces/LiveQueryCollectionConfig.md index d17f76708..b2b9df507 100644 --- a/docs/reference/interfaces/LiveQueryCollectionConfig.md +++ b/docs/reference/interfaces/LiveQueryCollectionConfig.md @@ -35,7 +35,7 @@ const config: LiveQueryCollectionConfig = { ### TContext -`TContext` *extends* [`Context`](./Context.md) +`TContext` *extends* [`Context`](Context.md) ### TResult diff --git a/docs/reference/interfaces/LocalOnlyCollectionConfig.md b/docs/reference/interfaces/LocalOnlyCollectionConfig.md index 4cbeb05d6..cfee0127e 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 c0f03283d..c86fbc07b 100644 --- a/docs/reference/interfaces/LocalOnlyCollectionUtils.md +++ b/docs/reference/interfaces/LocalOnlyCollectionUtils.md @@ -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 1d9641c76..81c4b21db 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 74ca57c06..9472f18f6 100644 --- a/docs/reference/interfaces/LocalStorageCollectionUtils.md +++ b/docs/reference/interfaces/LocalStorageCollectionUtils.md @@ -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 59ae447d8..9d38e5a51 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 cbf3c615e..2b9c68cc9 100644 --- a/docs/reference/interfaces/PendingMutation.md +++ b/docs/reference/interfaces/PendingMutation.md @@ -22,7 +22,7 @@ Contains information about the original and modified data, as well as metadata ### 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 f220cefb9..b38776d5c 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/RangeQueryOptions.md b/docs/reference/interfaces/RangeQueryOptions.md index cae26c2a6..cdf9c1ba4 100644 --- a/docs/reference/interfaces/RangeQueryOptions.md +++ b/docs/reference/interfaces/RangeQueryOptions.md @@ -5,7 +5,7 @@ title: RangeQueryOptions # Interface: RangeQueryOptions -Defined in: [packages/db/src/indexes/btree-index.ts:19](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L19) +Defined in: [packages/db/src/indexes/btree-index.ts:20](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L20) Options for range queries @@ -17,7 +17,7 @@ Options for range queries optional from: any; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:20](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L20) +Defined in: [packages/db/src/indexes/btree-index.ts:21](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L21) *** @@ -27,7 +27,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:20](https://github.com/TanSt optional fromInclusive: boolean; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:22](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L22) +Defined in: [packages/db/src/indexes/btree-index.ts:23](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L23) *** @@ -37,7 +37,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:22](https://github.com/TanSt optional to: any; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:21](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L21) +Defined in: [packages/db/src/indexes/btree-index.ts:22](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L22) *** @@ -47,4 +47,4 @@ Defined in: [packages/db/src/indexes/btree-index.ts:21](https://github.com/TanSt optional toInclusive: boolean; ``` -Defined in: [packages/db/src/indexes/btree-index.ts:23](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L23) +Defined in: [packages/db/src/indexes/btree-index.ts:24](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L24) diff --git a/docs/reference/interfaces/SubscribeChangesSnapshotOptions.md b/docs/reference/interfaces/SubscribeChangesSnapshotOptions.md index 538b5b8eb..891572c77 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/SyncConfig.md b/docs/reference/interfaces/SyncConfig.md index 4435cb981..495813de2 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 diff --git a/docs/reference/interfaces/ThrottleStrategy.md b/docs/reference/interfaces/ThrottleStrategy.md index 021b995a3..0732d3b3a 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 54a72db64..cffa50699 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 diff --git a/docs/reference/powersync-db-collection/index.md b/docs/reference/powersync-db-collection/index.md index f0ccfa5f9..f6467856d 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/PowerSyncCollectionUtils.md b/docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionUtils.md index 7707d9cc2..6657add36 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 296cfbba7..2ce69107c 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/query-db-collection/classes/DeleteOperationItemNotFoundError.md b/docs/reference/query-db-collection/classes/DeleteOperationItemNotFoundError.md index 42c8651ec..ed4d24c84 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 c16216a59..8c6038af9 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 8247b446e..adb0bb685 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 9352db37d..bc37f4f43 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 66397ac56..9643105fc 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 42734e4e8..a9c7f9a17 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 c157cf4e7..a1ee4accc 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 7530e3545..cf983aae2 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 8013b6450..4e443177e 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 b3c3c6a3e..8acbcf589 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 5efa4a6b7..fdbbafa46 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 e3b0b4829..25a501e89 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 5575b2a5c..0fd2aab5c 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 a5ce2ea4c..3a86f840e 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/index.md b/docs/reference/query-db-collection/index.md index 7449dd1d1..569ee31dd 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/CollectionConfigSingleRowOption.md b/docs/reference/type-aliases/CollectionConfigSingleRowOption.md index 550b4bd16..fb95fbc12 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 7c5c1ada1..35716ab0e 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 fa1cf399c..2e3885ea7 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/InsertMutationFn.md b/docs/reference/type-aliases/InsertMutationFn.md index 458c76219..be33c491a 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 69258624b..5a443bb6a 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 0872eaefc..540df483f 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 1bf4373d6..9ebaa5538 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/ResolveTransactionChanges.md b/docs/reference/type-aliases/ResolveTransactionChanges.md index 89af36e85..12a4e2ed0 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 b6eacb4bf..e7dd3712d 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 417a0df00..3aca2e51f 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 abeb57229..62f96c857 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 712ace30b..64965f2a0 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 38a77e83b..8aa5a3cba 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/package.json b/package.json index 3f377c21e..6386bd547 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,6 @@ "format": "prettier --experimental-cli --ignore-unknown '**/*' --write", "lint": "pnpm --filter \"./packages/**\" lint", "lint-all": "eslint . --fix", - "prepare": "husky", "test": "pnpm --filter \"./packages/**\" test", "test:docs": "node scripts/verify-links.ts", "generate-docs": "node scripts/generate-docs.ts" @@ -39,12 +38,9 @@ "eslint": "^9.39.1", "eslint-import-resolver-typescript": "^4.4.4", "eslint-plugin-react": "^7.37.5", - "husky": "^9.1.7", "jsdom": "^27.2.0", "knip": "^5.70.2", - "lint-staged": "^15.5.2", "markdown-link-extractor": "^4.0.3", - "mitt": "^3.0.1", "prettier": "^3.7.3", "publint": "^0.3.15", "sherif": "^1.9.0", @@ -55,10 +51,5 @@ "vite": "^7.2.6", "vitest": "^3.2.4", "zod": "^3.25.76" - }, - "lint-staged": { - "*.{ts,tsx}": [ - "eslint --fix" - ] } } diff --git a/packages/db/package.json b/packages/db/package.json index f918d6353..5e06358e7 100644 --- a/packages/db/package.json +++ b/packages/db/package.json @@ -54,6 +54,7 @@ "devDependencies": { "@vitest/coverage-istanbul": "^3.2.4", "arktype": "^2.1.27", + "mitt": "^3.0.1", "superjson": "^2.2.6", "temporal-polyfill": "^0.3.0" } diff --git a/packages/rxdb-db-collection/package.json b/packages/rxdb-db-collection/package.json index ac177f041..5e61c5c59 100644 --- a/packages/rxdb-db-collection/package.json +++ b/packages/rxdb-db-collection/package.json @@ -53,11 +53,11 @@ "src" ], "dependencies": { - "rxdb": "16.21.0", "@standard-schema/spec": "^1.0.0", "@tanstack/db": "workspace:*", "@tanstack/store": "^0.8.0", - "debug": "^4.4.3" + "debug": "^4.4.3", + "rxdb": "16.21.0" }, "peerDependencies": { "rxdb": ">=16.17.2", diff --git a/packages/svelte-db/tsconfig.json b/packages/svelte-db/tsconfig.json index fc534e3d5..58906938a 100644 --- a/packages/svelte-db/tsconfig.json +++ b/packages/svelte-db/tsconfig.json @@ -1,7 +1,6 @@ { "extends": "../../tsconfig.json", "compilerOptions": { - "types": ["svelte"], "target": "ES2020", "module": "ESNext", "moduleResolution": "Bundler", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index a1f5867d2..590f0dc10 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -59,24 +59,15 @@ importers: eslint-plugin-react: specifier: ^7.37.5 version: 7.37.5(eslint@9.39.1(jiti@2.6.1)) - husky: - specifier: ^9.1.7 - version: 9.1.7 jsdom: specifier: ^27.2.0 version: 27.2.0(postcss@8.5.6) knip: specifier: ^5.70.2 version: 5.70.2(@types/node@24.7.0)(typescript@5.9.3) - lint-staged: - specifier: ^15.5.2 - version: 15.5.2 markdown-link-extractor: specifier: ^4.0.3 version: 4.0.3 - mitt: - specifier: ^3.0.1 - version: 3.0.1 prettier: specifier: ^3.7.3 version: 3.7.3 @@ -709,6 +700,9 @@ importers: arktype: specifier: ^2.1.27 version: 2.1.27 + mitt: + specifier: ^3.0.1 + version: 3.0.1 superjson: specifier: ^2.2.6 version: 2.2.6 @@ -4945,10 +4939,6 @@ packages: resolution: {integrity: sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==} engines: {node: '>=16'} - commander@13.1.0: - resolution: {integrity: sha512-/rFeCpNJQbhSZjGVwO9RFV3xPqbnERS8MmIQzCtD/zl6gpJuV/bMLuN92oG3F7d8oDEHHRrujSXNUr8fpjntKw==} - engines: {node: '>=18'} - commander@2.20.3: resolution: {integrity: sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==} @@ -5706,10 +5696,6 @@ packages: resolution: {integrity: sha512-adbxcyWV46qiHyvSp50TKt05tB4tK3HcmF7/nxfAdhnox83seTDbwnaqKO4sXRy7roHAIFqJP/Rw/AuEbX61LA==} engines: {node: '>=6'} - execa@8.0.1: - resolution: {integrity: sha512-VyhnebXciFV2DESc+p6B+y0LjSm0krU4OgJN44qFAhBY0TJ+1V61tYD2+wHusZ6F9n5K+vl8k0sTy7PEfV4qpg==} - engines: {node: '>=16.17'} - expect-type@1.2.2: resolution: {integrity: sha512-JhFGDVJ7tmDJItKhYgJCGLOWjuK9vPxiXoUFLwLDc99NlmklilbiQJwoctZtt13+xMw91MCk/REan6MWHqDjyA==} engines: {node: '>=12.0.0'} @@ -5947,10 +5933,6 @@ packages: resolution: {integrity: sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w==} engines: {node: '>=6'} - get-stream@8.0.1: - resolution: {integrity: sha512-VaUJspBffn/LMCJVoMvSAdmscJyS1auj5Zulnn5UoYcY531UWmdwhRWkcGKnGU93m5HSXP9LP2usOryrBtQowA==} - engines: {node: '>=16'} - get-symbol-description@1.1.0: resolution: {integrity: sha512-w9UMqWwJxHNOvoNzSJ2oPF5wvYcvP7jUvYzhp67yEhTi17ZDBBC1z9pTdGuzjD+EFIqLSYRweZjqfiPzQ06Ebg==} engines: {node: '>= 0.4'} @@ -6123,15 +6105,6 @@ packages: resolution: {integrity: sha512-3gKm/gCSUipeLsRYZbbdA1BD83lBoWUkZ7G9VFrhWPAU76KwYo5KR8V28bpoPm/ygy0x5/GCbpRQdY7VLYCoIg==} hasBin: true - human-signals@5.0.0: - resolution: {integrity: sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ==} - engines: {node: '>=16.17.0'} - - husky@9.1.7: - resolution: {integrity: sha512-5gs5ytaNjBrh5Ow3zrvdUUY+0VxIuWVL4i9irt6friV+BqdCfmV11CQTWMiBYWHbXhco+J1kHfTOUkePhCDvMA==} - engines: {node: '>=18'} - hasBin: true - iconv-lite@0.4.24: resolution: {integrity: sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==} engines: {node: '>=0.10.0'} @@ -6344,10 +6317,6 @@ packages: resolution: {integrity: sha512-uQPm8kcs47jx38atAcWTVxyltQYoPT68y9aWYdV6yWXSyW8mzSat0TL6CiWdZeCdF3KrAvpVtnHbTv4RN+rqdQ==} engines: {node: '>=0.10.0'} - is-stream@3.0.0: - resolution: {integrity: sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==} - engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} - is-string@1.1.1: resolution: {integrity: sha512-BtEeSsoaQjlSPBemMQIrY1MY0uM6vnS1g5fmufYOtnxLGUZM2178PKbhsk7Ffv58IX+ZtcvoGwccYsh0PglkAA==} engines: {node: '>= 0.4'} @@ -6688,15 +6657,6 @@ packages: linkify-it@5.0.0: resolution: {integrity: sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==} - lint-staged@15.5.2: - resolution: {integrity: sha512-YUSOLq9VeRNAo/CTaVmhGDKG+LBtA8KF1X4K5+ykMSwWST1vDxJRB2kv2COgLb1fvpCo+A/y9A0G0znNVmdx4w==} - engines: {node: '>=18.12.0'} - hasBin: true - - listr2@8.3.3: - resolution: {integrity: sha512-LWzX2KsqcB1wqQ4AHgYb4RsDXauQiqhjLk+6hjbaeHG4zpjjVAB6wC/gz6X0l+Du1cN3pUB5ZlrvTbhGSNnUQQ==} - engines: {node: '>=18.0.0'} - listr2@9.0.1: resolution: {integrity: sha512-SL0JY3DaxylDuo/MecFeiC+7pedM0zia33zl0vcjgwcq1q1FWWF1To9EIauPbl8GbMCU0R2e0uJ8bZunhYKD2g==} engines: {node: '>=20.0.0'} @@ -6847,9 +6807,6 @@ packages: resolution: {integrity: sha512-Snk314V5ayFLhp3fkUREub6WtjBfPdCPY1Ln8/8munuLuiYhsABgBVWsozAG+MWMbVEvcdcpbi9R7ww22l9Q3g==} engines: {node: '>=18'} - merge-stream@2.0.0: - resolution: {integrity: sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==} - merge2@1.4.1: resolution: {integrity: sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==} engines: {node: '>= 8'} @@ -6888,10 +6845,6 @@ packages: engines: {node: '>=4.0.0'} hasBin: true - mimic-fn@4.0.0: - resolution: {integrity: sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw==} - engines: {node: '>=12'} - mimic-function@5.0.1: resolution: {integrity: sha512-VP79XUPxV2CigYP3jWwAUFSku2aKqBH7uTAapFWCBqutsbmDo96KY5o8uh6U+/YSIn5OxJnXp73beVkpqMIGhA==} engines: {node: '>=18'} @@ -7151,10 +7104,6 @@ packages: resolution: {integrity: sha512-lJxZYlT4DW/bRUtFh1MQIWqmLwQfAxnqWG4HhEdjMlkrJYnJn0Jrr2u3mgxqaWsdiBc76TYkTG/mhrnYTuzfHw==} engines: {node: '>=4'} - npm-run-path@5.3.0: - resolution: {integrity: sha512-ppwTtiJZq0O/ai0z7yfudtBpWIoxM8yE6nHi1X47eFR2EWORqfbu6CnPlNsjeN683eT0qG6H/Pyf9fCcvjnnnQ==} - engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} - nth-check@2.1.1: resolution: {integrity: sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==} @@ -7209,10 +7158,6 @@ packages: once@1.4.0: resolution: {integrity: sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==} - onetime@6.0.0: - resolution: {integrity: sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ==} - engines: {node: '>=12'} - onetime@7.0.0: resolution: {integrity: sha512-VXJjc87FScF88uafS3JllDgvAm+c/Slfz06lorj2uAY34rlUu0Nt+v8wreiImcrgAjjIHp1rXpTDlLOGw29WwQ==} engines: {node: '>=18'} @@ -7348,10 +7293,6 @@ packages: resolution: {integrity: sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==} engines: {node: '>=8'} - path-key@4.0.0: - resolution: {integrity: sha512-haREypq7xkM7ErfgIyA0z+Bj4AGKlMSdlQE2jvJo6huWD1EdkKYV+G/T4nq0YEF2vgTT8kqMFKo1uHn950r4SQ==} - engines: {node: '>=12'} - path-parse@1.0.7: resolution: {integrity: sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==} @@ -7421,11 +7362,6 @@ packages: resolution: {integrity: sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==} engines: {node: '>=12'} - pidtree@0.6.0: - resolution: {integrity: sha512-eG2dWTVw5bzqGRztnHExczNxt5VGsE6OwTeCG3fdUf9KBsZzO3R5OIIIzWR+iZA0NtZ+RDVdaoE2dK1cn6jH4g==} - engines: {node: '>=0.10'} - hasBin: true - pify@2.3.0: resolution: {integrity: sha512-udgsAY+fTnvv7kI7aaxbqwWNb0AHiB0qBO89PZKPkoTmGOgdbrHDKD+0B2X4uTfJ/FT1R09r9gTsjUjNJotuog==} engines: {node: '>=0.10.0'} @@ -8198,10 +8134,6 @@ packages: resolution: {integrity: sha512-7FCwGGmx8mD5xQd3RPUvnSpUXHM3BWuzjtpD4TXsfcZ9EL4azvVVUscFYwD9nx8Kh+uCBC00XBtAykoMHwTh8Q==} engines: {node: '>=0.10.0'} - strip-final-newline@3.0.0: - resolution: {integrity: sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw==} - engines: {node: '>=12'} - strip-indent@3.0.0: resolution: {integrity: sha512-laJTa3Jb+VQpaC6DseHhF7dXVqHTfJPCRDaEbid/drOhgitgYku/letMUqOXFoWV0zIIUbjpdH2t+tYj4bQMRQ==} engines: {node: '>=8'} @@ -13583,8 +13515,6 @@ snapshots: commander@11.1.0: optional: true - commander@13.1.0: {} - commander@2.20.3: optional: true @@ -14473,18 +14403,6 @@ snapshots: signal-exit: 3.0.7 strip-eof: 1.0.0 - execa@8.0.1: - dependencies: - cross-spawn: 7.0.6 - get-stream: 8.0.1 - human-signals: 5.0.0 - is-stream: 3.0.0 - merge-stream: 2.0.0 - npm-run-path: 5.3.0 - onetime: 6.0.0 - signal-exit: 4.1.0 - strip-final-newline: 3.0.0 - expect-type@1.2.2: {} exponential-backoff@3.1.2: {} @@ -14828,8 +14746,6 @@ snapshots: dependencies: pump: 3.0.3 - get-stream@8.0.1: {} - get-symbol-description@1.1.0: dependencies: call-bound: 1.0.4 @@ -15006,10 +14922,6 @@ snapshots: human-id@4.1.1: {} - human-signals@5.0.0: {} - - husky@9.1.7: {} - iconv-lite@0.4.24: dependencies: safer-buffer: 2.1.2 @@ -15202,8 +15114,6 @@ snapshots: is-stream@1.1.0: {} - is-stream@3.0.0: {} - is-string@1.1.1: dependencies: call-bound: 1.0.4 @@ -15563,30 +15473,6 @@ snapshots: dependencies: uc.micro: 2.1.0 - lint-staged@15.5.2: - dependencies: - chalk: 5.6.2 - commander: 13.1.0 - debug: 4.4.3 - execa: 8.0.1 - lilconfig: 3.1.3 - listr2: 8.3.3 - micromatch: 4.0.8 - pidtree: 0.6.0 - string-argv: 0.3.2 - yaml: 2.8.1 - transitivePeerDependencies: - - supports-color - - listr2@8.3.3: - dependencies: - cli-truncate: 4.0.0 - colorette: 2.0.20 - eventemitter3: 5.0.1 - log-update: 6.1.0 - rfdc: 1.4.1 - wrap-ansi: 9.0.2 - listr2@9.0.1: dependencies: cli-truncate: 4.0.0 @@ -15761,8 +15647,6 @@ snapshots: merge-descriptors@2.0.0: {} - merge-stream@2.0.0: {} - merge2@1.4.1: {} methods@1.1.2: {} @@ -15788,8 +15672,6 @@ snapshots: mime@2.6.0: {} - mimic-fn@4.0.0: {} - mimic-function@5.0.1: {} min-indent@1.0.1: {} @@ -16039,10 +15921,6 @@ snapshots: dependencies: path-key: 2.0.1 - npm-run-path@5.3.0: - dependencies: - path-key: 4.0.0 - nth-check@2.1.1: dependencies: boolbase: 1.0.0 @@ -16101,10 +15979,6 @@ snapshots: dependencies: wrappy: 1.0.2 - onetime@6.0.0: - dependencies: - mimic-fn: 4.0.0 - onetime@7.0.0: dependencies: mimic-function: 5.0.1 @@ -16280,8 +16154,6 @@ snapshots: path-key@3.1.1: {} - path-key@4.0.0: {} - path-parse@1.0.7: {} path-scurry@1.11.1: @@ -16340,8 +16212,6 @@ snapshots: picomatch@4.0.3: {} - pidtree@0.6.0: {} - pify@2.3.0: {} pify@4.0.1: {} @@ -17280,8 +17150,6 @@ snapshots: strip-eof@1.0.0: {} - strip-final-newline@3.0.0: {} - strip-indent@3.0.0: dependencies: min-indent: 1.0.1