Class Checkout

A special step used to check out source code to the configured path. (defaults to the working_directory).

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

Hierarchy

Checkout

Implements

Command

Index

Constructors

constructor

Properties

parameters

Accessors

Methods

generate

Constructors

constructor

new Checkout(parameters?: CheckoutParameters): Checkout

- Defined in src/lib/Components/Commands/exports/Native/Checkout.ts:17
Parameters
- Optional parameters: CheckoutParameters
Returns Checkout

Properties

Optional parameters

parameters?: CheckoutParameters

Step parameters

Accessors

generableType

get generableType(): GenerableType

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

Returns GenerableType

name

get name(): string

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

Returns string

Methods

generate

generate(): string | CheckoutCommandShape

Implementation of Command.generate
- Defined in src/lib/Components/Commands/exports/Native/Checkout.ts:24
Generate Checkout Command shape.

Returns string | CheckoutCommandShape
The generated JSON for the Checkout Command.

Generated using TypeDoc