teraslice-cli / helpers/config / default

Class: default

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

Parameters

Parameter	Type
cliArgs	Record<string, any>

Returns

default

Source

teraslice-cli/src/helpers/config.ts:21

Properties

aliases

aliases: default

Source

teraslice-cli/src/helpers/config.ts:19

---

args

args: Record<string, any>

Source

teraslice-cli/src/helpers/config.ts:18

Accessors

aliasesFile

get aliasesFile(): string

Returns

string

Source

teraslice-cli/src/helpers/config.ts:69

---

allSubDirs

get allSubDirs(): string[]

Returns

string[]

Source

teraslice-cli/src/helpers/config.ts:97

---

assetDir

get assetDir(): string

Returns

string

Source

teraslice-cli/src/helpers/config.ts:93

---

clusterUrl

get clusterUrl(): string

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

Source

teraslice-cli/src/helpers/config.ts:58

---

jobStateDir

get jobStateDir(): string

Returns

string

Source

teraslice-cli/src/helpers/config.ts:85

---

jobStateFile

get jobStateFile(): string

Returns

string

Source

teraslice-cli/src/helpers/config.ts:89

---

outdir

get outdir(): string

Returns the user provided output directory or the current directory as default

Returns

string

Source

teraslice-cli/src/helpers/config.ts:77