@5ed5war5it/js-table

js-table: A JavaScript Library for Rendering Tables in the Console

Introduction

js-table is a JavaScript library that allows you to easily render tables in the console. It provides a simple and intuitive API for creating tables with various styles and formatting options.

Installation

To install js-table, simply run the following command in your terminal:

npm install js-table

Usage

To use js-table, import the library into your JavaScript file:

import TableCLI from 'js-table';

Once imported, you can use the redner method to render a table. The redner method takes two parameters:

• table: The table object containing rows and dataset.
• params: The parameters object containing styles, fill, and gap.

The following code snippet shows how to use the redner method to render a simple table:

const table = {
  rows: ['Name', 'Age', 'City'],
  dataset: [
    ['John Doe', 30, 'New York'],
    ['Jane Doe', 25, 'Los Angeles'],
    ['Peter Smith', 40, 'Chicago'],
  ],
};

const params = {
  styles: {
    color: {
      row: ['\x1b[32m', '\x1b[38;0;0m'],
      header: ['\x1b[36m', '\x1b[38;0;0m'],
    },
  },
  fill: '-',
  gap: 2,
};

const renderedTable = TableCLI.redner(table, params);

console.log(renderedTable);

The above code will render the following table in the console:

Name         Age  City
-----------  ---  -----------
John Doe     30   New York
Jane Doe     25   Los Angeles
Peter Smith  40   Chicago

API

The js-table library provides the following methods:

• redner(table, params): Renders a table with the given data and parameters.