Class TableFormatter

Table formatting utilities for beautiful tables, boxes, and lists.

Index

Constructors

Methods

box format formatTable list padString separator stripAnsi

Constructors

constructor

new TableFormatter(): TableFormatter
Returns TableFormatter

Methods

`Static`box

box(
    text: string,
    options?: {
        border?: "single" | "double" | "rounded" | "heavy";
        borderColor?: string[];
        color?: string[];
        padding?: number;
    },
    useColors?: boolean,
): string[]
Parameters
- text: string
- options: {
      border?: "single" | "double" | "rounded" | "heavy";
      borderColor?: string[];
      color?: string[];
      padding?: number;
  } = {}
- useColors: boolean = true
Returns string[]
- Defined in transports/formatters/TableFormatter.ts:339

`Static`format

format(
    data: Record<string, unknown>[],
    options?: TableOptions,
    useColors?: boolean,
): string[]
Parameters
- data: Record<string, unknown>[]
- options: TableOptions = {}
- useColors: boolean = true
Returns string[]
- Defined in transports/formatters/TableFormatter.ts:201

`Static`formatTable

formatTable(data: unknown, options?: TableOptions): string
Main public API for formatting data as a table
Parameters
- data: unknown
- options: TableOptions = {}
Returns string
- Defined in transports/formatters/TableFormatter.ts:131

`Static`list

list(
    items: string[],
    options?: {
        bullet?: string;
        bulletColor?: string[];
        indent?: number;
        itemColor?: string[];
    },
    useColors?: boolean,
): string[]
Parameters
- items: string[]
- options: {
      bullet?: string;
      bulletColor?: string[];
      indent?: number;
      itemColor?: string[];
  } = {}
- useColors: boolean = true
Returns string[]
- Defined in transports/formatters/TableFormatter.ts:397

`Static`padString

padString(str: string, width: number, align?: string): string
Parameters
- str: string
- width: number
- align: string = 'left'
Returns string
- Defined in transports/formatters/TableFormatter.ts:186

`Static`separator

separator(
    char?: string,
    width?: number,
    color?: string[],
    useColors?: boolean,
): string
Parameters
- char: string = '─'
- width: number = 50
- Optionalcolor: string[]
- useColors: boolean = true
Returns string
- Defined in transports/formatters/TableFormatter.ts:334

`Static`stripAnsi

stripAnsi(str: string): string
Parameters
- str: string
Returns string
- Defined in transports/formatters/TableFormatter.ts:181