Mercurial > hg > nginx-site
changeset 2941:8f50cc590cd7
Updated njs Compatibility.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 14 Feb 2023 14:48:36 +0000 |
parents | eff433088019 |
children | ee84a44fa7f7 |
files | xml/en/docs/njs/compatibility.xml xml/en/docs/njs/reference.xml |
diffstat | 2 files changed, 233 insertions(+), 15 deletions(-) [+] |
line wrap: on
line diff
--- a/xml/en/docs/njs/compatibility.xml +++ b/xml/en/docs/njs/compatibility.xml @@ -9,7 +9,7 @@ <article name="Compatibility" link="/en/docs/njs/compatibility.html" lang="en" - rev="36" + rev="37" toc="no"> <section> @@ -275,6 +275,7 @@ non-standard: <link doc="reference.xml" id="string_frombytes"><literal>fromBytes</literal></link>, <link doc="reference.xml" id="string_fromutf8"><literal>fromUTF8</literal></link>, <link doc="reference.xml" id="string_tobytes"><literal>toBytes</literal></link>, +<link doc="reference.xml" id="string_tostring"><literal>toString</literal></link>, <link doc="reference.xml" id="string_toutf8"><literal>toUTF8</literal></link> </listitem> </list> @@ -584,15 +585,15 @@ ES6: <list type="bullet"> <listitem> ES6: -<literal>any()</literal> +<literal>any</literal> (<link doc="changes.xml" id="njs0.6.2">0.6.2</link>), -<literal> all()</literal> +<literal> all</literal> (<link doc="changes.xml" id="njs0.6.2">0.6.2</link>), -<literal> allSettled()</literal> +<literal> allSettled</literal> (<link doc="changes.xml" id="njs0.6.2">0.6.2</link>), <literal>reject</literal>, <literal>resolve</literal>, -<literal>race()</literal> (<link doc="changes.xml" id="njs0.6.2">0.6.2</link>) +<literal>race</literal> (<link doc="changes.xml" id="njs0.6.2">0.6.2</link>) </listitem> </list> @@ -851,11 +852,23 @@ functions <link doc="reference.xml" id="fs_accesssync"><literal>fs.accessSync</literal></link> (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>), <link doc="reference.xml" id="appendfilesync"><literal>fs.appendFileSync</literal></link>, +<link doc="reference.xml" id="fs_filehandle"><literal>fs.FileHandle</literal></link> +(<link doc="changes.xml" id="njs0.7.7">0.7.7</link>), +<link doc="reference.xml" id="fs_fstatsync"><literal>fs.fstatSync</literal></link> +(<link doc="changes.xml" id="njs0.7.7">0.7.7</link>), +<link doc="reference.xml" id="fs_lstatsync"><literal>fs.lstatSync</literal></link> +(<link doc="changes.xml" id="njs0.7.7">0.7.1</link>), <link doc="reference.xml" id="fs_mkdirsync"><literal>fs.mkdirSync</literal></link> (<link doc="changes.xml" id="njs0.4.2">0.4.2</link>), +<link doc="reference.xml" id="fs_opensync"><literal>fs.openSync</literal></link> +(<link doc="changes.xml" id="njs0.7.7">0.7.7</link>), +<link doc="reference.xml" id="fs_promises_open"><literal>fs.promises.open</literal></link> +(<link doc="changes.xml" id="njs0.7.7">0.7.7</link>), <link doc="reference.xml" id="fs_readdirsync"><literal>fs.readdirSync</literal></link> (<link doc="changes.xml" id="njs0.4.2">0.4.2</link>), <link doc="reference.xml" id="readfilesync"><literal>fs.readFileSync</literal></link>, +<link doc="reference.xml" id="fs_readsync"><literal>fs.readSync</literal></link> +(<link doc="changes.xml" id="njs0.7.7">0.7.7</link>), <link doc="reference.xml" id="fs_realpathsync"><literal>fs.realpathSync</literal></link> (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>), <link doc="reference.xml" id="fs_renamesync"><literal>fs.renameSync</literal></link> @@ -867,6 +880,8 @@ functions <link doc="reference.xml" id="fs_unlinksync"><literal>fs.unlinkSync</literal></link> (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>), <link doc="reference.xml" id="fs_writefilesync"><literal>fs.writeFileSync</literal></link> +<link doc="reference.xml" id="fs_writesync_buf"><literal>fs.writeSync</literal></link> +(<link doc="changes.xml" id="njs0.7.7">0.7.7</link>) </listitem> <listitem> @@ -875,7 +890,7 @@ asynchronous version of file system meth </listitem> <listitem> -<literal>Crypto</literal> methods +<link doc="reference.xml" id="crypto"><literal>Crypto</literal></link> methods (<link doc="changes.xml" id="njs0.2.0">0.2.0</link>): <link doc="reference.xml" id="crypto_createhash"><literal>crypto.createHash</literal></link>, <link doc="reference.xml" id="crypto_createhmac"><literal>crypto.createHmac</literal></link> @@ -915,12 +930,9 @@ methods <link doc="reference.xml" id="xml"><literal>XML</literal></link> methods (<link doc="changes.xml" id="njs0.7.10">0.7.10</link>): -<link doc="reference.xml" id="xml_parse"><literal>parse()</literal></link>, -<link doc="reference.xml" id="xml_c14n"><literal>xml.c14n()</literal></link>, -<link doc="reference.xml" id="xml_exclusiveC14n"><literal>xml.exclusiveC14n()</literal></link>, -<link doc="reference.xml" id="xml_doc"><literal>XMLDoc</literal></link>, -<link doc="reference.xml" id="xml_node"><literal>XMLNode</literal></link>, -<link doc="reference.xml" id="xml_xmlattr"><literal>XMLAttr</literal></link> +<link doc="reference.xml" id="xml_parse"><literal>parse</literal></link>, +<link doc="reference.xml" id="xml_c14n"><literal>xml.c14n</literal></link>, +<link doc="reference.xml" id="xml_exclusiveC14n"><literal>xml.exclusiveC14n</literal></link> </listitem> <listitem> @@ -948,17 +960,223 @@ Global objects <list type="bullet"> <listitem> +<link doc="reference.xml" id="builtin_crypto"><literal>crypto</literal></link> +(<link doc="changes.xml" id="njs0.7.0">0.7.0</link>): +<link doc="reference.xml" id="crypto_get_random_values"><literal>getRandomValues</literal></link>, +<link doc="reference.xml" id="crypto_subtle_encrypt"><literal>subtle.encrypt</literal></link>, +<link doc="reference.xml" id="crypto_subtle_decrypt"><literal>subtle.decrypt</literal></link>, +<link doc="reference.xml" id="crypto_subtle_derive_bits"><literal>subtle.deriveBits</literal></link>, +<link doc="reference.xml" id="crypto_subtle_derive_key"><literal>subtle.deriveKey</literal></link>, +<link doc="reference.xml" id="crypto_subtle_digest"><literal>subtle.digest</literal></link> +<link doc="reference.xml" id="crypto_subtle_export_key"><literal>subtle.exportKey</literal></link> +(<link doc="changes.xml" id="njs0.7.10">0.7.10</link>), +<link doc="reference.xml" id="crypto_subtle_generate_key"><literal>subtle.generateKey</literal></link> +(<link doc="changes.xml" id="njs0.7.10">0.7.10</link>), +<link doc="reference.xml" id="crypto_subtle_import_key"><literal>subtle.importKey</literal></link>, +<link doc="reference.xml" id="crypto_subtle_sign"><literal>subtle.sign</literal></link>, +<link doc="reference.xml" id="crypto_subtle_verify"><literal>subtle.verify</literal></link> +</listitem> + +<listitem> <literal>globalThis</literal> alias (<link doc="changes.xml" id="njs0.3.8">0.3.8</link>), </listitem> <listitem> -<link doc="reference.xml" id="process"><literal>process</literal></link> +<link doc="reference.xml" id="njs"><literal>njs</literal></link>: +<link doc="reference.xml" id="njs_version"><literal>version</literal></link>, +<link doc="reference.xml" id="njs_version_number"><literal>version_number</literal></link> +(<link doc="changes.xml" id="njs0.7.4">0.7.4</link>), +<link doc="reference.xml" id="njs_dump"><literal>dump</literal></link>, +<link doc="reference.xml" id="njs_memory_stats"><literal>memoryStats</literal></link> +(<link doc="changes.xml" id="njs0.7.8">0.7.8</link>), +<link doc="reference.xml" id="njs_on"><literal>on</literal></link> +(<link doc="changes.xml" id="njs0.5.2">0.5.2</link>) +</listitem> + +<listitem> +<link doc="reference.xml" id="process"><literal>process</literal></link>: +<link doc="reference.xml" id="process_argv"><literal>argv</literal></link>, +<link doc="reference.xml" id="process_env"><literal>env</literal></link>, +<link doc="reference.xml" id="process_pid"><literal>pid</literal></link>, +<link doc="reference.xml" id="process_ppid"><literal>ppid</literal></link>, </listitem> </list> </listitem> +<listitem> +nginx object methods: +<list type="bullet"> + +<listitem> +<link doc="reference.xml" id="http"><literal>HTTP Request</literal></link>: +<link doc="reference.xml" id="r_done"><literal>r.done</literal></link> +(<link doc="changes.xml" id="njs0.5.2">0.5.2</link>), +<link doc="reference.xml" id="r_error"><literal>r.error</literal></link>, +<link doc="reference.xml" id="r_finish"><literal>r.finish</literal></link>, +<link doc="reference.xml" id="r_internal_redirect"><literal>r.internalRedirect</literal></link>, +<link doc="reference.xml" id="r_log"><literal>r.log</literal></link>, +<link doc="reference.xml" id="r_return"><literal>r.return</literal></link> +(<link doc="changes.xml" id="njs0.5.0">0.5.0</link>), +<link doc="reference.xml" id="r_send"><literal>r.send</literal></link> +(<link doc="changes.xml" id="njs0.5.0">0.5.0</link>), +<link doc="reference.xml" id="r_sendbuffer"><literal>r.sendBuffer</literal></link> +(<link doc="changes.xml" id="njs0.5.2">0.5.2</link>), +<link doc="reference.xml" id="r_send_header"><literal>r.sendHeader</literal></link>, +<link doc="reference.xml" id="r_set_return_value"><literal>r.setReturnValue</literal></link> +(<link doc="changes.xml" id="njs0.7.0">0.7.0</link>), +<link doc="reference.xml" id="r_subrequest"><literal>r.subrequest</literal></link>, +<link doc="reference.xml" id="r_warn"><literal>r.warn</literal></link> +</listitem> + +<listitem> +<link doc="reference.xml" id="stream"><literal>Stream Session</literal></link>: +<link doc="reference.xml" id="s_allow"><literal>s.allow</literal></link> +(<link doc="changes.xml" id="njs0.2.4">0.2.4</link>), +<link doc="reference.xml" id="s_decline"><literal>s.decline</literal></link> +(<link doc="changes.xml" id="njs0.2.4">0.2.4</link>), +<link doc="reference.xml" id="s_deny"><literal>s.deny</literal></link> +(<link doc="changes.xml" id="njs0.2.4">0.2.4</link>), +<link doc="reference.xml" id="s_done"><literal>s.done</literal></link> +(<link doc="changes.xml" id="njs0.2.4">0.2.4</link>), +<link doc="reference.xml" id="s_error"><literal>s.error</literal></link>, +<link doc="reference.xml" id="s_log"><literal>s.log</literal></link>, +<link doc="reference.xml" id="s_off"><literal>s.off</literal></link> +(<link doc="changes.xml" id="njs0.2.4">0.2.4</link>), +<link doc="reference.xml" id="s_on"><literal>s.on</literal></link> +(<link doc="changes.xml" id="njs0.2.4">0.2.4</link>), +<link doc="reference.xml" id="s_send"><literal>s.send</literal></link> +(<link doc="changes.xml" id="njs0.2.4">0.2.4</link>), +<link doc="reference.xml" id="s_send_downstream"><literal>s.sendDownstream</literal></link> +(<link doc="changes.xml" id="njs0.7.8">0.7.8</link>), +<link doc="reference.xml" id="s_send_upstream"><literal>s.sendUpstream</literal></link> +(<link doc="changes.xml" id="njs0.7.8">0.7.8</link>), +<link doc="reference.xml" id="s_set_return_value"><literal>s.setReturnValue</literal></link> +(<link doc="changes.xml" id="njs0.7.0">0.7.0</link>), +<link doc="reference.xml" id="s_warn"><literal>s.warn</literal></link> +</listitem> + +<listitem> +<link doc="reference.xml" id="headers"><literal>Headers</literal></link> +(<link doc="changes.xml" id="njs0.5.1">0.5.1</link>): +<link doc="reference.xml" id="headers_append"><literal>append</literal></link>, +<link doc="reference.xml" id="headers_delete"><literal>delete</literal></link>, +<link doc="reference.xml" id="headers_get"><literal>get</literal></link>, +<link doc="reference.xml" id="headers_getall"><literal>getAll</literal></link>, +<link doc="reference.xml" id="headers_foreach"><literal>forEach</literal></link>, +<link doc="reference.xml" id="headers_has"><literal>has</literal></link>, +<link doc="reference.xml" id="headers_set"><literal>set</literal></link> +</listitem> + +<listitem> +<link doc="reference.xml" id="request"><literal>Request</literal></link> +(<link doc="changes.xml" id="njs0.7.10">0.7.10</link>): +<link doc="reference.xml" id="request_arraybuffer"><literal>arrayBuffer</literal></link>, +<link doc="reference.xml" id="request_headers"><literal>headers</literal></link>, +<link doc="reference.xml" id="request_json"><literal>json</literal></link>, +<link doc="reference.xml" id="request_text"><literal>text</literal></link> +</listitem> + +<listitem> +<link doc="reference.xml" id="response"><literal>Response</literal></link> +(<link doc="changes.xml" id="njs0.5.1">0.5.1</link>): +<link doc="reference.xml" id="response_arraybuffer"><literal>arrayBuffer</literal></link>, +<link doc="reference.xml" id="response_headers"><literal>headers</literal></link>, +<link doc="reference.xml" id="response_json"><literal>json</literal></link>, +<link doc="reference.xml" id="response_text"><literal>text</literal></link> +</listitem> + +<listitem> +<link doc="reference.xml" id="ngx"><literal>ngx</literal></link> +(<link doc="changes.xml" id="njs0.5.0">0.5.0</link>): +<link doc="reference.xml" id="ngx_fetch"><literal>fetch</literal></link> +(<link doc="changes.xml" id="njs0.5.1">0.5.1</link>), +<link doc="reference.xml" id="ngx_log"><literal>log</literal></link> +</listitem> + +</list> +</listitem> + +<listitem> +nginx object properties: +<list type="bullet"> + +<listitem> +<link doc="reference.xml" id="http"><literal>HTTP Request</literal></link>: +<link doc="reference.xml" id="r_args"><literal>r.args</literal></link>, +<link doc="reference.xml" id="r_headers_in"><literal>r.headersIn</literal></link>, +<link doc="reference.xml" id="r_headers_out"><literal>r.headersOut</literal></link>, +<link doc="reference.xml" id="r_http_version"><literal>r.httpVersion</literal></link>, +<link doc="reference.xml" id="r_internal"><literal>r.internal</literal></link>, +<link doc="reference.xml" id="r_method"><literal>r.method</literal></link>, +<link doc="reference.xml" id="r_parent"><literal>r.parent</literal></link>, +<link doc="reference.xml" id="r_raw_headers_in"><literal>r.rawHeadersIn</literal></link> +(<link doc="changes.xml" id="njs0.4.1">0.4.1</link>), +<link doc="reference.xml" id="r_raw_headers_out"><literal>r.rawHeadersOut</literal></link> +(<link doc="changes.xml" id="njs0.4.1">0.4.1</link>), +<link doc="reference.xml" id="r_raw_variables"><literal>r.rawVariables</literal></link> +(<link doc="changes.xml" id="njs0.5.0">0.5.0</link>), +<link doc="reference.xml" id="r_remote_address"><literal>r.remoteAddress</literal></link>, +<link doc="reference.xml" id="r_request_body"><literal>r.requestBody</literal></link>, +<link doc="reference.xml" id="r_request_buffer"><literal>r.requestBuffer</literal></link> +(<link doc="changes.xml" id="njs0.5.0">0.5.0</link>), +<link doc="reference.xml" id="r_request_text"><literal>r.requestText</literal></link>, +<link doc="reference.xml" id="r_response_body"><literal>r.responseBody</literal></link> +(<link doc="changes.xml" id="njs0.5.0">0.5.0</link>), +<link doc="reference.xml" id="r_response_buffer"><literal>r.responseBuffer</literal></link> +(<link doc="changes.xml" id="njs0.5.0">0.5.0</link>), +<link doc="reference.xml" id="r_response_text"><literal>r.responseText</literal></link> +(<link doc="changes.xml" id="njs0.5.0">0.5.0</link>), +<link doc="reference.xml" id="r_status"><literal>r.status</literal></link>, +<link doc="reference.xml" id="r_uri"><literal>r.uri</literal></link>, +<link doc="reference.xml" id="r_variables"><literal>r.variables</literal></link> +(<link doc="changes.xml" id="njs0.2.8">0.2.8</link>) +</listitem> + +<listitem> +<link doc="reference.xml" id="stream"><literal>Stream Session</literal></link>: +<link doc="reference.xml" id="s_remote_address"><literal>s.remoteAddress</literal></link>, +<link doc="reference.xml" id="s_raw_variables"><literal>s.rawVariables</literal></link> +(<link doc="changes.xml" id="njs0.5.0">0.5.0</link>), +<link doc="reference.xml" id="s_status"><literal>s.status</literal></link> +(<link doc="changes.xml" id="njs0.5.2">0.5.2</link>), +<link doc="reference.xml" id="s_variables"><literal>s.variables</literal></link> +(<link doc="changes.xml" id="njs0.2.8">0.2.8</link>) +</listitem> + +<listitem> +<link doc="reference.xml" id="request"><literal>Request</literal></link> +(<link doc="changes.xml" id="njs0.7.10">0.7.10</link>): +<link doc="reference.xml" id="request_bodyused"><literal>bodyUsed</literal></link>, +<link doc="reference.xml" id="request_cache"><literal>cache</literal></link>, +<link doc="reference.xml" id="request_credentials"><literal>credentials</literal></link>, +<link doc="reference.xml" id="request_method"><literal>method</literal></link>, +<link doc="reference.xml" id="request_mode"><literal>mode</literal></link>, +<link doc="reference.xml" id="request_url"><literal>url</literal></link> +</listitem> + +<listitem> +<link doc="reference.xml" id="response"><literal>Response</literal></link> +(<link doc="changes.xml" id="njs0.5.1">0.5.1</link>): +<link doc="reference.xml" id="response_bodyused"><literal>bodyUsed</literal></link>, +<link doc="reference.xml" id="response_ok"><literal>ok</literal></link>, +<link doc="reference.xml" id="response_redirect"><literal>redirected</literal></link>, +<link doc="reference.xml" id="response_status"><literal>status</literal></link>, +<link doc="reference.xml" id="response_statustext"><literal>statusText</literal></link>, +<link doc="reference.xml" id="response_type"><literal>type</literal></link>, +<link doc="reference.xml" id="response_url"><literal>url</literal></link> +</listitem> + +<listitem> +<link doc="reference.xml" id="ngx"><literal>ngx</literal></link> +(<link doc="changes.xml" id="njs0.5.0">0.5.0</link>): +<link doc="reference.xml" id="ngx_conf_prefix"><literal>conf_prefix</literal></link> +(<link doc="changes.xml" id="njs0.7.8">0.7.8</link>) +</listitem> + +</list> +</listitem> </list> </para>
--- a/xml/en/docs/njs/reference.xml +++ b/xml/en/docs/njs/reference.xml @@ -9,7 +9,7 @@ <article name="Reference" link="/en/docs/njs/reference.html" lang="en" - rev="98"> + rev="99"> <section id="summary"> @@ -947,7 +947,7 @@ Returns a string containing the values o separated by a comma and a space. </tag-desc> -<tag-name id="response_headers_getall"><literal>getAll(<value>name</value>)</literal></tag-name> +<tag-name id="headers_getall"><literal>getAll(<value>name</value>)</literal></tag-name> <tag-desc> Returns an array containing the values of all headers with the specified name. </tag-desc>