chore: Docs for clear rows (#132)

Author: ayonious

cypress/e2e/page_tests.cy.ts

@@ -15,7 +15,7 @@ describe("Testing Each Documentation Page", () => {
     },
     {
       title: "Adding Rows",
-      headlines: ["One row at a time", "Batch Row Adding", "Chained Row adding"]
+      headlines: ["One row at a time", "Batch Row Adding", "Chained Row adding", "Clearing Rows"]
     },
     {
       title: "Row Dividers",
@@ -161,4 +161,4 @@ describe("Testing Each Documentation Page", () => {
       }
     });
   });
-}); 
+}); 

cypress/e2e/url_tests.cy.ts

@@ -20,7 +20,7 @@ describe("Testing Each Documentation Page", () => {
     {
       url: "/docs/doc-adding-rows",
       title: "Adding Rows",
-      headlines: ["One row at a time", "Batch Row Adding", "Chained Row adding"]
+      headlines: ["One row at a time", "Batch Row Adding", "Chained Row adding", "Clearing Rows"]
     },
     {
       url: "/docs/doc-row-divider",
@@ -159,4 +159,4 @@ describe("Testing Each Documentation Page", () => {
       }
     });
   });
-}); 
+}); 

docs/api/table-methods.md

@@ -98,6 +98,58 @@ table.addRows([
 ]);
 ```
 
+### clearRows
+
+### `clearRows(): Table`
+
+Removes all rows from the table while keeping the table columns and configuration.
+
+Use this when the table structure should stay the same, but the row data needs to be replaced or reset.
+
+**Parameters:** None
+
+**Returns:** `Table` instance (for method chaining)
+
+**Example:**
+```javascript
+const table = new Table(["id", "status"]);
+
+table.addRows([
+  { id: 1, status: "Queued" },
+  { id: 2, status: "Running" }
+]);
+
+table.clearRows();
+table.addRow({ id: 3, status: "Done" });
+table.printTable();
+```
+
+**Chaining:**
+```javascript
+const table = new Table(["id", "status"])
+  .addRows([
+    { id: 1, status: "Queued" },
+    { id: 2, status: "Running" }
+  ])
+  .clearRows()
+  .addRows([{ id: 3, status: "Done" }]);
+```
+
+**Clearing Constructor Rows:**
+```javascript
+const table = new Table({
+  columns: [{ name: "task" }, { name: "state" }],
+  rows: [
+    { task: "fetch", state: "pending" },
+    { task: "build", state: "running" }
+  ]
+});
+
+table.clearRows().addRow({ task: "deploy", state: "done" });
+```
+
+After rows are cleared, `render()` and `printTable()` keep the existing table headers and render an empty body until new rows are added.
+
 ## Column Management Methods
 
 ### addColumn

docs/doc-adding-rows.md

@@ -66,3 +66,43 @@ p.addRow({ Weight: "1kg", text: "red wine", value: 10.212 })
   .addRow({ Weight: 3, text: "rosa hemd wie immer", value: 100 });
 p.printTable();
 ```
+
+## Clearing Rows
+
+Use `clearRows()` when you want to remove the current row data and reuse the same table instance. The table keeps its columns and configuration, so you can add fresh rows without rebuilding the table.
+
+`clearRows()` returns the table instance, so it can be used in a method chain.
+
+```javascript
+import { Table } from 'console-table-printer';
+
+const p = new Table(["id", "status"])
+  .addRows([
+    { id: 1, status: "Queued" },
+    { id: 2, status: "Running" },
+  ])
+  .clearRows()
+  .addRows([{ id: 3, status: "Done" }]);
+
+p.printTable();
+```
+
+Rows added during table creation can also be cleared.
+
+```javascript
+import { Table } from 'console-table-printer';
+
+const p = new Table({
+  columns: [{ name: "task" }, { name: "state" }],
+  rows: [
+    { task: "fetch", state: "pending" },
+    { task: "build", state: "running" },
+  ],
+});
+
+p.clearRows().addRow({ task: "deploy", state: "done" });
+
+p.printTable();
+```
+
+After calling `clearRows()`, rendering the table shows the existing headers with an empty body until new rows are added.

docs/doc-table-instance-creation.md

@@ -93,6 +93,7 @@ new Table({
 
 - `addRow(rowObjet, options)` adding single row.
 - `addRows(rowObjects, options)` adding multiple rows. array of row object. This case options will be applied to all the objects in row
+- `clearRows()` removes all rows while keeping the table columns and options. This can be chained
 - `addColumn(columnObject)` adding single column
 - `addColumns(columnObjects)` adding multiple columns
 - `printTable()` Prints the table on your console