Class Pipeline

Not fully implemented yet. Fetch pipeline parameters from inside a CircleCI job.

alpha

Hierarchy

Pipeline

Index

Constructors

constructor

Properties

_isLocal

Accessors

Methods

Constructors

constructor

new Pipeline(): Pipeline

- Defined in src/lib/Config/Pipeline/index.ts:16
Array of user defined parameters

Returns Pipeline

Properties

Private _isLocal

_isLocal: boolean

Pipeline parameter values are passed at the config level on CircleCI. These values will not be present on a local system.

Accessors

id

get id(): string

- Defined in src/lib/Config/Pipeline/index.ts:31
A globally unique id representing for the pipeline

beta
Returns string

number

get number(): number

- Defined in src/lib/Config/Pipeline/index.ts:42
A project unique integer id for the pipeline

beta
Returns number

Methods

git

git(): Git

- Defined in src/lib/Config/Pipeline/index.ts:58
Git metadata

Returns Git

project

project(): Project

- Defined in src/lib/Config/Pipeline/index.ts:52
Project metadata

Returns Project

Generated using TypeDoc