this repo has no description
Update startSseConsumer JSDoc to reflect new priority semantics
The SDK `startSseConsumer` and `useStartSseConsumer` JSDocs still
described the old "pass a URL as a fallback for instances without
stored config" behavior — priority-3 semantics that no longer exist.
Under the collapsed chain, a caller-supplied URL is promoted to the
runtime override (priority 1) and wins over PDS accountConfig.
Documentation updated to match.
+11
-7
+5
-4
packages/opake-react/src/hooks/use-start-sse-consumer.ts
+5
-4
packages/opake-react/src/hooks/use-start-sse-consumer.ts
···
25
25
* Start the WASM SSE consumer imperatively. No corresponding stop —
26
26
* see the module comment for why.
27
27
*
28
-
* Omit `indexerUrl` to use the URL stored on the Opake instance from
29
-
* config (recommended). Pass an explicit value to override for
30
-
* instances without stored config. Pass `null` to skip the start
31
-
* (use when gating on a runtime condition).
28
+
* Omit `indexerUrl` to resolve via the Opake's priority chain (runtime
29
+
* override → PDS accountConfig → compile-time default). Pass an
30
+
* explicit string to promote it to the runtime override (priority 1),
31
+
* winning over PDS config for the rest of the session. Pass `null` to
32
+
* skip the start entirely (use when gating on a runtime condition).
32
33
*
33
34
* The Provider auto-starts the consumer unless `disableSseAutoStart`
34
35
* is set, so in most apps you don't need this hook at all. Use it
+6
-3
packages/opake-sdk/src/opake.ts
+6
-3
packages/opake-sdk/src/opake.ts
···
784
784
* snapshots cross into JS. Idempotent: safe to call multiple times
785
785
* (StrictMode double-mount is handled internally).
786
786
*
787
-
* `indexerUrl` is optional: if omitted, the URL is resolved from the
788
-
* Opake instance's stored config (loaded during `init`). Pass an
789
-
* explicit value as a fallback for instances without stored config.
787
+
* `indexerUrl` is optional. Omitted: resolve via the Opake's priority
788
+
* chain (runtime override → PDS accountConfig → compile-time default).
789
+
* Provided: promoted to the runtime override (priority 1) — it wins
790
+
* over PDS config and persists across subsequent indexer calls on the
791
+
* same Opake instance, so passing it here is equivalent to calling
792
+
* `setIndexerUrl` before start.
790
793
*/
791
794
@wrapWasmErrors
792
795
startSseConsumer(indexerUrl?: string): Promise<void> {