External module "switch"

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

SavedStates

SavedStates: object

Type declaration

[switchName: string]: string

SelectedSwitchOptions

SelectedSwitchOptions: object

Repository of selected switch options.

Type declaration

[name: string]: DeployTargetSwitchOption

Variables

Const BUTTONS

BUTTONS: Button[] = []

Const KEY_SWITCH_STATES

KEY_SWITCH_STATES: "vsdSwitchStates" = "vsdSwitchStates"

Let nextButtonId

nextButtonId: number = -1

Let switchStates

switchStates: SelectedSwitchOptions

Functions

changeSwitch

changeSwitch(): Promise<void>

- Defined in switch.ts:75
Changes a switch target.

Returns Promise<void>

getCurrentOptionOf

getCurrentOptionOf<TDefault>(target: DeployTargetSwitch, defaultValue?: TDefault): DeployTargetSwitchOption | TDefault

- Defined in switch.ts:142
Returns the current option of a target.

Type parameters
- TDefault
Parameters
- target: DeployTargetSwitch
  
  The target.
- Default value defaultValue: TDefault = <TDefault><any>false
Returns DeployTargetSwitchOption | TDefault

The option (if found).

getSelectedSwitchOptions

getSelectedSwitchOptions(): SelectedSwitchOptions

- Defined in switch.ts:177
Returns the object that stores the states of all switches.

Returns SelectedSwitchOptions

The object with the states.

getSwitchName

getSwitchName(target: DeployTargetSwitch, index: number): string

- Defined in switch.ts:189
Parameters
- target: DeployTargetSwitch
- index: number
Returns string

getSwitchOptionName

getSwitchOptionName(target: DeployTargetSwitchOption, index: number): string

- Defined in switch.ts:203
Parameters
- target: DeployTargetSwitchOption
- index: number
Returns string

getSwitches

getSwitches(): DeployTargetSwitch[]

- Defined in switch.ts:181
Returns DeployTargetSwitch[]

getTargetOptionsOf

getTargetOptionsOf(target: DeployTargetSwitch): DeployTargetSwitchOption[]

- Defined in switch.ts:224
Returns the options of a switch target.

Parameters
- target: DeployTargetSwitch
  
  The target.
Returns DeployTargetSwitchOption[]

The options.

isSwitch

isSwitch(target: DeployTarget): boolean

- Defined in switch.ts:270
Parameters
- target: DeployTarget
Returns boolean

printSwitchStates

printSwitchStates(): void

- Defined in switch.ts:280
Returns void

reloadButtons

reloadButtons(): void

- Defined in switch.ts:323
Reloads the switch buttons.

Returns void

reloadTargetStates

reloadTargetStates(): void

- Defined in switch.ts:410
Reloads the target states for switches.

Returns void

resetTargetStates

resetTargetStates(): void

- Defined in switch.ts:453
Resets all target states for switches.

Returns void

saveStates

saveStates(): Promise<void>

- Defined in switch.ts:460
Saves the states to the current workspace.

Returns Promise<void>

selectTargetOption

selectTargetOption(target: DeployTargetSwitch, index: number): Promise<void>

- Defined in switch.ts:483
Parameters
- target: DeployTargetSwitch
- index: number
Returns Promise<void>

setCurrentOptionFor

setCurrentOptionFor(target: DeployTargetSwitch, option: DeployTargetSwitchOption): NewSwitchOptionState

- Defined in switch.ts:578
Sets the current option for a switch target.

Parameters
- target: DeployTargetSwitch
  
  The target.
- option: DeployTargetSwitchOption
  
  The option to set.
Returns NewSwitchOptionState

The new data.

updateButtons

updateButtons(): void

- Defined in switch.ts:596
Returns void

Generated using TypeDoc