Options
All
  • Public
  • Public/Protected
  • All
Menu

Module display/tables

Tables. Currently, markdown-based.

Index

Enumerations

Interfaces

Type aliases

Variables

Functions

Type aliases

Column

Column: string | [name: string] | [name: string, type: ColumnType] | [name: string, align: Align] | [name: string, format: Formatter] | [name: string, fixed: boolean] | [name: string, format: Formatter, align: Align] | [name: string, format: Formatter, fixed: boolean] | ColumnSpec

Description of a table column

Variables

Const ColTypes

ColTypes: {[ K in keyof typeof coltypes]: ColumnType } = ...

Functions

asAlign

asColumn

asColumnSpec

  • asColumnSpec(a: any): { align: Align; fixed?: boolean; format: Formatter; name: any }

asColumnType

Const formatCell

Const isAlign

  • isAlign(a: any): a is Align

Const isColumn

  • isColumn(c: any): c is Column

Const isColumnSpec

Const isColumnType

Const row

  • row(...args: any[]): string

  • Format a row of values in a Markdown table.

    Parameters

    • Rest ...args: any[]

      Array of values for the cells in the row

    Returns string

    a markdown-formatted string

Const table

  • table(columns: ColMap | Column[], ...rows: any): string

toAlign

toColumn

toColumnSpec

  • toColumnSpec(a: any): { align: Align; fixed?: boolean; format: Formatter; name: any }

toColumnType

Generated using TypeDoc