Skip to content

Commit

Permalink
update reference.json (#31)
Browse files Browse the repository at this point in the history
Co-authored-by: ryepup <ryepup@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and ryepup authored Sep 15, 2023
1 parent ade8acd commit 8eee4ed
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions reference-lib/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion reference-lib/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@nginxinc/reference-lib",
"version": "1.0.4",
"version": "1.0.5",
"description": "",
"main": "dist/index.js",
"scripts": {
Expand Down
14 changes: 7 additions & 7 deletions reference-lib/src/reference.json
Original file line number Diff line number Diff line change
Expand Up @@ -4615,8 +4615,8 @@
"<p><em><code>function</code></em> | <em><code>module.function</code></em> [<code>interval</code>=<em><code>time</code></em>] [<code>jitter</code>=<em><code>number</code></em>] [<code>worker_affinity</code>=<em><code>mask</code></em>]</p>\n"
],
"isBlock": false,
"description_md": "Specifies a content handler to run at regular interval.\nThe handler receives a session object as its first argument,\nit also has access to global objects such as\n[ngx](https://nginx.org/en/docs/njs/reference.html#ngx).\n\nThe optional `interval` parameter\nsets the interval between two consecutive runs,\nby default, 5 seconds.\n\nThe optional `jitter` parameter sets the time within which\nthe location content handler will be randomly delayed,\nby default, there is no delay.\n\nBy default, the `js_handler` is executed on worker process 0.\nThe optional `worker_affinity` parameter\nallows specifying particular worker processes\nwhere the location content handler should be executed.\nEach worker process set is represented by a bitmask of allowed worker processes.\nThe `all` mask allows the handler to be executed\nin all worker processes.\n\nExample:\n```\nexample.conf:\n\nlocation @periodics {\n # to be run at 1 minute intervals in worker process 0\n js_periodic main.handler interval=60s;\n\n # to be run at 1 minute intervals in all worker processes\n js_periodic main.handler interval=60s worker_affinity=all;\n\n # to be run at 1 minute intervals in worker processes 1 and 3\n js_periodic main.handler interval=60s worker_affinity=0101;\n\n resolver 10.0.0.1;\n js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;\n}\n\nexample.js:\n\nasync function handler(s) {\n let reply = async ngx.fetch('https://nginx.org/en/docs/njs/');\n let body = async reply.text();\n\n ngx.log(ngx.INFO, body);\n}\n```",
"description_html": "<p>Specifies a content handler to run at regular interval.\nThe handler receives a session object as its first argument,\nit also has access to global objects such as\n<a href=\"https://nginx.org/en/docs/njs/reference.html#ngx\" target=\"_blank\">ngx</a>.</p>\n\n<p>The optional <code>interval</code> parameter\nsets the interval between two consecutive runs,\nby default, 5 seconds.</p>\n\n<p>The optional <code>jitter</code> parameter sets the time within which\nthe location content handler will be randomly delayed,\nby default, there is no delay.</p>\n\n<p>By default, the <code>js_handler</code> is executed on worker process 0.\nThe optional <code>worker_affinity</code> parameter\nallows specifying particular worker processes\nwhere the location content handler should be executed.\nEach worker process set is represented by a bitmask of allowed worker processes.\nThe <code>all</code> mask allows the handler to be executed\nin all worker processes.</p>\n\n<p>Example:</p>\n\n<pre><code>example.conf:\n\nlocation @periodics {\n # to be run at 1 minute intervals in worker process 0\n js_periodic main.handler interval=60s;\n\n # to be run at 1 minute intervals in all worker processes\n js_periodic main.handler interval=60s worker_affinity=all;\n\n # to be run at 1 minute intervals in worker processes 1 and 3\n js_periodic main.handler interval=60s worker_affinity=0101;\n\n resolver 10.0.0.1;\n js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;\n}\n\nexample.js:\n\nasync function handler(s) {\n let reply = async ngx.fetch('https://nginx.org/en/docs/njs/');\n let body = async reply.text();\n\n ngx.log(ngx.INFO, body);\n}\n</code></pre>\n"
"description_md": "Specifies a content handler to run at regular interval.\nThe handler receives a session object as its first argument,\nit also has access to global objects such as\n[ngx](https://nginx.org/en/docs/njs/reference.html#ngx).\n\nThe optional `interval` parameter\nsets the interval between two consecutive runs,\nby default, 5 seconds.\n\nThe optional `jitter` parameter sets the time within which\nthe location content handler will be randomly delayed,\nby default, there is no delay.\n\nBy default, the `js_handler` is executed on worker process 0.\nThe optional `worker_affinity` parameter\nallows specifying particular worker processes\nwhere the location content handler should be executed.\nEach worker process set is represented by a bitmask of allowed worker processes.\nThe `all` mask allows the handler to be executed\nin all worker processes.\n\nExample:\n```\nexample.conf:\n\nlocation @periodics {\n # to be run at 1 minute intervals in worker process 0\n js_periodic main.handler interval=60s;\n\n # to be run at 1 minute intervals in all worker processes\n js_periodic main.handler interval=60s worker_affinity=all;\n\n # to be run at 1 minute intervals in worker processes 1 and 3\n js_periodic main.handler interval=60s worker_affinity=0101;\n\n resolver 10.0.0.1;\n js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;\n}\n\nexample.js:\n\nasync function handler(s) {\n let reply = await ngx.fetch('https://nginx.org/en/docs/njs/');\n let body = await reply.text();\n\n ngx.log(ngx.INFO, body);\n}\n```",
"description_html": "<p>Specifies a content handler to run at regular interval.\nThe handler receives a session object as its first argument,\nit also has access to global objects such as\n<a href=\"https://nginx.org/en/docs/njs/reference.html#ngx\" target=\"_blank\">ngx</a>.</p>\n\n<p>The optional <code>interval</code> parameter\nsets the interval between two consecutive runs,\nby default, 5 seconds.</p>\n\n<p>The optional <code>jitter</code> parameter sets the time within which\nthe location content handler will be randomly delayed,\nby default, there is no delay.</p>\n\n<p>By default, the <code>js_handler</code> is executed on worker process 0.\nThe optional <code>worker_affinity</code> parameter\nallows specifying particular worker processes\nwhere the location content handler should be executed.\nEach worker process set is represented by a bitmask of allowed worker processes.\nThe <code>all</code> mask allows the handler to be executed\nin all worker processes.</p>\n\n<p>Example:</p>\n\n<pre><code>example.conf:\n\nlocation @periodics {\n # to be run at 1 minute intervals in worker process 0\n js_periodic main.handler interval=60s;\n\n # to be run at 1 minute intervals in all worker processes\n js_periodic main.handler interval=60s worker_affinity=all;\n\n # to be run at 1 minute intervals in worker processes 1 and 3\n js_periodic main.handler interval=60s worker_affinity=0101;\n\n resolver 10.0.0.1;\n js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;\n}\n\nexample.js:\n\nasync function handler(s) {\n let reply = await ngx.fetch('https://nginx.org/en/docs/njs/');\n let body = await reply.text();\n\n ngx.log(ngx.INFO, body);\n}\n</code></pre>\n"
},
{
"name": "js_preload_object",
Expand Down Expand Up @@ -8386,8 +8386,8 @@
"<p>[<code>SSLv2</code>] [<code>SSLv3</code>] [<code>TLSv1</code>] [<code>TLSv1.1</code>] [<code>TLSv1.2</code>] [<code>TLSv1.3</code>]</p>\n"
],
"isBlock": false,
"description_md": "Enables the specified protocols.\n\nIf the directive is specified on the [`server`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#server) level,\nthe value from the default server can be used.\nDetails are provided in the\n“[Virtual server selection](https://nginx.org/en/docs/http/server_names.html#virtual_server_selection)” section.\n\n> The `TLSv1.1` and `TLSv1.2` parameters\n> (1.1.13, 1.0.12) work only when OpenSSL 1.0.1 or higher is used.\n\n> The `TLSv1.3` parameter (1.13.0) works only when\n> OpenSSL 1.1.1 or higher is used.\n\n> The `TLSv1.3` parameter is used by default\n> since 1.23.4.",
"description_html": "<p>Enables the specified protocols.</p>\n\n<p>If the directive is specified on the <a href=\"https://nginx.org/en/docs/http/ngx_http_ssl_module.html#server\" target=\"_blank\"><code>server</code></a> level,\nthe value from the default server can be used.\nDetails are provided in the\n“<a href=\"https://nginx.org/en/docs/http/server_names.html#virtual_server_selection\" target=\"_blank\">Virtual server selection</a>” section.</p>\n\n<blockquote>\n<p>The <code>TLSv1.1</code> and <code>TLSv1.2</code> parameters\n(1.1.13, 1.0.12) work only when OpenSSL 1.0.1 or higher is used.</p>\n\n<p>The <code>TLSv1.3</code> parameter (1.13.0) works only when\nOpenSSL 1.1.1 or higher is used.</p>\n\n<p>The <code>TLSv1.3</code> parameter is used by default\nsince 1.23.4.</p>\n</blockquote>\n"
"description_md": "Enables the specified protocols.\n\nIf the directive is specified\non the [`server`](https://nginx.org/en/docs/http/ngx_http_core_module.html#server) level,\nthe value from the default server can be used.\nDetails are provided in the\n“[Virtual server selection](https://nginx.org/en/docs/http/server_names.html#virtual_server_selection)” section.\n\n> The `TLSv1.1` and `TLSv1.2` parameters\n> (1.1.13, 1.0.12) work only when OpenSSL 1.0.1 or higher is used.\n\n> The `TLSv1.3` parameter (1.13.0) works only when\n> OpenSSL 1.1.1 or higher is used.\n\n> The `TLSv1.3` parameter is used by default\n> since 1.23.4.",
"description_html": "<p>Enables the specified protocols.</p>\n\n<p>If the directive is specified\non the <a href=\"https://nginx.org/en/docs/http/ngx_http_core_module.html#server\" target=\"_blank\"><code>server</code></a> level,\nthe value from the default server can be used.\nDetails are provided in the\n“<a href=\"https://nginx.org/en/docs/http/server_names.html#virtual_server_selection\" target=\"_blank\">Virtual server selection</a>” section.</p>\n\n<blockquote>\n<p>The <code>TLSv1.1</code> and <code>TLSv1.2</code> parameters\n(1.1.13, 1.0.12) work only when OpenSSL 1.0.1 or higher is used.</p>\n\n<p>The <code>TLSv1.3</code> parameter (1.13.0) works only when\nOpenSSL 1.1.1 or higher is used.</p>\n\n<p>The <code>TLSv1.3</code> parameter is used by default\nsince 1.23.4.</p>\n</blockquote>\n"
},
{
"name": "ssl_reject_handshake",
Expand Down Expand Up @@ -12907,8 +12907,8 @@
"<p><em><code>function</code></em> | <em><code>module.function</code></em> [<code>interval</code>=<em><code>time</code></em>] [<code>jitter</code>=<em><code>number</code></em>] [<code>worker_affinity</code>=<em><code>mask</code></em>]</p>\n"
],
"isBlock": false,
"description_md": "Specifies a content handler to run at regular interval.\nThe handler receives a session object as its first argument,\nit also has access to global objects such as\n[ngx](https://nginx.org/en/docs/njs/reference.html#ngx).\n\nThe optional `interval` parameter\nsets the interval between two consecutive runs,\nby default, 5 seconds.\n\nThe optional `jitter` parameter sets the time within which\nthe location content handler will be randomly delayed,\nby default, there is no delay.\n\nBy default, the `js_handler` is executed on worker process 0.\nThe optional `worker_affinity` parameter\nallows specifying particular worker processes\nwhere the location content handler should be executed.\nEach worker process set is represented by a bitmask of allowed worker processes.\nThe `all` mask allows the handler to be executed\nin all worker processes.\n\nExample:\n```\nexample.conf:\n\nlocation @periodics {\n # to be run at 1 minute intervals in worker process 0\n js_periodic main.handler interval=60s;\n\n # to be run at 1 minute intervals in all worker processes\n js_periodic main.handler interval=60s worker_affinity=all;\n\n # to be run at 1 minute intervals in worker processes 1 and 3\n js_periodic main.handler interval=60s worker_affinity=0101;\n\n resolver 10.0.0.1;\n js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;\n}\n\nexample.js:\n\nasync function handler(s) {\n let reply = async ngx.fetch('https://nginx.org/en/docs/njs/');\n let body = async reply.text();\n\n ngx.log(ngx.INFO, body);\n}\n```",
"description_html": "<p>Specifies a content handler to run at regular interval.\nThe handler receives a session object as its first argument,\nit also has access to global objects such as\n<a href=\"https://nginx.org/en/docs/njs/reference.html#ngx\" target=\"_blank\">ngx</a>.</p>\n\n<p>The optional <code>interval</code> parameter\nsets the interval between two consecutive runs,\nby default, 5 seconds.</p>\n\n<p>The optional <code>jitter</code> parameter sets the time within which\nthe location content handler will be randomly delayed,\nby default, there is no delay.</p>\n\n<p>By default, the <code>js_handler</code> is executed on worker process 0.\nThe optional <code>worker_affinity</code> parameter\nallows specifying particular worker processes\nwhere the location content handler should be executed.\nEach worker process set is represented by a bitmask of allowed worker processes.\nThe <code>all</code> mask allows the handler to be executed\nin all worker processes.</p>\n\n<p>Example:</p>\n\n<pre><code>example.conf:\n\nlocation @periodics {\n # to be run at 1 minute intervals in worker process 0\n js_periodic main.handler interval=60s;\n\n # to be run at 1 minute intervals in all worker processes\n js_periodic main.handler interval=60s worker_affinity=all;\n\n # to be run at 1 minute intervals in worker processes 1 and 3\n js_periodic main.handler interval=60s worker_affinity=0101;\n\n resolver 10.0.0.1;\n js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;\n}\n\nexample.js:\n\nasync function handler(s) {\n let reply = async ngx.fetch('https://nginx.org/en/docs/njs/');\n let body = async reply.text();\n\n ngx.log(ngx.INFO, body);\n}\n</code></pre>\n"
"description_md": "Specifies a content handler to run at regular interval.\nThe handler receives a session object as its first argument,\nit also has access to global objects such as\n[ngx](https://nginx.org/en/docs/njs/reference.html#ngx).\n\nThe optional `interval` parameter\nsets the interval between two consecutive runs,\nby default, 5 seconds.\n\nThe optional `jitter` parameter sets the time within which\nthe location content handler will be randomly delayed,\nby default, there is no delay.\n\nBy default, the `js_handler` is executed on worker process 0.\nThe optional `worker_affinity` parameter\nallows specifying particular worker processes\nwhere the location content handler should be executed.\nEach worker process set is represented by a bitmask of allowed worker processes.\nThe `all` mask allows the handler to be executed\nin all worker processes.\n\nExample:\n```\nexample.conf:\n\nlocation @periodics {\n # to be run at 1 minute intervals in worker process 0\n js_periodic main.handler interval=60s;\n\n # to be run at 1 minute intervals in all worker processes\n js_periodic main.handler interval=60s worker_affinity=all;\n\n # to be run at 1 minute intervals in worker processes 1 and 3\n js_periodic main.handler interval=60s worker_affinity=0101;\n\n resolver 10.0.0.1;\n js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;\n}\n\nexample.js:\n\nasync function handler(s) {\n let reply = await ngx.fetch('https://nginx.org/en/docs/njs/');\n let body = await reply.text();\n\n ngx.log(ngx.INFO, body);\n}\n```",
"description_html": "<p>Specifies a content handler to run at regular interval.\nThe handler receives a session object as its first argument,\nit also has access to global objects such as\n<a href=\"https://nginx.org/en/docs/njs/reference.html#ngx\" target=\"_blank\">ngx</a>.</p>\n\n<p>The optional <code>interval</code> parameter\nsets the interval between two consecutive runs,\nby default, 5 seconds.</p>\n\n<p>The optional <code>jitter</code> parameter sets the time within which\nthe location content handler will be randomly delayed,\nby default, there is no delay.</p>\n\n<p>By default, the <code>js_handler</code> is executed on worker process 0.\nThe optional <code>worker_affinity</code> parameter\nallows specifying particular worker processes\nwhere the location content handler should be executed.\nEach worker process set is represented by a bitmask of allowed worker processes.\nThe <code>all</code> mask allows the handler to be executed\nin all worker processes.</p>\n\n<p>Example:</p>\n\n<pre><code>example.conf:\n\nlocation @periodics {\n # to be run at 1 minute intervals in worker process 0\n js_periodic main.handler interval=60s;\n\n # to be run at 1 minute intervals in all worker processes\n js_periodic main.handler interval=60s worker_affinity=all;\n\n # to be run at 1 minute intervals in worker processes 1 and 3\n js_periodic main.handler interval=60s worker_affinity=0101;\n\n resolver 10.0.0.1;\n js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;\n}\n\nexample.js:\n\nasync function handler(s) {\n let reply = await ngx.fetch('https://nginx.org/en/docs/njs/');\n let body = await reply.text();\n\n ngx.log(ngx.INFO, body);\n}\n</code></pre>\n"
},
{
"name": "js_preload_object",
Expand Down Expand Up @@ -14872,5 +14872,5 @@
]
}
],
"version": "http://hg.nginx.org/nginx.org/rev/758e2e1dfd22"
"version": "http://hg.nginx.org/nginx.org/rev/ac4191d05fdf"
}

0 comments on commit 8eee4ed

Please sign in to comment.