Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StatefulModule Abstract

abstract
description

This concern requires the presence of fields that consist in delivering module-able information or information that is scoped/focussed in several submodules.

since

v0.1.0

Hierarchy

Index

Constructors

Properties

logger: LogService

Requires state information of the module. This object is typically populated upon first execution and updated any time later.

see

StateService

access

protected

var

{StateDocument}

stateService: StateService

Accessors

  • get stateIdentifier(): string
  • Getter for the discovery state identifier, e.g. "discovery.accounts", "discovery.transactions", "payout.outputs" etc.

    This method must be implemented by extended classes to create the correct state query for this discovery service.

    abstract
    access

    protected

    var

    {string}

    Returns string

Methods

  • debugLog(message: string): void
  • errorLog(message: string, stack?: string): void
  • getStateData(): any
  • This helper method should return the latest execution state such that it can be saved.

    Execution states refer to one module's required state data, potentially necessary during execution, and which is fetched in run before execution and updated in run after execution (using the name as an identifier).

    access

    protected

    Returns any

  • infoLog(message: string): void

Generated using TypeDoc