# roundel/kleur

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

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

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

```ts
import kleur from 'roundel/kleur';
import type { Color, Kleur } from 'roundel/kleur';
```

## Constants

### default

The default export, declared as `kleur`.

kleur's module object: `enabled`, then the styles.

```ts
const kleur: Kleur & {
    enabled: boolean;
};
```

### module.exports

What `require()` returns: the default export, `kleur`, under the name Node's `require(esm)` reads.

## Interfaces

### Color

One style: text in, styled text out; nothing in, a chain out. As kleur declares it.

```ts
interface Color {
    (x: string | number): string;
    (): Kleur;
}
```

### Kleur

Every style, by kleur's names.

```ts
interface Kleur {
    black: Color;
    red: Color;
    green: Color;
    yellow: Color;
    blue: Color;
    magenta: Color;
    cyan: Color;
    white: Color;
    gray: Color;
    grey: Color;
    bgBlack: Color;
    bgRed: Color;
    bgGreen: Color;
    bgYellow: Color;
    bgBlue: Color;
    bgMagenta: Color;
    bgCyan: Color;
    bgWhite: Color;
    reset: Color;
    bold: Color;
    dim: Color;
    italic: Color;
    underline: Color;
    inverse: Color;
    hidden: Color;
    strikethrough: Color;
}
```