"api/goal/GoalWithFulfillment"

Index

Type aliases

Fulfillment

Fulfillment: Implementation | SideEffect

PlannedGoals

PlannedGoals: Record<string, { dependsOn?: string | string[]; goals: PlannedGoal | Array<PlannedGoal | PlannedGoal[]> }>

Functions

getEnvironment

getEnvironment(details?: { environment?: string | GoalEnvironment }): GoalEnvironment

- Defined in lib/api/goal/GoalWithFulfillment.ts:457
Parameters
- Optional details: { environment?: string | GoalEnvironment }
  - Optional environment?: string | GoalEnvironment
Returns GoalEnvironment

getGoalDefinitionFrom

getGoalDefinitionFrom(goalDetails: FulfillableGoalDetails | string, uniqueName: string, definition?: GoalDefinition): { uniqueName: string } | PredicatedGoalDefinition

- Defined in lib/api/goal/GoalWithFulfillment.ts:398
Construct a PredicatedGoalDefinition from the provided goalDetails

Parameters
- goalDetails: FulfillableGoalDetails | string
- uniqueName: string
- Optional definition: GoalDefinition
Returns { uniqueName: string } | PredicatedGoalDefinition

goal

goal(details?: FulfillableGoalDetails, goalExecutor?: ExecuteGoal, options?: { logInterpreter?: InterpretLog; plan?: (pli: StatefulPushListenerInvocation, goals: Goals) => Promise<PlannedGoals | PlannedGoal>; progressReporter?: ReportProgress; pushTest?: PushTest }): GoalWithFulfillment

- Defined in lib/api/goal/GoalWithFulfillment.ts:363
Creates a new GoalWithFulfillment instance using conventions if overwrites aren't provided

Call this from your machine.ts where you configure your sdm to create a custom goal.

Caution: if you wrap this in another function, then you MUST provide details.uniqueName, because the default is based on where in the code this goal function is called.

Parameters
- Default value details: FulfillableGoalDetails = {}
  
  It is highly recommended that you supply at least uniqueName.
- Optional goalExecutor: ExecuteGoal
- Optional options: { logInterpreter?: InterpretLog; plan?: (pli: StatefulPushListenerInvocation, goals: Goals) => Promise<PlannedGoals | PlannedGoal>; progressReporter?: ReportProgress; pushTest?: PushTest }
  - Optional logInterpreter?: InterpretLog
  - Optional plan?: (pli: StatefulPushListenerInvocation, goals: Goals) => Promise<PlannedGoals | PlannedGoal>
    - - (pli: StatefulPushListenerInvocation, goals: Goals): Promise<PlannedGoals | PlannedGoal>
      - Parameters
        
        pli: StatefulPushListenerInvocation
        
        goals: Goals
        
        Returns Promise<PlannedGoals | PlannedGoal>
  - Optional progressReporter?: ReportProgress
  - Optional pushTest?: PushTest
Returns GoalWithFulfillment

isImplementation

isImplementation(f: Fulfillment): f is Implementation

- Defined in lib/api/goal/GoalWithFulfillment.ts:105
Parameters
- f: Fulfillment
Returns f is Implementation

isSideEffect

isSideEffect(f: Fulfillment): f is SideEffect

- Defined in lib/api/goal/GoalWithFulfillment.ts:115
Parameters
- f: Fulfillment
Returns f is SideEffect

mergeOptions

mergeOptions<OPTIONS>(defaults: OPTIONS, explicit: OPTIONS, configurationPath?: string): OPTIONS

- Defined in lib/api/goal/GoalWithFulfillment.ts:448
Merge Goal configuration options into a final options object. Starts off by merging the explicitly provided options over the provided defaults; finally merges the configuration values at the given configuration path (prefixed with sdm.) over the previous merge.

Type parameters
- OPTIONS
Parameters
- defaults: OPTIONS
- explicit: OPTIONS
- Optional configurationPath: string
Returns OPTIONS

Index

Classes

Interfaces

Type aliases

Functions

Type aliases

Fulfillment

PlannedGoals

Functions

getEnvironment

Parameters

Optional details: { environment?: string | GoalEnvironment }

Optional environment?: string | GoalEnvironment

Returns GoalEnvironment

getGoalDefinitionFrom

Parameters

goalDetails: FulfillableGoalDetails | string

uniqueName: string

Optional definition: GoalDefinition

Returns { uniqueName: string } | PredicatedGoalDefinition

goal

Parameters

Default value details: FulfillableGoalDetails = {}

Optional goalExecutor: ExecuteGoal

Optional options: { logInterpreter?: InterpretLog; plan?: (pli: StatefulPushListenerInvocation, goals: Goals) => Promise<PlannedGoals | PlannedGoal>; progressReporter?: ReportProgress; pushTest?: PushTest }

Optional logInterpreter?: InterpretLog

Optional plan?: (pli: StatefulPushListenerInvocation, goals: Goals) => Promise<PlannedGoals | PlannedGoal>

Parameters

pli: StatefulPushListenerInvocation

goals: Goals

Returns Promise<PlannedGoals | PlannedGoal>

Optional progressReporter?: ReportProgress

Optional pushTest?: PushTest

Returns GoalWithFulfillment

isImplementation

Parameters

f: Fulfillment

Returns f is Implementation

isSideEffect

Parameters

f: Fulfillment

Returns f is SideEffect

mergeOptions

Type parameters

OPTIONS

Parameters

defaults: OPTIONS

explicit: OPTIONS

Optional configurationPath: string

Returns OPTIONS