Mercurial > hg > nginx-site
diff xml/ru/docs/http/ngx_http_js_module.xml @ 2530:407c5bd5bffc
Documented the js_import directive and corresponding changes.
Also the following changes:
- js_include is deprecated
- js_access, js_content, js_filter, js_preread, js_set
can now accept module.function
- Example Configuration changed for both http and stream js modules.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Wed, 22 Apr 2020 16:54:11 +0100 |
parents | 1101e24c6d14 |
children | 617bc29bd759 |
line wrap: on
line diff
--- a/xml/ru/docs/http/ngx_http_js_module.xml Tue Apr 21 17:38:08 2020 +0300 +++ b/xml/ru/docs/http/ngx_http_js_module.xml Wed Apr 22 16:54:11 2020 +0100 @@ -9,7 +9,7 @@ <module name="Модуль ngx_http_js_module" link="/ru/docs/http/ngx_http_js_module.html" lang="ru" - rev="19"> + rev="20"> <section id="summary"> @@ -32,22 +32,24 @@ <section id="example" name="Пример конфигурации"> <para> +Пример работает начиная с версии +<link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link>. <example> load_module modules/ngx_http_js_module.so; ... http { - js_include http.js; + js_import http.js; - js_set $foo foo; - js_set $summary summary; + js_set $foo http.foo; + js_set $summary http.summary; server { listen 8000; location / { add_header X-Foo $foo; - js_content baz; + js_content http.baz; } location = /summary { @@ -55,7 +57,7 @@ } location = /hello { - js_content hello; + js_content http.hello; } } } @@ -63,7 +65,7 @@ </para> <para> -Файл <path>http.js</path>: +The <path>http.js</path> file: <example> function foo(r) { r.log("hello from foo() handler"); @@ -110,6 +112,8 @@ function hello(r) { r.return(200, "Hello world!"); } + +export default {foo, summary, baz, hello}; </example> </para> @@ -119,13 +123,45 @@ <section id="directives" name="Директивы"> <directive name="js_content"> -<syntax><value>функция</value></syntax> +<syntax><value>функция</value> | <value>модуль.функция</value></syntax> <default/> <context>location</context> <context>limit_except</context> <para> Задаёт функцию njs в качестве обработчика содержимого location. +Начиная с версии <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link> +можно ссылаться на функцию модуля. +</para> + +</directive> + + +<directive name="js_import"> +<syntax><value>модуль.js</value> | +<value>имя_экспорта из модуль.js</value></syntax> +<default/> +<context>http</context> +<appeared-in>0.4.0</appeared-in> + +<para> +Импортирует модуль, позволяющий задавать обработчики location и переменных +на njs. +<literal>Имя_экспорта</literal> является пространством имён +при доступе к функциям модуля. +Если <literal>имя_экспорта</literal> не задано, +то пространством имён будет являться имя модуля. +<example> +js_import http.js; +</example> +В примере при доступе к экспорту в качестве +пространства имён используется имя модуля <literal>http</literal>. +Если импортируемый модуль содержит <literal>foo()</literal>, +то для доступа используется <literal>http.foo</literal>. +</para> + +<para> +Директив <literal>js_import</literal> может быть несколько. </para> </directive> @@ -137,8 +173,25 @@ <context>http</context> <para> -Задаёт файл, позволяющий задавать обработчики location и переменных -на njs. +Задаёт файл, позволяющий задавать обработчики location и переменных на njs: +<example> +nginx.conf: +js_include http.js; +location /version { + js_content version; +} + +http.js: +function version(r) { + r.return(200, njs.version); +} +</example> +</para> + +<para> +Директива устарела начиная с +<link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link>, +вместо неё следует использовать директиву <link id="js_import"/>. </para> </directive> @@ -160,12 +213,15 @@ <directive name="js_set"> <syntax> -<value>$переменная</value> <value>функция</value></syntax> +<value>$переменная</value> <value>функция</value> | +<value>модуль.функция</value></syntax> <default/> <context>http</context> <para> Задаёт функцию njs для указанной переменной. +Начиная с <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link> +можно ссылаться на функцию модуля. </para> </directive>