Class ParametersBuilder

Fluent builder for command parameters. Similar to inquirer.js API.

Hierarchy

ParametersBuilder

Implements

ParametersListing

Index

Properties

Methods

Properties

mappedParameters

mappedParameters: NamedMappedParameter[] = []

parameters

parameters: NamedParameter[] = []

secrets

secrets: NamedSecret[] = []

values

values: NamedValue[] = []

Methods

addMappedParameters

addMappedParameters(mp: NamedMappedParameter, ...more: NamedMappedParameter[]): this

- Defined in lib/api/registration/ParametersBuilder.ts:48
Declare a new mapped parameter for a command

Parameters
- mp: NamedMappedParameter
- Rest ...more: NamedMappedParameter[]
Returns this

addParameters

addParameters(p: NamedParameter, ...more: NamedParameter[]): this

- Defined in lib/api/registration/ParametersBuilder.ts:38
Declare a new parameter for a command

Parameters
- p: NamedParameter
- Rest ...more: NamedParameter[]
Returns this

addSecrets

addSecrets(s: NamedSecret, ...more: NamedSecret[]): this

- Defined in lib/api/registration/ParametersBuilder.ts:58
Declare a new secret parameter for a command

Parameters
- s: NamedSecret
- Rest ...more: NamedSecret[]
Returns this

addValues

addValues(s: NamedValue, ...more: NamedValue[]): this

- Defined in lib/api/registration/ParametersBuilder.ts:68
Declare a new configuration value parameter for a command

Parameters
- s: NamedValue
- Rest ...more: NamedValue[]
Returns this

Generated using TypeDoc