Graphorin API reference v0.12.1

---

Graphorin API reference / @graphorin/server / / SubscribeResult

Type Alias: SubscribeResult

type SubscribeResult = 
  | {
  ok: true;
  replayedCount: number;
  snapshotEventId: string | undefined;
  subscription: WsSubscriptionSnapshot;
  dispatchReplay: void;
}
  | {
  ok: false;
  reason:   | "subject-malformed"
     | "subject-unknown"
     | "subject-wildcard"
     | "scope-denied";
};

Defined in: packages/server/src/ws/dispatcher.ts:117

Result of WsDispatcher.subscribe.

Union Members

Type Literal

{
  ok: true;
  replayedCount: number;
  snapshotEventId: string | undefined;
  subscription: WsSubscriptionSnapshot;
  dispatchReplay: void;
}

Name	Type	Description	Defined in
ok	true	-	packages/server/src/ws/dispatcher.ts:119
replayedCount	number	-	packages/server/src/ws/dispatcher.ts:121
snapshotEventId	string | undefined	-	packages/server/src/ws/dispatcher.ts:122
subscription	WsSubscriptionSnapshot	-	packages/server/src/ws/dispatcher.ts:120
dispatchReplay()	() => void	E-02 (S-15/8): deliver the replay frames captured at subscribe time. Idempotent - the second call is a no-op. When deferReplay was not requested the frames were already dispatched inside subscribe() and this is a no-op too.	packages/server/src/ws/dispatcher.ts:129

---

Type Literal

{
  ok: false;
  reason:   | "subject-malformed"
     | "subject-unknown"
     | "subject-wildcard"
     | "scope-denied";
}

Stable