# roundel/yoctocolors

> Every export of roundel/yoctocolors, with its signature and doc comment: reset, bold, dim, italic, underline, underlineDouble and 56 more, plus 1 type.

Source: https://roundel.interlace.tools/docs/api/yoctocolors

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

```ts
import value from 'roundel/yoctocolors';
import { reset, bold, dim, … } from 'roundel/yoctocolors';
```

## Constants

### bgBlack

```ts
const bgBlack: Format;
```

### bgBlue

```ts
const bgBlue: Format;
```

### bgBlueBright

```ts
const bgBlueBright: Format;
```

### bgCyan

```ts
const bgCyan: Format;
```

### bgCyanBright

```ts
const bgCyanBright: Format;
```

### bgGray

```ts
const bgGray: Format;
```

### bgGreen

```ts
const bgGreen: Format;
```

### bgGreenBright

```ts
const bgGreenBright: Format;
```

### bgMagenta

```ts
const bgMagenta: Format;
```

### bgMagentaBright

```ts
const bgMagentaBright: Format;
```

### bgRed

```ts
const bgRed: Format;
```

### bgRedBright

```ts
const bgRedBright: Format;
```

### bgWhite

```ts
const bgWhite: Format;
```

### bgWhiteBright

```ts
const bgWhiteBright: Format;
```

### bgYellow

```ts
const bgYellow: Format;
```

### bgYellowBright

```ts
const bgYellowBright: Format;
```

### black

```ts
const black: Format;
```

### blue

```ts
const blue: Format;
```

### blueBright

```ts
const blueBright: Format;
```

### bold

```ts
const bold: Format;
```

### cyan

```ts
const cyan: Format;
```

### cyanBright

```ts
const cyanBright: Format;
```

### dim

```ts
const dim: Format;
```

### gray

```ts
const gray: Format;
```

### green

```ts
const green: Format;
```

### greenBright

```ts
const greenBright: Format;
```

### hidden

```ts
const hidden: Format;
```

### inverse

```ts
const inverse: Format;
```

### italic

```ts
const italic: Format;
```

### magenta

```ts
const magenta: Format;
```

### magentaBright

```ts
const magentaBright: Format;
```

### overline

```ts
const overline: Format;
```

### red

```ts
const red: Format;
```

### redBright

```ts
const redBright: Format;
```

### reset

```ts
const reset: Format;
```

### strikethrough

```ts
const strikethrough: Format;
```

### underline

```ts
const underline: Format;
```

### underlineBlack

```ts
const underlineBlack: Format;
```

### underlineBlue

```ts
const underlineBlue: Format;
```

### underlineBlueBright

```ts
const underlineBlueBright: Format;
```

### underlineCurly

```ts
const underlineCurly: Format;
```

### underlineCyan

```ts
const underlineCyan: Format;
```

### underlineCyanBright

```ts
const underlineCyanBright: Format;
```

### underlineDashed

```ts
const underlineDashed: Format;
```

### underlineDotted

```ts
const underlineDotted: Format;
```

### underlineDouble

```ts
const underlineDouble: Format;
```

### underlineGray

```ts
const underlineGray: Format;
```

### underlineGreen

```ts
const underlineGreen: Format;
```

### underlineGreenBright

```ts
const underlineGreenBright: Format;
```

### underlineMagenta

```ts
const underlineMagenta: Format;
```

### underlineMagentaBright

```ts
const underlineMagentaBright: Format;
```

### underlineRed

```ts
const underlineRed: Format;
```

### underlineRedBright

```ts
const underlineRedBright: Format;
```

### underlineWhite

```ts
const underlineWhite: Format;
```

### underlineWhiteBright

```ts
const underlineWhiteBright: Format;
```

### underlineYellow

```ts
const underlineYellow: Format;
```

### underlineYellowBright

```ts
const underlineYellowBright: Format;
```

### white

```ts
const white: Format;
```

### whiteBright

```ts
const whiteBright: Format;
```

### yellow

```ts
const yellow: Format;
```

### yellowBright

```ts
const yellowBright: Format;
```

## Namespaces

### default

The module's own namespace: every export on this page, as one object.

```ts
export * as default from './yoctocolors.js';
```

## Types

### Format

One style: the text between an open and a close code.

```ts
type Format = (string: string) => string;
```
