@circleci/circleci-config-sdk
Version:
An SDK for building CircleCI Configuration files with JavaScript.
22 lines • 671 B
TypeScript
import { Generable } from '../../index';
import { StringParameter } from '../../Parameters/types';
import { AnyCommandShape, CommandParameters } from '../types/Command.types';
/**
* Abstract - A generic Command
*/
export interface Command extends Generable {
/**
* The name of the CircleCI step, which will appear in the CircleCI UI.
*/
name: StringParameter;
/**
* Step parameters
*/
parameters?: CommandParameters;
/**
* Generate the JSON shape for the Command.
* @param flatten - If true, short hand will be attempted.
*/
generate(flatten?: boolean): AnyCommandShape;
}
//# sourceMappingURL=Command.d.ts.map