BroadcastPayoutsCommandOptions | @dhealthdapps/backend

interface: BroadcastPayoutsCommandOptions
description: This interface defines arguments that can be passed to this processor command that is implemented in the backend runtime.

Note that it is important that child classes extend this interface with their own specification of arguments.

Additional note relating to this implementation is that the payout preparation command does not need any other command options.
see: PayoutCommandOptions
since: v0.4.0

Hierarchy

PayoutCommandOptions
- BroadcastPayoutsCommandOptions

Index

Properties

Optional debug

debug?: boolean

Whether debug must be enabled. Enabling this argument will display log messages for all modes (including mode debug).

When this argument is enabled, it is possible that many logs will be printed to the terminal/shell during runtime.

access: public
var: {boolean}

dryRun

dryRun: boolean

Defines whether the command is executed in "dry-mode" or not. In dry-mode, commands will not broadcast transactions. Transactions may still be prepared.

access: public
var: {boolean}

maxCount

maxCount: number

Defines the maximum number of broadcast operations that will be executed with this command execution.

access: public
var: {number}

Optional quiet

quiet?: boolean

Whether quiet must be enabled. Enabling this argument will display no log messages at all except for errors.

When this argument is enabled, the runtime will not produce any logs outside of errors.

access: public
var: {boolean}