Class EasyOptionsBuilder

Class to build options more easily than inheriting from OptionsBuilderBase.

Hierarchy (View Summary)

OptionsBuilderBase
- EasyOptionsBuilder

Index

Constructors

Accessors

additionalOptions flags listParameters optionsBuilderHelper packageInfo parameters

Methods

Constructors

constructor

new EasyOptionsBuilder(
    packageInfo: PackageInfo,
    flags: string[],
    parameters: string[],
    listParameters: string[],
    additionalOptions?: string[],
): EasyOptionsBuilder
Parameters
- packageInfo: PackageInfo
  Information about the package.
- flags: string[]
  Flag options for the package.
- parameters: string[]
  Parameter options for the package.
- listParameters: string[]
  List parameter options for the package.
- OptionaladditionalOptions: string[]
  Additional options for the package.
Returns EasyOptionsBuilder
Overrides OptionsBuilderBase.constructor
- Defined in packageRunner/easyOptionsBuilder.ts:48

Accessors

`Protected`additionalOptions

get additionalOptions(): string[]
Additional options for the package.

Returns string[]
- Defined in packageRunner/easyOptionsBuilder.ts:37

`Protected`flags

get flags(): string[]
Flag options for the package.

Returns string[]
- Defined in packageRunner/easyOptionsBuilder.ts:16

`Protected`listParameters

get listParameters(): string[]
List parameter options for the package.

Returns string[]
- Defined in packageRunner/easyOptionsBuilder.ts:30

`Protected`optionsBuilderHelper

get optionsBuilderHelper(): OptionsBuilderHelper
Helper to build options.

Returns OptionsBuilderHelper
Inherited from OptionsBuilderBase.optionsBuilderHelper
- Defined in packageRunner/optionsBuilderBase.ts:22

packageInfo

get packageInfo(): PackageInfo
Information about the package.

Returns PackageInfo
Inherited from OptionsBuilderBase.packageInfo
- Defined in packageRunner/optionsBuilderBase.ts:14

`Protected`parameters

get parameters(): string[]
Parameter options for the package.

Returns string[]
- Defined in packageRunner/easyOptionsBuilder.ts:23

Methods

build

build(uris: Uri[]): Promise<string[]>
Base implementation of build. Override this method to build options for a specific package.
Parameters
- uris: Uri[]
  File paths and folder paths to run package for.
Returns Promise<string[]>
Options for the package.
Overrides OptionsBuilderBase.build
- Defined in packageRunner/easyOptionsBuilder.ts:62