Appearance

Documentation / @etherfold/browser / BrowserGenerationRegistryOptions

Type Alias: BrowserGenerationRegistryOptions ​

BrowserGenerationRegistryOptions = object

Defined in: packages/browser/src/storage/generation/OnIndexedDB.ts:287

Properties ​

caps? ​

optional caps?: Partial<GenerationCaps>

Defined in: packages/browser/src/storage/generation/OnIndexedDB.ts:315

Overrides for BROWSER_GENERATION_CAPS.

dropState ​

dropState: (id) => Promise<void>

Defined in: packages/browser/src/storage/generation/OnIndexedDB.ts:297

How this deployment drops the state store a generation folded into.

Required, and injected rather than derived, because WHERE a generation's state lives is decided by the container above StateStore -- a later task -- and a registry that invented a database-naming convention here would fork one the rest of the system does not share. On the IndexedDB default that is indexedDB.deleteDatabase(...) of whatever the host named it.

Parameters ​

id ​

GenerationId

Returns ​

Promise<void>

readStateCursor? ​

optional readStateCursor?: (id) => Promise<number | undefined>

Defined in: packages/browser/src/storage/generation/OnIndexedDB.ts:313

How far the fold in one generation's state got (lastToBlock), for a generation the asker holds no fold for -- dropState's READ sibling, and injected for the same reason (see GenerationRegistryPort.readStateCursor).

OPTIONAL here and REQUIRED of nobody on this runtime, which is a statement about which container reads it rather than an exception to "every host that names the tables supplies it". A tab runs the CHAIN-FACING container, whose promotion trigger reads the cursor each held ENGINE publishes, so nothing here asks -- and a required option nothing consults would be accepted and ignored. A RECEIVING container over this port (ReceivingIndexer, what a server and the CLI fold through) is the one that asks, and it cannot promote on its own without it: absent, every position reads as NOT READABLE and the pointer stays where it is.

Parameters ​

id ​

GenerationId

Returns ​

Promise<number | undefined>

store? ​

optional store?: UseStore

Defined in: packages/browser/src/storage/generation/OnIndexedDB.ts:321

The idb-keyval store to keep the records in. Defaults to the shared one, which is the one the stream keeper writes into -- deliberately, since the sweep has to SEE those subtrees.