Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CommandHandlerRegistration<PARAMS>

Type for registering a project edit, which can encapsulate changes to projects. One of listener or createCommand function must be provided.

Type parameters

  • PARAMS = NoParameters

Hierarchy

Index

Properties

Properties

Optional autoSubmit

autoSubmit: boolean

Configure command to submit without confirmation

Optional description

description: string

Description of the command

Optional intent

intent: string | string[] | RegExp

Intent or list of intents. What you need to type to invoke the command, for example via the bot.

listener

listener: CommandListener<PARAMS>

Callback executing the command

name

name: string

Name of the command

Optional parameterStyle

parameterStyle: ParameterStyle

Configure strategy on how to prompt for parameters in chat or web

Optional parameters

parameters: ParametersDefinition<PARAMS>

Define parameters used by this command.

Optional paramsMaker

paramsMaker: Maker<PARAMS>

Function to create a parameters object used by this command. Empty parameters will be returned by default.

Optional registerWhen

registerWhen: (sdmConfiguration: SoftwareDeliveryMachineConfiguration) => boolean

If provided, select when this command is registered. Enables conditional registration on SDM startup, based on configuration, environment variables etc. This method is invoked during SDM startup.

param
returns

Type declaration

Optional repoFinder

repoFinder: RepoFinder

Optional repoLoader

repoLoader: (p: PARAMS) => RepoLoader

Type declaration

    • (p: PARAMS): RepoLoader

    • Parameters

      • p: PARAMS

      Returns RepoLoader

Optional tags

tags: string | string[]

Tags associated with this command. Useful in searching.

Generated using TypeDoc