From 9444bd71a0b9165ef1a900f19b08a88592d2bb5c Mon Sep 17 00:00:00 2001
From: Ryan Dahl <ry@tinyclouds.org>
Date: Wed, 20 Mar 2019 12:39:47 -0400
Subject: Website and manual improvements (#1967)

---
 js/metrics.ts | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

(limited to 'js')

diff --git a/js/metrics.ts b/js/metrics.ts
index 111015078..c4ba14c7d 100644
--- a/js/metrics.ts
+++ b/js/metrics.ts
@@ -34,7 +34,19 @@ function res(baseRes: null | msg.Base): Metrics {
   };
 }
 
-/** Receive metrics from the privileged side of Deno. */
+/** Receive metrics from the privileged side of Deno.
+ *
+ *    > console.table(Deno.metrics())
+ *   ┌──────────────────┬────────┐
+ *   │     (index)      │ Values │
+ *   ├──────────────────┼────────┤
+ *   │  opsDispatched   │   9    │
+ *   │   opsCompleted   │   9    │
+ *   │ bytesSentControl │  504   │
+ *   │  bytesSentData   │   0    │
+ *   │  bytesReceived   │  856   │
+ *   └──────────────────┴────────┘
+ */
 export function metrics(): Metrics {
   return res(dispatch.sendSync(...req()));
 }
-- 
cgit v1.2.3