Skip to content

Commit 556b9db

Browse files
update reference.json (#453)
Co-authored-by: ryepup <[email protected]>
1 parent 5f0d070 commit 556b9db

File tree

3 files changed

+144
-4
lines changed

3 files changed

+144
-4
lines changed

reference-lib/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

reference-lib/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@nginx/reference-lib",
3-
"version": "1.1.16",
3+
"version": "1.1.17",
44
"description": "",
55
"main": "dist/index.js",
66
"type": "module",

reference-lib/src/reference.json

Lines changed: 141 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5156,6 +5156,78 @@
51565156
"description_md": "Sets the verification depth in the HTTPS server certificates chain\nwith [Fetch API](https://nginx.org/en/docs/njs/reference.html#ngx_fetch).",
51575157
"description_html": "<p>Sets the verification depth in the HTTPS server certificates chain\nwith <a href=\"https://nginx.org/en/docs/njs/reference.html#ngx_fetch\" target=\"_blank\">Fetch API</a>.</p>\n"
51585158
},
5159+
{
5160+
"name": "js_fetch_keepalive",
5161+
"default": "0",
5162+
"contexts": [
5163+
"http",
5164+
"server",
5165+
"location"
5166+
],
5167+
"syntax_md": [
5168+
"*`connections`*"
5169+
],
5170+
"syntax_html": [
5171+
"<p><em><code>connections</code></em></p>\n"
5172+
],
5173+
"isBlock": false,
5174+
"description_md": "Activates the cache for connections to destination servers.\nWhen the value is greater than `0`,\nenables keepalive connections for\n[Fetch API](https://nginx.org/en/docs/njs/reference.html#ngx_fetch).\n\nThe *`connections`* parameter sets the maximum number of idle\nkeepalive connections to destination servers that are preserved in the cache\nof each worker process.\nWhen this number is exceeded, the least recently used connections are closed.\n\nExample:\n```\nlocation /fetch {\n js_fetch_keepalive 32;\n js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;\n js_content main.fetch_handler;\n}\n```",
5175+
"description_html": "<p>Activates the cache for connections to destination servers.\nWhen the value is greater than <code>0</code>,\nenables keepalive connections for\n<a href=\"https://nginx.org/en/docs/njs/reference.html#ngx_fetch\" target=\"_blank\">Fetch API</a>.</p>\n\n<p>The <em><code>connections</code></em> parameter sets the maximum number of idle\nkeepalive connections to destination servers that are preserved in the cache\nof each worker process.\nWhen this number is exceeded, the least recently used connections are closed.</p>\n\n<p>Example:</p>\n\n<pre><code>location /fetch {\n js_fetch_keepalive 32;\n js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;\n js_content main.fetch_handler;\n}\n</code></pre>\n"
5176+
},
5177+
{
5178+
"name": "js_fetch_keepalive_requests",
5179+
"default": "1000",
5180+
"contexts": [
5181+
"http",
5182+
"server",
5183+
"location"
5184+
],
5185+
"syntax_md": [
5186+
"*`number`*"
5187+
],
5188+
"syntax_html": [
5189+
"<p><em><code>number</code></em></p>\n"
5190+
],
5191+
"isBlock": false,
5192+
"description_md": "Sets the maximum number of requests that can be served through one keepalive\nconnection with [Fetch API](https://nginx.org/en/docs/njs/reference.html#ngx_fetch).\nAfter the maximum number of requests is made, the connection is closed.\n\nClosing connections periodically is necessary to free per-connection memory\nallocations.\nTherefore, using too high maximum number of requests could result in\nexcessive memory usage and not recommended.",
5193+
"description_html": "<p>Sets the maximum number of requests that can be served through one keepalive\nconnection with <a href=\"https://nginx.org/en/docs/njs/reference.html#ngx_fetch\" target=\"_blank\">Fetch API</a>.\nAfter the maximum number of requests is made, the connection is closed.</p>\n\n<p>Closing connections periodically is necessary to free per-connection memory\nallocations.\nTherefore, using too high maximum number of requests could result in\nexcessive memory usage and not recommended.</p>\n"
5194+
},
5195+
{
5196+
"name": "js_fetch_keepalive_time",
5197+
"default": "1h",
5198+
"contexts": [
5199+
"http",
5200+
"server",
5201+
"location"
5202+
],
5203+
"syntax_md": [
5204+
"*`time`*"
5205+
],
5206+
"syntax_html": [
5207+
"<p><em><code>time</code></em></p>\n"
5208+
],
5209+
"isBlock": false,
5210+
"description_md": "Limits the maximum time during which requests can be processed through one\nkeepalive connection with [Fetch API](https://nginx.org/en/docs/njs/reference.html#ngx_fetch).\nAfter this time is reached, the connection is closed following the subsequent\nrequest processing.",
5211+
"description_html": "<p>Limits the maximum time during which requests can be processed through one\nkeepalive connection with <a href=\"https://nginx.org/en/docs/njs/reference.html#ngx_fetch\" target=\"_blank\">Fetch API</a>.\nAfter this time is reached, the connection is closed following the subsequent\nrequest processing.</p>\n"
5212+
},
5213+
{
5214+
"name": "js_fetch_keepalive_timeout",
5215+
"default": "60s",
5216+
"contexts": [
5217+
"http",
5218+
"server",
5219+
"location"
5220+
],
5221+
"syntax_md": [
5222+
"*`time`*"
5223+
],
5224+
"syntax_html": [
5225+
"<p><em><code>time</code></em></p>\n"
5226+
],
5227+
"isBlock": false,
5228+
"description_md": "Sets a timeout during which an idle keepalive connection to a destination server\nwill stay open with [Fetch API](https://nginx.org/en/docs/njs/reference.html#ngx_fetch).",
5229+
"description_html": "<p>Sets a timeout during which an idle keepalive connection to a destination server\nwill stay open with <a href=\"https://nginx.org/en/docs/njs/reference.html#ngx_fetch\" target=\"_blank\">Fetch API</a>.</p>\n"
5230+
},
51595231
{
51605232
"name": "js_header_filter",
51615233
"default": "",
@@ -14737,6 +14809,74 @@
1473714809
"description_md": "Sets the verification depth in the HTTPS server certificates chain\nwith [Fetch API](https://nginx.org/en/docs/njs/reference.html#ngx_fetch).",
1473814810
"description_html": "<p>Sets the verification depth in the HTTPS server certificates chain\nwith <a href=\"https://nginx.org/en/docs/njs/reference.html#ngx_fetch\" target=\"_blank\">Fetch API</a>.</p>\n"
1473914811
},
14812+
{
14813+
"name": "js_fetch_keepalive",
14814+
"default": "0",
14815+
"contexts": [
14816+
"stream",
14817+
"server"
14818+
],
14819+
"syntax_md": [
14820+
"*`connections`*"
14821+
],
14822+
"syntax_html": [
14823+
"<p><em><code>connections</code></em></p>\n"
14824+
],
14825+
"isBlock": false,
14826+
"description_md": "Activates the cache for connections to destination servers.\nWhen the value is greater than `0`,\nenables keepalive connections for\n[Fetch API](https://nginx.org/en/docs/njs/reference.html#ngx_fetch).\n\nThe *`connections`* parameter sets the maximum number of idle\nkeepalive connections to destination servers that are preserved in the cache\nof each worker process.\nWhen this number is exceeded, the least recently used connections are closed.\n\nExample:\n```\nserver {\n listen 12345;\n js_fetch_keepalive 32;\n js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;\n js_preread main.fetch_handler;\n}\n```",
14827+
"description_html": "<p>Activates the cache for connections to destination servers.\nWhen the value is greater than <code>0</code>,\nenables keepalive connections for\n<a href=\"https://nginx.org/en/docs/njs/reference.html#ngx_fetch\" target=\"_blank\">Fetch API</a>.</p>\n\n<p>The <em><code>connections</code></em> parameter sets the maximum number of idle\nkeepalive connections to destination servers that are preserved in the cache\nof each worker process.\nWhen this number is exceeded, the least recently used connections are closed.</p>\n\n<p>Example:</p>\n\n<pre><code>server {\n listen 12345;\n js_fetch_keepalive 32;\n js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;\n js_preread main.fetch_handler;\n}\n</code></pre>\n"
14828+
},
14829+
{
14830+
"name": "js_fetch_keepalive_requests",
14831+
"default": "1000",
14832+
"contexts": [
14833+
"stream",
14834+
"server"
14835+
],
14836+
"syntax_md": [
14837+
"*`number`*"
14838+
],
14839+
"syntax_html": [
14840+
"<p><em><code>number</code></em></p>\n"
14841+
],
14842+
"isBlock": false,
14843+
"description_md": "Sets the maximum number of requests that can be served through one keepalive\nconnection with [Fetch API](https://nginx.org/en/docs/njs/reference.html#ngx_fetch).\nAfter the maximum number of requests is made, the connection is closed.\n\nClosing connections periodically is necessary to free per-connection memory\nallocations.\nTherefore, using too high maximum number of requests could result in\nexcessive memory usage and not recommended.",
14844+
"description_html": "<p>Sets the maximum number of requests that can be served through one keepalive\nconnection with <a href=\"https://nginx.org/en/docs/njs/reference.html#ngx_fetch\" target=\"_blank\">Fetch API</a>.\nAfter the maximum number of requests is made, the connection is closed.</p>\n\n<p>Closing connections periodically is necessary to free per-connection memory\nallocations.\nTherefore, using too high maximum number of requests could result in\nexcessive memory usage and not recommended.</p>\n"
14845+
},
14846+
{
14847+
"name": "js_fetch_keepalive_time",
14848+
"default": "1h",
14849+
"contexts": [
14850+
"stream",
14851+
"server"
14852+
],
14853+
"syntax_md": [
14854+
"*`time`*"
14855+
],
14856+
"syntax_html": [
14857+
"<p><em><code>time</code></em></p>\n"
14858+
],
14859+
"isBlock": false,
14860+
"description_md": "Limits the maximum time during which requests can be processed through one\nkeepalive connection with [Fetch API](https://nginx.org/en/docs/njs/reference.html#ngx_fetch).\nAfter this time is reached, the connection is closed following the subsequent\nrequest processing.",
14861+
"description_html": "<p>Limits the maximum time during which requests can be processed through one\nkeepalive connection with <a href=\"https://nginx.org/en/docs/njs/reference.html#ngx_fetch\" target=\"_blank\">Fetch API</a>.\nAfter this time is reached, the connection is closed following the subsequent\nrequest processing.</p>\n"
14862+
},
14863+
{
14864+
"name": "js_fetch_keepalive_timeout",
14865+
"default": "60s",
14866+
"contexts": [
14867+
"stream",
14868+
"server"
14869+
],
14870+
"syntax_md": [
14871+
"*`time`*"
14872+
],
14873+
"syntax_html": [
14874+
"<p><em><code>time</code></em></p>\n"
14875+
],
14876+
"isBlock": false,
14877+
"description_md": "Sets a timeout during which an idle keepalive connection to a destination server\nwill stay open with [Fetch API](https://nginx.org/en/docs/njs/reference.html#ngx_fetch).",
14878+
"description_html": "<p>Sets a timeout during which an idle keepalive connection to a destination server\nwill stay open with <a href=\"https://nginx.org/en/docs/njs/reference.html#ngx_fetch\" target=\"_blank\">Fetch API</a>.</p>\n"
14879+
},
1474014880
{
1474114881
"name": "js_filter",
1474214882
"default": "",
@@ -17206,5 +17346,5 @@
1720617346
]
1720717347
}
1720817348
],
17209-
"version": "https://github.com/nginx/nginx.org/commit/691ef741892dfd42868625323e5ddb0a55411c95"
17349+
"version": "https://github.com/nginx/nginx.org/commit/af022c460b34b24278fd29afff8dbbeff5c159db"
1721017350
}

0 commit comments

Comments
 (0)