summaryrefslogtreecommitdiff
path: root/cli/dts/lib.deno.ns.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'cli/dts/lib.deno.ns.d.ts')
-rw-r--r--cli/dts/lib.deno.ns.d.ts8
1 files changed, 8 insertions, 0 deletions
diff --git a/cli/dts/lib.deno.ns.d.ts b/cli/dts/lib.deno.ns.d.ts
index 9c645882d..c01ac80fb 100644
--- a/cli/dts/lib.deno.ns.d.ts
+++ b/cli/dts/lib.deno.ns.d.ts
@@ -4017,6 +4017,14 @@ declare namespace Deno {
* }
* ```
*
+ * Note that this function *consumes* the given connection passed to it, thus the
+ * original connection will be unusable after calling this. Additionally, you
+ * need to ensure that the connection is not being used elsewhere when calling
+ * this function in order for the connection to be consumed properly.
+ * For instance, if there is a `Promise` that is waiting for read operation on
+ * the connection to complete, it is considered that the connection is being
+ * used elsewhere. In such a case, this function will fail.
+ *
* @category HTTP Server
*/
export function serveHttp(conn: Conn): HttpConn;