Class DevContainerCliContribution

Handles the --attach-container CLI argument and stashes the value.

Implements

CliContribution

Index

Constructors

Properties

attachContainerId scanForDevJson

Methods

configure consumeAttachContainerId getAttachContainerId setArguments shouldScanForDevJson

Constructors

constructor

new DevContainerCliContribution(): DevContainerCliContribution
Returns DevContainerCliContribution

Properties

`Protected`attachContainerId

attachContainerId: undefined | string

`Protected`scanForDevJson

scanForDevJson: boolean = true

Methods

configure

configure(conf: Argv): void
Parameters
- conf: Argv
Returns void
Implementation of CliContribution.configure
- Defined in packages/dev-container/src/electron-node/dev-container-cli-contribution.ts:31

consumeAttachContainerId

consumeAttachContainerId(): undefined | string
Returns and clears the attach container ID so the startup attach flow runs at most once (the window reloads after connecting to the remote).

Returns undefined | string
- Defined in packages/dev-container/src/electron-node/dev-container-cli-contribution.ts:59

getAttachContainerId

getAttachContainerId(): undefined | string
Returns undefined | string
- Defined in packages/dev-container/src/electron-node/dev-container-cli-contribution.ts:51

setArguments

setArguments(
args: { _: (string | number)[]; $0: string; [argName: string]: unknown },
): void
Parameters
- args: { _: (string | number)[]; $0: string; [argName: string]: unknown }
  - [argName: string]: unknown
    All remaining options
  - _: (string | number)[]
    Non-option arguments
  - $0: string
    The script name or node command
Returns void
Implementation of CliContribution.setArguments
- Defined in packages/dev-container/src/electron-node/dev-container-cli-contribution.ts:43

shouldScanForDevJson

shouldScanForDevJson(): boolean
Returns boolean
- Defined in packages/dev-container/src/electron-node/dev-container-cli-contribution.ts:65