foldkit-remote 0.11.0 → 0.13.0

package/README.md

@@ -348,6 +348,40 @@ const clientLayer = Layer.unwrap(
 )
 ```
 
+Or, with no Effect RPC on the server, plain JSON over HTTP: each call a `POST`
+of `{ operation, payload }`, answered `{ result }` or `{ error }`.
+[`RemoteServer.answer`](../remote-server/README.md#over-plain-json) is the
+other end. `Remote.json(send)` is the same client over any other way of
+sending the request, a worker or a server running in the page:
+
+```ts
+const overHttp = Remote.clientLayer(
+  Remote.http('/remote', { headers: () => ({ 'x-session': 'the session token' }) }),
+)
+```
+
+`headers` is read for each request, so a token that changes reaches the next
+call. Neither carries live data.
+
+For a server in a worker or in the page (a sandbox), `foldkit-remote/port`
+speaks Effect's own RPC worker protocol over a `MessagePort`, so live data,
+typed errors and interruption cross it too.
+[`servePort`](../remote-server/README.md#over-a-messageport) is the other end:
+
+```ts
+import { port } from 'foldkit-remote/port'
+
+// A new conversation each time the protocol connects: one port here, the other to the server.
+const overPort = port(() => {
+  const channel = new MessageChannel()
+  worker.port.postMessage({ open: 'remote' }, [channel.port2])
+  return channel.port1
+})
+```
+
+It is a `Layer<RemoteClient>` like the others; a port that cannot be set up is
+a defect, not a failed read.
+
 The stock client is accepted as it is. When its transport fails, the call
 fails with its own Remote error (`RemoteReadError`, `RemoteQueryError`,
 `RemoteMutationError`, `RemoteLiveError`), which the UI shows and retries like
@@ -500,7 +534,8 @@ When a read sits at `Initial` and you expected data, ask the Model why with
 `Data.why`; see [Why is it still `Initial`?](#why-is-it-still-initial).
 
 `RemoteData.match` is exhaustive, so adding or omitting a state is visible at
-compile time.
+compile time. `RemoteData.answered(data)` is whether a read has an answer yet:
+`Ready`, `Refreshing`, `Failed` or `NotFound`, not `Initial` or `Loading`.
 
 ### Drawing one: `RemoteData.render`