# flagstaff

> Every export of flagstaff, with its signature and doc comment: box, boxComponent, fromCliSpinners, fromCliBoxes, hoist, manualClock and 13 more, plus 30 types.

Source: https://flagstaff.interlace.tools/docs/api

<!-- Generated by scripts/api-reference.ts from the built dist/*.d.ts. Do not edit; run `npx tsx scripts/api-reference.ts`. -->

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.

```ts
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`](/docs/api/box#box) |
| `boxComponent` | function | [`flagstaff/box`](/docs/api/box#boxcomponent) |
| `fromCliBoxes` | function | [`flagstaff/import`](/docs/api/import#fromcliboxes) |
| `fromCliSpinners` | function | [`flagstaff/import`](/docs/api/import#fromclispinners) |
| `glyph` | function | [`flagstaff/plugin`](/docs/api/plugin#glyph) |
| `hoist` | function | [`flagstaff/loop`](/docs/api/loop#hoist) |
| `lookupBorder` | function | [`flagstaff/plugin`](/docs/api/plugin#lookupborder) |
| `lookupSpinner` | function | [`flagstaff/plugin`](/docs/api/plugin#lookupspinner) |
| `manualClock` | function | [`flagstaff/loop`](/docs/api/loop#manualclock) |
| `progress` | function | [`flagstaff/progress`](/docs/api/progress#progress) |
| `register` | function | [`flagstaff/plugin`](/docs/api/plugin#register) |
| `registered` | function | [`flagstaff/plugin`](/docs/api/plugin#registered) |
| `spinner` | function | [`flagstaff/spinner`](/docs/api/spinner#spinner) |
| `table` | function | [`flagstaff/table`](/docs/api/table#table) |
| `tableComponent` | function | [`flagstaff/table`](/docs/api/table#tablecomponent) |
| `tasks` | function | [`flagstaff/tasks`](/docs/api/tasks#tasks) |
| `validate` | function | [`flagstaff/plugin`](/docs/api/plugin#validate) |
| `PluginError` | class | [`flagstaff/plugin`](/docs/api/plugin#pluginerror) |
| `CONTRACT` | const | [`flagstaff/plugin`](/docs/api/plugin#contract) |
| `BorderStyle` | interface | [`flagstaff/plugin`](/docs/api/plugin#borderstyle) |
| `BoxOptions` | interface | [`flagstaff/box`](/docs/api/box#boxoptions) |
| `BoxState` | interface | [`flagstaff/box`](/docs/api/box#boxstate) |
| `CliSpinner` | interface | [`flagstaff/import`](/docs/api/import#clispinner) |
| `Clock` | interface | [`flagstaff/loop`](/docs/api/loop#clock) |
| `Component` | interface | [`flagstaff/plugin`](/docs/api/plugin#component) |
| `FromCliBoxesOptions` | interface | [`flagstaff/import`](/docs/api/import#fromcliboxesoptions) |
| `FromCliSpinnersOptions` | interface | [`flagstaff/import`](/docs/api/import#fromclispinnersoptions) |
| `Hoisted` | interface | [`flagstaff/loop`](/docs/api/loop#hoisted) |
| `Linked` | interface | [`flagstaff/table`](/docs/api/table#linked) |
| `ManualClock` | interface | [`flagstaff/loop`](/docs/api/loop#manualclock) |
| `Plugin` | interface | [`flagstaff/plugin`](/docs/api/plugin#plugin) |
| `ProgressOptions` | interface | [`flagstaff/progress`](/docs/api/progress#progressoptions) |
| `ProgressState` | interface | [`flagstaff/progress`](/docs/api/progress#progressstate) |
| `Runtime` | interface | [`flagstaff/loop`](/docs/api/loop#runtime) |
| `SpinnerDef` | interface | [`flagstaff/plugin`](/docs/api/plugin#spinnerdef) |
| `SpinnerState` | interface | [`flagstaff/spinner`](/docs/api/spinner#spinnerstate) |
| `TableOptions` | interface | [`flagstaff/table`](/docs/api/table#tableoptions) |
| `TableState` | interface | [`flagstaff/table`](/docs/api/table#tablestate) |
| `Task` | interface | [`flagstaff/tasks`](/docs/api/tasks#task) |
| `TasksOptions` | interface | [`flagstaff/tasks`](/docs/api/tasks#tasksoptions) |
| `TasksState` | interface | [`flagstaff/tasks`](/docs/api/tasks#tasksstate) |
| `Writer` | interface | [`flagstaff/loop`](/docs/api/loop#writer) |
| `Cell` | type | [`flagstaff/table`](/docs/api/table#cell) |
| `CliBox` | type | [`flagstaff/import`](/docs/api/import#clibox) |
| `PluginErrorCode` | type | [`flagstaff/plugin`](/docs/api/plugin#pluginerrorcode) |
| `Row` | type | [`flagstaff/table`](/docs/api/table#row) |
| `SpinnerStatus` | type | [`flagstaff/spinner`](/docs/api/spinner#spinnerstatus) |
| `TaskStatus` | type | [`flagstaff/tasks`](/docs/api/tasks#taskstatus) |
| `Terminal` | type | [`flagstaff/box`](/docs/api/box#terminal) |