Skip to content
Interfaceutilsv0.8.17

TableOptions

interface TableOptions

align

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.

align?: Alignment | readonly Alignment[]

Default:'left'

border

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

border?: BorderStyle

Default:'rounded'

emptyCell

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

emptyCell?: string

Default:''

fence

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

fence?: boolean

Default:false

maxWidth

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

maxWidth?: number

numericAlign

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.

numericAlign?: boolean

Default:false

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.

overflow?: Overflow

Default:'wrap'

padding

Spaces on each side of every cell.

padding?: number

Default:1