@aws-amplify/amplify-cli-shared-interfaces
Version:
API interfaces to be shared across different amplfy-cli packages
87 lines (78 loc) • 2.06 kB
Markdown
not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
// @public (undocumented)
export interface ICommandInput {
// (undocumented)
argv: Array<string>;
// (undocumented)
command: string;
// (undocumented)
options?: {
[ ]: string | boolean;
};
// (undocumented)
plugin?: string;
// (undocumented)
subCommands?: string[];
}
// @public (undocumented)
export interface IFlowData {
// (undocumented)
assignProjectIdentifier: (envName?: string) => string | undefined;
// (undocumented)
getFlowReport: () => IFlowReport | Record<string, never>;
// (undocumented)
pushHeadlessFlow: (headlessFlowDataString: string, input: ICommandInput) => void;
// (undocumented)
pushInteractiveFlow: (prompt: string, input: unknown) => void;
// (undocumented)
setIsHeadless: (headless: boolean) => void;
}
// @public (undocumented)
export interface IFlowReport {
// (undocumented)
category: string;
// (undocumented)
cmd: string;
// (undocumented)
executable: string;
// (undocumented)
input: ICommandInput;
// (undocumented)
isHeadless: boolean;
// (undocumented)
optionFlowData: Array<TypeOptionFlowData>;
// (undocumented)
projectEnvIdentifier?: string;
// (undocumented)
projectIdentifier?: string;
// (undocumented)
runtime: string;
// (undocumented)
subCmd: string | undefined;
// (undocumented)
timestamp: string;
// (undocumented)
version: string;
}
// @public (undocumented)
export interface IOptionFlowCLIData {
// (undocumented)
input: unknown;
// (undocumented)
prompt: string;
// (undocumented)
timestamp: number;
}
// @public (undocumented)
export interface IOptionFlowHeadlessData {
// (undocumented)
input: string;
// (undocumented)
timestamp: number;
}
// @public (undocumented)
export type TypeOptionFlowData = IOptionFlowHeadlessData | IOptionFlowCLIData;
// (No @packageDocumentation comment for this package)
```
> Do