Mercurial > hg > nginx-site

changeset 3009:2e8c1384d211

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented ngx.shared.SharedDict.items in njs Reference.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 12 Sep 2023 21:32:51 +0100
parents 4470b2bff7b7
children 758e2e1dfd22
files xml/en/docs/njs/compatibility.xml xml/en/docs/njs/reference.xml xml/ru/docs/njs/compatibility.xml
diffstat 3 files changed, 38 insertions(+), 26 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/njs/compatibility.xml
+++ b/xml/en/docs/njs/compatibility.xml
@@ -9,7 +9,7 @@
 <article name="Compatibility"
         link="/en/docs/njs/compatibility.html"
         lang="en"
-        rev="40"
+        rev="41"
         toc="no">
 
 <section>
@@ -1122,10 +1122,11 @@ nginx object methods:
 <link doc="reference.xml" id="dict_add"><literal>add</literal></link>,
 <link doc="reference.xml" id="dict_clear"><literal>clear</literal></link>,
 <link doc="reference.xml" id="dict_delete"><literal>delete</literal></link>,
-<link doc="reference.xml" id="dict_incr"><literal>incr</literal></link>,
 <link doc="reference.xml" id="dict_freespace"><literal>freeSpace</literal></link>,
 <link doc="reference.xml" id="dict_get"><literal>get</literal></link>,
 <link doc="reference.xml" id="dict_has"><literal>has</literal></link>,
+<link doc="reference.xml" id="dict_incr"><literal>incr</literal></link>,
+<link doc="reference.xml" id="dict_items"><literal>items</literal></link>,
 <link doc="reference.xml" id="dict_keys"><literal>keys</literal></link>,
 <link doc="reference.xml" id="dict_pop"><literal>pop</literal></link>,
 <link doc="reference.xml" id="dict_replace"><literal>replace</literal></link>,
--- a/xml/en/docs/njs/reference.xml
+++ b/xml/en/docs/njs/reference.xml
@@ -9,7 +9,7 @@
 <article name="Reference"
         link="/en/docs/njs/reference.html"
         lang="en"
-        rev="115">
+        rev="116">
 
 <section id="summary">
 
@@ -1599,10 +1599,11 @@ since <link doc="changes.xml" id="njs0.8
 <tr><td><link id="dict_capacity"><literal>ngx.shared.SharedDict.capacity</literal></link></td></tr>
 <tr><td><link id="dict_clear"><literal>ngx.shared.SharedDict.clear()</literal></link></td></tr>
 <tr><td><link id="dict_delete"><literal>ngx.shared.SharedDict.delete()</literal></link></td></tr>
-<tr><td><link id="dict_incr"><literal>ngx.shared.SharedDict.incr()</literal></link></td></tr>
 <tr><td><link id="dict_freespace"><literal>ngx.shared.SharedDict.freeSpace()</literal></link></td></tr>
 <tr><td><link id="dict_get"><literal>ngx.shared.SharedDict.get()</literal></link></td></tr>
 <tr><td><link id="dict_has"><literal>ngx.shared.SharedDict.has()</literal></link></td></tr>
+<tr><td><link id="dict_incr"><literal>ngx.shared.SharedDict.incr()</literal></link></td></tr>
+<tr><td><link id="dict_items"><literal>ngx.shared.SharedDict.items()</literal></link></td></tr>
 <tr><td><link id="dict_keys"><literal>ngx.shared.SharedDict.keys()</literal></link></td></tr>
 <tr><td><link id="dict_name"><literal>ngx.shared.SharedDict.name</literal></link></td></tr>
 <tr><td><link id="dict_pop"><literal>ngx.shared.SharedDict.pop()</literal></link></td></tr>
@@ -1669,6 +1670,27 @@ from the <literal>SharedDict</literal> d
 <literal>false</literal> otherwise.
 </tag-desc>
 
+<tag-name id="dict_freespace"><literal>ngx.shared.SharedDict.freeSpace()</literal></tag-name>
+<tag-desc>
+Returns the free page size in bytes.
+If the size is zero, the <literal>SharedDict</literal> dictionary
+will still accept new values if there is space in the occupied pages.
+</tag-desc>
+
+<tag-name id="dict_get"><literal>ngx.shared.SharedDict.get(<value>key</value>)</literal></tag-name>
+<tag-desc>
+Retrieves the item by its <literal>key</literal>,
+returns the value associated with the <literal>key</literal>
+or <literal>undefined</literal> if there is none.
+</tag-desc>
+
+<tag-name id="dict_has"><literal>ngx.shared.SharedDict.has(<value>key</value>)</literal></tag-name>
+<tag-desc>
+Searches for an item by its <literal>key</literal>,
+returns <literal>true</literal> if such item exists or
+<literal>false</literal> otherwise.
+</tag-desc>
+
 <tag-name id="dict_incr"><literal>ngx.shared.SharedDict.incr(<value>key</value>,<value>delta</value>[,<value>init</value>])</literal></tag-name>
 <tag-desc>
 Increments the integer value associated with the <literal>key</literal>
@@ -1694,25 +1716,14 @@ or
 </note>
 </tag-desc>
 
-<tag-name id="dict_freespace"><literal>ngx.shared.SharedDict.freeSpace()</literal></tag-name>
-<tag-desc>
-Returns the free page size in bytes.
-If the size is zero, the <literal>SharedDict</literal> dictionary
-will still accept new values if there is space in the occupied pages.
-</tag-desc>
-
-<tag-name id="dict_get"><literal>ngx.shared.SharedDict.get(<value>key</value>)</literal></tag-name>
-<tag-desc>
-Retrieves the item by its <literal>key</literal>,
-returns the value associated with the <literal>key</literal>
-or <literal>undefined</literal> if there is none.
-</tag-desc>
-
-<tag-name id="dict_has"><literal>ngx.shared.SharedDict.has(<value>key</value>)</literal></tag-name>
-<tag-desc>
-Searches for an item by its <literal>key</literal>,
-returns <literal>true</literal> if such item exists or
-<literal>false</literal> otherwise.
+<tag-name id="dict_items"><literal>ngx.shared.SharedDict.items([<value>maxCount</value>])</literal></tag-name>
+<tag-desc>
+Returns an array of the <literal>SharedDict</literal> dictionary
+key-value items (since <link doc="changes.xml" id="njs0.8.1">0.8.1</link>).
+The <literal>maxCount</literal> parameter
+sets maximum number of items to retrieve,
+by default is <literal>1024</literal>.
+
 </tag-desc>
 
 <tag-name id="dict_keys"><literal>ngx.shared.SharedDict.keys([<value>maxCount</value>])</literal></tag-name>
@@ -1721,7 +1732,6 @@ Returns an array of the <literal>SharedD
 The <literal>maxCount</literal> parameter
 sets maximum number of keys to retrieve,
 by default is <literal>1024</literal>.
-
 </tag-desc>
 
 <tag-name id="dict_name"><literal>ngx.shared.SharedDict.name</literal></tag-name>
--- a/xml/ru/docs/njs/compatibility.xml
+++ b/xml/ru/docs/njs/compatibility.xml
@@ -9,7 +9,7 @@
 <article name="Совместимость"
         link="/ru/docs/njs/compatibility.html"
         lang="ru"
-        rev="40"
+        rev="41"
         toc="no">
 
 <section>
@@ -1122,10 +1122,11 @@ ES6 поддержка стрелочных функций
 <link doc="reference.xml" id="dict_add"><literal>add</literal></link>,
 <link doc="reference.xml" id="dict_clear"><literal>clear</literal></link>,
 <link doc="reference.xml" id="dict_delete"><literal>delete</literal></link>,
-<link doc="reference.xml" id="dict_incr"><literal>incr</literal></link>,
 <link doc="reference.xml" id="dict_freespace"><literal>freeSpace</literal></link>,
 <link doc="reference.xml" id="dict_get"><literal>get</literal></link>,
 <link doc="reference.xml" id="dict_has"><literal>has</literal></link>,
+<link doc="reference.xml" id="dict_incr"><literal>incr</literal></link>,
+<link doc="reference.xml" id="dict_items"><literal>items</literal></link>,
 <link doc="reference.xml" id="dict_keys"><literal>keys</literal></link>,
 <link doc="reference.xml" id="dict_pop"><literal>pop</literal></link>,
 <link doc="reference.xml" id="dict_replace"><literal>replace</literal></link>,