# flagstaff/spinner

> Every export of flagstaff/spinner, with its signature and doc comment: spinner, plus 2 types.

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

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

```ts
import { spinner } from 'flagstaff/spinner';
```

## Functions

### spinner

A spinner in the named style (`dots` by default); every style is a registered plugin's.

```ts
function spinner(style?: string): Component<SpinnerState>;
```

| Parameter | Type |
| :-- | :-- |
| `style` (optional) | `string` |

**Returns** `Component<SpinnerState>`

## Interfaces

### SpinnerState

```ts
interface SpinnerState {
    text: string;
    /** `running` when omitted. */
    status?: SpinnerStatus;
}
```

## Types

### SpinnerStatus

```ts
type SpinnerStatus = 'running' | 'ok' | 'fail' | 'warn' | 'info';
```