Mercurial > hg > nginx-site

comparison xml/en/docs/njs/reference.xml @ 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 3184864bbb3f
children c0a4a4a55e45
comparison
equal deleted inserted replaced
3008:4470b2bff7b7 3009:2e8c1384d211
7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd"> 7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd">
8 8
9 <article name="Reference" 9 <article name="Reference"
10 link="/en/docs/njs/reference.html" 10 link="/en/docs/njs/reference.html"
11 lang="en" 11 lang="en"
12 rev="115"> 12 rev="116">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 <link doc="index.xml">njs</link> provides objects, methods and properties 17 <link doc="index.xml">njs</link> provides objects, methods and properties
1597 <table width="100%"> 1597 <table width="100%">
1598 <tr><td><link id="dict_add"><literal>ngx.shared.SharedDict.add()</literal></link></td></tr> 1598 <tr><td><link id="dict_add"><literal>ngx.shared.SharedDict.add()</literal></link></td></tr>
1599 <tr><td><link id="dict_capacity"><literal>ngx.shared.SharedDict.capacity</literal></link></td></tr> 1599 <tr><td><link id="dict_capacity"><literal>ngx.shared.SharedDict.capacity</literal></link></td></tr>
1600 <tr><td><link id="dict_clear"><literal>ngx.shared.SharedDict.clear()</literal></link></td></tr> 1600 <tr><td><link id="dict_clear"><literal>ngx.shared.SharedDict.clear()</literal></link></td></tr>
1601 <tr><td><link id="dict_delete"><literal>ngx.shared.SharedDict.delete()</literal></link></td></tr> 1601 <tr><td><link id="dict_delete"><literal>ngx.shared.SharedDict.delete()</literal></link></td></tr>
1602 <tr><td><link id="dict_incr"><literal>ngx.shared.SharedDict.incr()</literal></link></td></tr>
1603 <tr><td><link id="dict_freespace"><literal>ngx.shared.SharedDict.freeSpace()</literal></link></td></tr> 1602 <tr><td><link id="dict_freespace"><literal>ngx.shared.SharedDict.freeSpace()</literal></link></td></tr>
1604 <tr><td><link id="dict_get"><literal>ngx.shared.SharedDict.get()</literal></link></td></tr> 1603 <tr><td><link id="dict_get"><literal>ngx.shared.SharedDict.get()</literal></link></td></tr>
1605 <tr><td><link id="dict_has"><literal>ngx.shared.SharedDict.has()</literal></link></td></tr> 1604 <tr><td><link id="dict_has"><literal>ngx.shared.SharedDict.has()</literal></link></td></tr>
1605 <tr><td><link id="dict_incr"><literal>ngx.shared.SharedDict.incr()</literal></link></td></tr>
1606 <tr><td><link id="dict_items"><literal>ngx.shared.SharedDict.items()</literal></link></td></tr>
1606 <tr><td><link id="dict_keys"><literal>ngx.shared.SharedDict.keys()</literal></link></td></tr> 1607 <tr><td><link id="dict_keys"><literal>ngx.shared.SharedDict.keys()</literal></link></td></tr>
1607 <tr><td><link id="dict_name"><literal>ngx.shared.SharedDict.name</literal></link></td></tr> 1608 <tr><td><link id="dict_name"><literal>ngx.shared.SharedDict.name</literal></link></td></tr>
1608 <tr><td><link id="dict_pop"><literal>ngx.shared.SharedDict.pop()</literal></link></td></tr> 1609 <tr><td><link id="dict_pop"><literal>ngx.shared.SharedDict.pop()</literal></link></td></tr>
1609 <tr><td><link id="dict_replace"><literal>ngx.shared.SharedDict.replace()</literal></link></td></tr> 1610 <tr><td><link id="dict_replace"><literal>ngx.shared.SharedDict.replace()</literal></link></td></tr>
1610 <tr><td><link id="dict_set"><literal>ngx.shared.SharedDict.set()</literal></link></td></tr> 1611 <tr><td><link id="dict_set"><literal>ngx.shared.SharedDict.set()</literal></link></td></tr>
1664 <tag-name id="dict_delete"><literal>ngx.shared.SharedDict.delete(<value>key</value>)</literal></tag-name> 1665 <tag-name id="dict_delete"><literal>ngx.shared.SharedDict.delete(<value>key</value>)</literal></tag-name>
1665 <tag-desc> 1666 <tag-desc>
1666 Removes the item associated with the specified key 1667 Removes the item associated with the specified key
1667 from the <literal>SharedDict</literal> dictionary, 1668 from the <literal>SharedDict</literal> dictionary,
1668 <literal>true</literal> if the item in the dictionary existed and was removed, 1669 <literal>true</literal> if the item in the dictionary existed and was removed,
1670 <literal>false</literal> otherwise.
1671 </tag-desc>
1672
1673 <tag-name id="dict_freespace"><literal>ngx.shared.SharedDict.freeSpace()</literal></tag-name>
1674 <tag-desc>
1675 Returns the free page size in bytes.
1676 If the size is zero, the <literal>SharedDict</literal> dictionary
1677 will still accept new values if there is space in the occupied pages.
1678 </tag-desc>
1679
1680 <tag-name id="dict_get"><literal>ngx.shared.SharedDict.get(<value>key</value>)</literal></tag-name>
1681 <tag-desc>
1682 Retrieves the item by its <literal>key</literal>,
1683 returns the value associated with the <literal>key</literal>
1684 or <literal>undefined</literal> if there is none.
1685 </tag-desc>
1686
1687 <tag-name id="dict_has"><literal>ngx.shared.SharedDict.has(<value>key</value>)</literal></tag-name>
1688 <tag-desc>
1689 Searches for an item by its <literal>key</literal>,
1690 returns <literal>true</literal> if such item exists or
1669 <literal>false</literal> otherwise. 1691 <literal>false</literal> otherwise.
1670 </tag-desc> 1692 </tag-desc>
1671 1693
1672 <tag-name id="dict_incr"><literal>ngx.shared.SharedDict.incr(<value>key</value>,<value>delta</value>[,<value>init</value>])</literal></tag-name> 1694 <tag-name id="dict_incr"><literal>ngx.shared.SharedDict.incr(<value>key</value>,<value>delta</value>[,<value>init</value>])</literal></tag-name>
1673 <tag-desc> 1695 <tag-desc>
1692 or 1714 or
1693 <link doc="../stream/ngx_stream_js_module.xml" id="js_shared_dict_zone">stream</link>. 1715 <link doc="../stream/ngx_stream_js_module.xml" id="js_shared_dict_zone">stream</link>.
1694 </note> 1716 </note>
1695 </tag-desc> 1717 </tag-desc>
1696 1718
1697 <tag-name id="dict_freespace"><literal>ngx.shared.SharedDict.freeSpace()</literal></tag-name> 1719 <tag-name id="dict_items"><literal>ngx.shared.SharedDict.items([<value>maxCount</value>])</literal></tag-name>
1698 <tag-desc> 1720 <tag-desc>
1699 Returns the free page size in bytes. 1721 Returns an array of the <literal>SharedDict</literal> dictionary
1700 If the size is zero, the <literal>SharedDict</literal> dictionary 1722 key-value items (since <link doc="changes.xml" id="njs0.8.1">0.8.1</link>).
1701 will still accept new values if there is space in the occupied pages. 1723 The <literal>maxCount</literal> parameter
1702 </tag-desc> 1724 sets maximum number of items to retrieve,
1703 1725 by default is <literal>1024</literal>.
1704 <tag-name id="dict_get"><literal>ngx.shared.SharedDict.get(<value>key</value>)</literal></tag-name> 1726
1705 <tag-desc>
1706 Retrieves the item by its <literal>key</literal>,
1707 returns the value associated with the <literal>key</literal>
1708 or <literal>undefined</literal> if there is none.
1709 </tag-desc>
1710
1711 <tag-name id="dict_has"><literal>ngx.shared.SharedDict.has(<value>key</value>)</literal></tag-name>
1712 <tag-desc>
1713 Searches for an item by its <literal>key</literal>,
1714 returns <literal>true</literal> if such item exists or
1715 <literal>false</literal> otherwise.
1716 </tag-desc> 1727 </tag-desc>
1717 1728
1718 <tag-name id="dict_keys"><literal>ngx.shared.SharedDict.keys([<value>maxCount</value>])</literal></tag-name> 1729 <tag-name id="dict_keys"><literal>ngx.shared.SharedDict.keys([<value>maxCount</value>])</literal></tag-name>
1719 <tag-desc> 1730 <tag-desc>
1720 Returns an array of the <literal>SharedDict</literal> dictionary keys. 1731 Returns an array of the <literal>SharedDict</literal> dictionary keys.
1721 The <literal>maxCount</literal> parameter 1732 The <literal>maxCount</literal> parameter
1722 sets maximum number of keys to retrieve, 1733 sets maximum number of keys to retrieve,
1723 by default is <literal>1024</literal>. 1734 by default is <literal>1024</literal>.
1724
1725 </tag-desc> 1735 </tag-desc>
1726 1736
1727 <tag-name id="dict_name"><literal>ngx.shared.SharedDict.name</literal></tag-name> 1737 <tag-name id="dict_name"><literal>ngx.shared.SharedDict.name</literal></tag-name>
1728 <tag-desc> 1738 <tag-desc>
1729 Returns the name of the <literal>SharedDict</literal> dictionary, 1739 Returns the name of the <literal>SharedDict</literal> dictionary,