# roundel/kleur/colors

> Every export of roundel/kleur/colors, with its signature and doc comment: $, reset, bold, dim, italic, underline and 21 more, plus 1 type.

Source: https://roundel.interlace.tools/docs/api/kleur/colors

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

```ts
import { $, reset, bold, … } from 'roundel/kleur/colors';
```

## Constants

### $

The switch every function reads: kleur's decision at import, and whatever a caller assigns after.

```ts
const $: {
    enabled: boolean;
};
```

### bgBlack

```ts
const bgBlack: Colorize;
```

### bgBlue

```ts
const bgBlue: Colorize;
```

### bgCyan

```ts
const bgCyan: Colorize;
```

### bgGreen

```ts
const bgGreen: Colorize;
```

### bgMagenta

```ts
const bgMagenta: Colorize;
```

### bgRed

```ts
const bgRed: Colorize;
```

### bgWhite

```ts
const bgWhite: Colorize;
```

### bgYellow

```ts
const bgYellow: Colorize;
```

### black

```ts
const black: Colorize;
```

### blue

```ts
const blue: Colorize;
```

### bold

```ts
const bold: Colorize;
```

### cyan

```ts
const cyan: Colorize;
```

### dim

```ts
const dim: Colorize;
```

### gray

```ts
const gray: Colorize;
```

### green

```ts
const green: Colorize;
```

### grey

```ts
const grey: Colorize;
```

### hidden

```ts
const hidden: Colorize;
```

### inverse

```ts
const inverse: Colorize;
```

### italic

```ts
const italic: Colorize;
```

### magenta

```ts
const magenta: Colorize;
```

### red

```ts
const red: Colorize;
```

### reset

```ts
const reset: Colorize;
```

### strikethrough

```ts
const strikethrough: Colorize;
```

### underline

```ts
const underline: Colorize;
```

### white

```ts
const white: Colorize;
```

### yellow

```ts
const yellow: Colorize;
```

## Interfaces

### Colorize

One function, typed as kleur/colors declares it: a value styled, nothing and `null` returned as given.

```ts
interface Colorize {
    (input: string | boolean | number): string;
    (input: undefined | void): undefined;
    (input: null): null;
}
```