comparison xml/ru/docs/http/ngx_http_js_module.xml @ 2882:986e1f930e3b

Documented server, location, if contexts for some js directives.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 18 Aug 2022 15:44:39 +0100
parents a3aee2697d4e
children 9719a0184a67
comparison
equal deleted inserted replaced
2881:e59e8645055d 2882:986e1f930e3b
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="35"> 12 rev="36">
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> позволяет задавать
150 <directive name="js_body_filter"> 150 <directive name="js_body_filter">
151 <syntax><value>функция</value> | <value>модуль.функция</value> 151 <syntax><value>функция</value> | <value>модуль.функция</value>
152 [<value>buffer_type</value>=<value>строка</value> | <value>буфер</value>]</syntax> 152 [<value>buffer_type</value>=<value>строка</value> | <value>буфер</value>]</syntax>
153 <default/> 153 <default/>
154 <context>location</context> 154 <context>location</context>
155 <context>if in location</context>
155 <context>limit_except</context> 156 <context>limit_except</context>
156 <appeared-in>0.5.2</appeared-in> 157 <appeared-in>0.5.2</appeared-in>
157 158
158 <para> 159 <para>
159 Задаёт функцию njs в качестве фильтра тела ответа. 160 Задаёт функцию njs в качестве фильтра тела ответа.
224 <link doc="../njs/reference.xml" id="settimeout">setTimeout()</link>, 225 <link doc="../njs/reference.xml" id="settimeout">setTimeout()</link>,
225 не поддерживаются. 226 не поддерживаются.
226 </note> 227 </note>
227 </para> 228 </para>
228 229
230 <para>
231 <note>
232 Директива может быть указана внутри
233 блока <link doc="../http/ngx_http_rewrite_module.xml" id="if">if</link>
234 начиная с <link doc="../njs/changes.xml" id="njs0.7.7">0.7.7</link>.
235 </note>
236 </para>
237
229 </directive> 238 </directive>
230 239
231 240
232 <directive name="js_content"> 241 <directive name="js_content">
233 <syntax><value>функция</value> | <value>модуль.функция</value></syntax> 242 <syntax><value>функция</value> | <value>модуль.функция</value></syntax>
234 <default/> 243 <default/>
235 <context>location</context> 244 <context>location</context>
245 <context>if in location</context>
236 <context>limit_except</context> 246 <context>limit_except</context>
237 247
238 <para> 248 <para>
239 Задаёт функцию njs в качестве обработчика содержимого location. 249 Задаёт функцию njs в качестве обработчика содержимого location.
240 Начиная с версии <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link> 250 Начиная с версии <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link>
241 можно ссылаться на функцию модуля. 251 можно ссылаться на функцию модуля.
252 </para>
253
254 <para>
255 <note>
256 Директива может быть указана внутри
257 блока <link doc="../http/ngx_http_rewrite_module.xml" id="if">if</link>
258 начиная с <link doc="../njs/changes.xml" id="njs0.7.7">0.7.7</link>.
259 </note>
242 </para> 260 </para>
243 261
244 </directive> 262 </directive>
245 263
246 264
391 409
392 <directive name="js_header_filter"> 410 <directive name="js_header_filter">
393 <syntax><value>функция</value> | <value>модуль.функция</value></syntax> 411 <syntax><value>функция</value> | <value>модуль.функция</value></syntax>
394 <default/> 412 <default/>
395 <context>location</context> 413 <context>location</context>
414 <context>if in location</context>
396 <context>limit_except</context> 415 <context>limit_except</context>
397 <appeared-in>0.5.1</appeared-in> 416 <appeared-in>0.5.1</appeared-in>
398 417
399 <para> 418 <para>
400 Задаёт функцию njs в качестве фильтра заголовка ответа. 419 Задаёт функцию njs в качестве фильтра заголовка ответа.
412 <link doc="../njs/reference.xml" id="settimeout">setTimeout()</link>, 431 <link doc="../njs/reference.xml" id="settimeout">setTimeout()</link>,
413 не поддерживаются. 432 не поддерживаются.
414 </note> 433 </note>
415 </para> 434 </para>
416 435
436 <para>
437 <note>
438 Директива может быть указана внутри
439 блока <link doc="../http/ngx_http_rewrite_module.xml" id="if">if</link>
440 начиная с <link doc="../njs/changes.xml" id="njs0.7.7">0.7.7</link>.
441 </note>
442 </para>
443
417 </directive> 444 </directive>
418 445
419 446
420 <directive name="js_import"> 447 <directive name="js_import">
421 <syntax><value>модуль.js</value> | 448 <syntax><value>модуль.js</value> |
422 <value>имя_экспорта from модуль.js</value></syntax> 449 <value>имя_экспорта from модуль.js</value></syntax>
423 <default/> 450 <default/>
424 <context>http</context> 451 <context>http</context>
452 <context>server</context>
453 <context>location</context>
425 <appeared-in>0.4.0</appeared-in> 454 <appeared-in>0.4.0</appeared-in>
426 455
427 <para> 456 <para>
428 Импортирует модуль, позволяющий задавать обработчики location и переменных 457 Импортирует модуль, позволяющий задавать обработчики location и переменных
429 на njs. 458 на njs.
442 471
443 <para> 472 <para>
444 Директив <literal>js_import</literal> может быть несколько. 473 Директив <literal>js_import</literal> может быть несколько.
445 </para> 474 </para>
446 475
476 <para>
477 <note>
478 Директива может быть указана
479 на уровне <literal>server</literal> и <literal>location</literal>
480 начиная с <link doc="../njs/changes.xml" id="njs0.7.7">0.7.7</link>.
481 </note>
482 </para>
483
447 </directive> 484 </directive>
448 485
449 486
450 <directive name="js_include"> 487 <directive name="js_include">
451 <syntax><value>файл</value></syntax> 488 <syntax><value>файл</value></syntax>
482 <directive name="js_path"> 519 <directive name="js_path">
483 <syntax> 520 <syntax>
484 <value>путь</value></syntax> 521 <value>путь</value></syntax>
485 <default/> 522 <default/>
486 <context>http</context> 523 <context>http</context>
524 <context>server</context>
525 <context>location</context>
487 <appeared-in>0.3.0</appeared-in> 526 <appeared-in>0.3.0</appeared-in>
488 527
489 <para> 528 <para>
490 Задаёт дополнительный путь для модулей njs. 529 Задаёт дополнительный путь для модулей njs.
530 </para>
531
532 <para>
533 <note>
534 Директива может быть указана
535 на уровне <literal>server</literal> и <literal>location</literal>
536 начиная с <link doc="../njs/changes.xml" id="njs0.7.7">0.7.7</link>.
537 </note>
491 </para> 538 </para>
492 539
493 </directive> 540 </directive>
494 541
495 542
497 <syntax> 544 <syntax>
498 <value>$переменная</value> <value>функция</value> | 545 <value>$переменная</value> <value>функция</value> |
499 <value>модуль.функция</value></syntax> 546 <value>модуль.функция</value></syntax>
500 <default/> 547 <default/>
501 <context>http</context> 548 <context>http</context>
549 <context>server</context>
550 <context>location</context>
502 551
503 <para> 552 <para>
504 Задаёт <literal>функцию</literal> njs 553 Задаёт <literal>функцию</literal> njs
505 для указанной <literal>переменной</literal>. 554 для указанной <literal>переменной</literal>.
506 Начиная с <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link> 555 Начиная с <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link>
533 <link doc="../njs/reference.xml" id="settimeout">setTimeout()</link>, 582 <link doc="../njs/reference.xml" id="settimeout">setTimeout()</link>,
534 не поддерживаются. 583 не поддерживаются.
535 </note> 584 </note>
536 </para> 585 </para>
537 586
587 <para>
588 <note>
589 Директива может быть указана
590 на уровне <literal>server</literal> и <literal>location</literal>
591 начиная с <link doc="../njs/changes.xml" id="njs0.7.7">0.7.7</link>.
592 </note>
593 </para>
594
538 </directive> 595 </directive>
539 596
540 597
541 <directive name="js_var"> 598 <directive name="js_var">
542 <syntax><value>$переменная</value> [<value>значение</value>]</syntax> 599 <syntax><value>$переменная</value> [<value>значение</value>]</syntax>
543 <default/> 600 <default/>
544 <context>http</context> 601 <context>http</context>
602 <context>server</context>
603 <context>location</context>
545 <appeared-in>0.5.3</appeared-in> 604 <appeared-in>0.5.3</appeared-in>
546 605
547 <para> 606 <para>
548 Объявляет 607 Объявляет
549 <link doc="../njs/reference.xml" id="r_variables">перезаписываемую</link> 608 <link doc="../njs/reference.xml" id="r_variables">перезаписываемую</link>
552 Переменная не перезаписывается после перенаправления, 611 Переменная не перезаписывается после перенаправления,
553 в отличие от переменных, созданных при помощи 612 в отличие от переменных, созданных при помощи
554 директивы <link doc="ngx_http_rewrite_module.xml" id="set"/>. 613 директивы <link doc="ngx_http_rewrite_module.xml" id="set"/>.
555 </para> 614 </para>
556 615
616 <para>
617 <note>
618 Директива может быть указана
619 на уровне <literal>server</literal> и <literal>location</literal>
620 начиная с <link doc="../njs/changes.xml" id="njs0.7.7">0.7.7</link>.
621 </note>
622 </para>
623
557 </directive> 624 </directive>
558 625
559 </section> 626 </section>
560 627
561 628