# PagedTableOptions

`interface` in `utils` · v0.8.17

<https://seedcord.org/docs/packages/utils/0.8.17/interfaces/paged-table-options>

[`TableOptions`](/docs/packages/utils/0.8.17/interfaces/table-options) with `budget` required. The overload signal that makes renderTable return `string[]` of pages.

```ts
interface PagedTableOptions extends TableOptions
```

## Properties

### align

```ts
align?: Alignment | readonly Alignment[]
```

Cell alignment. A scalar applies to every column. An array sets alignment per column and any column past the end of the array falls back to left.

### border

```ts
border?: BorderStyle
```

Frame glyph set. `markdown` emits GFM with no outer frame.

### budget

```ts
budget: number;
```

Max characters per rendered page. The header is re-emitted on every page. Lower it to leave room
for surrounding text. Defaults to Discord's 2000-char message limit.

### emptyCell

```ts
emptyCell?: string
```

Fills a missing or empty cell so ragged rows stay aligned.

### fence

```ts
fence?: boolean
```

Wraps the output in a triple-backtick code block so Discord renders it monospace. The fence
characters count against the page budget.

### header

```ts
header?: boolean
```

Treats the first row as a header and draws a separator beneath it. The double frame draws that separator heavier.
The markdown border always carries its delimiter row. Turning this off puts a blank row above it.

### maxWidth

```ts
maxWidth?: number
```

Max content display width applied to every column. Wider cells are wrapped or truncated.

### numericAlign

```ts
numericAlign?: boolean
```

Right-aligns a column whose non-empty body cells are all numeric. The header label is not judged, so
a numeric column under a text header still aligns. An explicit align for that column wins.

### overflow

```ts
overflow?: Overflow
```

How an over-wide cell is handled once maxWidth is set. `wrap` word-wraps onto multiple lines, `truncate` cuts with a trailing ellipsis.
A GFM cell holds one line. The markdown border truncates whatever this says.

### padding

```ts
padding?: number
```

Spaces on each side of every cell.