From 2449d5fee69d27ba8579c5ff1ed0ebdd81c60494 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Tue, 24 Dec 2019 04:07:33 -0800 Subject: [PATCH] doc,https: use code markup/markdown in headers Backport-PR-URL: https://github.com/nodejs/node/pull/31108 PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen Reviewed-By: Ruben Bridgewater --- doc/api/https.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/doc/api/https.md b/doc/api/https.md index 0d8f859e9c7517..e82ffa2225d934 100644 --- a/doc/api/https.md +++ b/doc/api/https.md @@ -7,7 +7,7 @@ HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a separate module. -## Class: https.Agent +## Class: `https.Agent` @@ -54,7 +54,7 @@ added: v0.3.4 See [`http.Server`][] for more information. -### server.close(\[callback\]) +### `server.close([callback])` @@ -64,7 +64,7 @@ added: v0.1.90 See [`server.close()`][`http.close()`] from the HTTP module for details. -### server.headersTimeout +### `server.headersTimeout` @@ -73,18 +73,18 @@ added: v11.3.0 See [`http.Server#headersTimeout`][]. -### server.listen() +### `server.listen()` Starts the HTTPS server listening for encrypted connections. This method is identical to [`server.listen()`][] from [`net.Server`][]. -### server.maxHeadersCount +### `server.maxHeadersCount` * {number} **Default:** `2000` See [`http.Server#maxHeadersCount`][]. -### server.setTimeout(\[msecs\]\[, callback\]) +### `server.setTimeout([msecs][, callback])` @@ -95,7 +95,7 @@ added: v0.11.2 See [`http.Server#setTimeout()`][]. -### server.timeout +### `server.timeout` @@ -104,7 +104,7 @@ added: v0.11.2 See [`http.Server#timeout`][]. -### server.keepAliveTimeout +### `server.keepAliveTimeout` @@ -113,7 +113,7 @@ added: v8.0.0 See [`http.Server#keepAliveTimeout`][]. -## https.createServer(\[options\]\[, requestListener\]) +## `https.createServer([options][, requestListener])` @@ -156,8 +156,8 @@ https.createServer(options, (req, res) => { }).listen(8000); ``` -## https.get(options\[, callback\]) -## https.get(url\[, options\]\[, callback\]) +## `https.get(options[, callback])` +## `https.get(url[, options][, callback])` Global instance of [`https.Agent`][] for all HTTPS client requests. -## https.request(options\[, callback\]) -## https.request(url\[, options\]\[, callback\]) +## `https.request(options[, callback])` +## `https.request(url[, options][, callback])`