Appearance

Documentation / @etherfold/browser / createIndexerState

Function: createIndexerState() ​

createIndexerState<ABI, ProcessResultType, ProcessorConfig>(processor, options?): object

Defined in: browser/src/IndexerState.ts:59

Type Parameters ​

ABI ​

ABI extends Abi

ProcessResultType ​

ProcessResultType

ProcessorConfig ​

ProcessorConfig = undefined

Parameters ​

processor ​

EventProcessorWithInitialState<ABI, ProcessResultType, ProcessorConfig>

options? ​

catchupThreshold? ​

number

createIndexer? ​

(provider, processor, source, config) => EthereumIndexer<ABI, ProcessResultType>

keepState? ​

KeepState<ABI, ProcessResultType, unknown, ProcessorConfig>

keepStream? ​

ExistingStream<ABI>

logRequests? ​

boolean

trackNumRequests? ​

boolean

Returns ​

object

dispose ​

dispose: () => void

Returns ​

void

indexMore ​

indexMore: () => Promise<LastSync<ABI>>

Returns ​

Promise<LastSync<ABI>>

indexMoreAndCatchupIfNeeded ​

indexMoreAndCatchupIfNeeded: () => Promise<LastSync<ABI>>

Returns ​

Promise<LastSync<ABI>>

indexToLatest ​

indexToLatest: () => Promise<LastSync<ABI>>

Returns ​

Promise<LastSync<ABI>>

init ​

init: InitFunction<ABI, ProcessorConfig>

reset ​

reset: () => Promise<void>

Returns ​

Promise<void>

startAutoIndexing ​

startAutoIndexing: (intervalInSeconds) => Promise<boolean>

Parameters ​

intervalInSeconds? ​

number = 4

Returns ​

Promise<boolean>

state ​

state: object

state.subscribe ​

subscribe: (this, run, invalidate?) => Unsubscriber = readableState.subscribe

Subscribe on value changes.

Parameters ​
this ​

void

run ​

Subscriber<ProcessResultType>

subscription callback

invalidate? ​

Invalidator<ProcessResultType>

cleanup callback

Returns ​

Unsubscriber

state.$state ​

Get Signature ​

get $state(): ProcessResultType

Defined in: browser/src/IndexerState.ts:455

Returns ​

ProcessResultType

status ​

status: object

status.subscribe ​

subscribe: (this, run, invalidate?) => Unsubscriber = readableStatus.subscribe

Subscribe on value changes.

Parameters ​
this ​

void

run ​

Subscriber<StatusState>

subscription callback

invalidate? ​

Invalidator<StatusState>

cleanup callback

Returns ​

Unsubscriber

status.$state ​

Get Signature ​

get $state(): StatusState

Defined in: browser/src/IndexerState.ts:461

Returns ​

StatusState

stopAutoIndexing ​

stopAutoIndexing: () => boolean

Returns ​

boolean

syncing ​

syncing: object

syncing.subscribe ​

subscribe: (this, run, invalidate?) => Unsubscriber = readableSyncing.subscribe

Subscribe on value changes.

Parameters ​
this ​

void

run ​

Subscriber<SyncingState<ABI>>

subscription callback

invalidate? ​

Invalidator<SyncingState<ABI>>

cleanup callback

Returns ​

Unsubscriber

syncing.$state ​

Get Signature ​

get $state(): SyncingState<ABI>

Defined in: browser/src/IndexerState.ts:449

Returns ​

SyncingState<ABI>

updateIndexer() ​

updateIndexer(update): Promise<void>

Parameters ​

update ​
provider? ​

EIP1193ProviderWithoutEvents

source? ​

IndexingSource<ABI>

streamConfig? ​

ProvidedStreamConfig

Returns ​

Promise<void>

updateProcessor() ​

updateProcessor(newProcessor, options?): Promise<void>

Parameters ​

newProcessor ​

EventProcessorWithInitialState<ABI, ProcessResultType, ProcessorConfig>

options? ​
force? ​

boolean

Returns ​

Promise<void>

withHooks() ​

withHooks(react): object

Parameters ​

react ​

ReactHooks

Returns ​

object

dispose ​

dispose: () => void

Returns ​

void

indexMore ​

indexMore: () => Promise<LastSync<ABI>>

Returns ​

Promise<LastSync<ABI>>

indexMoreAndCatchupIfNeeded ​

indexMoreAndCatchupIfNeeded: () => Promise<LastSync<ABI>>

Returns ​

Promise<LastSync<ABI>>

indexToLatest ​

indexToLatest: () => Promise<LastSync<ABI>>

Returns ​

Promise<LastSync<ABI>>

init ​

init: InitFunction<ABI, ProcessorConfig>

reset ​

reset: () => Promise<void>

Returns ​

Promise<void>

startAutoIndexing ​

startAutoIndexing: (intervalInSeconds) => Promise<boolean>

Parameters ​
intervalInSeconds? ​

number = 4

Returns ​

Promise<boolean>

state ​

state: object

state.subscribe ​

subscribe: (this, run, invalidate?) => Unsubscriber = readableState.subscribe

Subscribe on value changes.

Parameters ​
this ​

void

run ​

Subscriber<ProcessResultType>

subscription callback

invalidate? ​

Invalidator<ProcessResultType>

cleanup callback

Returns ​

Unsubscriber

state.$state ​
Get Signature ​

get $state(): ProcessResultType

Defined in: browser/src/IndexerState.ts:455

Returns ​

ProcessResultType

status ​

status: object

status.subscribe ​

subscribe: (this, run, invalidate?) => Unsubscriber = readableStatus.subscribe

Subscribe on value changes.

Parameters ​
this ​

void

run ​

Subscriber<StatusState>

subscription callback

invalidate? ​

Invalidator<StatusState>

cleanup callback

Returns ​

Unsubscriber

status.$state ​
Get Signature ​

get $state(): StatusState

Defined in: browser/src/IndexerState.ts:461

Returns ​

StatusState

stopAutoIndexing ​

stopAutoIndexing: () => boolean

Returns ​

boolean

syncing ​

syncing: object

syncing.subscribe ​

subscribe: (this, run, invalidate?) => Unsubscriber = readableSyncing.subscribe

Subscribe on value changes.

Parameters ​
this ​

void

run ​

Subscriber<SyncingState<ABI>>

subscription callback

invalidate? ​

Invalidator<SyncingState<ABI>>

cleanup callback

Returns ​

Unsubscriber

syncing.$state ​
Get Signature ​

get $state(): SyncingState<ABI>

Defined in: browser/src/IndexerState.ts:449

Returns ​

SyncingState<ABI>

useState ​

useState: () => ProcessResultType

Returns ​

ProcessResultType

useStatus ​

useStatus: () => StatusState

Returns ​

StatusState

useSyncing ​

useSyncing: () => SyncingState<ABI>

Returns ​

SyncingState<ABI>

updateIndexer() ​

updateIndexer(update): Promise<void>

Parameters ​
update ​
provider? ​

EIP1193ProviderWithoutEvents

source? ​

IndexingSource<ABI>

streamConfig? ​

ProvidedStreamConfig

Returns ​

Promise<void>

updateProcessor() ​

updateProcessor(newProcessor, options?): Promise<void>

Parameters ​
newProcessor ​

EventProcessorWithInitialState<ABI, ProcessResultType, ProcessorConfig>

options? ​
force? ​

boolean

Returns ​

Promise<void>

withHooks() ​

withHooks(react): { useState: () => ProcessResultType; useSyncing: () => SyncingState<ABI>; useStatus: () => StatusState; syncing: { subscribe: (this: void, run: Subscriber<SyncingState<ABI>>, invalidate?: Invalidator<...> | undefined) => Unsubscriber; readonly $state: SyncingState<...>; }; ... 12 more ...; withHooks(react: ReactHook...

Parameters ​
react ​

ReactHooks

Returns ​

{ useState: () => ProcessResultType; useSyncing: () => SyncingState<ABI>; useStatus: () => StatusState; syncing: { subscribe: (this: void, run: Subscriber<SyncingState<ABI>>, invalidate?: Invalidator<...> | undefined) => Unsubscriber; readonly $state: SyncingState<...>; }; ... 12 more ...; withHooks(react: ReactHook...