Table | voici.js

Represent a dataset in tabular form. The columns are infered from the dataset's first item.

Type Parameters

TRow extends Row

Type of a dataset row.
TDColumns extends object = never

Type of the dynamic columns.

Hierarchy

Table

Constructors

constructor

new Table<TRow, TDColumns>(dataset: TRow[], config?: Partial<{ align: "LEFT" | "CENTER" | "RIGHT"; bgColorColumns: string[]; body: Partial<{ accumulation: Partial<{ bgColor: string; columns: Partial<Accumulation<TRow, TDColumns>>; separator: string }>; bgColor: string; fillEmpty: Partial<FillEmptyOption<DatasetRow<TRow, TDColumns>>>; highlightCell: Partial<{ bold: boolean; italic: boolean; textColor: string; underline: boolean; func: any }>; highlightRow: Partial<{ bgColor: string; func: any }>; peek: number | [number, number]; precision: number; striped: boolean; subset: [number?, number?]; textColor: string; filterRow: any }>; border: Partial<{ color: string; groupSize: number; horizontal: string; vertical: string }>; header: Partial<{ bgColor: string; bold: boolean; displayNames: Partial<{ [ key in number | "#"]: string }>; dynamic: DynamicColumn<TRow, TDColumns>; exclude: InferRowAttributes<TRow>[]; include: InferRowAttributes<TRow>[]; italic: boolean; lowercase: boolean; maxWidth: number | "auto"; order: InferAttributesOrigin<TRow, TDColumns>[]; origin: boolean; separator: string; textColor: string; underline: boolean; uppercase: boolean; upperfirst: boolean; width: number | "auto" | "stretch" }>; padding: Partial<{ char: string; size: number }>; sort: Sort<InferAttributesOrigin<TRow, TDColumns>> }>): Table<TRow, TDColumns>

- Defined in table.ts:93
Creates a new Table instance.

Type Parameters
- TRow extends Row
- TDColumns extends object = never
Parameters
- dataset: TRow[]
  
  the dataset
- config: Partial<{ align: "LEFT" | "CENTER" | "RIGHT"; bgColorColumns: string[]; body: Partial<{ accumulation: Partial<{ bgColor: string; columns: Partial<Accumulation<TRow, TDColumns>>; separator: string }>; bgColor: string; fillEmpty: Partial<FillEmptyOption<DatasetRow<TRow, TDColumns>>>; highlightCell: Partial<{ bold: boolean; italic: boolean; textColor: string; underline: boolean; func: any }>; highlightRow: Partial<{ bgColor: string; func: any }>; peek: number | [number, number]; precision: number; striped: boolean; subset: [number?, number?]; textColor: string; filterRow: any }>; border: Partial<{ color: string; groupSize: number; horizontal: string; vertical: string }>; header: Partial<{ bgColor: string; bold: boolean; displayNames: Partial<{ [ key in number | "#"]: string }>; dynamic: DynamicColumn<TRow, TDColumns>; exclude: InferRowAttributes<TRow>[]; include: InferRowAttributes<TRow>[]; italic: boolean; lowercase: boolean; maxWidth: number | "auto"; order: InferAttributesOrigin<TRow, TDColumns>[]; origin: boolean; separator: string; textColor: string; underline: boolean; uppercase: boolean; upperfirst: boolean; width: number | "auto" | "stretch" }>; padding: Partial<{ char: string; size: number }>; sort: Sort<InferAttributesOrigin<TRow, TDColumns>> }> = {}
  
  the config
Returns Table<TRow, TDColumns>

Properties

Private _config

_config: Required<Partial<{ align: "LEFT" | "CENTER" | "RIGHT"; bgColorColumns: string[]; body: Partial<{ accumulation: Partial<{ bgColor: string; columns: Partial<Accumulation<TRow, TDColumns>>; separator: string }>; bgColor: string; fillEmpty: Partial<FillEmptyOption<DatasetRow<TRow, TDColumns>>>; highlightCell: Partial<{ bold: boolean; italic: boolean; textColor: string; underline: boolean; func: any }>; highlightRow: Partial<{ bgColor: string; func: any }>; peek: number | [number, number]; precision: number; striped: boolean; subset: [number?, number?]; textColor: string; filterRow: any }>; border: Partial<{ color: string; groupSize: number; horizontal: string; vertical: string }>; header: Partial<{ bgColor: string; bold: boolean; displayNames: Partial<{ [ key in number | "#"]: string }>; dynamic: DynamicColumn<TRow, TDColumns>; exclude: InferRowAttributes<TRow>[]; include: InferRowAttributes<TRow>[]; italic: boolean; lowercase: boolean; maxWidth: number | "auto"; order: InferAttributesOrigin<TRow, TDColumns>[]; origin: boolean; separator: string; textColor: string; underline: boolean; uppercase: boolean; upperfirst: boolean; width: number | "auto" | "stretch" }>; padding: Partial<{ char: string; size: number }>; sort: Sort<InferAttributesOrigin<TRow, TDColumns>> }>>

The table config.

Private _dataset

_dataset: DatasetRow<TRow, TDColumns>[]

The dataset.

Private accumulatedRow

accumulatedRow: AccumulationRow<TRow, TDColumns>

The row containing the accumulated data.

Private columnNames

columnNames: InferDatasetRowAttributesOrigin<TRow, TDColumns>[] = []

The column names. Including the dynamic and origin column names

Private columnWidths

columnWidths: Map<InferDatasetRowAttributesOrigin<TRow, TDColumns>, number> = ...

The maximum width of each column.

Private tableWidth

tableWidth: number

The table width.

Private touched

touched: boolean = true

A flag to check whether the header or body has changed since the last build. Prevents unnecessary builds.

Accessors

columns

get columns(): InferDatasetRowAttributesOrigin<TRow, TDColumns>[]

- Defined in table.ts:125
Returns InferDatasetRowAttributesOrigin<TRow, TDColumns>[]

config

get config(): Required<Partial<{ align: "LEFT" | "CENTER" | "RIGHT"; bgColorColumns: string[]; body: Partial<{ accumulation: Partial<{ bgColor: string; columns: Partial<Accumulation<TRow, TDColumns>>; separator: string }>; bgColor: string; fillEmpty: Partial<FillEmptyOption<DatasetRow<TRow, TDColumns>>>; highlightCell: Partial<{ bold: boolean; italic: boolean; textColor: string; underline: boolean; func: any }>; highlightRow: Partial<{ bgColor: string; func: any }>; peek: number | [number, number]; precision: number; striped: boolean; subset: [number?, number?]; textColor: string; filterRow: any }>; border: Partial<{ color: string; groupSize: number; horizontal: string; vertical: string }>; header: Partial<{ bgColor: string; bold: boolean; displayNames: Partial<{ [ key in number | "#"]: string }>; dynamic: DynamicColumn<TRow, TDColumns>; exclude: InferRowAttributes<TRow>[]; include: InferRowAttributes<TRow>[]; italic: boolean; lowercase: boolean; maxWidth: number | "auto"; order: InferAttributesOrigin<TRow, TDColumns>[]; origin: boolean; separator: string; textColor: string; underline: boolean; uppercase: boolean; upperfirst: boolean; width: number | "auto" | "stretch" }>; padding: Partial<{ char: string; size: number }>; sort: Sort<InferAttributesOrigin<TRow, TDColumns>> }>>

- Defined in table.ts:121
Returns Required<Partial<{ align: "LEFT" | "CENTER" | "RIGHT"; bgColorColumns: string[]; body: Partial<{ accumulation: Partial<{ bgColor: string; columns: Partial<Accumulation<TRow, TDColumns>>; separator: string }>; bgColor: string; fillEmpty: Partial<FillEmptyOption<DatasetRow<TRow, TDColumns>>>; highlightCell: Partial<{ bold: boolean; italic: boolean; textColor: string; underline: boolean; func: any }>; highlightRow: Partial<{ bgColor: string; func: any }>; peek: number | [number, number]; precision: number; striped: boolean; subset: [number?, number?]; textColor: string; filterRow: any }>; border: Partial<{ color: string; groupSize: number; horizontal: string; vertical: string }>; header: Partial<{ bgColor: string; bold: boolean; displayNames: Partial<{ [ key in number | "#"]: string }>; dynamic: DynamicColumn<TRow, TDColumns>; exclude: InferRowAttributes<TRow>[]; include: InferRowAttributes<TRow>[]; italic: boolean; lowercase: boolean; maxWidth: number | "auto"; order: InferAttributesOrigin<TRow, TDColumns>[]; origin: boolean; separator: string; textColor: string; underline: boolean; uppercase: boolean; upperfirst: boolean; width: number | "auto" | "stretch" }>; padding: Partial<{ char: string; size: number }>; sort: Sort<InferAttributesOrigin<TRow, TDColumns>> }>>

dataset

get dataset(): DatasetRow<TRow, TDColumns>[]
set dataset(dataset: DatasetRow<TRow, TDColumns>[]): void

- Defined in table.ts:99
Returns DatasetRow<TRow, TDColumns>[]
- Defined in table.ts:103
Parameters
- dataset: DatasetRow<TRow, TDColumns>[]
Returns void

shape

get shape(): [rows: number, columns: number]

- Defined in table.ts:129
Returns [rows: number, columns: number]

Methods

Private build

build(force?: boolean): void

- Defined in table.ts:1044
Builds the table. For performance reasons the table is only built if Table.touched is true.

Parameters
- force: boolean = false
  
  force the build
Returns void

Private buildBody

buildBody(): string

- Defined in table.ts:1008
Builds the body.

Returns string
the build body

Private buildBodyCell

buildBodyCell(row: number, col: InferDatasetRowAttributesOrigin<TRow, TDColumns>): [content: string, overflow: string]

- Defined in table.ts:866
Builds the given body cell content.

Parameters
- row: number
  
  the cell's row
- col: InferDatasetRowAttributesOrigin<TRow, TDColumns>
  
  the cell's column
Returns [content: string, overflow: string]
the built cell content

Private buildBodyPeekRow

buildBodyPeekRow(): string

- Defined in table.ts:978
Builds the peek row. The placeholder row for the hidden rows if the peek config is set.

Returns string
the peek row

Private buildBodyRow

buildBodyRow(row: number): string

- Defined in table.ts:946
Builds the given body row.

Parameters
- row: number
  
  the row
Returns string
the built row content

Private buildBodyRowHorizontalBorder

buildBodyRowHorizontalBorder(row: number): string

- Defined in table.ts:926
Builds the horizontal border for the given row.

Parameters
- row: number
  
  the row
Returns string
the horizontal row border

Private buildCellContent

buildCellContent(padLeft: number, text: string, padRight: number): CellContent

- Defined in table.ts:484
Builds a cell content array.

Parameters
- padLeft: number
  
  the cell's left padding
- text: string
  
  the cell's text
- padRight: number
  
  the cell's right padding
Returns CellContent
the cell content

Private buildColumnNames

buildColumnNames(): void

- Defined in table.ts:310
Builds the column names from the dataset in the right order. The result is stored in Table.columnNames.

All column names are converted to string in order to avoid complications when using arrays and numbers and indices.

Returns void

Private buildDataset

buildDataset(dataset: TRow[]): DatasetRow<TRow, TDColumns>[]

- Defined in table.ts:219
Merges the user dataset with the dynamic columns.

Parameters
- dataset: TRow[]
Returns DatasetRow<TRow, TDColumns>[]
the new dataset

Private buildEmptyCellContent

buildEmptyCellContent(col: InferDatasetRowAttributesOrigin<TRow, TDColumns>): CellContent

- Defined in table.ts:494
Builds an empty cell content.

Parameters
- col: InferDatasetRowAttributesOrigin<TRow, TDColumns>
  
  the cell's column
Returns CellContent
the empty cell content

Private buildHeader

buildHeader(): string

- Defined in table.ts:744
Builds the header.

Returns string
the built header

Private buildHeaderCell

buildHeaderCell(col: InferDatasetRowAttributesOrigin<TRow, TDColumns>): [content: string, overflow: string]

- Defined in table.ts:706
Builds the given header cell content.

Parameters
- col: InferDatasetRowAttributesOrigin<TRow, TDColumns>
  
  the cell's column
Returns [content: string, overflow: string]
the built cell content

Private buildRowOverflow

buildRowOverflow(row: number, overflow: string[]): string

- Defined in table.ts:547
Builds the subsequent lines (overflow) of the given row. Set row=0 for the header.

Parameters
- row: number
  
  the initial row
- overflow: string[]
  
  the text overflow for each solumn
Returns string
the subsequent lines

Private buildRowSeparator

buildRowSeparator(separator: string): string

- Defined in table.ts:438
Builds the row separator.

Parameters
- separator: string
  
  the separator character
Returns string
the row separator string

Private calculateAccumulation

calculateAccumulation(): AccumulationRow<TRow, TDColumns>

- Defined in table.ts:447
Computes the rows of the accumulated columns.

Returns AccumulationRow<TRow, TDColumns>
the calculated rows

Private calculateBodyCellPadding

calculateBodyCellPadding(row: number, col: InferDatasetRowAttributesOrigin<TRow, TDColumns>): number

- Defined in table.ts:775
Calculates the body cell padding.

Parameters
- row: number
  
  the cell's row
- col: InferDatasetRowAttributesOrigin<TRow, TDColumns>
  
  the cell's column
Returns number
the cell padding

Private calculateColumnWidths

calculateColumnWidths(): void

- Defined in table.ts:372
Calculates the width of all columns. The result is stored in Table.columnWidths

Returns void

Private calculateHeaderCellPadding

calculateHeaderCellPadding(col: InferDatasetRowAttributesOrigin<TRow, TDColumns>): number

- Defined in table.ts:626
Calculates the header cell padding. The padding is based on the column's width and its display name.

Parameters
- col: InferDatasetRowAttributesOrigin<TRow, TDColumns>
  
  the cell's column
Returns number
the cell padding

Private calculateTableWidth

calculateTableWidth(): number

- Defined in table.ts:290
Calculates the width of the complete table. The table width is based on the width of the columns, the padding and the border.

Returns number
the table width

exportFile

exportFile(filepath: string, mode?: OpenMode): void

- Defined in table.ts:206
Exports the plain table to the given file (without advanced style).

Parameters
- filepath: string
  
  the filepath
- mode: OpenMode = 'w'
  
  the file's open mode
Returns void

Private formatBodyCellContent

formatBodyCellContent(row: number, col: InferDatasetRowAttributesOrigin<TRow, TDColumns>, content: CellContent): string

- Defined in table.ts:791
Formats the content of the given body cell.

Parameters
- row: number
  
  the cell's row
- col: InferDatasetRowAttributesOrigin<TRow, TDColumns>
  
  the cell's column
- content: CellContent
  
  the cell's content
Returns string
the formatted cell content

Private formatBodyRowContent

formatBodyRowContent(row: number, content: string): string

- Defined in table.ts:905
Formats the content of the given body row.

Parameters
- row: number
  
  the cell's row
- content: string
  
  the rows's content
Returns string
the formatted row content

Private formatHeaderCellContent

formatHeaderCellContent(col: InferDatasetRowAttributesOrigin<TRow, TDColumns>, content: CellContent): string

- Defined in table.ts:639
Formats the content of the given header cell. The return value includes also the content's length because the content also contains ANSI escape codes.

Parameters
- col: InferDatasetRowAttributesOrigin<TRow, TDColumns>
  
  cell's column
- content: CellContent
  
  cell's content
Returns string
the formatted cell content and its length

Private getCellText

getCellText(row: number, col: InferDatasetRowAttributesOrigin<TRow, TDColumns>, cropped?: boolean): string

- Defined in table.ts:522
Gets the text of given the given cell.

Parameters
- row: number
  
  the cell's row
- col: InferDatasetRowAttributesOrigin<TRow, TDColumns>
  
  the cell's column
- cropped: boolean = true
  
  whether the text should be cropped or not.
Returns string
the cell text

Private getColumnDisplayName

getColumnDisplayName(col: InferDatasetRowAttributesOrigin<TRow, TDColumns>, cropped?: boolean): string

- Defined in table.ts:352
Gets the display name of the given column.

Parameters
- col: InferDatasetRowAttributesOrigin<TRow, TDColumns>
  
  the column
- cropped: boolean = false
  
  whether the column name should be cropped or not.
Returns string
the column's display name string

Private getColumnIndex

getColumnIndex(col: InferDatasetRowAttributesOrigin<TRow, TDColumns>): number

- Defined in table.ts:428
Gets the index of the given column.

Parameters
- col: InferDatasetRowAttributesOrigin<TRow, TDColumns>
  
  the column's name
Returns number
the column's index

Private getColumnWidth

getColumnWidth(col: InferDatasetRowAttributesOrigin<TRow, TDColumns>): number

- Defined in table.ts:341
Gets the width of the given column.

Parameters
- col: InferDatasetRowAttributesOrigin<TRow, TDColumns>
  
  the column
Returns number
the column's text width

Private getConsoleWidth

getConsoleWidth(): number

- Defined in table.ts:242
Get the width of the console window. Padding is substracted from the width.

Returns number
the console width

getDataCell

getDataCell(row: number, col: InferDatasetRowAttributesOrigin<TRow, TDColumns>): AccumulationRow<TRow, TDColumns>[InferDatasetRowAttributesOrigin<TRow, TDColumns>]

- Defined in table.ts:140
Gets the value of the given cell in the dataset.

Parameters
- row: number
  
  the cell's row
- col: InferDatasetRowAttributesOrigin<TRow, TDColumns>
  
  the cell's col
Returns AccumulationRow<TRow, TDColumns>[InferDatasetRowAttributesOrigin<TRow, TDColumns>]
the cell's value

Private getPadding

getPadding(size: number): string

- Defined in table.ts:254
Gets the character padding of the given size.

Parameters
- size: number
  
  the padding size
Returns string
the character padding

Private isBorder

isBorder(text: string): boolean

- Defined in table.ts:264
Checks whether the given text is a border character.

Parameters
- text: string
  
  the text to check
Returns boolean
whether the text is a border character

Private parseCellText

parseCellText(text: unknown): string

- Defined in table.ts:509
Parses the given cell text to String.

Parameters
- text: unknown
  
  the text to parse
Returns string
the parsed cell text

print

print(clear?: boolean): void

- Defined in table.ts:186
Prints the table to the console.

Parameters
- clear: boolean = false
  
  clear the console before printing
Returns void

printPlain

printPlain(): void

- Defined in table.ts:195
Prints the plain (unstyled) table to the console.

Returns void

Private sort

sort(): void

- Defined in table.ts:275
Sorts the dataset by the columns provided in Table._config.

Returns void

toPlainString

toPlainString(): string

- Defined in table.ts:167
Gets the table as plain string without any advanced styling. Can be used for example to write the table to a file or to paste it anywhere as text.

Returns string
the plain table string

toString

toString(): string

- Defined in table.ts:156
Gets the table as string. Can be used to print the table on the console.

Returns string
the table string

Type Parameters

TRow extends Row

TDColumns extends object = never

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

TRow extends Row

TDColumns extends object = never

Parameters

dataset: TRow[]

Returns Table<TRow, TDColumns>

Properties

Private _config

Private _dataset

Private accumulatedRow

Private columnNames

Private columnWidths

Private tableWidth

Private touched

Accessors

columns

Returns InferDatasetRowAttributesOrigin<TRow, TDColumns>[]

config

dataset

Returns DatasetRow<TRow, TDColumns>[]

Parameters

dataset: DatasetRow<TRow, TDColumns>[]

Returns void

shape

Returns [rows: number, columns: number]

Methods

Private build

Parameters

force: boolean = false

Returns void

Private buildBody

Returns string

Private buildBodyCell

Parameters

row: number

col: InferDatasetRowAttributesOrigin<TRow, TDColumns>

Returns [content: string, overflow: string]

Private buildBodyPeekRow

Returns string

Private buildBodyRow

Parameters

row: number

Returns string

Private buildBodyRowHorizontalBorder

Parameters

row: number

Returns string

Private buildCellContent

Parameters

padLeft: number

text: string

padRight: number

Returns CellContent

Private buildColumnNames

Returns void

Private buildDataset

Parameters

dataset: TRow[]

Returns DatasetRow<TRow, TDColumns>[]

Private buildEmptyCellContent

Parameters

col: InferDatasetRowAttributesOrigin<TRow, TDColumns>

Returns CellContent

Private buildHeader

Returns string

Private buildHeaderCell

Parameters

col: InferDatasetRowAttributesOrigin<TRow, TDColumns>

Returns [content: string, overflow: string]