summaryrefslogtreecommitdiff
path: root/ext/net/lib.deno_net.d.ts
diff options
context:
space:
mode:
authorYoshiya Hinosawa <stibium121@gmail.com>2021-09-07 16:26:21 +0900
committerGitHub <noreply@github.com>2021-09-07 16:26:21 +0900
commit3925435bf9110869778f8dab694befe3b9ade5b3 (patch)
tree7ccca604dabf450a13498676e881dab05a2be633 /ext/net/lib.deno_net.d.ts
parentd331c4b283cf52614c519b1e9a3883e46dc25aab (diff)
docs(ext/net): add note about listening 0.0.0.0 (#11938)
Co-authored-by: Craig Morten <cmorten@users.noreply.github.com>
Diffstat (limited to 'ext/net/lib.deno_net.d.ts')
-rw-r--r--ext/net/lib.deno_net.d.ts7
1 files changed, 6 insertions, 1 deletions
diff --git a/ext/net/lib.deno_net.d.ts b/ext/net/lib.deno_net.d.ts
index e41dd62d8..dd2e4677d 100644
--- a/ext/net/lib.deno_net.d.ts
+++ b/ext/net/lib.deno_net.d.ts
@@ -49,7 +49,12 @@ declare namespace Deno {
/** The port to listen on. */
port: number;
/** A literal IP address or host name that can be resolved to an IP address.
- * If not specified, defaults to `0.0.0.0`. */
+ * If not specified, defaults to `0.0.0.0`.
+ *
+ * __Note about `0.0.0.0`__ While listening `0.0.0.0` works on all platforms,
+ * the browsers on Windows don't work with the address `0.0.0.0`.
+ * You should show the message like `server running on localhost:8080` instead of
+ * `server running on 0.0.0.0:8080` if your program supports Windows. */
hostname?: string;
}