DocsReference@proto-kit/indexerClassesIndexSettlementTask

@proto-kit/indexerDocs


Documentation / @proto-kit/indexer / IndexSettlementTask

Class: IndexSettlementTask

Used by various module sub-types that may need to be configured

Extends

Implements

Constructors

new IndexSettlementTask()

new IndexSettlementTask(settlementStorage): IndexSettlementTask

Parameters

settlementStorage: SettlementStorage

Returns

IndexSettlementTask

Overrides

TaskWorkerModule.constructor

Defined in

indexer/src/tasks/IndexSettlementTask.ts:20

Properties

currentConfig

protected currentConfig: undefined | NoConfig

Store the config separately, so that we can apply additional checks when retrieving it via the getter

Inherited from

TaskWorkerModule.currentConfig

Defined in

common/dist/config/ConfigurableModule.d.ts:17


name

name: string = "index-settlement"

Implementation of

Task.name

Defined in

indexer/src/tasks/IndexSettlementTask.ts:18


settlementStorage

settlementStorage: SettlementStorage

Defined in

indexer/src/tasks/IndexSettlementTask.ts:22

Accessors

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

config: Config

Returns

void

Inherited from

TaskWorkerModule.config

Defined in

common/dist/config/ConfigurableModule.d.ts:18

Methods

compute()

compute(input): Promise<string | void>

Parameters

input: Settlement

Returns

Promise<string | void>

Implementation of

Task.compute

Defined in

indexer/src/tasks/IndexSettlementTask.ts:30


create()

create(childContainerProvider): void

Parameters

childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

TaskWorkerModule.create

Defined in

common/dist/config/ConfigurableModule.d.ts:20


inputSerializer()

inputSerializer(): TaskSerializer<Settlement>

Returns

TaskSerializer<Settlement>

Implementation of

Task.inputSerializer

Defined in

indexer/src/tasks/IndexSettlementTask.ts:42


prepare()

prepare(): Promise<void>

Returns

Promise<void>

Implementation of

Task.prepare

Defined in

indexer/src/tasks/IndexSettlementTask.ts:28


resultSerializer()

resultSerializer(): TaskSerializer<string | void>

Returns

TaskSerializer<string | void>

Implementation of

Task.resultSerializer

Defined in

indexer/src/tasks/IndexSettlementTask.ts:54