Skip to content

Documentation / @etherfold/processor-entities / openForReading

Function: openForReading() ​

openForReading(store): StateStore

Defined in: packages/state-store/dist/store.d.ts:448

Hold a store as a READER: the same store, narrowed to what it can answer.

ts
function render(store: StateStore) { ... }
render(openForReading(writableStore));

It returns the very store it was handed and wraps nothing, because there is nothing to intercept: the TYPE is the whole guard. That is the one way it differs from readOnlyStream (ADR-0044), which SWALLOWS its writes -- it has to, because that seam's save is driven by the indexing loop, so a follower has nowhere to not call it from. Here the caller holds the handle and decides every call, so a discarded write would be a mutation that looked like it worked, which is the failure this whole split exists to prevent.

Parameters ​

store ​

StateStore

Returns ​

StateStore