demux
Options
All
  • Public
  • Public/Protected
  • All
Menu

Exposes the BaseActionWatcher's API methods through a simple REST interface using Express

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected actionHandler

actionHandler: AbstractActionHandler

Protected actionReader

actionReader: AbstractActionReader

express

express: Express = express()
param

The port to use for the Express server

Protected log

log: Logger
param

An instance of an implemented AbstractActionReader

param

An instance of an implemented AbstractActionHandler

param

Number of milliseconds between each polling loop iteration

Protected pollInterval

pollInterval: number

Protected port

port: number

Private server

server: Server | null = null

Accessors

info

info:

Information about the current state of Demux

Methods

Protected checkForBlocks

  • checkForBlocks(isReplay?: boolean): Promise<void>

  • Use the actionReader and actionHandler to process new blocks.

    Parameters

    • Default value isReplay: boolean = false

      Set to true to disable Effects from running until caught up with head block.

    Returns Promise<void>

close

  • close(): Promise<boolean>

listen

  • listen(): Promise<boolean>

pause

  • pause(): boolean

replay

  • replay(): Promise<void>

start

  • start(): boolean

watch

  • watch(isReplay?: boolean): Promise<void>

  • Start a polling loop

    Parameters

    • Default value isReplay: boolean = false

      Set to true to disable Effects from running until caught up with head block.

    Returns Promise<void>