Class Restore

Restores a previously saved cache based on a key. A cache must have been previously created using the Save step.

see: https://circleci.com/docs/configuration-reference#restorecache

Hierarchy

Restore

Implements

Command

Index

Constructors

constructor

Properties

parameters

Accessors

Methods

generate

Constructors

constructor

new Restore(parameters: RestoreCacheParameters): Restore

- Defined in src/lib/Components/Commands/exports/Native/Cache/Restore.ts:11
Parameters
- parameters: RestoreCacheParameters
Returns Restore

Properties

parameters

parameters: RestoreCacheParameters

Step parameters

Accessors

generableType

get generableType(): GenerableType

Implementation of Command.generableType
- Defined in src/lib/Components/Commands/exports/Native/Cache/Restore.ts:28
Type of generable object

Returns GenerableType

name

get name(): string

Implementation of Command.name
- Defined in src/lib/Components/Commands/exports/Native/Cache/Restore.ts:24
The name of the CircleCI step, which will appear in the CircleCI UI.

Returns string

Methods

generate

generate(): RestoreCacheCommandShape

Implementation of Command.generate
- Defined in src/lib/Components/Commands/exports/Native/Cache/Restore.ts:18
Generate Restore.cache Command shape.

Returns RestoreCacheCommandShape
The generated JSON for the Restore.cache Command.

Generated using TypeDoc