@circleci/circleci-config-sdk
Version:
An SDK for building CircleCI Configuration files with JavaScript.
37 lines • 1.39 kB
TypeScript
import { GenerableType } from '../../../../../Config/exports/Mapping';
import { ListParameter, StringParameter } from '../../../../Parameters/types';
import { CommandParameters, CommandShape } from '../../../types/Command.types';
import { Command } from '../../Command';
/**
* Restores a previously saved cache based on a key. A cache must have been previously created using the Save step.
* @see {@link https://circleci.com/docs/configuration-reference#restorecache}
*/
export declare class Restore implements Command {
parameters: RestoreCacheParameters;
constructor(parameters: RestoreCacheParameters);
/**
* Generate Restore.cache Command shape.
* @returns The generated JSON for the Restore.cache Command.
*/
generate(): RestoreCacheCommandShape;
get name(): StringParameter;
get generableType(): GenerableType;
}
/**
* Command parameters for the RestoreCache command
*/
export interface RestoreCacheParameters extends CommandParameters {
/**
* List of cache keys to lookup for a cache to restore. Only first existing key will be restored.
*/
readonly keys?: ListParameter;
readonly key?: StringParameter;
}
/**
* Generated Shape of the RestoreCache command.
*/
interface RestoreCacheCommandShape extends CommandShape {
restore_cache: RestoreCacheParameters;
}
export {};
//# sourceMappingURL=Restore.d.ts.map