nginx-site: xml/en/docs/njs/reference.xml annotate

annotate xml/en/docs/njs/reference.xml @ 2570:44792f1ee284

Added IDs to methods in njs Reference.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Thu, 16 Jul 2020 08:22:37 +0100
parents	2edc64c05b0e
children	3e47eecce384

rev	line source
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	2
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	3 <!--
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	4 Copyright (C) Nginx, Inc.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	5 -->
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	6
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	8
2246 32ba43abf9cd Renamed njs API, njs Changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2245 diff changeset	9 <article name="Reference"
32ba43abf9cd Renamed njs API, njs Changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2245 diff changeset	10 link="/en/docs/njs/reference.html"
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	11 lang="en"
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	12 rev="47">
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	13
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	14 <section id="summary">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	15
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	16 <para>
2244 467aef18bf12 Renamed the "About njs" page. Yaroslav Zhuravlev <yar@nginx.com> parents: 2237 diff changeset	17 <link doc="index.xml">njs</link> provides objects, methods and properties
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	18 for extending nginx functionality.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	19 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	20
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	21 <para>
2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	22 This reference contains only njs specific properties, methods and modules
2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	23 not compliant with ECMAScript.
2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	24 Definitions of njs properties and methods compliant with ECMAScript
2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	25 can be found in
2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	26 <link url="http://www.ecma-international.org/ecma-262/">ECMAScript
2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	27 specification</link>.
2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	28 List of all njs properties and methods can be found in
2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	29 <link doc="compatibility.xml">Compatibility</link>.
2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	30 </para>
2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	31
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	32 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	33
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	34
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	35 <section id="http_stream" name="nginx objects">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	36
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	37
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	38 <section id="http" name="HTTP Request">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	39
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	40 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	41 The HTTP request object is available only in the
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	42 <link doc="../http/ngx_http_js_module.xml">ngx_http_js_module</link> module.
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	43 All string properties of the object are
44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	44 <link id="string">byte strings</link>.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	45
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	46 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	47
2353 21f3a93fbe97 njs-0.3.0 Yaroslav Zhuravlev <yar@nginx.com> parents: 2348 diff changeset	48 <tag-name id="r_args"><literal>r.args{}</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	49 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	50 request arguments object, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	51 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	52
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	53 <tag-name id="r_error"><literal>r.error(<value>string</value>)</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	54 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	55 writes a <literal>string</literal> to the error log
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	56 on the <literal>error</literal> level of logging
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	57 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	58
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	59 <tag-name id="r_finish"><literal>r.finish()</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	60 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	61 finishes sending a response to the client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	62 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	63
2353 21f3a93fbe97 njs-0.3.0 Yaroslav Zhuravlev <yar@nginx.com> parents: 2348 diff changeset	64 <tag-name id="r_headers_in"><literal>r.headersIn{}</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	65 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	66 incoming headers object, read-only.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	67 <para>
2543 f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	68 The <literal>Foo</literal> request header
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	69 can be accessed with the syntax:
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	70 <literal>headersIn.foo</literal> or <literal>headersIn['Foo']</literal>.
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	71 </para>
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	72
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	73 <para>
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	74 The
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	75 <header>Authorization</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	76 <header>Content-Length</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	77 <header>Content-Range</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	78 <header>Content-Type</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	79 <header>ETag</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	80 <header>Expect</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	81 <header>From</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	82 <header>Host</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	83 <header>If-Match</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	84 <header>If-Modified-Since</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	85 <header>If-None-Match</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	86 <header>If-Range</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	87 <header>If-Unmodified-Since</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	88 <header>Max-Forwards</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	89 <header>Proxy-Authorization</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	90 <header>Referer</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	91 <header>Transfer-Encoding</header>, and
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	92 <header>User-Agent</header>
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	93 request headers can have only one field value
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	94 (<link doc="changes.xml" id="njs0.4.1">0.4.1</link>).
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	95 Duplicate field values in <header>Cookie</header> headers
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	96 are separated by semicolon (<literal>;</literal>).
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	97 Duplicate field values in all other request headers are separated by commas.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	98 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	99 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	100
2331 5eba0f7b24a9 njs-0.2.8 Yaroslav Zhuravlev <yar@nginx.com> parents: 2315 diff changeset	101 <tag-name id="r_headers_out"><literal>r.headersOut{}</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	102 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	103 outgoing headers object, writable.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	104 <para>
2532 423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	105 The <header>Foo</header> response header
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	106 can be accessed with the syntax:
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	107 <literal>headersOut.foo</literal> or <literal>headersOut['Foo']</literal>.
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	108 </para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	109
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	110 <para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	111 Field values of multi-value response headers
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	112 (<link doc="changes.xml" id="njs0.4.0">0.4.0</link>)
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	113 can be set with the syntax:
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	114 <example>
2544 33347df1da9c Relocated sentence in r.headers.Out, added dot, corrected quotes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2543 diff changeset	115 r.headersOut['Foo'] = ['a', 'b']
2532 423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	116 </example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	117 where the output will be:
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	118 <example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	119 Foo: a
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	120 Foo: b
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	121 </example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	122 All previous field values of the <header>Foo</header> response header
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	123 will be deleted.
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	124 </para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	125
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	126 <para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	127 For standard response headers
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	128 that accept only a single field value such as
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	129 <header>Content-Type</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	130 only the last element of the array will take effect.
2544 33347df1da9c Relocated sentence in r.headers.Out, added dot, corrected quotes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2543 diff changeset	131 Field values of the <header>Set-Cookie</header> response header
33347df1da9c Relocated sentence in r.headers.Out, added dot, corrected quotes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2543 diff changeset	132 are always returned as an array.
2532 423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	133 Duplicate field values in
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	134 <header>Age</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	135 <header>Content-Encoding</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	136 <header>Content-Length</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	137 <header>Content-Type</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	138 <header>ETag</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	139 <header>Expires</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	140 <header>Last-Modified</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	141 <header>Location</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	142 <header>Retry-After</header>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	143 response headers are ignored.
2537 d6bbfd20c82f Rephrased a sentence in r.headersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2532 diff changeset	144 Duplicate field values in all other response headers
d6bbfd20c82f Rephrased a sentence in r.headersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2532 diff changeset	145 are separated by commas.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	146 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	147 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	148
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	149 <tag-name id="r_http_version"><literal>r.httpVersion</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	150 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	151 HTTP version, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	152 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	153
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	154 <tag-name id="r_internal_redirect"><literal>r.internalRedirect(<value>uri</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	155 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	156 performs an internal redirect to the specified <literal>uri</literal>.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	157 If the uri starts with the “<literal>@</literal>” prefix,
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	158 it is considered a named location.
2525 6ce28e0beec0 Updated description of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2509 diff changeset	159 The actual redirect happens after the handler execution is completed.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	160 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	161
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	162 <tag-name id="r_log"><literal>r.log(<value>string</value>)</literal></tag-name>
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	163 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	164 writes a <literal>string</literal> to the error log
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	165 on the <literal>info</literal> level of logging
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	166 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	167
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	168 <tag-name id="r_method"><literal>r.method</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	169 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	170 HTTP method, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	171 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	172
2497 805c4b84cc61 Added missing feature and links to njs-0.3.8 Changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2496 diff changeset	173 <tag-name id="r_parent"><literal>r.parent</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	174 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	175 references the parent request object
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	176 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	177
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	178 <tag-name id="r_remote_address"><literal>r.remoteAddress</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	179 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	180 client address, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	181 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	182
2546 6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	183 <tag-name id="r_raw_headers_in"><literal>r.rawHeadersIn{}</literal></tag-name>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	184 <tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	185 returns an array of key-value pairs
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	186 exactly as they were received from the client
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	187 (<link doc="changes.xml" id="njs0.4.1">0.4.1</link>).
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	188 <para>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	189 For example, with the following request headers:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	190 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	191 Host: localhost
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	192 Foo: bar
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	193 foo: bar2
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	194 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	195 the output of <literal>r.rawHeadersIn</literal> will be:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	196 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	197 [
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	198 ['Host', 'localhost'],
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	199 ['Foo', 'bar'],
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	200 ['foo', 'bar2']
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	201 ]
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	202 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	203 All <literal>foo</literal> headers
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	204 can be collected with the syntax:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	205 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	206 r.rawHeadersIn.filter(v=>v[0].toLowerCase() == 'foo').map(v=>v[1])
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	207 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	208 the output will be:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	209 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	210 ['bar', 'bar2']
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	211 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	212 Header field names are not converted to lower case,
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	213 duplicate field values are not merged.
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	214 </para>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	215 </tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	216
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	217 <tag-name id="r_raw_headers_out"><literal>r.rawHeadersOut{}</literal></tag-name>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	218 <tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	219 returns an array of key-value pairs of response headers
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	220 (<link doc="changes.xml" id="njs0.4.1">0.4.1</link>).
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	221 Header field names are not converted to lower case,
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	222 duplicate field values are not merged.
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	223 </tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	224
2259 9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	225 <tag-name id="r_request_body"><literal>r.requestBody</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	226 <tag-desc>
2259 9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	227 returns the client request body if it has not been
9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	228 written to a temporary file.
9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	229 To ensure that the client request body is in memory,
9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	230 its size should be limited by
9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	231 <link doc="../http/ngx_http_core_module.xml" id="client_max_body_size"/>,
9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	232 and a sufficient buffer size should be set using
9644ecb67081 Unified description of njs r.requestBody with perl request_body. Yaroslav Zhuravlev <yar@nginx.com> parents: 2247 diff changeset	233 <link doc="../http/ngx_http_core_module.xml" id="client_body_buffer_size"/>.
2356 ea6964391d52 Clarified usage of r.requestBody in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2353 diff changeset	234 The property is available only in the
ea6964391d52 Clarified usage of r.requestBody in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2353 diff changeset	235 <link doc="../http/ngx_http_js_module.xml" id="js_content"/> directive.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	236 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	237
2353 21f3a93fbe97 njs-0.3.0 Yaroslav Zhuravlev <yar@nginx.com> parents: 2348 diff changeset	238 <tag-name id="r_response_body"><literal>r.responseBody</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	239 <tag-desc>
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	240 holds the <link id="r_subrequest">subrequest</link> response body, read-only.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	241 The size of <literal>r.responseBody</literal> is limited by the
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	242 <link doc="../http/ngx_http_core_module.xml" id="subrequest_output_buffer_size"/>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	243 directive.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	244 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	245
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	246 <tag-name id="r_return"><literal>r.return(status[, string])</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	247 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	248 sends the entire response
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	249 with the specified <literal>status</literal> to the client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	250 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	251 It is possible to specify either a redirect URL
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	252 (for codes 301, 302, 303, 307, and 308)
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	253 or the response body text (for other codes) as the second argument
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	254 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	255 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	256
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	257 <tag-name id="r_send"><literal>r.send(<value>string</value>)</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	258 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	259 sends a part of the response body to the client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	260 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	261
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	262 <tag-name><literal>r.sendHeader()</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	263 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	264 sends the HTTP headers to the client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	265 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	266
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	267 <tag-name id="r_status"><literal>r.status</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	268 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	269 status, writable
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	270 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	271
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	272 <tag-name id="r_subrequest"><literal>r.subrequest(<value>uri</value>[,
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	273 <value>options</value>[, <value>callback</value>]])</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	274 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	275 creates a subrequest with the given <literal>uri</literal> and
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	276 <literal>options</literal>, and installs
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	277 an optional completion <literal>callback</literal>.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	278
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	279 <para>
2340 537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	280 A
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	281 <link doc="../dev/development_guide.xml.xml" id="http_subrequests">subrequest</link>
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	282 shares its input headers with the client request.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	283 To send headers different from original headers to a proxied server, the
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	284 <link doc="../http/ngx_http_proxy_module.xml" id="proxy_set_header"/>
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	285 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	286 To send a completely new set of headers to a proxied server, the
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	287 <link doc="../http/ngx_http_proxy_module.xml" id="proxy_pass_request_headers"/>
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	288 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	289 </para>
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	290
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	291 <para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	292 If <literal>options</literal> is a string, then it
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	293 holds the subrequest arguments string.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	294 Otherwise, <literal>options</literal> is expected to be
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	295 an object with the following keys:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	296 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	297 <tag-name><literal>args</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	298 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	299 arguments string, by default an empty string is used
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	300 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	301 <tag-name><literal>body</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	302 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	303 request body,
ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	304 by default the request body of the parent request object is used
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	305 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	306
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	307 <tag-name><literal>method</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	308 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	309 HTTP method, by default the <literal>GET</literal> method is used
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	310 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	311
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	312 <tag-name><literal>detached</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	313 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	314 boolean flag (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>),
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	315 if <literal>true</literal>, the created subrequest is a detached subrequest.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	316 Responses to detached subrequests are ignored.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	317 Unlike ordinary subrequests, a detached subrequest
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	318 can be created inside a variable handler.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	319 The detached flag and callback argument are mutually exclusive.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	320 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	321
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	322 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	323 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	324
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	325 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	326 The completion <literal>callback</literal> receives
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	327 a subrequest response object with methods and properties
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	328 identical to the parent request object.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	329 </para>
2484 2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	330
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	331 <para>
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	332 Since <link doc="changes.xml" id="njs0.3.8">0.3.8</link>,
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	333 if a <literal>callback</literal> is not provided,
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	334 the <literal>Promise</literal> object
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	335 that resolves to the subrequest response object is returned.
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	336 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	337 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	338
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	339 <tag-name id="r_uri"><literal>r.uri</literal></tag-name>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	340 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	341 current <link doc="../http/ngx_http_core_module.xml" id="var_uri">URI</link>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	342 in request,
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	343 <link doc="../http/ngx_http_core_module.xml" id="location">normalized</link>,
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	344 read-only
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	345 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	346
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	347 <tag-name id="r_variables"><literal>r.variables{}</literal></tag-name>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	348 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	349 nginx variables object,
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	350 writable (since <link doc="changes.xml" id="njs0.2.8">0.2.8</link>)
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	351 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	352
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	353 <tag-name id="r_warn"><literal>r.warn(<value>string</value>)</literal></tag-name>
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	354 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	355 writes a <literal>string</literal> to the error log
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	356 on the <literal>warning</literal> level of logging
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	357 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	358
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	359 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	360 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	361
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	362 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	363
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	364
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	365 <section id="stream" name="Stream Session">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	366
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	367 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	368 The stream session object is available only in the
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	369 <link doc="../stream/ngx_stream_js_module.xml">ngx_stream_js_module</link>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	370 module.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	371 All string properties of the object are <link id="string">byte strings</link>.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	372 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	373
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	374 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	375 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	376
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	377 <tag-name id="s_allow"><literal>s.allow()</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	378 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	379 successfully finalizes the phase handler
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	380 (<link doc="changes.xml" id="njs0.2.4">0.2.4</link>)
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	381 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	382
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	383 <tag-name id="s_decline"><literal>s.decline()</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	384 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	385 finalizes the phase handler and passes control to the next handler
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	386 (<link doc="changes.xml" id="njs0.2.4">0.2.4</link>)
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	387 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	388
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	389 <tag-name id="s_deny"><literal>s.deny()</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	390 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	391 finalizes the phase handler with the access error code
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	392 (<link doc="changes.xml" id="njs0.2.4">0.2.4</link>)
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	393 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	394
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	395 <tag-name id="s_done"><literal>s.done</literal>(<value>[code]</value>)</tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	396 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	397 successfully finalizes the current phase handler
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	398 or finalizes it with the specified numeric code
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	399 (<link doc="changes.xml" id="njs0.2.4">0.2.4</link>).
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	400 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	401
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	402 <tag-name id="s_error"><literal>s.error(<value>string</value>)</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	403 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	404 writes a sent <literal>string</literal> to the error log
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	405 on the <literal>error</literal> level of logging
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	406 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	407
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	408 <tag-name id="s_log"><literal>s.log(<value>string</value>)</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	409 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	410 writes a sent <value>string</value> to the error log
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	411 on the <literal>info</literal> level of logging
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	412 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	413
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	414 <tag-name id="s_off"><literal>s.off(<value>eventName</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	415 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	416 unregisters the callback set by the <link id="s_on">s.on()</link> method
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	417 (<link doc="changes.xml" id="njs0.2.4">0.2.4</link>)
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	418 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	419
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	420 <tag-name id="s_on"><literal>s.on(<value>event</value>,
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	421 <value>callback</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	422 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	423 registers a <literal>callback</literal> for the specified <literal>event</literal>
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	424 (<link doc="changes.xml" id="njs0.2.4">0.2.4</link>).
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	425
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	426 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	427 An <literal>event</literal> may be one of the following strings:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	428 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	429 <tag-name><literal>upload</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	430 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	431 new data from a client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	432 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	433
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	434 <tag-name><literal>download</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	435 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	436 new data to a client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	437 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	438
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	439 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	440 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	441
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	442 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	443 The completion callback has the following prototype:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	444 <literal>callback(data, flags)</literal>, where
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	445 <literal>data</literal> is string,
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	446 <literal>flags</literal> is an object
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	447 with the following properties:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	448 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	449 <tag-name id="s_on_callback_last"><literal>last</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	450 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	451 a boolean value, true if data is a last buffer.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	452 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	453
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	454 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	455 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	456 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	457
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	458 <tag-name id="s_remote_address"><literal>s.remoteAddress</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	459 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	460 client address, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	461 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	462
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	463 <tag-name id="s_send"><literal>s.send(<value>data</value>[,
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	464 <value>options</value>])</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	465 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	466 sends the data to the client
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	467 (<link doc="changes.xml" id="njs0.2.4">0.2.4</link>).
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	468 The <literal>options</literal> is an object used
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	469 to override nginx buffer flags derived from an incoming data chunk buffer.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	470 The flags can be overriden with the following flags:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	471 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	472 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	473
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	474 <tag-name><literal>last</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	475 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	476 boolean, true if the buffer is the last buffer
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	477 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	478
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	479 <tag-name><literal>flush</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	480 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	481 boolean, true if the buffer should have the <literal>flush</literal> flag
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	482 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	483 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	484 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	485 The method can be called multiple times per callback invocation.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	486 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	487
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	488 <tag-name id="s_variables"><literal>s.variables{}</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	489 <tag-desc>
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	490 nginx variables object, writable
39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	491 (since <link doc="changes.xml" id="njs0.2.8">0.2.8</link>)
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	492 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	493
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	494 <tag-name id="s_warn"><literal>s.warn(<value>string</value>)</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	495 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	496 writes a sent <literal>string</literal> to the error log
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	497 on the <literal>warning</literal> level of logging
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	498 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	499
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	500 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	501 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	502
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	503 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	504
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	505 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	506
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	507
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	508 <section id="core" name="Core">
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	509
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	510
2405 dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	511 <section id="core_global" name="Global">
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	512
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	513
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	514 <section id="process" name="Process">
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	515
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	516 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	517 The <literal>process</literal> object is a global object
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	518 that provides information about the current process
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	519 (<link doc="changes.xml" id="njs0.3.3">0.3.3</link>).
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	520 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	521
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	522
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	523 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	524 <list type="tag">
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	525
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	526 <tag-name id="process_argv"><literal>process.argv</literal></tag-name>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	527 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	528 Returns an array that contains the command line arguments
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	529 passed when the current process was launched.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	530 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	531
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	532 <tag-name id="process_env"><literal>process.env</literal></tag-name>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	533 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	534 Returns an object containing the user environment.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	535 <note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	536 By default, nginx removes all environment variables inherited
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	537 from its parent process except the TZ variable.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	538 Use the <link doc="../ngx_core_module.xml" id="env"/> directive
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	539 to preserve some of the inherited variables.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	540 </note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	541 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	542
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	543 <tag-name id="process_pid"><literal>process.pid</literal></tag-name>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	544 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	545 Returns the PID of the current process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	546 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	547
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	548 <tag-name id="process_ppid"><literal>process.ppid</literal></tag-name>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	549 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	550 Returns the PID of the current parent process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	551 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	552
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	553 </list>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	554 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	555
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	556 </section>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	557
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	558 </section>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	559
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	560
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	561 <section id="string" name="String">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	562
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	563 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	564 There are two types of strings in njs: a Unicode string (default) and
ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	565 a byte string.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	566 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	567
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	568 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	569 A Unicode string corresponds to an ECMAScript string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	570 which contains Unicode characters.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	571 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	572
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	573 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	574 Byte strings contain a sequence of bytes
ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	575 and are used to serialize Unicode strings
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	576 to external data and deserialize from external sources.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	577 For example, the <link id="string_toutf8">toUTF8()</link> method serializes
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	578 a Unicode string to a byte string using UTF8 encoding:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	579 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	580 >> '£'.toUTF8().toString('hex')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	581 'c2a3' /* C2 A3 is the UTF8 representation of 00A3 ('£') code point */
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	582 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	583 The <link id="string_tobytes">toBytes()</link> method serializes
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	584 a Unicode string with code points up to 255 into a byte string,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	585 otherwise, <literal>null</literal> is returned:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	586 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	587 >> '£'.toBytes().toString('hex')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	588 'a3' /* a3 is a byte equal to 00A3 ('£') code point */
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	589 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	590 Only byte strings can be converted to different encodings.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	591 For example, a string cannot be encoded to <literal>hex</literal> directly:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	592 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	593 >> 'αβγδ'.toString('base64')
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	594 TypeError: argument must be a byte string
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	595 at String.prototype.toString (native)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	596 at main (native)
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	597 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	598 To convert a Unicode string to hex,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	599 first, it should be converted to a byte string and then to hex:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	600 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	601 >> 'αβγδ'.toUTF8().toString('base64')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	602 'zrHOss6zzrQ='
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	603 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	604
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	605 <list type="tag">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	606
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	607 <tag-name id="string_bytesfrom"><literal>String.bytesFrom(<value>array</value>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	608 \| <value>string</value>, <value>encoding</value>)</literal></tag-name>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	609 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	610 Creates a byte string either from an array that contains octets,
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	611 or from an encoded string
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	612 (<link doc="changes.xml" id="njs0.2.3">0.2.3</link>).
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	613 The encoding can be
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	614 <literal>hex</literal>,
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	615 <literal>base64</literal>, and
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	616 <literal>base64url</literal>.
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	617 <example>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	618 >> String.bytesFrom([0x62, 0x75, 0x66, 0x66, 0x65, 0x72])
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	619 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	620
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	621 >> String.bytesFrom('YnVmZmVy', 'base64')
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	622 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	623 </example>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	624 </tag-desc>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	625
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	626 <tag-name id="string_frombytes"><literal>String.prototype.fromBytes(<value>start</value>[,
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	627 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	628 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	629 Returns a new Unicode string from a byte string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	630 where each byte is replaced with a corresponding Unicode code point.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	631 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	632
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	633 <tag-name id="string_fromutf8"><literal>String.prototype.fromUTF8(<value>start</value>[,
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	634 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	635 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	636 Converts a byte string containing a valid UTF8 string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	637 into a Unicode string,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	638 otherwise <literal>null</literal> is returned.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	639 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	640
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	641 <tag-name id="string_tobytes"><literal>String.prototype.toBytes(start[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	642 end])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	643 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	644 Serializes a Unicode string to a byte string.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	645 Returns <literal>null</literal> if a character larger than 255 is
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	646 found in the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	647 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	648
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	649 <tag-name id="string_tostring"><literal>String.prototype.toString([<value>encoding</value>])</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	650 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	651 <para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	652 If no <literal>encoding</literal> is specified,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	653 returns a specified Unicode string or byte string as in ECMAScript.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	654 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	655
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	656 <para>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	657 If <literal>encoding</literal> is specified,
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	658 encodes a <link id="string_tobytes">byte string</link> to
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	659 <literal>hex</literal>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	660 <literal>base64</literal>, or
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	661 <literal>base64url</literal>.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	662 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	663 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	664 >> 'αβγδ'.toUTF8().toString('base64url')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	665 'zrHOss6zzrQ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	666 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	667 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	668
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	669 <tag-name id="string_toutf8"><literal>String.prototype.toUTF8(<value>start</value>[,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	670 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	671 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	672 Serializes a Unicode string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	673 to a byte string using UTF8 encoding.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	674 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	675 >> 'αβγδ'.toUTF8().length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	676 8
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	677 >> 'αβγδ'.length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	678 4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	679 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	680 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	681
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	682 </list>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	683 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	684
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	685 </section>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	686
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	687
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	688 <section id="crypto" name="Crypto">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	689
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	690 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	691 The Crypto module provides cryptographic functionality support.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	692 The Crypto module object is returned by <literal>require('crypto')</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	693 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	694
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	695 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	696 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	697
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	698 <tag-name id="crypto_createhash"><literal>crypto.createHash(<value>algorithm</value>)</literal></tag-name>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	699 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	700 Creates and returns a <link id="crypto_hash">Hash</link> object
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	701 that can be used to generate hash digests
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	702 using the given <value>algorithm</value>.
2496 9dddac1420fe Fixed typo in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2484 diff changeset	703 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	704 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	705 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	706 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	707 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	708
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	709 <tag-name id="crypto_createhmac"><literal>crypto.createHmac(<value>algorithm</value>,
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	710 <value>secret key</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	711 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	712 Creates and returns an <link id="crypto_hmac">HMAC</link> object
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	713 that uses the given <value>algorithm</value> and <value>secret key</value>.
2496 9dddac1420fe Fixed typo in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2484 diff changeset	714 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	715 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	716 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	717 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	718 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	719
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	720 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	721 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	722
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	723
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	724 <section id="crypto_hash" name="Hash">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	725
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	726 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	727 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	728
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	729 <tag-name><literal>hash.update(<value>data</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	730 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	731 Updates the hash content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	732 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	733
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	734 <tag-name><literal>hash.digest([<value>encoding</value>])</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	735 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	736 Calculates the digest of all of the data passed using
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	737 <literal>hash.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	738 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	739 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	740 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	741 <literal>base64url</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	742 If encoding is not provided, a byte string is returned.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	743 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	744
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	745 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	746 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	747
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	748 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	749 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	750 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	751 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	752
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	753 >> cr.createHash('sha1').update('A').update('B').digest('base64url')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	754 'BtlFlCqiamG-GMPiK_GbvKjdK10'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	755 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	756 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	757
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	758 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	759
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	760
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	761 <section id="crypto_hmac" name="HMAC">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	762
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	763 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	764 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	765
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	766 <tag-name><literal>hmac.update(<value>data</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	767 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	768 Updates the HMAC content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	769 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	770
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	771 <tag-name><literal>hmac.digest([<value>encoding</value>])</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	772 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	773 Calculates the HMAC digest of all of the data passed using
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	774 <literal>hmac.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	775 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	776 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	777 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	778 <literal>base64url</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	779 If encoding is not provided, a byte string is returned.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	780 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	781 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	782 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	783
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	784 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	785 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	786 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	787 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	788
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	789 >> cr.createHmac('sha1', 'secret.key').update('AB').digest('base64url')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	790 'Oglm93xn23_MkiaEq_e9u8zk374'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	791 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	792 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	793
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	794 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	795
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	796 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	797
2203 56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	798 <section id="njs_api_timers" name="Timers">
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	799
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	800 <para>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	801
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	802 <list type="tag">
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	803
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	804 <tag-name id="cleartimeout"><literal>clearTimeout(<value>timeout</value>)</literal></tag-name>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	805 <tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	806 Cancels a <literal>timeout</literal> object
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	807 created by <link id="settimeout">setTimeout()</link>.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	808 </tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	809
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	810 <tag-name id="settimeout"><literal>setTimeout(<value>function</value>,
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	811 <value>ms</value>[, <value>arg1</value>, <value>argN</value>])</literal></tag-name>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	812 <tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	813 Calls a <literal>function</literal>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	814 after a specified number of <literal>milliseconds</literal>.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	815 One or more optional <literal>arguments</literal>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	816 can be passed to the specified function.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	817 Returns a <literal>timeout</literal> object.
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	818 <example>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	819 function handler(v)
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	820 {
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	821 // ...
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	822 }
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	823
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	824 t = setTimeout(handler, 12);
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	825
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	826 // ...
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	827
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	828 clearTimeout(t);
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	829 </example>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	830 </tag-desc>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	831
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	832 </list>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	833 </para>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	834
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	835 </section>
56a8cfb422ae Added setTimeout and clearTimeout for njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2202 diff changeset	836
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	837
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	838 <section id="njs_api_fs" name="File System">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	839
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	840 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	841 The File System module provides operations with files.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	842 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	843
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	844 <para>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	845 The module object is returned by <literal>require('fs')</literal>.
2508 d3d5b67a1462 Language fixes in njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2507 diff changeset	846 Since <link doc="changes.xml" id="njs0.3.9">0.3.9</link>,
d3d5b67a1462 Language fixes in njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2507 diff changeset	847 promissified versions of file system methods are available through
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	848 <literal>require('fs').promises</literal> object:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	849 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	850 > var fs = require('fs').promises;
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	851 undefined
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	852 > fs.readFile("/file/path").then((data)=>console.log(data))
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	853 <file data>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	854 </example>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	855 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	856
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	857 <tag-name id="fs_accesssync"><literal>accessSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	858 <value>mode</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	859 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	860 Synchronously tests permissions for a file or directory
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	861 specified in the <literal>path</literal>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	862 (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>).
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	863 If the check fails, an error will be returned,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	864 otherwise, the method will return undefined.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	865 <list type="tag">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	866
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	867 <tag-name><literal>mode</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	868 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	869 by default is <link id="access_const"><literal>fs.constants.F_OK</literal></link>.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	870 The mode argument is an optional integer
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	871 that specifies the accessibility checks to be performed.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	872 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	873 try {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	874 fs.accessSync('/file/path', fs.constants.R_OK \| fs.constants.W_OK);
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	875 console.log('has access');
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	876 } catch (e) {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	877 console.log('no access');)
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	878 }
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	879 </example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	880 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	881
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	882 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	883 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	884
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	885 <tag-name id="fs_appendfilesync"><literal>appendFileSync(<value>filename</value>,
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	886 <value>data</value>[, <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	887 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	888 Synchronously appends specified <literal>data</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	889 to a file with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	890 If the file does not exist, it will be created.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	891 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	892 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	893 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	894
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	895 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	896 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	897 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	898 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	899
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	900 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	901 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	902 file system <link id="njs_api_fs_flags">flag</link>,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	903 by default is <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	904 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	905
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	906 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	907 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	908
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	909 <tag-name id="fs_mkdirsync"><literal>mkdirSync(<value>path</value>[,
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	910 <value>options</value>])</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	911 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	912 Synchronously creates a directory at the specified <literal>path</literal>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	913 (<link doc="changes.xml" id="njs0.4.2">0.4.2</link>).
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	914 The <literal>options</literal> parameter is expected to be an
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	915 <literal>integer</literal> that specifies
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	916 the <link id="fs_mkdirsync_mode">mode</link>,
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	917 or an object with the following keys:
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	918 <list type="tag">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	919
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	920 <tag-name id="fs_mkdirsync_mode"><literal>mode</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	921 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	922 mode option, by default is <literal>0o777</literal>.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	923 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	924
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	925 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	926 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	927
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	928 <tag-name id="fs_readdirsync"><literal>readdirSync(<value>path</value>[,
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	929 <value>options</value>])</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	930 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	931 Synchronously reads the contents of a directory
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	932 at the specified <literal>path</literal>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	933 (<link doc="changes.xml" id="njs0.4.2">0.4.2</link>).
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	934 The <literal>options</literal> parameter is expected to be
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	935 a string that specifies <link id="fs_readdirsync_encoding">encoding</link>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	936 or an object with the following keys:
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	937 <list type="tag">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	938
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	939 <tag-name id="fs_readdirsync_encoding"><literal>encoding</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	940 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	941 encoding, by default is not specified.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	942 The encoding can be <literal>utf8</literal>.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	943 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	944
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	945 <tag-name id="fs_readdirsync_withfiletypes"><literal>withFileTypes</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	946 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	947 if set to <literal>true</literal>, the files array will contain
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	948 <link id="fs_dirent"><literal>fs.Dirent</literal></link> objects,
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	949 by default is <literal>false</literal>.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	950 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	951
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	952 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	953 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	954
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	955 <tag-name id="fs_readfilesync"><literal>readFileSync(<value>filename</value>[,
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	956 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	957 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	958 Synchronously returns the contents of the file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	959 with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	960 The <literal>options</literal> parameter holds
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	961 <literal>string</literal> that specifies encoding.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	962 If not specified, a <link id="string_tobytes">byte string</link> is returned.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	963 If <literal>utf8</literal> encoding is specified, a Unicode string is returned.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	964 Otherwise, <literal>options</literal> is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	965 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	966 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	967
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	968 <tag-name><literal>encoding</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	969 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	970 encoding, by default is not specified.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	971 The encoding can be <literal>utf8</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	972 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	973
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	974 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	975 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	976 file system <link id="njs_api_fs_flags">flag</link>,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	977 by default is <literal>r</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	978 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	979
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	980 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	981 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	982 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	983 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	984 >> var file = fs.readFileSync('/file/path.tar.gz')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	985 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	986 >> var gzipped = /^\x1f\x8b/.test(file); gzipped
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	987 true
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	988 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	989 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	990
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	991 <tag-name id="fs_realpathsync"><literal>realpathSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	992 <value>options</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	993 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	994 Synchronously computes the canonical pathname by resolving
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	995 <literal>.</literal>, <literal>..</literal> and symbolic links using
2508 d3d5b67a1462 Language fixes in njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2507 diff changeset	996 <link url="http://man7.org/linux/man-pages/man3/realpath.3.html">realpath(3)</link>.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	997 The <literal>options</literal> argument can be a string specifying an encoding,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	998 or an object with an encoding property specifying the character encoding
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	999 to use for the path passed to the callback
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1000 (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>).
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1001 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1002
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1003 <tag-name id="fs_renamesync"><literal>renameSync(<value>oldPath</value>,
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1004 <value>newPath</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1005 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1006 Synchronously changes the name or location of a file from
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1007 <literal>oldPath</literal> to <literal>newPath</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1008 (<link doc="changes.xml" id="njs0.3.4">0.3.4</link>).
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1009 <example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1010 >> var fs = require('fs')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1011 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1012 >> var file = fs.renameSync('hello.txt', 'HelloWorld.txt')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1013 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1014 </example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1015 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1016
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1017 <tag-name id="fs_rmdirsync"><literal>rmdirSync(<value>path</value>)</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1018 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1019 Synchronously removes a directory at the specified <literal>path</literal>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1020 (<link doc="changes.xml" id="njs0.4.2">0.4.2</link>).
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1021 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1022
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1023 <tag-name id="fs_symlinksync"><literal>symlinkSync(<value>target</value>,
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1024 <value>path</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1025 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1026 Synchronously creates the link called <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1027 pointing to <literal>target</literal> using
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1028 <link url="http://man7.org/linux/man-pages/man2/symlink.2.html">symlink(2)</link>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1029 (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>).
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1030 Relative targets are relative to the link’s parent directory.
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1031 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1032
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1033 <tag-name id="fs_unlinksync"><literal>unlinkSync(<value>path</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1034 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1035 Synchronously unlinks a file by <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1036 (<link doc="changes.xml" id="njs0.3.9">0.3.9</link>).
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1037 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	1038
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	1039 <tag-name id="fs_writefilesync"><literal>writeFileSync(<value>filename</value>,
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1040 <value>data</value>[,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1041 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1042 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1043 Synchronously writes <literal>data</literal> to a file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1044 with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1045 If the file does not exist, it will be created,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1046 if the file exists, it will be replaced.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1047 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1048 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1049 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1050 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1051 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1052 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1053 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1054
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1055 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1056 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1057 file system <link id="njs_api_fs_flags">flag</link>,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1058 by default is <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1059 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1060
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1061 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1062 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1063 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1064 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1065 >> var file = fs.writeFileSync('hello.txt', 'Hello world')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1066 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1067 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1068 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1069
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1070 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1071 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1072
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1073
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1074 <section id="fs_dirent" name="fs.Dirent">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1075
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1076 <para>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1077 <literal>fs.Dirent</literal> is a representation of a directory entry—
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1078 a file or a subdirectory.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1079 When
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1080 <link id="fs_readdirsync"><literal>readdirSync()</literal></link>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1081 is called with the
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1082 <link id="fs_readdirsync_withfiletypes"><literal>withFileTypes</literal></link>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1083 option,
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1084 the resulting array contains <literal>fs.Dirent</literal> objects.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1085
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1086 <list type= "bullet" compact="no">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1087
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1088 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1089 <literal>dirent.isBlockDevice()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1090 <literal>true</literal> if the <literal>fs.Dirent</literal> object describes
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1091 a block device.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1092 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1093
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1094 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1095 <literal>dirent.isCharacterDevice()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1096 <literal>true</literal> if the <literal>fs.Dirent</literal> object describes
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1097 a character device.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1098 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1099
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1100 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1101 <literal>dirent.isDirectory()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1102 <literal>true</literal> if the <literal>fs.Dirent</literal> object describes
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1103 a file system directory.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1104 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1105
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1106 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1107 <literal>dirent.isFIFO()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1108 <literal>true</literal> if the <literal>fs.Dirent</literal> object describes
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1109 a first-in-first-out (FIFO) pipe.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1110 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1111
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1112 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1113 <literal>dirent.isFile()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1114 <literal>true</literal> if the <literal>fs.Dirent</literal> object describes
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1115 a regular file.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1116 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1117
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1118 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1119 <literal>dirent.isSocket()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1120 <literal>true</literal> if the <literal>fs.Dirent</literal> object describes
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1121 a socket.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1122 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1123
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1124 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1125 <literal>dirent.isSymbolicLink()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1126 <literal>true</literal> if the <literal>fs.Dirent</literal> object describes
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1127 a symbolic link.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1128 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1129
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1130 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1131 <literal>dirent.name</literal>—
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1132 the name of the file <literal>fs.Dirent</literal> object refers to.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1133 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1134
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1135 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1136 </para>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1137
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1138 </section>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1139
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	1140
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1141 <section id="access_const" name="File Access Constants">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1142
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1143 <para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1144 The <link id="fs_accesssync"><literal>access()</literal></link> method
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1145 can accept the following flags.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1146 These flags are exported by <literal>fs.constants</literal>:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1147
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1148 <list type= "bullet" compact="no">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1149
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1150 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1151 <literal>F_OK</literal>—indicates that the file
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1152 is visible to the calling process,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1153 used by default if no mode is specified
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1154 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1155
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1156 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1157 <literal>R_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1158 read by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1159 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1160
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1161 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1162 <literal>W_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1163 written by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1164 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1165
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1166 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1167 <literal>X_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1168 executed by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1169 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1170
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1171 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1172 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1173
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1174 </section>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1175
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1176
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1177 <section id="njs_api_fs_flags" name="File System Flags">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1178
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1179 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1180 The <literal>flag</literal> option can accept the following values:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1181
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1182 <list type= "bullet" compact="no">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1183
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1184 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1185 <literal>a</literal>—open a file for appending.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1186 The file is created if it does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1187 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1188
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1189 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1190 <literal>ax</literal>—the same as <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1191 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1192 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1193
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1194 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1195 <literal>a+</literal>—open a file for reading and appending.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1196 If the file does not exist, it will be created
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1197 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1198
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1199 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1200 <literal>ax+</literal>—the same as <literal>a+</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1201 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1202 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1203
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1204 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1205 <literal>as</literal>—open a file for appending in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1206 If the file does not exist, it will be created
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1207 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1208
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1209 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1210 <literal>as+</literal>—open a file for reading and appending
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1211 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1212 If the file does not exist, it will be created
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1213 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1214
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1215 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1216 <literal>r</literal>—open a file for reading.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1217 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1218 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1219
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1220 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1221 <literal>r+</literal>—open a file for reading and writing.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1222 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1223 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1224
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1225 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1226 <literal>rs+</literal>—open a file for reading and writing
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1227 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1228 Instructs the operating system to bypass the local file system cache
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1229 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1230
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1231 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1232 <literal>w</literal>—open a file for writing.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1233 If the file does not exist, it will be created.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1234 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1235 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1236
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1237 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1238 <literal>wx</literal>—the same as <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1239 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1240 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1241
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1242 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1243 <literal>w+</literal>—open a file for reading and writing.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1244 If the file does not exist, it will be created.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1245 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1246 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1247
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1248 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1249 <literal>wx+</literal>—the same as <literal>w+</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1250 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1251 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1252
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1253 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1254 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1255
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1256 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1257
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1258 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1259
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1260 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	1261
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1262 </article>

Mercurial > hg > nginx-site

annotate xml/en/docs/njs/reference.xml @ 2570:44792f1ee284