Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace config

Index

Namespaces

Type Aliases

Type Aliases

CircleCIConfigObject

CircleCIConfigObject: { commands?: ReusableCommand[]; executors?: ReusableExecutor[]; jobs?: Job[]; orbs?: OrbImport[]; version: ConfigVersion; workflows?: Workflow[] }

CircleCI configuration object

Type declaration

CircleCIConfigShape

CircleCIConfigShape: { commands?: ReusableCommandShape; executors?: ReusableExecutorsShape; jobs: JobsShape; orbs?: OrbImportsShape; parameters?: Record<string, ParameterShape>; setup: boolean; version: ConfigVersion; workflows: WorkflowsShape }

Generated Shape of the CircleCI config.

Type declaration

ConfigDependencies

ConfigDependencies: { commandList?: ReusableCommand[]; executorList?: ReusableExecutor[]; jobList: Job[]; parameterList?: CustomParametersList<AnyParameterLiteral>; workflows: Workflow[] }

Type declaration

ConfigOrbImport

ConfigOrbImport: Record<string, string>

Orb import object

ConfigVersion

ConfigVersion: 2 | 2.1

Selected config version

UnknownConfigShape

UnknownConfigShape: { commands?: Record<string, unknown>; executors?: Record<string, unknown>; jobs: Record<string, unknown>; orbs?: Record<string, unknown>; parameters?: Record<string, unknown>; setup: boolean; workflows: Record<string, unknown> }

Type declaration

  • Optional commands?: Record<string, unknown>
  • Optional executors?: Record<string, unknown>
  • jobs: Record<string, unknown>
  • Optional orbs?: Record<string, unknown>
  • Optional parameters?: Record<string, unknown>
  • setup: boolean
  • workflows: Record<string, unknown>

Generated using TypeDoc