UNPKG

1.9 kBTypeScriptView Raw
1import { NamedMappedParameter, NamedParameter, NamedSecret, NamedValue, ParametersListing } from "./ParametersDefinition";
2/**
3 * Fluent builder for command parameters. Similar to inquirer.js API.
4 */
5export declare class ParametersBuilder implements ParametersListing {
6 parameters: NamedParameter[];
7 mappedParameters: NamedMappedParameter[];
8 secrets: NamedSecret[];
9 values: NamedValue[];
10 /**
11 * Declare a new parameter for a command
12 * @return {this}
13 */
14 addParameters(p: NamedParameter, ...more: NamedParameter[]): this;
15 /**
16 * Declare a new mapped parameter for a command
17 * @return {this}
18 */
19 addMappedParameters(mp: NamedMappedParameter, ...more: NamedMappedParameter[]): this;
20 /**
21 * Declare a new secret parameter for a command
22 * @return {this}
23 */
24 addSecrets(s: NamedSecret, ...more: NamedSecret[]): this;
25 /**
26 * Declare a new configuration value parameter for a command
27 * @return {this}
28 */
29 addValues(s: NamedValue, ...more: NamedValue[]): this;
30}
31/**
32 * Declare a new parameter for the given command
33 * @return {ParametersBuilder}
34 */
35export declare function addParameters(p: NamedParameter, ...more: NamedParameter[]): ParametersBuilder;
36/**
37 * Declare a new mapped parameter for the given command
38 * @return {ParametersBuilder}
39 */
40export declare function addMappedParameters(p: NamedMappedParameter, ...more: NamedMappedParameter[]): ParametersBuilder;
41/**
42 * Declare a new secret parameter for the given command
43 * @return {ParametersBuilder}
44 */
45export declare function addSecrets(s: NamedSecret, ...more: NamedSecret[]): ParametersBuilder;
46/**
47 * Declare a new configuration value parameter for the given command
48 * @return {ParametersBuilder}
49 */
50export declare function addValues(s: NamedValue, ...more: NamedValue[]): ParametersBuilder;
51//# sourceMappingURL=ParametersBuilder.d.ts.map
\No newline at end of file