ShapeGroupOptions

Defined in: packages/client/src/circuits/shape-group.ts:24

Properties

fetch?

optional fetch?: typeof fetch

Defined in: packages/client/src/circuits/shape-group.ts:29

---

live?

optional live?: boolean

Defined in: packages/client/src/circuits/shape-group.ts:28

---

onStreamEnd?

optional onStreamEnd?: (shape, error) => void

Defined in: packages/client/src/circuits/shape-group.ts:39

One shape’s read ENDED — null for a normal end, an error for a read that died mid-session.

Forwarded straight from readShapeStream’s onEnd, and never fired for a stream this group closed itself: unsubscribeAll is the caller’s own instruction, not a condition to recover from. See readShapeStream for why a consumer that ignores this goes permanently quiet instead of failing.

Parameters

shape

string

error

Error | null

Returns

void

---

onTokenRejected?

optional onTokenRejected?: (status) => string | Promise<string | null> | null

Defined in: packages/client/src/circuits/shape-group.ts:27

Parameters

status

number

Returns

string | Promise<string | null> | null

---

shapes

shapes: Record<string, GroupShapeSpec>

Defined in: packages/client/src/circuits/shape-group.ts:25

---

signal?

optional signal?: AbortSignal

Defined in: packages/client/src/circuits/shape-group.ts:30

---

token

token: () => string | Promise<string>

Defined in: packages/client/src/circuits/shape-group.ts:26

Returns

string | Promise<string>