Interface Binding<C, I, A, D>

The concept of binding and its related services.

interface Binding {
    accumulator: A;
    activated: boolean;
    command: undefined | C;
    continuousCmdExecution: boolean;
    interaction: I;
    linterRules: ReadonlyMap<RuleName, Severity>;
    logBinding: boolean;
    logCmd: boolean;
    logUsage: boolean;
    name: string;
    produces: Observable<C>;
    running: boolean;
    timesCancelled: number;
    timesEnded: number;
    acceptVisitor(visitor): void;
    isWhenDefined(): boolean;
    uninstallBinding(): void;
}

Type Parameters

  • C extends Command

    The type of the command that will produce this binding.

  • I extends Interaction<D>

    The type of the interaction that will use this binding.

  • A

    The type of the accumulator.

  • D extends InteractionData = InteractionDataType<I>

    The interaction data type (infered from the interaction type)

Implemented by

Properties

accumulator activated command continuousCmdExecution interaction linterRules logBinding logCmd logUsage name produces running timesCancelled timesEnded

Methods

acceptVisitor isWhenDefined uninstallBinding

Properties

Readonly accumulator

accumulator: A

The accumulator used during the binding.

activated

activated: boolean

States whether the binding is activated.

Readonly command

command: undefined | C

The command in progress or null.

Readonly continuousCmdExecution

continuousCmdExecution: boolean

States whether the command must be executed on each step of the interaction (and not only at the end of the interaction execution).

Readonly interaction

interaction: I

The user interaction.

Readonly linterRules

linterRules: ReadonlyMap<RuleName, Severity>

The linter rules specific to this binding.

logBinding

logBinding: boolean

Logs (or not) binding execution information.

logCmd

logCmd: boolean

Logs (or not) command production information

logUsage

logUsage: boolean

Logs (or not) usage information of the binding for usage analysis

Readonly name

name: string

The name of the binding

Readonly produces

produces: Observable<C>

An RX observable objects that will provide the commands produced by the binding.

Readonly running

running: boolean

States whether the binding is running.

Readonly timesCancelled

timesCancelled: number

Information method. The number of times the binding was cancelled (nevermind a command was created or not).

Readonly timesEnded

timesEnded: number

Information method.

Returns

The number of times the binding successfully ended (nevermind a command was created or not).

Methods

acceptVisitor

isWhenDefined

uninstallBinding

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc