Documentation / @etherfold/browser / EntityEventProcessorLike

Type Alias: EntityEventProcessorLike<ABI, ProcessResultType, ProcessorConfig>

EntityEventProcessorLike<ABI, ProcessResultType, ProcessorConfig> = EventProcessor<ABI, ProcessResultType> & object

Defined in: packages/browser/src/IndexerState.ts:317

What the hook needs from a deployment's processor.

Structural rather than an import of EntityEventProcessor, so that @etherfold/browser does not have to depend on one entity runtime in order to type the path. EntityEventProcessor (@etherfold/processor-entities) satisfies it; so would anything else that runs an entity processor against a store.

state is a READ HANDLE and not a state object: there is no initial state to CREATE, because the state is already in the store and is read back through the handle. The handle exists the moment the processor does, has stable identity, and is what load and process hand back.

There used to be a second shape here -- a ProcessorKind tag discriminating this from the free-form EventProcessorWithInitialState a KeepState keeper persisted whole. That path is gone (ADR-0037), so the tag discriminates nothing and the call shape is the processor itself.

Type Declaration

state

readonly state: ProcessResultType

configure()

configure(config): void

Parameters

config

ProcessorConfig

Returns

void

Type Parameters

ABI

ABI extends Abi

ProcessResultType

ProcessResultType

ProcessorConfig

ProcessorConfig