# roundel

> Every export of roundel, with its signature and doc comment: channels, luminance, contrast, reportTheme, AA, AAA and 27 more, plus 17 types.

Source: https://roundel.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`. -->

roundel — the colours a CLI carries. Re-exports only; each subpath is its own entry
and costs only itself (R7), so prefer `roundel/tokens` when that is all you need.

```ts
import { channels, luminance, contrast, … } from 'roundel';
```

## Exports

Documented on the page of the entry point that declares them.

| Export | Kind | Documented in |
| :-- | :-- | :-- |
| `audit` | function | [`roundel/theme`](/docs/api/theme#audit) |
| `channels` | function | [`roundel/contrast`](/docs/api/contrast#channels) |
| `colorLevel` | function | [`roundel/policy`](/docs/api/policy#colorlevel) |
| `contrast` | function | [`roundel/contrast`](/docs/api/contrast#contrast) |
| `contributions` | function | [`roundel/plugin`](/docs/api/plugin#contributions) |
| `fly` | function | [`roundel/theme`](/docs/api/theme#fly) |
| `luminance` | function | [`roundel/contrast`](/docs/api/contrast#luminance) |
| `register` | function | [`roundel/plugin`](/docs/api/plugin#register) |
| `registered` | function | [`roundel/plugin`](/docs/api/plugin#registered) |
| `reportTheme` | function | [`roundel/contrast`](/docs/api/contrast#reporttheme) |
| `reset` | function | [`roundel/plugin`](/docs/api/plugin#reset) |
| `rgb256` | function | [`roundel/theme`](/docs/api/theme#rgb256) |
| `sgr` | function | [`roundel/tokens`](/docs/api/tokens#sgr) |
| `theme` | function | [`roundel/plugin`](/docs/api/plugin#theme) |
| `toOklab` | function | [`roundel/theme`](/docs/api/theme#tooklab) |
| `validate` | function | [`roundel/plugin`](/docs/api/plugin#validate) |
| `PluginError` | class | [`roundel/plugin`](/docs/api/plugin#pluginerror) |
| `AA` | const | [`roundel/contrast`](/docs/api/contrast#aa) |
| `AAA` | const | [`roundel/contrast`](/docs/api/contrast#aaa) |
| `command` | const | [`roundel/tokens`](/docs/api/tokens#command) |
| `CONTRACT` | const | [`roundel/plugin`](/docs/api/plugin#contract) |
| `error` | const | [`roundel/tokens`](/docs/api/tokens#error) |
| `flag` | const | [`roundel/tokens`](/docs/api/tokens#flag) |
| `floors` | const | [`roundel/contrast`](/docs/api/contrast#floors) |
| `flown` | const | [`roundel/policy`](/docs/api/policy#flown) |
| `heading` | const | [`roundel/tokens`](/docs/api/tokens#heading) |
| `hint` | const | [`roundel/tokens`](/docs/api/tokens#hint) |
| `muted` | const | [`roundel/tokens`](/docs/api/tokens#muted) |
| `ok` | const | [`roundel/tokens`](/docs/api/tokens#ok) |
| `outputMode` | const | [`roundel/policy`](/docs/api/policy#outputmode) |
| `round2` | const | [`roundel/contrast`](/docs/api/contrast#round2) |
| `value` | const | [`roundel/tokens`](/docs/api/tokens#value) |
| `warn` | const | [`roundel/tokens`](/docs/api/tokens#warn) |
| `Contribution` | interface | [`roundel/plugin`](/docs/api/plugin#contribution) |
| `ModeOptions` | interface | [`roundel/policy`](/docs/api/policy#modeoptions) |
| `Plugin` | interface | [`roundel/plugin`](/docs/api/plugin#plugin) |
| `Runtime` | interface | [`roundel/policy`](/docs/api/policy#runtime) |
| `SgrPair` | interface | [`roundel/tokens`](/docs/api/tokens#sgrpair) |
| `ThemeFinding` | interface | [`roundel/contrast`](/docs/api/contrast#themefinding) |
| `ColorLevel` | type | [`roundel/policy`](/docs/api/policy#colorlevel) |
| `Conformance` | type | [`roundel/contrast`](/docs/api/contrast#conformance) |
| `Format` | type | [`roundel/policy`](/docs/api/policy#format) |
| `Hex` | type | [`roundel/theme`](/docs/api/theme#hex) |
| `OutputMode` | type | [`roundel/policy`](/docs/api/policy#outputmode) |
| `Paint` | type | [`roundel/policy`](/docs/api/policy#paint) |
| `PluginErrorCode` | type | [`roundel/plugin`](/docs/api/plugin#pluginerrorcode) |
| `Style` | type | [`roundel/theme`](/docs/api/theme#style) |
| `Theme` | type | [`roundel/theme`](/docs/api/theme#theme) |
| `Token` | type | [`roundel/tokens`](/docs/api/tokens#token) |
| `TokenName` | type | [`roundel/policy`](/docs/api/policy#tokenname) |