External module "index"

Index

Classes

Terraform

Interfaces

Type aliases

Command

Functions

Type aliases

Command

Command: IApply | IDestroy | IFmt | IForceUnlock | IGet | IGraph | IImport | IInit | IOutput | IPlan | IProviders | IPush | IRefresh | IShow | IStateList | IStateMv | IStatePull | IStatePush | IStateRm | IStateShow | ITaint | IValidate | IUntaint | IWorkspaceList | IWorkspaceSelect | IWorkspaceNew | IWorkspaceDelete | IWorkspaceShow

Functions

Apply

Apply(dirOrPlan?: undefined | string, opts?: Partial<IApplyOpts>): IApply

- Defined in index.ts:336
Parameters
- Optional dirOrPlan: undefined | string
- Optional opts: Partial<IApplyOpts>
Returns IApply

Config

Config(props?: Partial<IConfig>): IConfig

- Defined in index.ts:12
Construct a config object for calls to exec

Parameters
- Default value props: Partial<IConfig> = {}
Returns IConfig

Destroy

Destroy(dir?: undefined | string, opts?: Partial<IDestroyOpts>): IDestroy

- Defined in index.ts:360
Parameters
- Optional dir: undefined | string
- Optional opts: Partial<IDestroyOpts>
Returns IDestroy

Fmt

Fmt(dir?: undefined | string, opts?: Partial<IFmtOpts>): IFmt

- Defined in index.ts:377
Parameters
- Optional dir: undefined | string
- Optional opts: Partial<IFmtOpts>
Returns IFmt

ForceUnlock

ForceUnlock(lockId: string, dir?: undefined | string, opts?: Partial<IForceUnlockOpts>): IForceUnlock

- Defined in index.ts:391
Parameters
- lockId: string
- Optional dir: undefined | string
- Optional opts: Partial<IForceUnlockOpts>
Returns IForceUnlock

Get

Get(dir?: undefined | string, opts?: Partial<IGetOpts>): IGet

- Defined in index.ts:405
Parameters
- Optional dir: undefined | string
- Optional opts: Partial<IGetOpts>
Returns IGet

Graph

Graph(dir?: undefined | string, opts?: Partial<IGraphOpts>): IGraph

- Defined in index.ts:420
Parameters
- Optional dir: undefined | string
- Optional opts: Partial<IGraphOpts>
Returns IGraph

Import

Import(src: string, dest: string, opts?: Partial<IImportOpts>): IImport

- Defined in index.ts:442
Parameters
- src: string
- dest: string
- Optional opts: Partial<IImportOpts>
Returns IImport

Init

Init(dir?: undefined | string, opts?: Partial<IInitOpts>): IInit

- Defined in index.ts:458
Parameters
- Optional dir: undefined | string
- Optional opts: Partial<IInitOpts>
Returns IInit

Output

Output(name?: undefined | string, opts?: Partial<IOutputOpts>): IOutput

- Defined in index.ts:474
Parameters
- Optional name: undefined | string
- Optional opts: Partial<IOutputOpts>
Returns IOutput

Plan

Plan(dirOrPlan?: undefined | string, opts?: Partial<IPlanOpts>): IPlan

- Defined in index.ts:499
Parameters
- Optional dirOrPlan: undefined | string
- Optional opts: Partial<IPlanOpts>
Returns IPlan

Providers

Providers(configPath?: undefined | string): IProviders

- Defined in index.ts:509
Parameters
- Optional configPath: undefined | string
Returns IProviders

Push

Push(path?: undefined | string, opts?: Partial<IPushOpts>): IPush

- Defined in index.ts:530
Parameters
- Optional path: undefined | string
- Optional opts: Partial<IPushOpts>
Returns IPush

Refresh

Refresh(dir?: undefined | string, opts?: Partial<IRefreshOpts>): IRefresh

- Defined in index.ts:551
Parameters
- Optional dir: undefined | string
- Optional opts: Partial<IRefreshOpts>
Returns IRefresh

Show

Show(path?: undefined | string, opts?: Partial<IShowOpts>): IShow

- Defined in index.ts:565
Parameters
- Optional path: undefined | string
- Optional opts: Partial<IShowOpts>
Returns IShow

StateList

StateList(addresses?: string[], opts?: Partial<IStateListOpts>): IStateList

- Defined in index.ts:579
Parameters
- Optional addresses: string[]
- Optional opts: Partial<IStateListOpts>
Returns IStateList

StateMv

StateMv(src: string, dest: string, opts?: Partial<IStateMvOpts>): IStateMv

- Defined in index.ts:596
Parameters
- src: string
- dest: string
- Optional opts: Partial<IStateMvOpts>
Returns IStateMv

StatePull

StatePull(): IStatePull

- Defined in index.ts:606
Returns IStatePull

StatePush

StatePush(path: string, opts?: Partial<IStatePushOpts>): IStatePush

- Defined in index.ts:620
Parameters
- path: string
- Optional opts: Partial<IStatePushOpts>
Returns IStatePush

StateRm

StateRm(addresses: string[], opts?: Partial<IStateRmOpts>): IStateRm

- Defined in index.ts:635
Parameters
- addresses: string[]
- Optional opts: Partial<IStateRmOpts>
Returns IStateRm

StateShow

StateShow(address: string, opts?: Partial<IStateShowOpts>): IStateShow

- Defined in index.ts:649
Parameters
- address: string
- Optional opts: Partial<IStateShowOpts>
Returns IStateShow

Taint

Taint(name: string, opts?: Partial<ITaintOpts>): ITaint

- Defined in index.ts:669
Parameters
- name: string
- Optional opts: Partial<ITaintOpts>
Returns ITaint

Untaint

Untaint(name: string, opts?: Partial<IUntaintOpts>): IUntaint

- Defined in index.ts:706
Parameters
- name: string
- Optional opts: Partial<IUntaintOpts>
Returns IUntaint

Validate

Validate(dir?: undefined | string, opts?: Partial<IValidateOpts>): IValidate

- Defined in index.ts:685
Parameters
- Optional dir: undefined | string
- Optional opts: Partial<IValidateOpts>
Returns IValidate

WorkspaceDelete

WorkspaceDelete(name: string, opts?: Partial<IWorkspaceDeleteOpts>): IWorkspaceDelete

- Defined in index.ts:754
Parameters
- name: string
- Optional opts: Partial<IWorkspaceDeleteOpts>
Returns IWorkspaceDelete

WorkspaceList

WorkspaceList(): IWorkspaceList

- Defined in index.ts:716
Returns IWorkspaceList

WorkspaceNew

WorkspaceNew(name: string, opts?: Partial<IWorkspaceNewOpts>): IWorkspaceNew

- Defined in index.ts:740
Parameters
- name: string
- Optional opts: Partial<IWorkspaceNewOpts>
Returns IWorkspaceNew

WorkspaceSelect

WorkspaceSelect(name: string): IWorkspaceSelect

- Defined in index.ts:726
Parameters
- name: string
Returns IWorkspaceSelect

WorkspaceShow

WorkspaceShow(): IWorkspaceShow

- Defined in index.ts:764
Returns IWorkspaceShow

dasherize

dasherize(str: string): string

- Defined in index.ts:793
Parameters
- str: string
Returns string

exec

exec(cmd: Command, cfg: undefined): function
exec(cmd: Command, cfg: IConfig): Promise<string>

- Defined in index.ts:34
Executes a command with the given configuration.

Parameters
- cmd: Command
- cfg: undefined
Returns function

a Promise to the stdout string result
- - (cfg: IConfig): Promise<string>
  - Parameters
    - cfg: IConfig
    Returns Promise<string>
- Defined in index.ts:35
Parameters
- cmd: Command
- cfg: IConfig
Returns Promise<string>

flag

flag(key: string): (Anonymous function)

- Defined in index.ts:788
Parameters
- key: string
Returns (Anonymous function)

flagKey

flagKey(str: string): string

- Defined in index.ts:794
Parameters
- str: string
Returns string

mapExec

mapExec(commands: Command[]): function
mapExec(commands: Command[], cfg: IConfig): Promise<string[]>

- Defined in index.ts:20
Executes multiple commands and return a promise to an array of their results

Parameters
- commands: Command[]
Returns function
- - (cfg: IConfig): Promise<string[]>
  - Parameters
    - cfg: IConfig
    Returns Promise<string[]>
- Defined in index.ts:21
Parameters
- commands: Command[]
- cfg: IConfig
Returns Promise<string[]>

maybe1

maybe1(a?: undefined | string): [string] | undefined

- Defined in index.ts:796
Parameters
- Optional a: undefined | string
Returns [string] | undefined

maybe1or2

maybe1or2(a: string, b?: undefined | string): [string] | [string, string]

- Defined in index.ts:795
Parameters
- a: string
- Optional b: undefined | string
Returns [string] | [string, string]

optsToArray

optsToArray(opts: any): string[]

- Defined in index.ts:776
Parameters
- opts: any
Returns string[]

toArray

toArray(__namedParameters: object): string[]

- Defined in index.ts:768
Parameters
- __namedParameters: object
  - args: undefined | string[] | Object | Object
  - command: "apply" | "destroy" | "fmt" | "force-unlock" | "get" | "graph" | "plan" | "import" | "init" | "output" | "providers" | "push" | "refresh" | "show" | "state list" | "state mv" | "state pull" | "state push" | "state rm" | "state show" | "taint" | "validate" | "untaint" | "workspace list" | "workspace select" | "workspace new" | "workspace delete" | "workspace show"
  - opts: undefined | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object
Returns string[]

Generated using TypeDoc