Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GoalSettingStructure<F, V>

Some (composed) mappings contain information about their internal structure.

It only extends Mapping<F,V> because it's expected to apply only to those

Type parameters

  • F

  • V

Hierarchy

  • Mapping<F, V>
    • GoalSettingStructure

Implemented by

Index

Properties

Properties

mapping

mapping: Mapper<F, V>

Compute a value for the given event. Return undefined if we don't find a mapped value. Return DoNotSetAnyGoals (null) to shortcut evaluation of the present set of rules, terminating evaluation and guarantee the return of undefined if we've reached this point. Only do so if you are sure that this evaluation must be short circuited if it has reached this point. If a previous rule has matched, it will still be used. The value may be static or computed on demand, depending on the implementation.

Readonly name

name: string

Name of the Mapping. Must be unique

structure

structure: { components: Array<Mapping<F, V>>; compositionStyle: GoalSettingCompositionStyle }

Type declaration

Generated using TypeDoc