comparison xml/en/docs/stream/ngx_stream_js_module.xml @ 2693:3cbd6e440581

Documented the js_var directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Mon, 29 Mar 2021 19:40:27 +0100
parents 45214e5316cd
children a45ba3a1d999
comparison
equal deleted inserted replaced
2692:3fe54f96476a 2693:3cbd6e440581
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_stream_js_module" 9 <module name="Module ngx_stream_js_module"
10 link="/en/docs/stream/ngx_stream_js_module.html" 10 link="/en/docs/stream/ngx_stream_js_module.html"
11 lang="en" 11 lang="en"
12 rev="25"> 12 rev="26">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_stream_js_module</literal> module is used to implement 17 The <literal>ngx_stream_js_module</literal> module is used to implement
280 right before the request is freed. 280 right before the request is freed.
281 </para> 281 </para>
282 282
283 </directive> 283 </directive>
284 284
285
286 <directive name="js_var">
287 <syntax><value>$variable</value> [<value>value</value>]</syntax>
288 <default/>
289 <context>stream</context>
290 <appeared-in>0.5.3</appeared-in>
291
292 <para>
293 Declares
294 a <link doc="../njs/reference.xml" id="r_variables">writable</link>
295 variable.
296 The value can contain text, variables, and their combination.
297 The variable is not overwritten after a redirect
298 unlike variables created with the
299 <link doc="ngx_stream_set_module.xml" id="set"/> directive.
300 </para>
301
302 </directive>
303
285 </section> 304 </section>
286 305
287 306
288 <section id="properties" name="Session Object Properties"> 307 <section id="properties" name="Session Object Properties">
289 308