Mercurial > hg > nginx-site
changeset 2901:9719a0184a67
Documented the js_preload_object directive.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Fri, 21 Oct 2022 12:19:07 +0100 |
parents | e4a87f3a05d8 |
children | 843bf979dcaa |
files | xml/en/docs/http/ngx_http_js_module.xml xml/en/docs/stream/ngx_stream_js_module.xml xml/ru/docs/http/ngx_http_js_module.xml xml/ru/docs/stream/ngx_stream_js_module.xml |
diffstat | 4 files changed, 118 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_js_module.xml Fri Oct 21 16:33:37 2022 -0700 +++ b/xml/en/docs/http/ngx_http_js_module.xml Fri Oct 21 12:19:07 2022 +0100 @@ -9,7 +9,7 @@ <module name="Module ngx_http_js_module" link="/en/docs/http/ngx_http_js_module.html" lang="en" - rev="36"> + rev="37"> <section id="summary"> @@ -539,6 +539,35 @@ </directive> +<directive name="js_preload_object"> +<syntax><value>name.json</value> | +<value>name</value> from <value>file.json</value></syntax> +<default/> +<context>http</context> +<context>server</context> +<context>location</context> +<appeared-in>0.7.8</appeared-in> + +<para> +Preloads an immutable object at configure time. +The <literal>name</literal> is used a name of the global variable +though which the object is available in njs code. +If the <literal>name</literal> is not specified, +the file name will be used instead. +<example> +js_preload_object map.json; +</example> +Here, the <literal>map</literal> is used as a name +while accessing the preloaded object. +</para> + +<para> +Several <literal>js_preload_object</literal> directives can be specified. +</para> + +</directive> + + <directive name="js_set"> <syntax> <value>$variable</value> <value>function</value> |
--- a/xml/en/docs/stream/ngx_stream_js_module.xml Fri Oct 21 16:33:37 2022 -0700 +++ b/xml/en/docs/stream/ngx_stream_js_module.xml Fri Oct 21 12:19:07 2022 +0100 @@ -9,7 +9,7 @@ <module name="Module ngx_stream_js_module" link="/en/docs/stream/ngx_stream_js_module.html" lang="en" - rev="33"> + rev="34"> <section id="summary"> @@ -471,6 +471,34 @@ </directive> +<directive name="js_preload_object"> +<syntax><value>name.json</value> | +<value>name</value> from <value>file.json</value></syntax> +<default/> +<context>stream</context> +<context>server</context> +<appeared-in>0.7.8</appeared-in> + +<para> +Preloads an immutable object at configure time. +The <literal>name</literal> is used a name of the global variable +though which the object is available in njs code. +If the <literal>name</literal> is not specified, +the file name will be used instead. +<example> +js_preload_object map.json; +</example> +Here, the <literal>map</literal> is used as a name +while accessing the preloaded object. +</para> + +<para> +Several <literal>js_preload_object</literal> directives can be specified. +</para> + +</directive> + + <directive name="js_preread"> <syntax><value>function</value> | <value>module.function</value></syntax> <default/>
--- a/xml/ru/docs/http/ngx_http_js_module.xml Fri Oct 21 16:33:37 2022 -0700 +++ b/xml/ru/docs/http/ngx_http_js_module.xml Fri Oct 21 12:19:07 2022 +0100 @@ -9,7 +9,7 @@ <module name="Модуль ngx_http_js_module" link="/ru/docs/http/ngx_http_js_module.html" lang="ru" - rev="36"> + rev="37"> <section id="summary"> @@ -540,6 +540,35 @@ </directive> +<directive name="js_preload_object"> +<syntax><value>имя.json</value> | +<value>имя</value> from <value>файл.json</value></syntax> +<default/> +<context>http</context> +<context>server</context> +<context>location</context> +<appeared-in>0.7.8</appeared-in> + +<para> +Предварительно загружает неизменяемый объект во время конфигурации. +<literal>Имя</literal> используется в качестве имени глобальной переменной, +через которую объект доступен в коде njs. +Если <literal>имя</literal> не указано, +то будет использоваться имя файла. +<example> +js_preload_object map.json; +</example> +В примере <literal>map</literal> используется в качестве имени +во время доступа к предварительно загруженному объекту. +</para> + +<para> +Директив <literal>js_preload_object</literal> может быть несколько. +</para> + +</directive> + + <directive name="js_set"> <syntax> <value>$переменная</value> <value>функция</value> |
--- a/xml/ru/docs/stream/ngx_stream_js_module.xml Fri Oct 21 16:33:37 2022 -0700 +++ b/xml/ru/docs/stream/ngx_stream_js_module.xml Fri Oct 21 12:19:07 2022 +0100 @@ -9,7 +9,7 @@ <module name="Модуль ngx_stream_js_module" link="/ru/docs/stream/ngx_stream_js_module.html" lang="ru" - rev="33"> + rev="34"> <section id="summary"> @@ -450,6 +450,34 @@ </directive> +<directive name="js_preload_object"> +<syntax><value>имя.json</value> | +<value>имя</value> from <value>файл.json</value></syntax> +<default/> +<context>stream</context> +<context>server</context> +<appeared-in>0.7.8</appeared-in> + +<para> +Предварительно загружает неизменяемый объект во время конфигурации. +<literal>Имя</literal> используется в качестве имени глобальной переменной, +через которую объект доступен в коде njs. +Если <literal>имя</literal> не указано, +то будет использоваться имя файла. +<example> +js_preload_object map.json; +</example> +В примере <literal>map</literal> используется в качестве имени +во время доступа к предварительно загруженному объекту. +</para> + +<para> +Директив <literal>js_preload_object</literal> может быть несколько. +</para> + +</directive> + + <directive name="js_preread"> <syntax><value>функция</value> | <value>модуль.функция</value></syntax> <default/>