aboutsummaryrefslogtreecommitdiff
path: root/node_modules/browser-process-hrtime/README.md
diff options
context:
space:
mode:
authorJoel Kronqvist <work.joelkronqvist@pm.me>2022-03-11 20:46:06 +0200
committerJoel Kronqvist <work.joelkronqvist@pm.me>2022-03-11 20:46:06 +0200
commit080c5819d87b933816d724a83f3bf4f1686770a7 (patch)
tree4a2ccc68b27edf7d4cbc586c932cc7542b655e19 /node_modules/browser-process-hrtime/README.md
parent5ac7049a9d30733165cc212dee308163c2a14644 (diff)
parentd003b82235a9329f912522a2f70aa950dfce4998 (diff)
downloadLYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.tar.gz
LYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.zip
Merge branch 'master' of https://github.com/JoelHMikael/FoodJS
Updating remote changes
Diffstat (limited to 'node_modules/browser-process-hrtime/README.md')
-rw-r--r--node_modules/browser-process-hrtime/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/node_modules/browser-process-hrtime/README.md b/node_modules/browser-process-hrtime/README.md
new file mode 100644
index 0000000..ec0ebc2
--- /dev/null
+++ b/node_modules/browser-process-hrtime/README.md
@@ -0,0 +1,27 @@
+# browser-process-hrtime
+
+Browser shim for Node.js `process.hrtime()`.
+See [documentation at nodejs.org](http://nodejs.org/api/process.html#process_process_hrtime)
+
+This module does not provide the same level of time precision as node.js, but provides a matching API and response format.
+
+### usage
+Use hrtime independent of environment (node or browser).
+It will use `process.hrtime` first and fallback if not present.
+```js
+const hrtime = require('browser-process-hrtime')
+const start = hrtime()
+// ...
+const delta = hrtime(start)
+```
+
+### monkey-patching
+You can monkey-patch `process.hrtime` for your dependency graph like this:
+```js
+process.hrtime = require('browser-process-hrtime')
+const coolTool = require('module-that-uses-hrtime-somewhere-in-its-depths')
+```
+
+### note
+This was originally pull-requested against [node-process](https://github.com/defunctzombie/node-process),
+but they are trying to stay lean.