Update hivegrid-cloud reference to latest main
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
1 parent
e98d38e716
commit
7b21524c86
3781 files changed
+373484
-225607
No files matched your search
@@ -1,6 +1,6 @@
|
||||
# @toolctrl/realtime
|
||||
# @hivegrid/realtime
|
||||
|
||||
`@toolctrl/realtime` is the public package boundary for typed realtime notification events, server-side Server-Sent Events (SSE) serialization, and the browser-facing subscriber. Downstream API and UI code should import from the package entrypoint only; internal source files are not part of the contract.
|
||||
`@hivegrid/realtime` is the public package boundary for typed realtime notification events, server-side Server-Sent Events (SSE) serialization, and the browser-facing subscriber. Downstream API and UI code should import from the package entrypoint only; internal source files are not part of the contract.
|
||||
|
||||
## Public contract
|
||||
|
||||
@@ -24,7 +24,7 @@ The browser subscriber reports status transitions (`connecting`, `open`, `reconn
|
||||
## API publisher example
|
||||
|
||||
```ts
|
||||
import { REALTIME_EVENT_NAMES, serializeRealtimeEvent, type NotificationStreamItem } from "@toolctrl/realtime";
|
||||
import { REALTIME_EVENT_NAMES, serializeRealtimeEvent, type NotificationStreamItem } from "@hivegrid/realtime";
|
||||
|
||||
export function publishNotificationUpdate(item: NotificationStreamItem, requestId: string) {
|
||||
return serializeRealtimeEvent(
|
||||
@@ -44,7 +44,7 @@ export function publishNotificationUpdate(item: NotificationStreamItem, requestI
|
||||
## UI subscriber example
|
||||
|
||||
```ts
|
||||
import { subscribeToRealtime } from "@toolctrl/realtime";
|
||||
import { subscribeToRealtime } from "@hivegrid/realtime";
|
||||
|
||||
const subscriber = subscribeToRealtime({
|
||||
url: "https://api.example.com/v1/notifications/stream",
|
||||
@@ -61,4 +61,4 @@ const subscriber = subscribeToRealtime({
|
||||
subscriber.close();
|
||||
```
|
||||
|
||||
Importing from internal files such as `@toolctrl/realtime/src/events`, `@toolctrl/realtime/src/server`, or `@toolctrl/realtime/src/client` is unsupported; use `@toolctrl/realtime` so future internal refactors do not break downstream slices.
|
||||
Importing from internal files such as `@hivegrid/realtime/src/events`, `@hivegrid/realtime/src/server`, or `@hivegrid/realtime/src/client` is unsupported; use `@hivegrid/realtime` so future internal refactors do not break downstream slices.
|
||||
Reference in new issue
Block a user