This repository has been archived by the owner on Nov 13, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 31
/
ICommandResponseParms.ts
68 lines (64 loc) · 2 KB
/
ICommandResponseParms.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
import { COMMAND_RESPONSE_FORMAT } from "../api/processor/ICommandResponseApi";
import { ICommandDefinition } from "../../../..";
import { Arguments } from "yargs";
/**
* Command response control parameters. Indicates how the command response should behave and allows influence over
* colorings, etc.
* @export
* @interface ICommandResponseParms
*/
export interface ICommandResponseParms {
/**
* Stream
* @type {*}
* @memberof ICommandResponseParms
*/
stream?: any; // TODO(Kelosky): should be net.Socket
/**
* The arguments specified on the command line
* @type {Arguments}
* @memberof ICommandResponseParms
*/
args?: Arguments;
/**
* The command definition for this response
* @type {ICommandDefinition}
* @memberof ICommandResponseParms
*/
definition?: ICommandDefinition;
/**
* The primary text color used by Chalk package for highlighting messages.
* @type {string}
* @memberof ICommandResponseParms
*/
primaryTextColor?: string;
/**
* Silent indicates that the command should produce absolutely no output to stdout/stderr (the console/terminal)
* @type {boolean}
* @memberof ICommandResponseParms
*/
silent?: boolean;
/**
* The response format for the command. Controls how output is generated for the command (ignored if silent is
* specified). See the type for more details.
* @type {COMMAND_RESPONSE_FORMAT}
* @memberof ICommandResponseParms
*/
responseFormat?: COMMAND_RESPONSE_FORMAT;
/**
* The Progress bar spinner characters.
* @type {string}
* @memberof ICommandResponseParms
*/
progressBarSpinner?: string;
}