@circleci/circleci-config-sdk
Version:
An SDK for building CircleCI Configuration files with JavaScript.
40 lines • 1.48 kB
TypeScript
import { GenerableType } from '../../../../Config/exports/Mapping';
import { StringParameter } from '../../../Parameters/types';
import { CommandParameters, CommandShape } from '../../types/Command.types';
import { Command } from '../Command';
/**
* Step to store artifacts (for example logs, binaries, etc) to be available in the web app or through the API.
* @see {@link https://circleci.com/docs/configuration-reference#storeartifacts}
*/
export declare class StoreArtifacts implements Command {
parameters: StoreArtifactsParameters;
constructor(parameters: StoreArtifactsParameters);
/**
* Generate StoreArtifacts Command shape.
* @returns The generated JSON for the StoreArtifacts Commands.
*/
generate(): StoreArtifactsCommandShape;
get name(): StringParameter;
get generableType(): GenerableType;
}
/**
* Command parameters for the StoreArtifacts command
*/
export interface StoreArtifactsParameters extends CommandParameters {
/**
* Directory in the primary container to save as job artifacts
*/
path: StringParameter;
/**
* Prefix added to the artifact paths in the artifacts API (default: the directory of the file specified in path)
*/
destination?: StringParameter;
}
/**
* Generated Shape of the StoreArtifacts command.
*/
interface StoreArtifactsCommandShape extends CommandShape {
store_artifacts: StoreArtifactsParameters;
}
export {};
//# sourceMappingURL=StoreArtifacts.d.ts.map