Skip to main content

Variable: options

const options: object

Defined in: cli.ts:29

Type Declaration​

branch​

readonly branch: object

branch.coerce​

readonly coerce: (value) => any

Parameters​
ParameterType
valueany
Returns​

any

branch.require​

readonly require: false = false

branch.type​

readonly type: "string" = 'string'

config​

readonly config: object

config.alias​

readonly alias: "c" = 'c'

config.describe​

readonly describe: "Path to config file. You can create a config file and set all options there. Valid extensions: .js, .json, .ts, .yml, or .yaml." = 'Path to config file. You can create a config file and set all options there. Valid extensions: .js, .json, .ts, .yml, or .yaml.'

config.require​

readonly require: false = false

config.type​

readonly type: "string" = 'string'

environment​

readonly environment: object

environment.alias​

readonly alias: readonly ["e", "env"]

environment.coerce​

readonly coerce: (value) => any

Parameters​
ParameterType
valueany
Returns​

any

environment.type​

readonly type: "string" = 'string'

environments​

readonly environments: object = {}

project​

readonly project: object

project.coerce​

readonly coerce: (value) => any

Parameters​
ParameterType
valueany
Returns​

any

project.require​

readonly require: false = false

project.type​

readonly type: "string" = 'string'

region​

readonly region: object

region.alias​

readonly alias: "r" = 'r'

region.default​

readonly default: "us-east-1" = AWS_DEFAULT_REGION

region.describe​

readonly describe: "AWS region." = 'AWS region.'

region.type​

readonly type: "string" = 'string'