comparison xml/ru/docs/http/ngx_http_js_module.xml @ 2149:6df1a86a60b8

Added new njs HTTP properties and methods.
author Roman Arutyunyan <arut@nginx.com>
date Fri, 06 Apr 2018 20:34:26 +0300
parents ca7568f67dee
children cd4889fdcfa4
comparison
equal deleted inserted replaced
2148:94a598ee1d49 2149:6df1a86a60b8
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Модуль ngx_http_js_module" 9 <module name="Модуль ngx_http_js_module"
10 link="/ru/docs/http/ngx_http_js_module.html" 10 link="/ru/docs/http/ngx_http_js_module.html"
11 lang="ru" 11 lang="ru"
12 rev="9"> 12 rev="10">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 Модуль <literal>ngx_http_js_module</literal> позволяет задавать 17 Модуль <literal>ngx_http_js_module</literal> позволяет задавать
207 <tag-name><literal>variables{}</literal></tag-name> 207 <tag-name><literal>variables{}</literal></tag-name>
208 <tag-desc> 208 <tag-desc>
209 объект переменных nginx, только чтение 209 объект переменных nginx, только чтение
210 </tag-desc> 210 </tag-desc>
211 211
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
212 <tag-name><literal>log(<value>строка</value>)</literal></tag-name> 223 <tag-name><literal>log(<value>строка</value>)</literal></tag-name>
213 <tag-desc> 224 <tag-desc>
214 записывает <literal>строку</literal> в лог-файл ошибок 225 записывает <literal>строку</literal> в лог-файл ошибок
215 на уровне лога <literal>info</literal> 226 на уровне лога <literal>info</literal>
216 </tag-desc> 227 </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>
217 </list> 279 </list>
218 </para> 280 </para>
219 281
220 <para> 282 <para>
221 Объект ответа имеет следующие свойства: 283 Объект ответа имеет следующие свойства:
261 323
262 <tag-name><literal>finish()</literal></tag-name> 324 <tag-name><literal>finish()</literal></tag-name>
263 <tag-desc> 325 <tag-desc>
264 завершает отправку ответа клиенту 326 завершает отправку ответа клиенту
265 </tag-desc> 327 </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
266 </list> 340 </list>
267 </para> 341 </para>
268 342
269 </section> 343 </section>
270 344