fast-api-tester 1.0.9 → 1.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-api-tester",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "Ultra-fast, connection-pooled API testing library for Node.js",
   "type": "module",
   "main": "./dist/index.js",

package/readme

@@ -161,6 +161,34 @@ All HTTP methods return a uniform response structure:
 
 ---
 
+## 📡 Advanced Features
+
+### Standalone Monitoring Setup (`startHeartbeat`)
+
+For continuous monitoring — as opposed to a single-run test suite — use `startHeartbeat` to run checks on a recurring interval. This is kept separate from your Vitest/Jest suites so that test runners don't auto-terminate the infinite monitoring loop.
+
+```typescript
+import { ApiEngine } from './index';
+
+const api = new ApiEngine().setBaseUrl('https://api.example.com');
+
+// Continuous heartbeat monitoring loop
+api.startHeartbeat(async () => {
+  const res = await api.get('/health');
+  res.expectLatencyUnder(200);
+});
+```
+
+### 📊 Interactive HTML Analytics & Historical Tracking
+
+Every execution run updates `test-report.html` and persists historical execution data to `.test-history.json` (retaining the last 10 runs).
+
+- **Current Run Breakdown**: Visual status pie chart for fast status verification.
+- **Historical Execution Trend**: Stacked bar chart visualizing test pass/fail trends over time across consecutive heartbeats.
+- **Detailed Table View**: Complete summary including HTTP Method, Endpoint, Status Code, Measured Latency, SLA Target, and exact error stack/messages for failing requests.
+
+---
+
 ## 📜 License
 
-[MIT](./LICENSE) © Kushan Amarasiri
+[MIT](./LICENSE) © Kushan Amarasiri