fix: allow readonly array input for table data

gajus · Mar 19, 2023 · bbc04d6 · bbc04d6
1 parent 28e8e6e
commit bbc04d6
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 3 deletions.
diff --git a/src/stringifyTableData.ts b/src/stringifyTableData.ts
@@ -5,7 +5,7 @@ import {
   normalizeString,
 } from './utils';
 
-export const stringifyTableData = (rows: unknown[][]): Row[] => {
+export const stringifyTableData = (rows: ReadonlyArray<readonly unknown[]>): Row[] => {
   return rows.map((cells) => {
     return cells.map((cell) => {
       return normalizeString(String(cell));

diff --git a/src/table.ts b/src/table.ts
@@ -38,7 +38,7 @@ import {
   validateTableData,
 } from './validateTableData';
 
-export const table = (data: unknown[][], userConfig: TableUserConfig = {}): string => {
+export const table = (data: ReadonlyArray<readonly unknown[]>, userConfig: TableUserConfig = {}): string => {
   validateTableData(data);
 
   let rows = stringifyTableData(data);

diff --git a/src/validateTableData.ts b/src/validateTableData.ts
@@ -2,7 +2,7 @@ import {
   normalizeString,
 } from './utils';
 
-export const validateTableData = (rows: unknown[][]): void => {
+export const validateTableData = (rows: ReadonlyArray<readonly unknown[]>): void => {
   if (!Array.isArray(rows)) {
     throw new TypeError('Table data must be an array.');
   }

diff --git a/test/table.ts b/test/table.ts
@@ -187,4 +187,21 @@ describe('drawTable', () => {
 ╚══════════╧══════════╧══════════╧══════════╝`);
     });
   });
+
+  context('readonly array data type input', () => {
+    it('works properly', () => {
+      const dataReadonly = data as ReadonlyArray<readonly string[]>;
+
+      const result = table(dataReadonly);
+
+      expectTable(result, `
+╔═════════════╤═════════════╗
+║ Lorem ipsum │ dolor sit   ║
+╟─────────────┼─────────────╢
+║ amet        │ consectetur ║
+╟─────────────┼─────────────╢
+║ adipiscing  │ elit        ║
+╚═════════════╧═════════════╝`);
+    });
+  });
 });