Skip to content

Commit 5e6692c

Browse files
committed
Add comprehensive documentation to bindings
- Document all types and functions in SkipruntimeCore.res - Document broker, reducers, and external service helpers in SkipruntimeHelpers.res - Document server bindings in SkipruntimeServer.res - Fix params inconsistency: use None for optional getStreamUUID params - Simplify PLAN.md to high-level status summary
1 parent e960e21 commit 5e6692c

File tree

9 files changed

+635
-20
lines changed

9 files changed

+635
-20
lines changed

PLAN.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,13 @@ Goal: Idiomatic ReScript bindings for Skip runtime APIs.
1010
4. **JS helpers** — Class constructors, SSE streaming in `bindings/SkipruntimeCoreHelpers.mjs`
1111
5. **Examples**`LiveClient.res` (minimal), `LiveHarness.res` (reducer semantics + SSE subscription)
1212

13-
## Not yet bound (external service helpers)
13+
## External service helpers (now bound)
1414

15-
From `@skipruntime/helpers`, these are not bound but available for advanced use cases:
15+
From `@skipruntime/helpers`, for distributed/federated architectures:
1616

17-
- **PolledExternalService** — For polling external data sources into reactive collections
18-
- **SkipExternalService** — For connecting to remote Skip services
19-
- **asLeader / asFollower** — For service replication patterns
20-
21-
These are for distributed/federated architectures; add bindings if needed.
17+
- **PolledExternalService** — Poll external HTTP endpoints into reactive collections
18+
- **SkipExternalService** — Connect to remote Skip services via SSE
19+
- **asLeader / asFollower** — Leader-follower replication patterns
2220

2321
## Quick start
2422

0 commit comments

Comments
 (0)