Changeset 2149:6df1a86a60b8 in nginx_org


Ignore:
Timestamp:
04/06/18 17:34:26 (2 years ago)
Author:
Roman Arutyunyan <arut@…>
Branch:
default
Phase:
public
Message:

Added new njs HTTP properties and methods.

Location:
xml
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • xml/en/docs/http/ngx_http_js_module.xml

    r2142 r2149  
    1010        link="/en/docs/http/ngx_http_js_module.html"
    1111        lang="en"
    12         rev="9">
     12        rev="10">
    1313
    1414<section id="summary">
     
    209209</tag-desc>
    210210
     211<tag-name><literal>response</literal></tag-name>
     212<tag-desc>
     213the response object (0.2.0), read-only
     214</tag-desc>
     215</list>
     216</para>
     217
     218<para>
     219The request object has the following methods:
     220<list type="tag">
     221
    211222<tag-name><literal>log(<value>string</value>)</literal></tag-name>
    212223<tag-desc>
     
    214225on the <literal>info</literal> level of logging
    215226</tag-desc>
     227
     228<tag-name><literal>warn(<value>string</value>)</literal></tag-name>
     229<tag-desc>
     230writes a <literal>string</literal> to the error log
     231on the <literal>warning</literal> level of logging (0.2.0)
     232</tag-desc>
     233
     234<tag-name><literal>error(<value>string</value>)</literal></tag-name>
     235<tag-desc>
     236writes a <literal>string</literal> to the error log
     237on the <literal>error</literal> level of logging (0.2.0)
     238</tag-desc>
     239
     240<tag-name><literal>subrequest(<value>uri</value>[, <value>options</value>[,
     241<value>callback</value>]])</literal></tag-name>
     242<tag-desc>
     243creates a subrequest with the given <literal>uri</literal> and
     244<literal>options</literal>, and installs
     245an optional completion <literal>callback</literal> (0.2.0).
     246
     247<para>
     248If <literal>options</literal> is a string, then it
     249holds the subrequest arguments string.
     250Otherwise <literal>options</literal> is expected to be
     251an object with the following keys:
     252<list type="tag">
     253<tag-name><literal>args</literal></tag-name>
     254<tag-desc>arguments string</tag-desc>
     255
     256<tag-name><literal>body</literal></tag-name>
     257<tag-desc>request body</tag-desc>
     258
     259<tag-name><literal>method</literal></tag-name>
     260<tag-desc>HTTP method</tag-desc>
     261</list>
     262</para>
     263
     264<para>
     265The <literal>callback</literal> receives a response object
     266with the following properties:
     267<literal>uri</literal>, <literal>method</literal>,
     268<literal>status</literal>, <literal>contentType</literal>,
     269<literal>contentLength</literal>, <literal>headers</literal>,
     270<literal>args</literal>.
     271These properties have the same meaning as the request object properties.
     272Additionally, a reply object has the <literal>body</literal> property
     273holding the subrequest response body
     274and the <literal>parent</literal> property
     275referencing the parent request object.
     276</para>
     277</tag-desc>
    216278</list>
    217279</para>
     
    261323finishes sending a response to the client
    262324</tag-desc>
     325
     326<tag-name><literal>return(status[, string])</literal></tag-name>
     327<tag-desc>
     328sends
     329the entire response with the specified <literal>status</literal> to the client
     330(0.2.0)
     331<para>
     332It is possible to specify either a redirect URL
     333(for codes 301, 302, 303, 307, and 308)
     334or the response body text (for other codes) as the second argument.
     335</para>
     336</tag-desc>
    263337</list>
    264338</para>
  • xml/ru/docs/http/ngx_http_js_module.xml

    r2142 r2149  
    1010        link="/ru/docs/http/ngx_http_js_module.html"
    1111        lang="ru"
    12         rev="9">
     12        rev="10">
    1313
    1414<section id="summary">
     
    210210</tag-desc>
    211211
     212<tag-name><literal>response</literal></tag-name>
     213<tag-desc>
     214объект ответа (0.2.0), только чтение
     215</tag-desc>
     216</list>
     217</para>
     218
     219<para>
     220Объект запроса имеет следующие свойства:
     221<list type="tag">
     222
    212223<tag-name><literal>log(<value>строка</value>)</literal></tag-name>
    213224<tag-desc>
     
    215226на уровне лога <literal>info</literal>
    216227</tag-desc>
     228
     229<tag-name><literal>warn(<value>строка</value>)</literal></tag-name>
     230<tag-desc>
     231записывает <literal>строку</literal> в лог-файл ошибок
     232на уровне лога <literal>warning</literal> (0.2.0)
     233</tag-desc>
     234
     235<tag-name><literal>error(<value>строка</value>)</literal></tag-name>
     236<tag-desc>
     237записывает <literal>строку</literal> в лог-файл ошибок
     238на уровне лога <literal>error</literal> (0.2.0)
     239</tag-desc>
     240
     241<tag-name><literal>subrequest(<value>uri</value>[, <value>options</value>[,
     242<value>callback</value>]])</literal></tag-name>
     243<tag-desc>
     244создаёт подзапрос с заданными <literal>uri</literal> и
     245<literal>options</literal> и
     246устанавливает необязательный <literal>callback</literal> завершения (0.2.0).
     247
     248<para>
     249Если <literal>options</literal> является строкой, то в ней
     250содержится срока аргументов подзапроса.
     251В противном случае ожидается, что <literal>options</literal> является объектом
     252со следующими ключами:
     253<list type="tag">
     254<tag-name><literal>args</literal></tag-name>
     255<tag-desc>строка с аргументами</tag-desc>
     256
     257<tag-name><literal>body</literal></tag-name>
     258<tag-desc>тело запроса</tag-desc>
     259
     260<tag-name><literal>method</literal></tag-name>
     261<tag-desc>метод HTTP</tag-desc>
     262</list>
     263</para>
     264
     265<para>
     266<literal>callback</literal> получает объект ответа
     267со следующими свойствами:
     268<literal>uri</literal>, <literal>method</literal>,
     269<literal>status</literal>, <literal>contentType</literal>,
     270<literal>contentLength</literal>, <literal>headers</literal>,
     271<literal>args</literal>.
     272Эти свойства имеют те же значения, что и свойства объекта запроса.
     273Дополнительно у объекта ответа есть свойство <literal>body</literal>,
     274содержащее тело ответа подзапроса,
     275и свойство <literal>parent</literal>,
     276ссылающееся на родительский объект запроса.
     277</para>
     278</tag-desc>
    217279</list>
    218280</para>
     
    264326завершает отправку ответа клиенту
    265327</tag-desc>
     328
     329<tag-name><literal>return(код[, строка])</literal></tag-name>
     330<tag-desc>
     331отправляет
     332клиенту полный ответ с указанным <literal>кодом</literal> (0.2.0)
     333<para>
     334Можно задать или URL перенаправления
     335(для кодов 301, 302, 303, 307 и 308),
     336или текст тела ответа (для остальных кодов) в качестве второго аргумента.
     337</para>
     338</tag-desc>
     339
    266340</list>
    267341</para>
Note: See TracChangeset for help on using the changeset viewer.