API reference
flagstaff
Every export of flagstaff, with its signature and doc comment: box, boxComponent, fromCliSpinners, fromCliBoxes, hoist, manualClock and 13 more, plus 30 types.
flagstaff — the staff the flag flies from. Re-exports only; each subpath is its own entry
and costs only itself, so prefer flagstaff/spinner when that is all you need.
import { box, boxComponent, fromCliSpinners, … } from 'flagstaff';Exports
Documented on the page of the entry point that declares them.
| Export | Kind | Documented in |
|---|---|---|
box | function | flagstaff/box |
boxComponent | function | flagstaff/box |
fromCliBoxes | function | flagstaff/import |
fromCliSpinners | function | flagstaff/import |
glyph | function | flagstaff/plugin |
hoist | function | flagstaff/loop |
lookupBorder | function | flagstaff/plugin |
lookupSpinner | function | flagstaff/plugin |
manualClock | function | flagstaff/loop |
progress | function | flagstaff/progress |
register | function | flagstaff/plugin |
registered | function | flagstaff/plugin |
spinner | function | flagstaff/spinner |
table | function | flagstaff/table |
tableComponent | function | flagstaff/table |
tasks | function | flagstaff/tasks |
validate | function | flagstaff/plugin |
PluginError | class | flagstaff/plugin |
CONTRACT | const | flagstaff/plugin |
BorderStyle | interface | flagstaff/plugin |
BoxOptions | interface | flagstaff/box |
BoxState | interface | flagstaff/box |
CliSpinner | interface | flagstaff/import |
Clock | interface | flagstaff/loop |
Component | interface | flagstaff/plugin |
FromCliBoxesOptions | interface | flagstaff/import |
FromCliSpinnersOptions | interface | flagstaff/import |
Hoisted | interface | flagstaff/loop |
Linked | interface | flagstaff/table |
ManualClock | interface | flagstaff/loop |
Plugin | interface | flagstaff/plugin |
ProgressOptions | interface | flagstaff/progress |
ProgressState | interface | flagstaff/progress |
Runtime | interface | flagstaff/loop |
SpinnerDef | interface | flagstaff/plugin |
SpinnerState | interface | flagstaff/spinner |
TableOptions | interface | flagstaff/table |
TableState | interface | flagstaff/table |
Task | interface | flagstaff/tasks |
TasksOptions | interface | flagstaff/tasks |
TasksState | interface | flagstaff/tasks |
Writer | interface | flagstaff/loop |
Cell | type | flagstaff/table |
CliBox | type | flagstaff/import |
PluginErrorCode | type | flagstaff/plugin |
Row | type | flagstaff/table |
SpinnerStatus | type | flagstaff/spinner |
TaskStatus | type | flagstaff/tasks |
Terminal | type | flagstaff/box |