Mercurial > hg > nginx-site
changeset 2578:fafb7767c128
Restructured njs Reference.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Thu, 06 Aug 2020 17:38:21 +0100 |
parents | 67fd664e2612 |
children | 63cef7604e0d |
files | xml/en/docs/njs/reference.xml |
diffstat | 1 files changed, 46 insertions(+), 40 deletions(-) [+] |
line wrap: on
line diff
--- a/xml/en/docs/njs/reference.xml Thu Aug 06 14:49:00 2020 +0100 +++ b/xml/en/docs/njs/reference.xml Thu Aug 06 17:38:21 2020 +0100 @@ -9,7 +9,7 @@ <article name="Reference" link="/en/docs/njs/reference.html" lang="en" - rev="48"> + rev="49"> <section id="summary"> @@ -685,6 +685,51 @@ </section> +<section id="njs_api_timers" name="Timers"> + +<para> + +<list type="tag"> + +<tag-name id="cleartimeout"><literal>clearTimeout(<value>timeout</value>)</literal></tag-name> +<tag-desc> +Cancels a <literal>timeout</literal> object +created by <link id="settimeout">setTimeout()</link>. +</tag-desc> + +<tag-name id="settimeout"><literal>setTimeout(<value>function</value>, +<value>ms</value>[, <value>arg1</value>, <value>argN</value>])</literal></tag-name> +<tag-desc> +Calls a <literal>function</literal> +after a specified number of <literal>milliseconds</literal>. +One or more optional <literal>arguments</literal> +can be passed to the specified function. +Returns a <literal>timeout</literal> object. +<example> +function handler(v) +{ + // ... +} + +t = setTimeout(handler, 12); + +// ... + +clearTimeout(t); +</example> +</tag-desc> + +</list> +</para> + +</section> + +</section> + + +<section id="built-in" name="Built-in Modules"> + + <section id="crypto" name="Crypto"> <para> @@ -795,45 +840,6 @@ </section> -<section id="njs_api_timers" name="Timers"> - -<para> - -<list type="tag"> - -<tag-name id="cleartimeout"><literal>clearTimeout(<value>timeout</value>)</literal></tag-name> -<tag-desc> -Cancels a <literal>timeout</literal> object -created by <link id="settimeout">setTimeout()</link>. -</tag-desc> - -<tag-name id="settimeout"><literal>setTimeout(<value>function</value>, -<value>ms</value>[, <value>arg1</value>, <value>argN</value>])</literal></tag-name> -<tag-desc> -Calls a <literal>function</literal> -after a specified number of <literal>milliseconds</literal>. -One or more optional <literal>arguments</literal> -can be passed to the specified function. -Returns a <literal>timeout</literal> object. -<example> -function handler(v) -{ - // ... -} - -t = setTimeout(handler, 12); - -// ... - -clearTimeout(t); -</example> -</tag-desc> - -</list> -</para> - -</section> - <section id="njs_api_fs" name="File System">