Add TypeScript type declaration

Author: antonilol

lib/index.d.ts

@@ -0,0 +1,77 @@
+type HorizontalTableRow = string[];
+type VerticalTableRow = Record<string, string>;
+type CrossTableRow = Record<string, string[]>;
+type TableRow = HorizontalTableRow | VerticalTableRow | CrossTableRow;
+
+interface TableOptions<T extends TableRow = TableRow> {
+    rows?: T[];
+    chars?: {
+        [k in
+            | 'top'
+            | 'top-mid'
+            | 'top-left'
+            | 'top-right'
+            | 'bottom'
+            | 'bottom-mid'
+            | 'bottom-left'
+            | 'bottom-right'
+            | 'left'
+            | 'left-mid'
+            | 'mid'
+            | 'mid-mid'
+            | 'right'
+            | 'right-mid'
+            | 'middle']?: string;
+    };
+    truncate?: string;
+    colors?: boolean;
+    colWidths?: number[];
+    colAligns?: Array<'left' | 'middle' | 'right'>;
+    style?: {
+        'padding-left'?: number;
+        'padding-right'?: number;
+        head?: string[];
+        border?: string[];
+        compact?: boolean;
+    };
+    head?: string[];
+}
+
+declare class Table<T extends TableRow = TableRow> extends Array<T> {
+    /**
+     * Table constructor
+     *
+     * @param options
+     * @api public
+     */
+    constructor(options?: T extends CrossTableRow ? never : TableOptions<T>);
+    constructor(options: T extends CrossTableRow ? TableOptions<T> & { head: ['', ...string[]] } : never);
+
+    /**
+     * Width getter
+     *
+     * @return width
+     * @api public
+     */
+    get width(): number;
+
+    /**
+     * Render to a string.
+     *
+     * @return table representation
+     * @api public
+     */
+    render(): string;
+
+    /**
+     * Render to a string.
+     *
+     * @return table representation
+     * @api public
+     */
+    toString(): string;
+
+    static readonly version: string;
+}
+
+export = Table;

package.json

@@ -17,7 +17,8 @@
     "expresso": "~0.9",
     "should": "~0.6"
   },
-  "main": "lib",
+  "main": "./lib/index.js",
+  "types": "./lib/main.d.ts",
   "files": ["lib"],
   "scripts": {
     "test": "make test"