Documentation / @etherfold/browser / ExistingStream
Type Alias: ExistingStream<ABI> ​
ExistingStream<
ABI> =object
Defined in: packages/core/dist/types.d.ts:720
Type Parameters ​
ABI ​
ABI extends Abi
Properties ​
clear ​
clear:
StreamClearer<ABI>
Defined in: packages/core/dist/types.d.ts:723
fetchFrom ​
fetchFrom:
StreamFetcher<ABI>
Defined in: packages/core/dist/types.d.ts:721
saveNewEvents ​
saveNewEvents:
StreamSaver<ABI>
Defined in: packages/core/dist/types.d.ts:722
setStreamConfig? ​
optionalsetStreamConfig?: (streamConfig) =>void
Defined in: packages/core/dist/types.d.ts:739
The other half of the stream's IDENTITY, handed over by the indexer.
A stream is identified by its FETCH FILTER plus its stream CONFIG (streamDigestOf), and only the first of those travels with every call: the source is an argument, the config is not. A keeper that ADDRESSES a stream by that identity therefore has to be told, and the indexer is the one place that holds the RESOLVED config -- so it hands it over in reinit, before any other call and again on every reconfigure, rather than an application repeating it at the keeper's construction site where it could silently disagree with the config the indexer is actually running.
OPTIONAL because a keeper that addresses NOTHING has no use for it: one that holds exactly one stream serves it whatever it is asked for.
Parameters ​
streamConfig ​
Returns ​
void