F+Foldkit Plus
HomeLearnPackagesComponentsDemosGitHub ↗

Remote

Guides

foldkit-remote

  • Overview
  • If you know TanStack Query, TanStack DB or fate
  • Find what you need
  • Which state belongs here?
  • The mental model
  • The first run: one entity, one Surface
  • Routing Remote's Messages
  • RemoteData: what does the Model know right now?
  • When it does not do what you expect
  • Normalized entities and selections
  • Reading, policies, and prefetch
  • Queries and pagination
  • Mutations and optimistic state
  • Live data
  • Retention and garbage collection
  • Persistence and hydration
  • Server rendering: Remote.resume
  • How the server packages fit
  • Introspection
  • Advanced: the kernel
  • What Remote owns
  • Limits
  • See also

foldkit-remote-server

  • Overview
  • Sixty seconds: answer one Entity read
  • The read lifecycle
  • Queries
  • Mutations
  • Live data
  • Authentication vs authorization
  • Compose and validate the server
  • Hardening
  • A backend held in memory
  • Over a MessagePort
  • Over plain JSON
  • Over fetch (Workers)

foldkit-remote-drizzle

  • Overview
  • Sixty seconds: one table, one Entity, one Source
  • Put the Source behind RemoteServer
  • The binding is the shared schema
  • Binding a foldkit-entity domain
  • Which rows a principal may see
  • Field authorization stays in RemoteServer
  • Singular relations
  • Collection relations
  • Windowed collection relations
  • Query connections
  • Mutations
  • Testing a binding
  • Diagnose the first read

Server-derived state

  • Overview
  • How they fit together
  • What is normalized
  • Requirements and observation
  • Mutations and live data
  • One owner per datum
  • Persistence and recovery
  • When not to use Remote
  • Worked examples and limits

API

foldkit-remote

  • foldkit-remote
  • foldkit-remote/port

foldkit-remote-server

  • foldkit-remote-server
  • foldkit-remote-server/port
  • foldkit-remote-server/fetch

foldkit-remote-drizzle

  • foldkit-remote-drizzle

Open source, MIT
Foldkit 0.168 · Effect 4

Remote / foldkit-remote

MergePolicy

type · packages/remote/src/persistence.ts:89

type MergePolicy = 'replace' | 'preserve-existing'

How a snapshot meets a store that already has entries.

Previousfoldkit-remote

Edit on GitHub ↗

This site is a Foldkit Plus application, rendered at build time with foldkit-ssr. Its source

FoldkitEffectGitHub