Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "api/context/parameterPrompt"

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

ParameterPrompt

ParameterPrompt<PARAMS>: (parameters: ParametersPromptObject<PARAMS>, options?: ParameterPromptOptions) => Promise<PARAMS>

ParameterPrompts let the caller prompt for the provided parameters

Type parameters

  • PARAMS

Type declaration

ParameterPromptFactory

ParameterPromptFactory<PARAMS>: (ctx: HandlerContext) => ParameterPrompt<PARAMS>

Factory to create a ParameterPrompt

Type parameters

  • PARAMS

Type declaration

ParametersPromptObject

ParametersPromptObject<PARAMS, K>: Record<K, ParametersObjectValue & { force?: boolean }>

Object with properties defining parameters. Useful for combination via spreads.

Type parameters

  • PARAMS

  • K: keyof PARAMS = keyof PARAMS

Variables

Const AtomistContinuationMimeType

AtomistContinuationMimeType: "application/x-atomist-continuation+json" = "application/x-atomist-continuation+json"

Functions

Const NoParameterPrompt

commandRequestParameterPromptFactory

  • commandRequestParameterPromptFactory<T>(ctx: HandlerContext): ParameterPrompt<T>

Generated using TypeDoc