# @hugop/discord-table

> A very simple package to build Markdown tables through the Discord API

Latest version **1.0.1** (published 2021-03-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @hugop/discord-table
pnpm add @hugop/discord-table
yarn add @hugop/discord-table
bun add @hugop/discord-table
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-03-19 |
| First published | 2021-03-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 11.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | hugop |
| Maintainers | hugop |
| Keywords | discord, table |

## Links

- npm: https://www.npmjs.com/package/@hugop/discord-table
- Repository: https://github.com/hugop95/discord-table
- Homepage: https://github.com/hugop95/discord-table#readme
- Issues: https://github.com/hugop95/discord-table/issues
- npm.io page: https://npm.io/package/@hugop/discord-table

## Alternatives

- [@lexical/table](https://npm.io/package/@lexical/table.md) — 3.0M weekly downloads
- [mantine-datatable](https://npm.io/package/mantine-datatable.md) — 98.2K weekly downloads
- [react-native-collapsible-tab-view](https://npm.io/package/react-native-collapsible-tab-view.md) — 70.6K weekly downloads
- [@handsontable/vue3](https://npm.io/package/@handsontable/vue3.md) — 16.1K weekly downloads
- [vuewordcloud](https://npm.io/package/vuewordcloud.md) — 7.2K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2021-03-19
- 1.0.0 — 2021-03-19
- 0.0.2 — 2021-03-18
- 0.0.1 — 2021-03-18

## README

# discord-table

![npm (scoped)](https://img.shields.io/npm/v/@hugop/discord-table)
![NPM](https://img.shields.io/npm/l/@hugop/discord-table)
[![Build Status](https://travis-ci.com/hugop95/discord-table.svg?branch=master)](https://travis-ci.com/hugop95/discord-table)

Discord Table is a very simple package to build Markdown tables through the Discord API.
Taking some formatting parameters, it returns a ```string[]``` object, usable with the Discord API
to print a table.

## Usage

The content of the table is an Array of lines.

A line is an Array of cells.

A cell is an Array of sub-cells.

### Javascript import
```js
const dcTable = require('@hugop/discord-table')
```

### TypeScript import
``` typescript
import {createDiscordTable} from "@hugop/discord-table";
```

### Basic usage

```js
 const headers = [
  ["USERNAME"], ["ROLES"], ["AGE"], ["DAYS SINCE JOINED"]
];
const content = [
  [["Jeremy"], ["Admin", "Regular"], ["18"], ["45 days"]],
  [["James"], ["Newcomer"], [], ["2 days"]],
  [["Marc"], ["Regular"], ["22"], ["20 days"]],
  [],
  [["Karl"], ["BANNED"], ["BANNED"], ["BANNED"]]
]
const result = dcTable.createDiscordTable({
  headers: headers,
  content: content,
  spacesBetweenColumns: [5, 5, 5],
  maxColumnLengths: [30, 30, 30, 30]
})
```

### Result on Discord

![Missing picture](images/example.PNG)

## Installation

[npm link](https://www.npmjs.com/package/@hugop/discord-table)

This is a [Node.js](https://nodejs.org/en/) module available through the
[npm registry](https://www.npmjs.com/).

Installation:
```bash
$ npm install @hugop/discord-table
```

## Features

* Customizable maximum column length for each column
* Customizable space between each column
* Multi-line cells

## Notes
* You are responsible for ensuring that the resulting object fits the Discord API limitations 
(such as maximum length authorized per message).
* The maximum width allowed by the table before a line wraps to another line depends on the client's screen width.
You might need to adjust column lengths and space between columns to ensure that most users can see each line properly.
* Some Emojis and special characters that are full width may shift how columns appear

---
_Source: https://npm.io/package/@hugop/discord-table · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._