Mercurial > hg > nginx-site

comparison xml/ru/docs/njs/reference.xml @ 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 28f98f596974
comparison
equal deleted inserted replaced
2569:2edc64c05b0e 2570:44792f1ee284
48 <tag-name id="r_args"><literal>r.args{}</literal></tag-name> 48 <tag-name id="r_args"><literal>r.args{}</literal></tag-name>
49 <tag-desc> 49 <tag-desc>
50 объект аргументов запроса, только чтение 50 объект аргументов запроса, только чтение
51 </tag-desc> 51 </tag-desc>
52 52
53 <tag-name><literal>r.error(<value>строка</value>)</literal></tag-name> 53 <tag-name id="r_error"><literal>r.error(<value>строка</value>)</literal></tag-name>
54 <tag-desc> 54 <tag-desc>
55 записывает <literal>строку</literal> в лог-файл ошибок 55 записывает <literal>строку</literal> в лог-файл ошибок
56 на уровне лога <literal>error</literal> 56 на уровне лога <literal>error</literal>
57 </tag-desc> 57 </tag-desc>
58 58
59 <tag-name><literal>r.finish()</literal></tag-name> 59 <tag-name id="r_finish"><literal>r.finish()</literal></tag-name>
60 <tag-desc> 60 <tag-desc>
61 завершает отправку ответа клиенту 61 завершает отправку ответа клиенту
62 </tag-desc> 62 </tag-desc>
63 63
64 <tag-name id="r_headers_in"><literal>r.headersIn{}</literal></tag-name> 64 <tag-name id="r_headers_in"><literal>r.headersIn{}</literal></tag-name>
145 Дубликаты значений поля в других заголовках ответов 145 Дубликаты значений поля в других заголовках ответов
146 разделяются при помощи запятой. 146 разделяются при помощи запятой.
147 </para> 147 </para>
148 </tag-desc> 148 </tag-desc>
149 149
150 <tag-name><literal>r.httpVersion</literal></tag-name> 150 <tag-name id="r_http_version"><literal>r.httpVersion</literal></tag-name>
151 <tag-desc> 151 <tag-desc>
152 версия HTTP, только чтение 152 версия HTTP, только чтение
153 </tag-desc> 153 </tag-desc>
154 154
155 <tag-name id="r_internal_redirect"><literal>r.internalRedirect(<value>uri</value>)</literal></tag-name> 155 <tag-name id="r_internal_redirect"><literal>r.internalRedirect(<value>uri</value>)</literal></tag-name>
158 Если uri начинается с префикса “<literal>@</literal>”, 158 Если uri начинается с префикса “<literal>@</literal>”,
159 то он считается именованным location. 159 то он считается именованным location.
160 Перенаправление осуществляется после завершения выполнения обработчика. 160 Перенаправление осуществляется после завершения выполнения обработчика.
161 </tag-desc> 161 </tag-desc>
162 162
163 <tag-name><literal>r.log(<value>строка</value>)</literal></tag-name> 163 <tag-name id="r_log"><literal>r.log(<value>строка</value>)</literal></tag-name>
164 <tag-desc> 164 <tag-desc>
165 записывает <literal>строку</literal> в лог-файл ошибок 165 записывает <literal>строку</literal> в лог-файл ошибок
166 на уровне лога <literal>info</literal> 166 на уровне лога <literal>info</literal>
167 </tag-desc> 167 </tag-desc>
168 168
169 <tag-name><literal>r.method</literal></tag-name> 169 <tag-name id="r_method"><literal>r.method</literal></tag-name>
170 <tag-desc> 170 <tag-desc>
171 HTTP метод, только чтение 171 HTTP метод, только чтение
172 </tag-desc> 172 </tag-desc>
173 173
174 <tag-name><literal>r.parent</literal></tag-name> 174 <tag-name id="r_parent"><literal>r.parent</literal></tag-name>
175 <tag-desc> 175 <tag-desc>
176 ссылается на родительский объект запроса 176 ссылается на родительский объект запроса
177 </tag-desc> 177 </tag-desc>
178 178
179 <tag-name><literal>r.remoteAddress</literal></tag-name> 179 <tag-name id="r_remote_address"><literal>r.remoteAddress</literal></tag-name>
180 <tag-desc> 180 <tag-desc>
181 адрес клиента, только чтение 181 адрес клиента, только чтение
182 </tag-desc> 182 </tag-desc>
183 183
184 <tag-name id="r_raw_headers_in"><literal>r.rawHeadersIn{}</literal></tag-name> 184 <tag-name id="r_raw_headers_in"><literal>r.rawHeadersIn{}</literal></tag-name>
236 <link doc="../http/ngx_http_js_module.xml" id="js_content"/>. 236 <link doc="../http/ngx_http_js_module.xml" id="js_content"/>.
237 </tag-desc> 237 </tag-desc>
238 238
239 <tag-name id="r_response_body"><literal>r.responseBody</literal></tag-name> 239 <tag-name id="r_response_body"><literal>r.responseBody</literal></tag-name>
240 <tag-desc> 240 <tag-desc>
241 хранит тело ответа <link id="subrequest">подзапроса</link>, только чтение. 241 хранит тело ответа <link id="r_subrequest">подзапроса</link>, только чтение.
242 Размер <literal>r.responseBody</literal> ограничивается директивой 242 Размер <literal>r.responseBody</literal> ограничивается директивой
243 <link doc="../http/ngx_http_core_module.xml" id="subrequest_output_buffer_size"/>. 243 <link doc="../http/ngx_http_core_module.xml" id="subrequest_output_buffer_size"/>.
244 </tag-desc> 244 </tag-desc>
245 245
246 <tag-name><literal>r.return(код[, строка])</literal></tag-name> 246 <tag-name id="r_return"><literal>r.return(код[, строка])</literal></tag-name>
247 <tag-desc> 247 <tag-desc>
248 отправляет 248 отправляет
249 клиенту полный ответ с указанным <literal>кодом</literal> 249 клиенту полный ответ с указанным <literal>кодом</literal>
250 <para> 250 <para>
251 Можно задать или URL перенаправления 251 Можно задать или URL перенаправления
252 (для кодов 301, 302, 303, 307 и 308), 252 (для кодов 301, 302, 303, 307 и 308),
253 или текст тела ответа (для остальных кодов) в качестве второго аргумента 253 или текст тела ответа (для остальных кодов) в качестве второго аргумента
254 </para> 254 </para>
255 </tag-desc> 255 </tag-desc>
256 256
257 <tag-name><literal>r.send(<value>строка</value>)</literal></tag-name> 257 <tag-name id="r_send"><literal>r.send(<value>строка</value>)</literal></tag-name>
258 <tag-desc> 258 <tag-desc>
259 отправляет часть тела ответа клиенту 259 отправляет часть тела ответа клиенту
260 </tag-desc> 260 </tag-desc>
261 261
262 <tag-name><literal>r.sendHeader()</literal></tag-name> 262 <tag-name id="r_send_header"><literal>r.sendHeader()</literal></tag-name>
263 <tag-desc> 263 <tag-desc>
264 отправляет заголовки HTTP клиенту 264 отправляет заголовки HTTP клиенту
265 </tag-desc> 265 </tag-desc>
266 266
267 <tag-name><literal>r.status</literal></tag-name> 267 <tag-name id="r_status"><literal>r.status</literal></tag-name>
268 <tag-desc> 268 <tag-desc>
269 статус, доступно для записи 269 статус, доступно для записи
270 </tag-desc> 270 </tag-desc>
271 271
272 <tag-name id="subrequest"><literal>r.subrequest(<value>uri</value>[, 272 <tag-name id="r_subrequest"><literal>r.subrequest(<value>uri</value>[,
273 <value>options</value>[, <value>callback</value>]])</literal></tag-name> 273 <value>options</value>[, <value>callback</value>]])</literal></tag-name>
274 <tag-desc> 274 <tag-desc>
275 создаёт подзапрос с заданными <literal>uri</literal> и 275 создаёт подзапрос с заданными <literal>uri</literal> и
276 <literal>options</literal> и устанавливает 276 <literal>options</literal> и устанавливает
277 необязательный <literal>callback</literal> завершения. 277 необязательный <literal>callback</literal> завершения.
337 <tag-desc> 337 <tag-desc>
338 объект переменных nginx, доступно для записи 338 объект переменных nginx, доступно для записи
339 (начиная с версии <link doc="changes.xml" id="njs0.2.8">0.2.8</link>) 339 (начиная с версии <link doc="changes.xml" id="njs0.2.8">0.2.8</link>)
340 </tag-desc> 340 </tag-desc>
341 341
342 <tag-name><literal>r.warn(<value>строка</value>)</literal></tag-name> 342 <tag-name id="r_warn"><literal>r.warn(<value>строка</value>)</literal></tag-name>
343 <tag-desc> 343 <tag-desc>
344 записывает <literal>строку</literal> в лог-файл ошибок 344 записывает <literal>строку</literal> в лог-файл ошибок
345 на уровне лога <literal>warning</literal> 345 на уровне лога <literal>warning</literal>
346 </tag-desc> 346 </tag-desc>
347 347
387 успешно финализирует текущий обработчик фазы 387 успешно финализирует текущий обработчик фазы
388 или финализирует его с указанным числовым кодом 388 или финализирует его с указанным числовым кодом
389 (<link doc="changes.xml" id="njs0.2.4">0.2.4</link>). 389 (<link doc="changes.xml" id="njs0.2.4">0.2.4</link>).
390 </tag-desc> 390 </tag-desc>
391 391
392 <tag-name><literal>s.error(<value>строка</value>)</literal></tag-name> 392 <tag-name id="s_error"><literal>s.error(<value>строка</value>)</literal></tag-name>
393 <tag-desc> 393 <tag-desc>
394 записывает отправленную <literal>строку</literal> в лог-файл ошибок 394 записывает отправленную <literal>строку</literal> в лог-файл ошибок
395 на уровне лога <literal>error</literal> 395 на уровне лога <literal>error</literal>
396 </tag-desc> 396 </tag-desc>
397 397
398 <tag-name><literal>s.log(<value>строка</value>)</literal></tag-name> 398 <tag-name id="s_log"><literal>s.log(<value>строка</value>)</literal></tag-name>
399 <tag-desc> 399 <tag-desc>
400 записывает отправленную <value>строку</value> в лог-файл ошибок 400 записывает отправленную <value>строку</value> в лог-файл ошибок
401 на уровне лога <literal>info</literal> 401 на уровне лога <literal>info</literal>
402 </tag-desc> 402 </tag-desc>
403 403
445 445
446 </list> 446 </list>
447 </para> 447 </para>
448 </tag-desc> 448 </tag-desc>
449 449
450 <tag-name><literal>s.remoteAddress</literal></tag-name> 450 <tag-name id="s_remote_address"><literal>s.remoteAddress</literal></tag-name>
451 <tag-desc> 451 <tag-desc>
452 адрес клиента, только чтение 452 адрес клиента, только чтение
453 </tag-desc> 453 </tag-desc>
454 454
455 <tag-name id="s_send"><literal>s.send(<value>данные</value>[, 455 <tag-name id="s_send"><literal>s.send(<value>данные</value>[,
484 <tag-desc> 484 <tag-desc>
485 объект переменных nginx, доступно для записи 485 объект переменных nginx, доступно для записи
486 (начиная с версии <link doc="changes.xml" id="njs0.2.8">0.2.8</link>) 486 (начиная с версии <link doc="changes.xml" id="njs0.2.8">0.2.8</link>)
487 </tag-desc> 487 </tag-desc>
488 488
489 <tag-name><literal>s.warn(<value>строка</value>)</literal></tag-name> 489 <tag-name id="s_warn"><literal>s.warn(<value>строка</value>)</literal></tag-name>
490 <tag-desc> 490 <tag-desc>
491 записывает отправленную <literal>строку</literal> в лог-файл ошибок 491 записывает отправленную <literal>строку</literal> в лог-файл ошибок
492 на уровне лога <literal>warning</literal> 492 на уровне лога <literal>warning</literal>
493 </tag-desc> 493 </tag-desc>
494 494
638 <tag-desc> 638 <tag-desc>
639 Сериализует строку Unicode в байтовую строку. 639 Сериализует строку Unicode в байтовую строку.
640 Возвращает <literal>null</literal>, если в строке найден символ больше, чем 255. 640 Возвращает <literal>null</literal>, если в строке найден символ больше, чем 255.
641 </tag-desc> 641 </tag-desc>
642 642
643 <tag-name><literal>String.prototype.toString([<value>кодировка</value>])</literal></tag-name> 643 <tag-name id="string_tostring"><literal>String.prototype.toString([<value>кодировка</value>])</literal></tag-name>
644 <tag-desc> 644 <tag-desc>
645 <para> 645 <para>
646 Если кодировка не указана, 646 Если кодировка не указана,
647 возвращает указанную строку Unicode string или байтовую строку как в ECMAScript. 647 возвращает указанную строку Unicode string или байтовую строку как в ECMAScript.
648 </para> 648 </para>