Class GoalSetterMapping<P>

PushRule implementation exposed in DSL. Continues fluent API.

Type parameters

P: PushListenerInvocation = PushListenerInvocation

Hierarchy

PushRule<Goals>
- GoalSetterMapping

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new GoalSetterMapping(guard1: PushTest, guards: PushTest[], reason?: string): GoalSetterMapping

Overrides PushRule.constructor
- Defined in lib/api/dsl/goalDsl.ts:44
Parameters
- guard1: PushTest
- guards: PushTest[]
- Optional reason: string
Returns GoalSetterMapping

Properties

Private goalsName

goalsName: string

Protected guard1

guard1: PushTest

Protected guards

guards: PushTest[]

Readonly pushTest

pushTest: PushTest

The test for this rule

Accessors

label

get label(): string

- Defined in lib/api/dsl/goalDsl.ts:42
Returns string

name

get name(): string

Inherited from PushRule.name
- Defined in lib/api/mapping/support/PushRule.ts:36
Returns string

test

get test(): PushTest

Inherited from PushRule.test
- Defined in lib/api/mapping/support/PushRule.ts:45
Returns PushTest

value

get value(): Goals

Inherited from PushRule.value
- Defined in lib/api/mapping/support/PushRule.ts:32
Returns Goals

Methods

itMeans

itMeans(reason: string): this

Inherited from PushRule.itMeans
- Defined in lib/api/mapping/support/PushRule.ts:62
Set an additional reason if we want to add information to that which is available from the push tests themselves

Parameters
- reason: string
Returns this

mapping

mapping(p: PushListenerInvocation): Promise<Goals | undefined>

Inherited from PushRule.mapping
- Defined in lib/api/mapping/support/PushRule.ts:77
Parameters
- p: PushListenerInvocation
Returns Promise<Goals | undefined>

set

set(value: Goals): this

Inherited from PushRule.set
- Defined in lib/api/mapping/support/PushRule.ts:72
Set the value that will be resolved from this rule

Parameters
- value: Goals
Returns this

setGoals

setGoals(goalComponent: GoalComponent): this

- Defined in lib/api/dsl/goalDsl.ts:50
Parameters
- goalComponent: GoalComponent
Returns this

setGoalsWhen

setGoalsWhen(f: (inv: P) => GoalComponent | Promise<GoalComponent>): this

- Defined in lib/api/dsl/goalDsl.ts:65
Set goals dynamically, depending on this push

Parameters
- f: (inv: P) => GoalComponent | Promise<GoalComponent>
  - - (inv: P): GoalComponent | Promise<GoalComponent>
    - Parameters
      - inv: P
      Returns GoalComponent | Promise<GoalComponent>
Returns this

setNoMoreGoals

setNoMoreGoals(name?: string): void

- Defined in lib/api/dsl/goalDsl.ts:90
Prevent setting any further goals on this push. Ordering matters: goals may previously have been set.

Parameters
- Optional name: string
  
  name of the empty Goals. Default is "No Goals"
Returns void

Generated using TypeDoc