summaryrefslogtreecommitdiff
path: root/std/node/README.md
diff options
context:
space:
mode:
authorLuca Casonato <lucacasonato@yahoo.com>2020-01-15 20:13:12 +0100
committerRy Dahl <ry@tinyclouds.org>2020-01-15 14:13:12 -0500
commit3eab20ce42458fced42dcd031958b07113322e0a (patch)
tree5444f37030cf5b7158432025ae71b49d06469531 /std/node/README.md
parentb310f32e39785987ddd3491e189aad06381d0139 (diff)
feat(std/node): Added node timers builtin (#3634)
Diffstat (limited to 'std/node/README.md')
-rw-r--r--std/node/README.md64
1 files changed, 62 insertions, 2 deletions
diff --git a/std/node/README.md b/std/node/README.md
index 14c245809..d0d638d05 100644
--- a/std/node/README.md
+++ b/std/node/README.md
@@ -1,11 +1,71 @@
# Deno Node compatibility
This module is meant to have a compatibility layer for the
-[nodeJS standard library](https://nodejs.org/docs/latest-v12.x/api/).
+[NodeJS standard library](https://nodejs.org/docs/latest-v12.x/api/).
-**Warning** : Any function of this module should not be referred anywhere in the
+**Warning**: Any function of this module should not be referred anywhere in the
deno standard library as it's a compatiblity module.
+## Supported Builtins
+
+- [ ] assert
+- [ ] buffer
+- [ ] child_process
+- [ ] cluster
+- [ ] console
+- [ ] crypto
+- [ ] dgram
+- [ ] dns
+- [ ] events
+- [x] fs _partly_
+- [ ] http
+- [ ] http2
+- [ ] https
+- [x] module
+- [ ] net
+- [ ] os
+- [x] path
+- [ ] perf_hooks
+- [x] process _partly_
+- [ ] querystring
+- [ ] readline
+- [ ] repl
+- [ ] stream
+- [ ] string_decoder
+- [ ] sys
+- [x] timers
+- [ ] tls
+- [ ] tty
+- [ ] url
+- [x] util _partly_
+- [ ] ~~v8~~ _can't implement_
+- [ ] vm
+- [ ] worker_threads
+- [ ] zlib
+
+* [x] node globals _partly_
+
+### Deprecated
+
+These builtins are deprecated in NodeJS v13 and will probably not be polyfilled:
+
+- constants
+- domain
+- freelist
+- punycode
+
+### Experimental
+
+These builtins are experimental in NodeJS v13 and will not be polyfilled until
+they are stable:
+
+- async_hooks
+- inspector
+- policies
+- report
+- trace_events
+- wasi
+
## CommonJS Module Loading
`createRequire(...)` is provided to create a `require` function for loading CJS