Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/collections/electric-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: Electric Collection
---

# Electric Collection

Electric collections provide seamless integration between TanStack DB and ElectricSQL, enabling real-time data synchronization with your Postgres database through Electric's sync engine.

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/collections/local-only-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: LocalOnly Collection
---

# LocalOnly Collection

LocalOnly collections are designed for in-memory client data or UI state that doesn't need to persist across browser sessions or sync across tabs.

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/collections/local-storage-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: LocalStorage Collection
---

# LocalStorage Collection

LocalStorage collections store small amounts of local-only state that persists across browser sessions and syncs across browser tabs in real-time.

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/collections/powersync-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: PowerSync Collection
---

# PowerSync Collection

PowerSync collections provide seamless integration between TanStack DB and [PowerSync](https://powersync.com), enabling automatic synchronization between your in-memory TanStack DB collections and PowerSync's SQLite database. This gives you offline-ready persistence, real-time sync capabilities, and powerful conflict resolution.

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/collections/query-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: Query Collection
---

# Query Collection

Query collections provide seamless integration between TanStack DB and TanStack Query, enabling automatic synchronization between your local database and remote data sources.

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/collections/rxdb-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: RxDB Collection
---

# RxDB Collection

RxDB collections provide seamless integration between TanStack DB and [RxDB](https://rxdb.info), enabling automatic synchronization between your in-memory TanStack DB collections and RxDB's local-first database. Giving you offline-ready persistence, and powerful sync capabilities with a wide range of backends.


Expand Down
2 changes: 0 additions & 2 deletions docs/collections/trailbase-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: TrailBase Collection
---

# TrailBase Collection

TrailBase collections provide seamless integration between TanStack DB and [TrailBase](https://trailbase.io), enabling real-time data synchronization with TrailBase's self-hosted application backend.

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/community/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Community Resources
id: community-resources
---

# Community Resources

This page contains a curated list of community-created packages, tools, and resources that extend or complement TanStack DB.

## Community Packages
Expand Down
2 changes: 0 additions & 2 deletions docs/guides/collection-options-creator.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: Creating a Collection Options Creator
id: guide/collection-options-creator
---
# Creating a Collection Options Creator

A collection options creator is a factory function that generates configuration options for TanStack DB collections. It provides a standardized way to integrate different sync engines and data sources with TanStack DB's reactive sync-first architecture.

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/guides/error-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Error Handling
id: error-handling
---

# Error Handling

TanStack DB provides comprehensive error handling capabilities to ensure robust data synchronization and state management. This guide covers the built-in error handling mechanisms and how to work with them effectively.

## Error Types
Expand Down
2 changes: 0 additions & 2 deletions docs/guides/live-queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Live Queries
id: live-queries
---

# TanStack DB Live Queries

TanStack DB provides a powerful, type-safe query system that allows you to fetch, filter, transform, and aggregate data from collections using a SQL-like fluent API. All queries are **live** by default, meaning they automatically update when the underlying data changes.

The query system is built around an API similar to SQL query builders like Kysely or Drizzle where you chain methods together to compose your query. The query builder doesn't perform operations in the order of method calls - instead, it composes your query into an optimal incremental pipeline that gets compiled and executed efficiently. Each method returns a new query builder, allowing you to chain operations together.
Expand Down
2 changes: 0 additions & 2 deletions docs/guides/mutations.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Mutations
id: mutations
---

# TanStack DB Mutations

TanStack DB provides a powerful mutation system that enables optimistic updates with automatic state management. This system is built around a pattern of **optimistic mutation β†’ backend persistence β†’ sync back β†’ confirmed state**. This creates a highly responsive user experience while maintaining data consistency and being easy to reason about.

Local changes are applied immediately as optimistic state, then persisted to your backend, and finally the optimistic state is replaced by the confirmed server state once it syncs back.
Expand Down
2 changes: 0 additions & 2 deletions docs/guides/schemas.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Schemas
id: schemas
---

# Schema Validation and Type Transformations

TanStack DB uses schemas to ensure your data is valid and type-safe throughout your application.

## What You'll Learn
Expand Down
2 changes: 0 additions & 2 deletions docs/guides/ssr.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: SSR and Hydration
id: ssr
---

# SSR and Hydration

TanStack DB SSR transports the smallest useful snapshot for the work the server
performed:

Expand Down
2 changes: 0 additions & 2 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Overview
id: overview
---

# TanStack DB - Documentation

Welcome to the TanStack DB documentation.

TanStack DB is the reactive client store for your API. It solves the problems of building fast, modern apps, helping you:
Expand Down
3 changes: 3 additions & 0 deletions typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"hidePageTitle": true
}
Loading