"api-helper/machine/handlerRegistrations"

Index

Classes

CommandListenerExecutionInterruptError

Variables

Object literals

Variables

Const GeneratorTag

GeneratorTag: "generator" = "generator"

Const InspectionTag

InspectionTag: "inspection" = "inspection"

Const TransformTag

TransformTag: "transform" = "transform"

Functions

addDryRunParameters

addDryRunParameters<PARAMS>(c: CommandRegistration<PARAMS>): void

- Defined in lib/api-helper/machine/handlerRegistrations.ts:502
Add the dryRun parameter into the list of parameters

Type parameters
- PARAMS
Parameters
- c: CommandRegistration<PARAMS>
Returns void

addJobParameters

addJobParameters<PARAMS>(c: CommandRegistration<PARAMS>): void

- Defined in lib/api-helper/machine/handlerRegistrations.ts:532
Add the job parameter into the list of parameters

Type parameters
- PARAMS
Parameters
- c: CommandRegistration<PARAMS>
Returns void

addParametersDefinedInBuilder

addParametersDefinedInBuilder<PARAMS>(c: CommandRegistration<PARAMS>): void

- Defined in lib/api-helper/machine/handlerRegistrations.ts:542
Add to the existing ParametersMaker any parameters defined in the builder itself

Type parameters
- PARAMS
Parameters
- c: CommandRegistration<PARAMS>
Returns void

codeInspectionRegistrationToCommand

codeInspectionRegistrationToCommand<R>(sdm: MachineOrMachineOptions, cir: CodeInspectionRegistration<R, any>): Maker<HandleCommand>

- Defined in lib/api-helper/machine/handlerRegistrations.ts:229
Type parameters
- R
Parameters
- sdm: MachineOrMachineOptions
- cir: CodeInspectionRegistration<R, any>
Returns Maker<HandleCommand>

codeTransformRegistrationToCommand

codeTransformRegistrationToCommand(sdm: MachineOrMachineOptions, ctr: CodeTransformRegistration<any>): Maker<HandleCommand>

- Defined in lib/api-helper/machine/handlerRegistrations.ts:97
Parameters
- sdm: MachineOrMachineOptions
- ctr: CodeTransformRegistration<any>
Returns Maker<HandleCommand>

commandHandlerRegistrationToCommand

commandHandlerRegistrationToCommand(sdm: MachineOrMachineOptions, c: CommandHandlerRegistration): Maker<HandleCommand>

- Defined in lib/api-helper/machine/handlerRegistrations.ts:388
Type parameters
- P = NoParameters
Parameters
- sdm: MachineOrMachineOptions
- c: CommandHandlerRegistration
Returns Maker<HandleCommand>

eventHandlerRegistrationToEvent

eventHandlerRegistrationToEvent(sdm: MachineOrMachineOptions, e: EventHandlerRegistration<any, any>): Maker<HandleEvent>

- Defined in lib/api-helper/machine/handlerRegistrations.ts:395
Parameters
- sdm: MachineOrMachineOptions
- e: EventHandlerRegistration<any, any>
Returns Maker<HandleEvent>

generatorRegistrationToCommand

generatorRegistrationToCommand(sdm: MachineOrMachineOptions, e: GeneratorRegistration): Maker<HandleCommand>

- Defined in lib/api-helper/machine/handlerRegistrations.ts:362
Type parameters
- P = any
Parameters
- sdm: MachineOrMachineOptions
- e: GeneratorRegistration
Returns Maker<HandleCommand>

gitBranchCompatible

gitBranchCompatible(name: string): string

- Defined in lib/api-helper/machine/handlerRegistrations.ts:724
Takes a potential git branch name and returns a legalised iteration of it

Parameters
- name: string
  
  the git branch name to sanitise.
Returns string

isDirty

isDirty(p: Project): Promise<boolean>

- Defined in lib/api-helper/machine/handlerRegistrations.ts:659
Parameters
- p: Project
Returns Promise<boolean>

isGitProject

isGitProject(p: Project): p is GitProject

- Defined in lib/api-helper/machine/handlerRegistrations.ts:671
Parameters
- p: Project
Returns p is GitProject

isMappedParameterOrSecretDeclaration

isMappedParameterOrSecretDeclaration(x: any): x is MappedParameterOrSecretDeclaration

- Defined in lib/api-helper/machine/handlerRegistrations.ts:566
Parameters
- x: any
Returns x is MappedParameterOrSecretDeclaration

isParametersListing

isParametersListing(p: ParametersDefinition<any>): p is ParametersListing

- Defined in lib/api-helper/machine/handlerRegistrations.ts:576
Parameters
- p: ParametersDefinition<any>
Returns p is ParametersListing

isValueDeclaration

isValueDeclaration(x: any): x is ValueDeclaration

- Defined in lib/api-helper/machine/handlerRegistrations.ts:571
Parameters
- x: any
Returns x is ValueDeclaration

resolveCredentialsPromise

resolveCredentialsPromise(creds: Promise<ProjectOperationCredentials> | ProjectOperationCredentials): Promise<ProjectOperationCredentials>

- Defined in lib/api-helper/machine/handlerRegistrations.ts:757
Parameters
- creds: Promise<ProjectOperationCredentials> | ProjectOperationCredentials
Returns Promise<ProjectOperationCredentials>

tagWith

tagWith(e: Partial<CommandDetails>, tag: string): void

- Defined in lib/api-helper/machine/handlerRegistrations.ts:350
Tag the command details with the given tag if it isn't already

Parameters
- e: Partial<CommandDetails>
- tag: string
Returns void

toCommandListenerInvocation

toCommandListenerInvocation(c: CommandRegistration, context: HandlerContext, parameters: P, sdm: SoftwareDeliveryMachineOptions): CommandListenerInvocation

- Defined in lib/api-helper/machine/handlerRegistrations.ts:435
Type parameters
- P
Parameters
- c: CommandRegistration
- context: HandlerContext
- parameters: P
- sdm: SoftwareDeliveryMachineOptions
Returns CommandListenerInvocation

toEditModeOrFactory

toEditModeOrFactory(ctr: CodeTransformRegistration, ci: CommandListenerInvocation): any

- Defined in lib/api-helper/machine/handlerRegistrations.ts:698
Type parameters
- P
Parameters
- ctr: CodeTransformRegistration
- ci: CommandListenerInvocation
Returns any

toOnCommand

toOnCommand<PARAMS>(c: CommandHandlerRegistration<any>): (sdm: MachineOrMachineOptions) => OnCommand<PARAMS>

- Defined in lib/api-helper/machine/handlerRegistrations.ts:410
Type parameters
- PARAMS
Parameters
- c: CommandHandlerRegistration<any>
Returns (sdm: MachineOrMachineOptions) => OnCommand<PARAMS>
- - (sdm: MachineOrMachineOptions): OnCommand<PARAMS>
 - Parameters
 - sdm: MachineOrMachineOptions
 Returns OnCommand<PARAMS>

toParametersListing

toParametersListing(p: ParametersDefinition<any>): ParametersListing

- Defined in lib/api-helper/machine/handlerRegistrations.ts:581
Parameters
- p: ParametersDefinition<any>
Returns ParametersListing

toProjectEditor

toProjectEditor(ct: CodeTransform, sdm: SoftwareDeliveryMachineOptions): ProjectEditor

- Defined in lib/api-helper/machine/handlerRegistrations.ts:633
Type parameters
- P
Parameters
- ct: CodeTransform
- sdm: SoftwareDeliveryMachineOptions
Returns ProjectEditor

toRepoTargetingParametersMaker

toRepoTargetingParametersMaker<PARAMS>(paramsMaker: Maker<PARAMS>, targets: Maker<RepoTargets>): Maker<RepoTargetingParameters & PARAMS>

- Defined in lib/api-helper/machine/handlerRegistrations.ts:682
Return a parameters maker that is targeting aware

Type parameters
- PARAMS
Parameters
- paramsMaker: Maker<PARAMS>
- targets: Maker<RepoTargets>
 
 targets parameters to set if necessary
Returns Maker<RepoTargetingParameters & PARAMS>

toScalarProjectEditor

toScalarProjectEditor<PARAMS>(ctot: CodeTransformOrTransforms<PARAMS>, sdm: SoftwareDeliveryMachineOptions, projectPredicate?: ProjectPredicate): ProjectEditor<PARAMS>

- Defined in lib/api-helper/machine/handlerRegistrations.ts:612
Convert to legacy automation-client "editor" signature

Type parameters
- PARAMS
Parameters
- ctot: CodeTransformOrTransforms<PARAMS>
- sdm: SoftwareDeliveryMachineOptions
- Optional projectPredicate: ProjectPredicate
Returns ProjectEditor<PARAMS>

Object literals

Const DryRunParameter

DryRunParameter: object

defaultValue

defaultValue: boolean = false

description

description: string = "Run Code Transform in dry run mode so that changes aren't committed to the repository"

name

required

required: false = false

type

type: "boolean" = "boolean"

Const JobDescriptionParameter

JobDescriptionParameter: object

description

description: string = "Description of the job to create"

displayable

displayable: false = false

name

required

required: false = false

type

type: "string" = "string"

Const JobNameParameter

JobNameParameter: object

description

description: string = "Name of the job to create"

displayable

displayable: false = false

name

required

required: false = false

type

type: "string" = "string"

Const JobRequiredParameter

JobRequiredParameter: object

description

description: string = "Is job required"

name

required

required: false = false

type

type: "boolean" = "boolean"

Const MsgIdParameter

MsgIdParameter: object

description

description: string = "Id of the code transform message"

displayable

displayable: false = false

name

required

required: false = false

type

type: "string" = "string"

Index

Classes

Variables

Functions

Object literals

Variables

Const GeneratorTag

Const InspectionTag

Const TransformTag

Functions

addDryRunParameters

Type parameters

PARAMS

Parameters

c: CommandRegistration<PARAMS>

Returns void

addJobParameters

Type parameters

PARAMS

Parameters

c: CommandRegistration<PARAMS>

Returns void

addParametersDefinedInBuilder

Type parameters

PARAMS

Parameters

c: CommandRegistration<PARAMS>

Returns void

codeInspectionRegistrationToCommand

Type parameters

R

Parameters

sdm: MachineOrMachineOptions

cir: CodeInspectionRegistration<R, any>

Returns Maker<HandleCommand>

codeTransformRegistrationToCommand

Parameters

sdm: MachineOrMachineOptions

ctr: CodeTransformRegistration<any>

Returns Maker<HandleCommand>

commandHandlerRegistrationToCommand

Type parameters

P = NoParameters

Parameters

sdm: MachineOrMachineOptions

c: CommandHandlerRegistration<P>

Returns Maker<HandleCommand<P>>

eventHandlerRegistrationToEvent

Parameters

sdm: MachineOrMachineOptions

e: EventHandlerRegistration<any, any>

Returns Maker<HandleEvent>

generatorRegistrationToCommand

Type parameters

P = any

Parameters

sdm: MachineOrMachineOptions

e: GeneratorRegistration<P>

Returns Maker<HandleCommand<P>>

gitBranchCompatible

Parameters

name: string

Returns string

isDirty

Parameters

p: Project

Returns Promise<boolean>

isGitProject

Parameters

p: Project

Returns p is GitProject

isMappedParameterOrSecretDeclaration

Parameters

x: any

Returns x is MappedParameterOrSecretDeclaration

isParametersListing

Parameters

p: ParametersDefinition<any>

Returns p is ParametersListing

isValueDeclaration