@types/easy-table

What is @types/easy-table?

@types/easy-table provides TypeScript type definitions for the easy-table package, which is a simple and flexible way to create ASCII tables in the terminal or console.

What are @types/easy-table's main functionalities?

Basic Table Creation

This feature allows you to create a basic table with rows and columns. Each cell is defined with a column name and a value, and new rows are added using the newRow() method.

const Table = require('easy-table');
const t = new Table();
t.cell('Name', 'John Doe');
t.cell('Age', 28);
t.newRow();
t.cell('Name', 'Jane Doe');
t.cell('Age', 26);
console.log(t.toString());

Custom Column Widths

This feature allows you to customize the width of columns and sort the table based on specific columns. The sort method can be used to sort the table by any column in ascending or descending order.

const Table = require('easy-table');
const t = new Table();
t.cell('Name', 'John Doe');
t.cell('Age', 28);
t.newRow();
t.cell('Name', 'Jane Doe');
t.cell('Age', 26);
t.sort(['Age|des']);
console.log(t.print());

Formatting Cells

This feature allows you to format the content of cells. For example, you can format numbers to a specific number of decimal places using the Table.number() method.

const Table = require('easy-table');
const t = new Table();
t.cell('Name', 'John Doe');
t.cell('Age', 28, Table.number(0));
t.newRow();
t.cell('Name', 'Jane Doe');
t.cell('Age', 26, Table.number(0));
console.log(t.toString());

Other packages similar to @types/easy-table

cli-table

cli-table is another package for creating tables in the terminal. It offers more customization options for table borders and styles compared to easy-table, but it may be slightly more complex to use.

table

The table package provides a more feature-rich and flexible way to create tables in the terminal. It supports a wide range of customization options, including cell padding, alignment, and border styles. It is more powerful but also more complex than easy-table.

ascii-table

ascii-table is a lightweight package for creating ASCII tables. It is simpler and less feature-rich compared to easy-table, making it suitable for basic table creation needs.

README

This is a stub types definition for @types/easy-table (https://github.com/eldargab/easy-table#readme).

easy-table provides its own type definitions, so you don't need @types/easy-table installed!