Interface: ClaimSpec<S, Ctx, D, A>

Defined in: modal/claims.ts:51

Type Parameters

S

S

Ctx

Ctx

D

D

A

A

Properties

acquire

acquire: (desire, signal) => Promise<A>

Defined in: modal/claims.ts:55

Bring the operation into being. The signal aborts on supersession/ceiling.

Parameters

desire

D

signal

AbortSignal

Returns

Promise<A>

---

ceilingMs?

optional ceilingMs?: number

Defined in: modal/claims.ts:59

Hard ceiling for one acquire; omit for self-bounded transports.

---

derive

derive: (state, ctx) => D | null

Defined in: modal/claims.ts:53

The pure derivation: what should exist right now (null = nothing).

Parameters

state

S

ctx

Ctx

Returns

D | null

---

release?

optional release?: (actual, desire) => void | Promise<void>

Defined in: modal/claims.ts:57

Tear it down. Must be idempotent-ish; errors are reported, not fatal.

Parameters

actual

A

desire

D

Returns

void | Promise<void>

---

same?

optional same?: (a, b) => boolean

Defined in: modal/claims.ts:61

Desire equality; defaults to structural (JSON) equality.

Parameters

a

D

b

D

Returns

boolean