teraslice-cli / helpers/config / default
Class: default
Defined in: teraslice-cli/src/helpers/config.ts:16
This is the top level config object, it manages the config directory and sub command configurations can be added on to this as properties. Config objects should only be used to make derived properties but should avoid copying command line arguments or options, those should be accessed via the .args object (which should not be modified)
NOTE: All properties on this.args are mapped to camelCase
Constructors
new default()
new default(
cliArgs):default
Defined in: teraslice-cli/src/helpers/config.ts:21
Parameters
| Parameter | Type |
|---|---|
cliArgs | Record<string, any> |
Returns
Properties
| Property | Type | Defined in |
|---|---|---|
aliases | default | teraslice-cli/src/helpers/config.ts:19 |
args | Record<string, any> | teraslice-cli/src/helpers/config.ts:18 |
Accessors
aliasesFile
Get Signature
get aliasesFile():
string
Defined in: teraslice-cli/src/helpers/config.ts:69
Returns
string
allSubDirs
Get Signature
get allSubDirs():
string[]
Defined in: teraslice-cli/src/helpers/config.ts:97
Returns
string[]
assetDir
Get Signature
get assetDir():
string
Defined in: teraslice-cli/src/helpers/config.ts:93
Returns
string
clusterUrl
Get Signature
get clusterUrl():
string
Defined in: teraslice-cli/src/helpers/config.ts:58
Returns the URL of the appropriate cluster with the following order of precedence:
- this.args.clusterUrl
- URL found in config file using clusterAlias
This implies that any command requiring clusterUrl or terasliceClient should provide both the cluster-alias argument and the cluster-url option Also, any command needing clusterUrl should use this instead of the cli equivalents.
Returns
string
jobStateDir
Get Signature
get jobStateDir():
string
Defined in: teraslice-cli/src/helpers/config.ts:85
Returns
string
jobStateFile
Get Signature
get jobStateFile():
string
Defined in: teraslice-cli/src/helpers/config.ts:89
Returns
string
outdir
Get Signature
get outdir():
string
Defined in: teraslice-cli/src/helpers/config.ts:77
Returns the user provided output directory or the current directory as default
Returns
string