Class AnonBinding<C, I, A, D>

A special implementation of a binding to be used in binders.

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)

Hierarchy

BindingImpl<C, I, A, D>
- AnonBinding

Constructors

constructor

new AnonBinding<C, I, A, D>(continuousExec, interaction, undoHistory, logger, cmdSupplierFn, widgets, dynamicNodes, loggers, timeoutThrottle, stopPropagation, prevDefault, linterRules, firstFn?, thenFn?, whenFn?, endFn?, cancelFn?, endOrCancelFn?, hadEffectsFn?, hadNoEffectFn?, cannotExecFn?, onErrFn?, name?, accInit?): AnonBinding<C, I, A, D>
Type Parameters
- C extends Command
- I extends Interaction<D>
- A
- D extends InteractionData = InteractionDataType<I>
Parameters
- continuousExec: boolean
- interaction: I
- undoHistory: UndoHistoryBase
- logger: Logger
- cmdSupplierFn: ((d) => C)
  - - (d): C
    - Parameters
      d: undefined | D
      Returns C
- widgets: readonly unknown[]
- dynamicNodes: readonly Node[]
- loggers: readonly LogLevel[]
- timeoutThrottle: number
- stopPropagation: boolean
- prevDefault: boolean
- linterRules: ReadonlyMap<RuleName, Severity>
- Optional firstFn: ((c, i, acc) => void)
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
- Optional thenFn: ((c, i, acc) => void)
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
- Optional whenFn: When<D, A>[]
- Optional endFn: ((c, i, acc) => void)
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
- Optional cancelFn: ((i, acc) => void)
  - - (i, acc): void
    - Parameters
      i: D
      acc: A
      Returns void
- Optional endOrCancelFn: ((i, acc) => void)
  - - (i, acc): void
    - Parameters
      i: D
      acc: A
      Returns void
- Optional hadEffectsFn: ((c, i, acc) => void)
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
- Optional hadNoEffectFn: ((c, i, acc) => void)
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
- Optional cannotExecFn: ((c, i, acc) => void)
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
- Optional onErrFn: ((ex) => void)
  - - (ex): void
    - Parameters
      ex: unknown
      Returns void
- Optional name: string
- Optional accInit: A
Returns AnonBinding<C, I, A, D>
Overrides BindingImpl.constructor
- Defined in impl/binding/AnonBinding.ts:58

Properties

`Protected` _activated

_activated: boolean

`Protected` _cmd

_cmd: undefined | C

The current action in progress.

`Protected` `Readonly` _interaction

_interaction: I

The source interaction.

`Protected` _name

_name: undefined | string

`Protected` _timeCancelled

_timeCancelled: number

`Protected` _timeEnded

_timeEnded: number

accumulator

accumulator: A

The accumulator used during the binding.

`Protected` `Readonly` accumulatorInit

accumulatorInit: undefined | A

`Private` `Readonly` cancelFn

cancelFn: undefined | ((i, acc) => void)

Type declaration

- (i, acc): void
- Parameters
  - i: D
  - acc: A
  Returns void

`Private` `Readonly` cannotExecFn

cannotExecFn: undefined | ((c, i, acc) => void)

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Protected` `Readonly` cmdProducer

cmdProducer: ((i?) => C)

Type declaration

- (i?): C
- The command class to instantiate.
  Parameters
  - Optional i: D
  Returns C

`Protected` `Readonly` cmdsProduced

cmdsProduced: Subject<C>

`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).

`Private` `Readonly` endOrCancelFn

endOrCancelFn: undefined | ((i, acc) => void)

Type declaration

- (i, acc): void
- Parameters
  - i: D
  - acc: A
  Returns void

`Private` `Readonly` firstFn

firstFn: undefined | ((c, i, acc) => void)

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Private` `Readonly` hadEffectsFn

hadEffectsFn: undefined | ((c, i, acc) => void)

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Private` `Readonly` hadNoEffectFn

hadNoEffectFn: undefined | ((c, i, acc) => void)

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`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 binding usage information, to perform data analysis on usage

logUsage

logUsage: boolean

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

`Protected` logger

logger: Logger

`Private` `Readonly` onEndFn

onEndFn: undefined | ((c, i, acc) => void)

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Private` `Readonly` onErrFn

onErrFn: undefined | ((ex) => void)

Type declaration

- (ex): void
- Parameters
  - ex: unknown
  Returns void

`Private` `Readonly` thenFn

thenFn: undefined | ((c, i, acc) => void)

Type declaration

- (c, i, acc): void
- Parameters
  - c: C
  - i: D
  - acc: A
  Returns void

`Protected` undoHistory

undoHistory: UndoHistoryBase

`Private` `Readonly` whenFn

whenFn: undefined | When<D, A>[]

Accessors

activated

get activated(): boolean
States whether the binding is activated.

Returns boolean
Inherited from BindingImpl.activated
- Defined in impl/binding/BindingImpl.ts:265
set activated(activated): void
States whether the binding is activated.
Parameters
- activated: boolean
Returns void
Inherited from BindingImpl.activated
- Defined in impl/binding/BindingImpl.ts:269

command

get command(): undefined | C
The command in progress or null.

Returns undefined | C
Inherited from BindingImpl.command
- Defined in impl/binding/BindingImpl.ts:261

interaction

get interaction(): I
The user interaction.

Returns I
Inherited from BindingImpl.interaction
- Defined in impl/binding/BindingImpl.ts:257

name

get name(): string
The name of the binding

Returns string
Inherited from BindingImpl.name
- Defined in impl/binding/BindingImpl.ts:143

produces

get produces(): Observable<C>
An RX observable objects that will provide the commands produced by the binding.

Returns Observable<C>
Inherited from BindingImpl.produces
- Defined in impl/binding/BindingImpl.ts:558

running

get running(): boolean
States whether the binding is running.

Returns boolean
Inherited from BindingImpl.running
- Defined in impl/binding/BindingImpl.ts:282

timesCancelled

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

Returns number
Inherited from BindingImpl.timesCancelled
- Defined in impl/binding/BindingImpl.ts:566

timesEnded

get timesEnded(): number
Information method.

Returns number
The number of times the binding successfully ended (nevermind a command was created or not).
Inherited from BindingImpl.timesEnded
- Defined in impl/binding/BindingImpl.ts:562

Methods

acceptVisitor

acceptVisitor(visitor): void
Visiting the binding.
Parameters
- visitor: VisitorBinding
  The visitor.
Returns void
Inherited from BindingImpl.acceptVisitor
- Defined in impl/binding/BindingImpl.ts:570

cancel

cancel(): void
When the interaction is cancelled. To override.

Returns void
Overrides BindingImpl.cancel
- Defined in impl/binding/AnonBinding.ts:136

catch

catch(err): void
Called when an error appeared during the execution of the binding. To override.
Parameters
- err: unknown
  The error.
Returns void
Overrides BindingImpl.catch
- Defined in impl/binding/AnonBinding.ts:235

clearEvents

clearEvents(): void
Stops the interaction and clears all its events waiting for a process.

Returns void
Inherited from BindingImpl.clearEvents
- Defined in impl/binding/BindingImpl.ts:162

`Private` configureLoggers

configureLoggers(loggers): void
Parameters
- loggers: readonly LogLevel[]
Returns void
- Defined in impl/binding/AnonBinding.ts:90

`Protected` createCommand

createCommand(): undefined | C
creates the command of the binding. If the attribute 'cmd' is not null, nothing will be done.

Returns undefined | C
The created command or undefined if an error occurred
Inherited from BindingImpl.createCommand
- Defined in impl/binding/BindingImpl.ts:170

end

end(): void
When the interaction ends. To override.

Returns void
Overrides BindingImpl.end
- Defined in impl/binding/AnonBinding.ts:124

endOrCancel

endOrCancel(): void
When the interaction ends or is cancelled. To override.

Returns void
Overrides BindingImpl.endOrCancel
- Defined in impl/binding/AnonBinding.ts:147

`Private` executeWhen

executeWhen(when): boolean
Parameters
- when: When<D, A>
Returns boolean
- Defined in impl/binding/AnonBinding.ts:216

first

first(): void
After being created, this method initialises the command. To override.

Returns void
Overrides BindingImpl.first
- Defined in impl/binding/AnonBinding.ts:99

`Protected` fsmCancels

fsmCancels(): void
Returns void
Inherited from BindingImpl.fsmCancels
- Defined in impl/binding/BindingImpl.ts:293

`Protected` fsmError

fsmError(err): void
Parameters
- err: unknown
Returns void
Inherited from BindingImpl.fsmError
- Defined in impl/binding/BindingImpl.ts:286

`Protected` fsmStarts

fsmStarts(): void
Returns void
Inherited from BindingImpl.fsmStarts
- Defined in impl/binding/BindingImpl.ts:333

`Protected` fsmStops

fsmStops(): void
Returns void
Inherited from BindingImpl.fsmStops
- Defined in impl/binding/BindingImpl.ts:412

`Protected` fsmUpdates

fsmUpdates(): void
Returns void
Inherited from BindingImpl.fsmUpdates
- Defined in impl/binding/BindingImpl.ts:359

ifCannotExecuteCmd

ifCannotExecuteCmd(): void
Called when an ongoing command cannot be executed. To override.

Returns void
Overrides BindingImpl.ifCannotExecuteCmd
- Defined in impl/binding/AnonBinding.ts:182

ifCmdHadEffects

ifCmdHadEffects(): void
Called when an executed command had effects. To override.

Returns void
Overrides BindingImpl.ifCmdHadEffects
- Defined in impl/binding/AnonBinding.ts:170

ifCmdHadNoEffect

ifCmdHadNoEffect(): void
Called when an executed command did not had effect. To override.

Returns void
Overrides BindingImpl.ifCmdHadNoEffect
- Defined in impl/binding/AnonBinding.ts:158

isWhenDefined

isWhenDefined(): boolean
Does this binding has a 'when' predicate defined?

Returns boolean
Overrides BindingImpl.isWhenDefined
- Defined in impl/binding/AnonBinding.ts:245

then

then(): void
Updates the current command. To override.

Returns void
Overrides BindingImpl.then
- Defined in impl/binding/AnonBinding.ts:112

uninstallBinding

uninstallBinding(): void
Returns void
Inherited from BindingImpl.uninstallBinding
- Defined in impl/binding/BindingImpl.ts:549

`Private` whenChecker

whenChecker(filterPredicate): boolean
Parameters
- filterPredicate: ((when) => boolean)
  - - (when): boolean
    - Parameters
      when: When<D, A>
      Returns boolean
Returns boolean
- Defined in impl/binding/AnonBinding.ts:206

`Protected` whenStart

whenStart(): boolean
Returns boolean
Overrides BindingImpl.whenStart
- Defined in impl/binding/AnonBinding.ts:194

`Protected` whenStop

whenStop(): boolean
Returns boolean
Overrides BindingImpl.whenStop
- Defined in impl/binding/AnonBinding.ts:202

`Protected` whenUpdate

whenUpdate(): boolean
Returns boolean
Overrides BindingImpl.whenUpdate
- Defined in impl/binding/AnonBinding.ts:198

Class AnonBinding<C, I, A, D>

Type Parameters

C extends Command

I extends Interaction<D>

A

D extends InteractionData = InteractionDataType<I>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

C extends Command

I extends Interaction<D>

A

D extends InteractionData = InteractionDataType<I>

Parameters

continuousExec: boolean

interaction: I

undoHistory: UndoHistoryBase

logger: Logger

cmdSupplierFn: ((d) => C)

Parameters

d: undefined | D

Returns C

widgets: readonly unknown[]

dynamicNodes: readonly Node[]

loggers: readonly LogLevel[]

timeoutThrottle: number

stopPropagation: boolean

prevDefault: boolean

linterRules: ReadonlyMap<RuleName, Severity>

Optional firstFn: ((c, i, acc) => void)

Parameters

c: C

i: D

acc: A

Returns void

Optional thenFn: ((c, i, acc) => void)

Parameters

c: C

i: D

acc: A

Returns void

Optional whenFn: When<D, A>[]

Optional endFn: ((c, i, acc) => void)

Parameters

c: C

i: D

acc: A

Returns void

Optional cancelFn: ((i, acc) => void)

Parameters

i: D

acc: A

Returns void

Optional endOrCancelFn: ((i, acc) => void)

Parameters

i: D

acc: A

Returns void

Optional hadEffectsFn: ((c, i, acc) => void)

Parameters

c: C

i: D

acc: A

Returns void

Optional hadNoEffectFn: ((c, i, acc) => void)

Parameters

c: C

i: D

acc: A

Returns void

Optional cannotExecFn: ((c, i, acc) => void)

Parameters

c: C

i: D

`Optional` firstFn: ((c, i, acc) => void)

`Optional` thenFn: ((c, i, acc) => void)

`Optional` whenFn: When<D, A>[]

`Optional` endFn: ((c, i, acc) => void)

`Optional` cancelFn: ((i, acc) => void)

`Optional` endOrCancelFn: ((i, acc) => void)

`Optional` hadEffectsFn: ((c, i, acc) => void)

`Optional` hadNoEffectFn: ((c, i, acc) => void)

`Optional` cannotExecFn: ((c, i, acc) => void)

`Optional` onErrFn: ((ex) => void)

`Optional` name: string

`Optional` accInit: A

`Protected` _activated

`Protected` _cmd

`Protected` `Readonly` _interaction

`Protected` _name

`Protected` _timeCancelled

`Protected` _timeEnded

`Protected` `Readonly` accumulatorInit

`Private` `Readonly` cancelFn

`Private` `Readonly` cannotExecFn

`Protected` `Readonly` cmdProducer

`Optional` i: D

`Protected` `Readonly` cmdsProduced

`Readonly` continuousCmdExecution

`Private` `Readonly` endOrCancelFn

`Private` `Readonly` firstFn

`Private` `Readonly` hadEffectsFn

`Private` `Readonly` hadNoEffectFn

`Readonly` linterRules

`Protected` logger