Remote / foldkit-remote

Capabilities

interface · packages/remote/src/capability.ts:42

interface Capabilities {
  readonly domain: string
  layers: Option.Option<LayerCapability>
  writes: Option.Option<WriteCapability>
  live: Option.Option<LiveCapability>
  bodies: Option.Option<BodyCapability>
}

The code a domain's declarations installed, by what it does.

Members

Capabilities.domain

property · packages/remote/src/capability.ts:44

readonly domain: string

The domain's name, for the defect a missing capability is.

Capabilities.layers

property · packages/remote/src/capability.ts:46

layers: Option.Option<LayerCapability>

Shows pending layers and overlays; installed by whatever makes one.

Capabilities.writes

property · packages/remote/src/capability.ts:48

writes: Option.Option<WriteCapability>

mutate and retry; installed by a Mutation the domain registers.

Capabilities.live

property · packages/remote/src/capability.ts:50

live: Option.Option<LiveCapability>

Live streams and their events; installed by a live read (foldkit-remote/live).

Capabilities.bodies

property · packages/remote/src/capability.ts:52

bodies: Option.Option<BodyCapability>

What a list's body does on the client; installed by a query declared with a body (Query.define).