Function showProgressList

  • Shows a list of Progressibles.

    Parameters

    • context: Context

      Context options.

    • items: Progressible[]

      List of Progressibles.

    • Optional options: {
          description?: string;
          overlay?: boolean;
          title?: string;
      }

      Progress list options.

      • Optional description?: string
      • Optional overlay?: boolean
      • Optional title?: string

    Returns Promise<void>

    Example

    import {showProgressList} from '@matterway/sdk-progress';

    ...
    await showProgressList(
    ctx,
    [
    {
    title: 'Title Progress',
    description: 'Example Running Progress',
    status: 'running',
    },
    {
    title: 'Title Progress',
    description: 'Example Done Progress',
    status: 'done',
    },
    {
    title: 'Title Progress',
    description: 'Example Pending Progress',
    status: 'pending',
    },
    {
    title: 'Title Progress',
    description: 'Example Failed Progress',
    status: 'failed',
    },
    ],
    {
    title: 'Title of the Step',
    description: 'Description of the Step',
    overlay: true,
    },
    );

Generated using TypeDoc