diff xml/en/docs/njs/reference.xml @ 3014:c0a4a4a55e45

Documented Periodic Session object in njs Reference.
author Yaroslav Zhuravlev <yar@nginx.com>
date Fri, 29 Sep 2023 20:06:59 +0100
parents 2e8c1384d211
children 3a85326ed38c
line wrap: on
line diff
--- a/xml/en/docs/njs/reference.xml	Fri Sep 22 15:11:23 2023 -0700
+++ b/xml/en/docs/njs/reference.xml	Fri Sep 29 20:06:59 2023 +0100
@@ -9,7 +9,7 @@
 <article name="Reference"
         link="/en/docs/njs/reference.html"
         lang="en"
-        rev="116">
+        rev="117">
 
 <section id="summary">
 
@@ -1008,6 +1008,44 @@
 </section>
 
 
+<section id="periodic_session" name="Periodic Session">
+
+<para>
+<table width="100%">
+<tr><td><link id="periodic_session_raw_variables"><literal>PeriodicSession.rawVariables{}</literal></link></td></tr>
+<tr><td><link id="periodic_session_variables"><literal>PeriodicSession.variables{}</literal></link></td></tr>
+</table>
+</para>
+
+<para>
+The <literal>Periodic Session</literal> object is provided as the first argument
+for the <literal>js_periodic</literal> handler for
+<link doc="../http/ngx_http_js_module.xml" id="js_periodic">http</link>
+and
+<link doc="../stream/ngx_stream_js_module.xml" id="js_periodic">stream</link>
+(since <link doc="changes.xml" id="njs0.8.1">0.8.1</link>).
+</para>
+
+<para>
+<list type="tag">
+
+<tag-name id="periodic_session_raw_variables"><literal>PeriodicSession.rawVariables{}</literal></tag-name>
+<tag-desc>
+nginx <link id="periodic_session_variables">variables</link> as Buffers,
+writable.
+</tag-desc>
+
+<tag-name id="periodic_session_variables"><literal>PeriodicSession.variables{}</literal></tag-name>
+<tag-desc>
+<link doc="../varindex.xml">nginx variables</link> object, writable.
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
+
 <section id="headers" name="Headers">
 
 <para>