Module "api/dsl/goalContribution"

Index

Classes

AdditiveGoalSetter

Interfaces

Type aliases

DefaultFacts

Functions

Type aliases

DefaultFacts

DefaultFacts: Record<string, any>

Functions

attachFacts

attachFacts<FACT, F>(compute: (f: F) => Promise<FACT>): GoalContribution<F>

- Defined in lib/api/dsl/goalContribution.ts:70
Enrich the invocation, attaching some facts. The returned object will be merged with any facts already on the invocation.

Type parameters
- FACT
- F: SdmContext = PushListenerInvocation
Parameters
- compute: (f: F) => Promise<FACT>
  
  additional facts.
  - - (f: F): Promise<FACT>
    - Parameters
      - f: F
      Returns Promise<FACT>
Returns GoalContribution<F>

enrichGoalSetters

enrichGoalSetters<F>(mapping: GoalContribution<F>, contributor: GoalContribution<F>, ...contributors: Array<GoalContribution<F>>): Mapping<F, Goals> & GoalSettingStructure<F, Goals>

- Defined in lib/api/dsl/goalContribution.ts:169
Enrich the given push mapping with our own contributions

Type parameters
- F: SdmContext = StatefulPushListenerInvocation<any>
Parameters
- mapping: GoalContribution<F>
- contributor: GoalContribution<F>
- Rest ...contributors: Array<GoalContribution<F>>
Returns Mapping<F, Goals> & GoalSettingStructure<F, Goals>

goalContributors

goalContributors<F>(contributor: GoalContribution<F>, ...contributors: Array<GoalContribution<F>>): Mapping<F, Goals>

- Defined in lib/api/dsl/goalContribution.ts:153
Contribute goals based on a series of contribution rules.

Instead of stopping at the first match, each push will get all the goals it qualifies for.

Duplicates will be removed.

Type parameters
- F: SdmContext = StatefulPushListenerInvocation<any>
Parameters
- contributor: GoalContribution<F>
  
  first contributor
- Rest ...contributors: Array<GoalContribution<F>>
Returns Mapping<F, Goals>

a mapping to goals

isAdditiveGoalSetter

isAdditiveGoalSetter(a: GoalContribution<any>): a is AdditiveGoalSetter<any>

- Defined in lib/api/dsl/goalContribution.ts:183
Parameters
- a: GoalContribution<any>
Returns a is AdditiveGoalSetter<any>

Generated using TypeDoc