## API Report File for "@aws-amplify/amplify-prompts"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

/// <reference types="node" />

import { IFlowData } from '@aws-amplify/amplify-cli-shared-interfaces';

// @public (undocumented)
export const alphanumeric: (message?: string) => Validator;

// @public (undocumented)
export class AmplifyPrinter implements Printer {
    constructor(outputStream?: NodeJS.WritableStream);
    // (undocumented)
    blankLine: () => void;
    // (undocumented)
    debug: (line: string) => void;
    // (undocumented)
    error: (line: string, error?: any) => void;
    // Warning: (ae-forgotten-export) The symbol "Color" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    info: (line: string, color?: Color) => void;
    // (undocumented)
    success: (line: string) => void;
    // (undocumented)
    warn: (line: string) => void;
}

// @public (undocumented)
export class AmplifySpinner {
    constructor();
    // (undocumented)
    resetMessage(text: string | null): void;
    // (undocumented)
    start(text: string | null): void;
    // (undocumented)
    stop(text?: string | null, success?: boolean): void;
}

// @public (undocumented)
export const and: (validators: [Validator, Validator, ...Validator[]], message?: string) => Validator;

// @public (undocumented)
export type BarOptions = {
    progressBarFormatter: (payload: ProgressPayload, value: number, total: number) => string;
    itemFormatter: (payload: ItemPayload) => {
        renderString: string;
        color: string;
    };
    loneWolf: boolean;
    hideCursor: boolean;
    barCompleteChar: string;
    barIncompleteChar: string;
    barSize: number;
    itemCompleteStatus: string[];
    itemFailedStatus: string[];
    prefixText: string;
    successText: string;
    failureText: string;
};

// @public (undocumented)
export const between: (min: number, max: number, message?: string) => Validator;

// Warning: (ae-forgotten-export) The symbol "EqualsFunction" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "SingleFilterFunction" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const byValue: <T>(selection: T, equals?: EqualsFunction<T>) => SingleFilterFunction<T>;

// Warning: (ae-forgotten-export) The symbol "MultiFilterFunction" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const byValues: <T>(selection: T[], equals?: EqualsFunction<T>) => MultiFilterFunction<T>;

// @public (undocumented)
export const exact: (expected: string, message?: string) => Validator;

// @public (undocumented)
export type Formatter = {
    list: (items: string[]) => void;
};

// @public (undocumented)
export const formatter: Formatter;

// @public (undocumented)
export const integer: (message?: string) => Validator;

// @public (undocumented)
export const isDebug: boolean;

// @public (undocumented)
export const isHeadless: boolean;

// @public (undocumented)
export const isInteractiveShell: boolean;

// @public (undocumented)
export const isSilent: boolean;

// @public (undocumented)
export const isYes: boolean;

// @public (undocumented)
export type ItemPayload = {
    LogicalResourceId: string;
    ResourceType: string;
    ResourceStatus: string;
    Timestamp: string;
};

// @public (undocumented)
export const matchRegex: (validatorRegex: RegExp, message?: string) => Validator;

// @public (undocumented)
export const maxLength: (maxLen: number, message?: string) => Validator;

// @public (undocumented)
export const minLength: (minLen: number, message?: string) => Validator;

// @public (undocumented)
export class MultiProgressBar {
    constructor(options: BarOptions);
    // (undocumented)
    create(bars: {
        name: string;
        value: number;
        total: number;
        payload: ProgressPayload;
    }[]): void;
    // (undocumented)
    finishAllBars(): void;
    // (undocumented)
    finishBar(name: string): void;
    // (undocumented)
    getBar(name: string): {
        name: string;
        bar: ProgressBar_2;
    } | undefined;
    // (undocumented)
    getBarCount(): number;
    // (undocumented)
    incrementBar(name: string, value: number): void;
    // (undocumented)
    isActive: boolean;
    // (undocumented)
    isTTY(): boolean;
    // (undocumented)
    render(): void;
    // (undocumented)
    stop(): void;
    // (undocumented)
    updateBar(name: string, updateObj: {
        name: string;
        payload: ItemPayload;
    }): void;
    // (undocumented)
    updatePrefixText(newPrefixText: string): void;
    // Warning: (ae-forgotten-export) The symbol "TerminalLine" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    writeLines(terminalLine: TerminalLine): void;
}

// @public (undocumented)
export const not: (validator: Validator, message: string) => Validator;

// @public (undocumented)
export const or: (validators: [Validator, Validator, ...Validator[]], message?: string) => Validator;

// @public (undocumented)
export type Printer = {
    debug: (line: string) => void;
    info: (line: string, color?: Color) => void;
    blankLine: () => void;
    success: (line: string) => void;
    warn: (line: string) => void;
    error: (line: string, error?: any) => void;
};

// @public (undocumented)
export const printer: Printer;

// @public (undocumented)
class ProgressBar_2 {
    constructor(options: BarOptions);
    // (undocumented)
    addItem(name: string, itemPayload: ItemPayload): void;
    // (undocumented)
    barCompleteString: string;
    // (undocumented)
    barIncompleteString: string;
    // (undocumented)
    barSize: number;
    // (undocumented)
    createBarString(): string;
    // (undocumented)
    finish(): void;
    // Warning: (ae-forgotten-export) The symbol "Item" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    getItem(name: string): Item | undefined;
    // (undocumented)
    getRenderStrings(): TerminalLine[];
    // (undocumented)
    getValue(): number;
    // (undocumented)
    hasItem(name: string): boolean;
    // (undocumented)
    increment(value?: number): void;
    // (undocumented)
    isFailed(): boolean;
    // (undocumented)
    isFinished(): boolean;
    // (undocumented)
    render(): void;
    // (undocumented)
    start(total: number, startValue: number, payload: ProgressPayload): void;
    // (undocumented)
    stop(): void;
    // (undocumented)
    updateItem(name: string, newPayload: ItemPayload): void;
}
export { ProgressBar_2 as ProgressBar }

// @public (undocumented)
export type ProgressPayload = {
    progressName: string;
    envName: string;
};

// Warning: (ae-forgotten-export) The symbol "Prompter" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const prompter: Prompter;

// @public (undocumented)
export type Validator = (value: string) => true | string | Promise<true | string>;

// (No @packageDocumentation comment for this package)

```