Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "lib/api/goal/GoalWithFulfillment"

Index

Type aliases

Fulfillment

Fulfillment: Implementation | SideEffect

Functions

getEnvironment

getGoalDefinitionFrom

goal

  • 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

    Returns GoalWithFulfillment

isImplementation

isSideEffect

mergeOptions

  • mergeOptions<OPTIONS>(defaults: OPTIONS, explicit: OPTIONS, configurationPath?: string): OPTIONS
  • 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

Generated using TypeDoc