Interface Command

Abstract - A generic Command

Hierarchy

Generable
- Command

Implemented by

Index

Properties

Methods

Properties

Readonly generableType

generableType: GenerableType

Type of generable object

name

name: string

The name of the CircleCI step, which will appear in the CircleCI UI.

Optional parameters

parameters?: CommandParameters

Step parameters

Methods

generate

generate(flatten?: boolean): AnyCommandShape

Overrides Generable.generate
- Defined in src/lib/Components/Commands/exports/Command.ts:21
Generate the JSON shape for the Command.

Parameters
- Optional flatten: boolean
  
  If true, short hand will be attempted.
Returns AnyCommandShape

Optional generateContents

generateContents(flatten?: boolean): unknown

Inherited from Generable.generateContents
- Defined in src/lib/Components/index.ts:16
Generate the CircleCI YAML equivalent JSON contents for config compilation

Parameters
- Optional flatten: boolean
Returns unknown

Generated using TypeDoc