Module "api-helper/command/createCommand"

createCommand

• createCommand<PARAMS>(sdm: MachineOrMachineOptions, commandMaker: (sdm: MachineOrMachineOptions) => OnCommand<PARAMS>, name: string, paramsMaker?: Maker<PARAMS>, details?: Partial<CommandDetails>): HandleCommand<PARAMS>

• Wrap a function in a command handler, allowing use of custom parameters. Targeting (targets property) is handled automatically if the parameters do not implement TargetsParams

  Type parameters

  • PARAMS = NoParameters

  Parameters

  • sdm: MachineOrMachineOptions

    machine or options

  • commandMaker: (sdm: MachineOrMachineOptions) => OnCommand<PARAMS>

    function to create command function

    • • (sdm: MachineOrMachineOptions): OnCommand<PARAMS>

      • Parameters

        • sdm: MachineOrMachineOptions

        Returns OnCommand<PARAMS>

  • name: string

    command name

  • Default value paramsMaker: Maker<PARAMS> = NoParameters as Maker<PARAMS>

    parameters factory, typically the name of a class with a no arg constructor

  • Default value details: Partial<CommandDetails> = {}

    optional details to customize behavior Add intent "edit "

  Returns HandleCommand<PARAMS>