Mercurial > hg > nginx-site

changeset 2570:44792f1ee284

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added IDs to methods in njs Reference.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 16 Jul 2020 08:22:37 +0100
parents 2edc64c05b0e
children 3e47eecce384
files xml/en/docs/njs/changes.xml xml/en/docs/njs/reference.xml xml/ru/docs/njs/reference.xml
diffstat 3 files changed, 49 insertions(+), 48 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/njs/changes.xml
+++ b/xml/en/docs/njs/changes.xml
@@ -9,7 +9,7 @@
 <article name="Changes"
         link="/en/docs/njs/changes.html"
         lang="en"
-        rev="34"
+        rev="35"
         toc="no">
 
 <section id="njs0.4.2" name="Changes with njs 0.4.2">
@@ -342,7 +342,7 @@ nginx modules:
 <para>
 Feature:
 added detached mode for
-<link doc="reference.xml" id="subrequest"><literal>r.subrequest()</literal></link>.
+<link doc="reference.xml" id="r_subrequest"><literal>r.subrequest()</literal></link>.
 Responses to detached subrequests are ignored.
 Unlike ordinary subrequests,
 a detached subrequest can be created inside a variable handler.
@@ -511,9 +511,9 @@ nginx modules:
 <para>
 Feature:
 added <literal>Promise</literal> support for
-<link doc="reference.xml" id="subrequest"><literal>r.subrequest()</literal></link>.
+<link doc="reference.xml" id="r_subrequest"><literal>r.subrequest()</literal></link>.
 If a callback is not provided,
-<link doc="reference.xml" id="subrequest"><literal>r.subrequest()</literal></link>
+<link doc="reference.xml" id="r_subrequest"><literal>r.subrequest()</literal></link>
 returns an ordinary
 <literal>Promise</literal> object
 that resolves to a subrequest response object.
@@ -1449,7 +1449,7 @@ getting of special response headers in
 <para>
 Improvement:
 working with unknown methods in
-<link doc="reference.xml" id="subrequest"><literal>r.subrequest()</literal></link>.
+<link doc="reference.xml" id="r_subrequest"><literal>r.subrequest()</literal></link>.
 </para>
 </listitem>
 
@@ -1457,7 +1457,7 @@ working with unknown methods in
 <para>
 Improvement:
 added support for null as a second argument of
-<link doc="reference.xml" id="subrequest"><literal>r.subrequest()</literal></link>.
+<link doc="reference.xml" id="r_subrequest"><literal>r.subrequest()</literal></link>.
 </para>
 </listitem>
 
@@ -2132,7 +2132,7 @@ added support for setting nginx variable
 <para>
 Bugfix:
 fixed
-<link doc="reference.xml" id="subrequest"><literal>r.subrequest()</literal></link>
+<link doc="reference.xml" id="r_subrequest"><literal>r.subrequest()</literal></link>
 for empty body value.
 </para>
 </listitem>
--- 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="46">
+        rev="47">
 
 <section id="summary">
 
@@ -40,7 +40,8 @@ List of all njs properties and methods c
 <para>
 The HTTP request object is available only in the
 <link doc="../http/ngx_http_js_module.xml">ngx_http_js_module</link> module.
-All string properties of the object are <link id="string">byte strings</link>.
+All string properties of the object are
+<link id="string">byte strings</link>.
 
 <list type="tag">
 
@@ -49,13 +50,13 @@ All string properties of the object are 
 request arguments object, read-only
 </tag-desc>
 
-<tag-name><literal>r.error(<value>string</value>)</literal></tag-name>
+<tag-name id="r_error"><literal>r.error(<value>string</value>)</literal></tag-name>
 <tag-desc>
 writes a <literal>string</literal> to the error log
 on the <literal>error</literal> level of logging
 </tag-desc>
 
-<tag-name><literal>r.finish()</literal></tag-name>
+<tag-name id="r_finish"><literal>r.finish()</literal></tag-name>
 <tag-desc>
 finishes sending a response to the client
 </tag-desc>
@@ -145,7 +146,7 @@ are separated by commas.
 </para>
 </tag-desc>
 
-<tag-name><literal>r.httpVersion</literal></tag-name>
+<tag-name id="r_http_version"><literal>r.httpVersion</literal></tag-name>
 <tag-desc>
 HTTP version, read-only
 </tag-desc>
@@ -158,13 +159,13 @@ it is considered a named location.
 The actual redirect happens after the handler execution is completed.
 </tag-desc>
 
-<tag-name><literal>r.log(<value>string</value>)</literal></tag-name>
+<tag-name id="r_log"><literal>r.log(<value>string</value>)</literal></tag-name>
 <tag-desc>
 writes a <literal>string</literal> to the error log
 on the <literal>info</literal> level of logging
 </tag-desc>
 
-<tag-name><literal>r.method</literal></tag-name>
+<tag-name id="r_method"><literal>r.method</literal></tag-name>
 <tag-desc>
 HTTP method, read-only
 </tag-desc>
@@ -174,7 +175,7 @@ HTTP method, read-only
 references the parent request object
 </tag-desc>
 
-<tag-name><literal>r.remoteAddress</literal></tag-name>
+<tag-name id="r_remote_address"><literal>r.remoteAddress</literal></tag-name>
 <tag-desc>
 client address, read-only
 </tag-desc>
@@ -236,13 +237,13 @@ The property is available only in the
 
 <tag-name id="r_response_body"><literal>r.responseBody</literal></tag-name>
 <tag-desc>
-holds the <link id="subrequest">subrequest</link> response body, read-only.
+holds the <link id="r_subrequest">subrequest</link> response body, read-only.
 The size of <literal>r.responseBody</literal> is limited by the
 <link doc="../http/ngx_http_core_module.xml" id="subrequest_output_buffer_size"/>
 directive.
 </tag-desc>
 
-<tag-name><literal>r.return(status[, string])</literal></tag-name>
+<tag-name id="r_return"><literal>r.return(status[, string])</literal></tag-name>
 <tag-desc>
 sends the entire response
 with the specified <literal>status</literal> to the client
@@ -253,7 +254,7 @@ or the response body text (for other cod
 </para>
 </tag-desc>
 
-<tag-name><literal>r.send(<value>string</value>)</literal></tag-name>
+<tag-name id="r_send"><literal>r.send(<value>string</value>)</literal></tag-name>
 <tag-desc>
 sends a part of the response body to the client
 </tag-desc>
@@ -263,12 +264,12 @@ sends a part of the response body to the
 sends the HTTP headers to the client
 </tag-desc>
 
-<tag-name><literal>r.status</literal></tag-name>
+<tag-name id="r_status"><literal>r.status</literal></tag-name>
 <tag-desc>
 status, writable
 </tag-desc>
 
-<tag-name id="subrequest"><literal>r.subrequest(<value>uri</value>[,
+<tag-name id="r_subrequest"><literal>r.subrequest(<value>uri</value>[,
 <value>options</value>[, <value>callback</value>]])</literal></tag-name>
 <tag-desc>
 creates a subrequest with the given <literal>uri</literal> and
@@ -349,7 +350,7 @@ nginx variables object,
 writable (since <link doc="changes.xml" id="njs0.2.8">0.2.8</link>)
 </tag-desc>
 
-<tag-name><literal>r.warn(<value>string</value>)</literal></tag-name>
+<tag-name id="r_warn"><literal>r.warn(<value>string</value>)</literal></tag-name>
 <tag-desc>
 writes a <literal>string</literal> to the error log
 on the <literal>warning</literal> level of logging
@@ -398,13 +399,13 @@ or finalizes it with the specified numer
 (<link doc="changes.xml" id="njs0.2.4">0.2.4</link>).
 </tag-desc>
 
-<tag-name><literal>s.error(<value>string</value>)</literal></tag-name>
+<tag-name id="s_error"><literal>s.error(<value>string</value>)</literal></tag-name>
 <tag-desc>
 writes a sent <literal>string</literal> to the error log
 on the <literal>error</literal> level of logging
 </tag-desc>
 
-<tag-name><literal>s.log(<value>string</value>)</literal></tag-name>
+<tag-name id="s_log"><literal>s.log(<value>string</value>)</literal></tag-name>
 <tag-desc>
 writes a sent <value>string</value> to the error log
 on the <literal>info</literal> level of logging
@@ -454,7 +455,7 @@ a boolean value, true if data is a last 
 </para>
 </tag-desc>
 
-<tag-name><literal>s.remoteAddress</literal></tag-name>
+<tag-name id="s_remote_address"><literal>s.remoteAddress</literal></tag-name>
 <tag-desc>
 client address, read-only
 </tag-desc>
@@ -490,7 +491,7 @@ nginx variables object, writable
 (since <link doc="changes.xml" id="njs0.2.8">0.2.8</link>)
 </tag-desc>
 
-<tag-name><literal>s.warn(<value>string</value>)</literal></tag-name>
+<tag-name id="s_warn"><literal>s.warn(<value>string</value>)</literal></tag-name>
 <tag-desc>
 writes a sent <literal>string</literal> to the error log
 on the <literal>warning</literal> level of logging
@@ -645,7 +646,7 @@ Returns <literal>null</literal> if a cha
 found in the string.
 </tag-desc>
 
-<tag-name><literal>String.prototype.toString([<value>encoding</value>])</literal></tag-name>
+<tag-name id="string_tostring"><literal>String.prototype.toString([<value>encoding</value>])</literal></tag-name>
 <tag-desc>
 <para>
 If no <literal>encoding</literal> is specified,
@@ -881,7 +882,7 @@ try {
 </list>
 </tag-desc>
 
-<tag-name id="appendfilesync"><literal>appendFileSync(<value>filename</value>,
+<tag-name id="fs_appendfilesync"><literal>appendFileSync(<value>filename</value>,
 <value>data</value>[, <value>options</value>])</literal></tag-name>
 <tag-desc>
 Synchronously appends specified <literal>data</literal>
@@ -951,7 +952,7 @@ by default is <literal>false</literal>.
 </list>
 </tag-desc>
 
-<tag-name id="readfilesync"><literal>readFileSync(<value>filename</value>[,
+<tag-name id="fs_readfilesync"><literal>readFileSync(<value>filename</value>[,
 <value>options</value>])</literal></tag-name>
 <tag-desc>
 Synchronously returns the contents of the file
@@ -1035,7 +1036,7 @@ Synchronously unlinks a file by <literal
 (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>).
 </tag-desc>
 
-<tag-name id="writefilesync"><literal>writeFileSync(<value>filename</value>,
+<tag-name id="fs_writefilesync"><literal>writeFileSync(<value>filename</value>,
 <value>data</value>[,
 <value>options</value>])</literal></tag-name>
 <tag-desc>
--- a/xml/ru/docs/njs/reference.xml
+++ b/xml/ru/docs/njs/reference.xml
@@ -50,13 +50,13 @@ ECMAScript</link>.
 объект аргументов запроса, только чтение
 </tag-desc>
 
-<tag-name><literal>r.error(<value>строка</value>)</literal></tag-name>
+<tag-name id="r_error"><literal>r.error(<value>строка</value>)</literal></tag-name>
 <tag-desc>
 записывает <literal>строку</literal> в лог-файл ошибок
 на уровне лога <literal>error</literal>
 </tag-desc>
 
-<tag-name><literal>r.finish()</literal></tag-name>
+<tag-name id="r_finish"><literal>r.finish()</literal></tag-name>
 <tag-desc>
 завершает отправку ответа клиенту
 </tag-desc>
@@ -147,7 +147,7 @@ Foo: b
 </para>
 </tag-desc>
 
-<tag-name><literal>r.httpVersion</literal></tag-name>
+<tag-name id="r_http_version"><literal>r.httpVersion</literal></tag-name>
 <tag-desc>
 версия HTTP, только чтение
 </tag-desc>
@@ -160,23 +160,23 @@ Foo: b
 Перенаправление осуществляется после завершения выполнения обработчика.
 </tag-desc>
 
-<tag-name><literal>r.log(<value>строка</value>)</literal></tag-name>
+<tag-name id="r_log"><literal>r.log(<value>строка</value>)</literal></tag-name>
 <tag-desc>
 записывает <literal>строку</literal> в лог-файл ошибок
 на уровне лога <literal>info</literal>
 </tag-desc>
 
-<tag-name><literal>r.method</literal></tag-name>
+<tag-name id="r_method"><literal>r.method</literal></tag-name>
 <tag-desc>
 HTTP метод, только чтение
 </tag-desc>
 
-<tag-name><literal>r.parent</literal></tag-name>
+<tag-name id="r_parent"><literal>r.parent</literal></tag-name>
 <tag-desc>
 ссылается на родительский объект запроса
 </tag-desc>
 
-<tag-name><literal>r.remoteAddress</literal></tag-name>
+<tag-name id="r_remote_address"><literal>r.remoteAddress</literal></tag-name>
 <tag-desc>
 адрес клиента, только чтение
 </tag-desc>
@@ -238,12 +238,12 @@ r.rawHeadersIn.filter(v=>v[0].toLowerCas
 
 <tag-name id="r_response_body"><literal>r.responseBody</literal></tag-name>
 <tag-desc>
-хранит тело ответа <link id="subrequest">подзапроса</link>, только чтение.
+хранит тело ответа <link id="r_subrequest">подзапроса</link>, только чтение.
 Размер <literal>r.responseBody</literal> ограничивается директивой
 <link doc="../http/ngx_http_core_module.xml" id="subrequest_output_buffer_size"/>.
 </tag-desc>
 
-<tag-name><literal>r.return(код[, строка])</literal></tag-name>
+<tag-name id="r_return"><literal>r.return(код[, строка])</literal></tag-name>
 <tag-desc>
 отправляет
 клиенту полный ответ с указанным <literal>кодом</literal>
@@ -254,22 +254,22 @@ r.rawHeadersIn.filter(v=>v[0].toLowerCas
 </para>
 </tag-desc>
 
-<tag-name><literal>r.send(<value>строка</value>)</literal></tag-name>
+<tag-name id="r_send"><literal>r.send(<value>строка</value>)</literal></tag-name>
 <tag-desc>
 отправляет часть тела ответа клиенту
 </tag-desc>
 
-<tag-name><literal>r.sendHeader()</literal></tag-name>
+<tag-name id="r_send_header"><literal>r.sendHeader()</literal></tag-name>
 <tag-desc>
 отправляет заголовки HTTP клиенту
 </tag-desc>
 
-<tag-name><literal>r.status</literal></tag-name>
+<tag-name id="r_status"><literal>r.status</literal></tag-name>
 <tag-desc>
 статус, доступно для записи
 </tag-desc>
 
-<tag-name id="subrequest"><literal>r.subrequest(<value>uri</value>[,
+<tag-name id="r_subrequest"><literal>r.subrequest(<value>uri</value>[,
 <value>options</value>[, <value>callback</value>]])</literal></tag-name>
 <tag-desc>
 создаёт подзапрос с заданными <literal>uri</literal> и
@@ -339,7 +339,7 @@ r.rawHeadersIn.filter(v=>v[0].toLowerCas
 (начиная с версии <link doc="changes.xml" id="njs0.2.8">0.2.8</link>)
 </tag-desc>
 
-<tag-name><literal>r.warn(<value>строка</value>)</literal></tag-name>
+<tag-name id="r_warn"><literal>r.warn(<value>строка</value>)</literal></tag-name>
 <tag-desc>
 записывает <literal>строку</literal> в лог-файл ошибок
 на уровне лога <literal>warning</literal>
@@ -389,13 +389,13 @@ r.rawHeadersIn.filter(v=>v[0].toLowerCas
 (<link doc="changes.xml" id="njs0.2.4">0.2.4</link>).
 </tag-desc>
 
-<tag-name><literal>s.error(<value>строка</value>)</literal></tag-name>
+<tag-name id="s_error"><literal>s.error(<value>строка</value>)</literal></tag-name>
 <tag-desc>
 записывает отправленную <literal>строку</literal> в лог-файл ошибок
 на уровне лога <literal>error</literal>
 </tag-desc>
 
-<tag-name><literal>s.log(<value>строка</value>)</literal></tag-name>
+<tag-name id="s_log"><literal>s.log(<value>строка</value>)</literal></tag-name>
 <tag-desc>
 записывает отправленную <value>строку</value> в лог-файл ошибок
 на уровне лога <literal>info</literal>
@@ -447,7 +447,7 @@ true, если данные являются последним буфером.
 </para>
 </tag-desc>
 
-<tag-name><literal>s.remoteAddress</literal></tag-name>
+<tag-name id="s_remote_address"><literal>s.remoteAddress</literal></tag-name>
 <tag-desc>
 адрес клиента, только чтение
 </tag-desc>
@@ -486,7 +486,7 @@ true, если буфер должен иметь флаг <literal>flush</literal>
 (начиная с версии <link doc="changes.xml" id="njs0.2.8">0.2.8</link>)
 </tag-desc>
 
-<tag-name><literal>s.warn(<value>строка</value>)</literal></tag-name>
+<tag-name id="s_warn"><literal>s.warn(<value>строка</value>)</literal></tag-name>
 <tag-desc>
 записывает отправленную <literal>строку</literal> в лог-файл ошибок
 на уровне лога <literal>warning</literal>
@@ -640,7 +640,7 @@ TypeError: argument must be a byte strin
 Возвращает <literal>null</literal>, если в строке найден символ больше, чем 255.
 </tag-desc>
 
-<tag-name><literal>String.prototype.toString([<value>кодировка</value>])</literal></tag-name>
+<tag-name id="string_tostring"><literal>String.prototype.toString([<value>кодировка</value>])</literal></tag-name>
 <tag-desc>
 <para>
 Если кодировка не указана,