Components

Progress

Usage

const { increment } = await io.display.progress('Migrating rows', {
  max: rows.length
})

for (const row of rows) {
  await migrateRow(row)
  increment()
}

Parameters

labelrequired
string

The label to render above the input.

options { ... }
description
string

Description to render. Default undefined.

indicator
boolean

Renders a percentage of progress. Default false.

max
string

Max value. Default 100.