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

annotate xml/en/docs/njs/reference.xml @ 2687:7ff9d8bda757

Revised TOC in njs Reference. Capitalization rules for njs Reference TOC: - names of classes are capitalized - names of global objects are not capitalized

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Fri, 19 Mar 2021 18:24:34 +0000
parents	5282d6d3d849
children	dd2bbd104146

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"
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	12 rev="70">
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
2663 a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	53 <tag-name id="r_done"><literal>r.done()</literal></tag-name>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	54 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	55 after calling this function,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	56 next data chunks will be passed to client without calling
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	57 <link doc="../http/ngx_http_js_module.xml" id="js_body_filter"/>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	58 (<link doc="changes.xml" id="njs0.5.2">0.5.2</link>).
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	59 May be called only from the
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	60 <link doc="../http/ngx_http_js_module.xml" id="js_body_filter"/> function
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	61 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	62
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	63 <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	64 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	65 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	66 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	67 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	68
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	69 <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	70 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	71 finishes sending a response to the client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	72 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	73
2353 21f3a93fbe97 njs-0.3.0 Yaroslav Zhuravlev <yar@nginx.com> parents: 2348 diff changeset	74 <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	75 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	76 incoming headers object, read-only.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	77 <para>
2543 f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	78 The <literal>Foo</literal> request header
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	79 can be accessed with the syntax:
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	80 <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	81 </para>
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	82
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	83 <para>
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	84 The
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	85 <header>Authorization</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	86 <header>Content-Length</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	87 <header>Content-Range</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	88 <header>Content-Type</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	89 <header>ETag</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	90 <header>Expect</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	91 <header>From</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	92 <header>Host</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	93 <header>If-Match</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	94 <header>If-Modified-Since</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	95 <header>If-None-Match</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	96 <header>If-Range</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	97 <header>If-Unmodified-Since</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	98 <header>Max-Forwards</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	99 <header>Proxy-Authorization</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	100 <header>Referer</header>,
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	101 <header>Transfer-Encoding</header>, and
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	102 <header>User-Agent</header>
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	103 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	104 (<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	105 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	106 are separated by semicolon (<literal>;</literal>).
f39c4724c0f8 Described multi-value headers in r.headersIn. Yaroslav Zhuravlev <yar@nginx.com> parents: 2537 diff changeset	107 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	108 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	109 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	110
2331 5eba0f7b24a9 njs-0.2.8 Yaroslav Zhuravlev <yar@nginx.com> parents: 2315 diff changeset	111 <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	112 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	113 outgoing headers object, writable.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	114 <para>
2532 423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	115 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	116 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	117 <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	118 </para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	119
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	120 <para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	121 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	122 (<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	123 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	124 <example>
2544 33347df1da9c Relocated sentence in r.headers.Out, added dot, corrected quotes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2543 diff changeset	125 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	126 </example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	127 where the output will be:
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	128 <example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	129 Foo: a
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	130 Foo: b
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	131 </example>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	132 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	133 will be deleted.
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	134 </para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	135
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	136 <para>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	137 For standard response headers
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	138 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	139 <header>Content-Type</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	140 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	141 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	142 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	143 Duplicate field values in
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	144 <header>Age</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	145 <header>Content-Encoding</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	146 <header>Content-Length</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	147 <header>Content-Type</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	148 <header>ETag</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	149 <header>Expires</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	150 <header>Last-Modified</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	151 <header>Location</header>,
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	152 <header>Retry-After</header>
423d813dc8bb Documented support for multi-value headers in r.headersOut. Yaroslav Zhuravlev <yar@nginx.com> parents: 2525 diff changeset	153 response headers are ignored.
2537 d6bbfd20c82f Rephrased a sentence in r.headersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2532 diff changeset	154 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	155 are separated by commas.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	156 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	157 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	158
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	159 <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	160 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	161 HTTP version, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	162 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	163
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	164 <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	165 <tag-desc>
2685 5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	166 performs an
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	167 <link doc="../dev/development_guide.xml" id="http_request_redirection">internal
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	168 redirect</link>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	169 to the specified <literal>uri</literal>.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	170 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	171 it is considered a named location.
2685 5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	172 Redirected requests become internal and can access the
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	173 <link doc="../http/ngx_http_core_module.xml" id="internal">internal</link>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	174 locations.
2525 6ce28e0beec0 Updated description of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2509 diff changeset	175 The actual redirect happens after the handler execution is completed.
2685 5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	176 <para>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	177 <note>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	178 After redirect,
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	179 a new njs VM is started in the target location,
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	180 the VM in the original location is stopped.
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	181 Values of nginx variables are kept
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	182 and can be used to pass information to the target location.
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	183 </note>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	184 </para>
5282d6d3d849 Improved descripion of r.internalRedirect in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2679 diff changeset	185
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	186 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	187
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	188 <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	189 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	190 writes a <literal>string</literal> to the error log
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	191 on the <literal>info</literal> level of logging
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	192 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	193
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	194 <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	195 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	196 HTTP method, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	197 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	198
2497 805c4b84cc61 Added missing feature and links to njs-0.3.8 Changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2496 diff changeset	199 <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	200 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	201 references the parent request object
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	202 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	203
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	204 <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	205 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	206 client address, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	207 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	208
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	209 <tag-name id="r_request_body"><literal>r.requestBody</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	210 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	211 the property is deprecated since
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	212 <link doc="changes.xml" id="njs0.5.0">0.5.0</link>,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	213 the <link id="r_request_buffer"><literal>r.requestBuffer</literal></link> or
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	214 <link id="r_request_text"><literal>r.requestText</literal></link> property
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	215 should be used instead.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	216 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	217
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	218 <tag-name id="r_request_buffer"><literal>r.requestBuffer</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	219 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	220 client request body if it has not been written to a temporary file
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	221 (since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>).
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	222 To ensure that the client request body is in memory,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	223 its size should be limited by
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	224 <link doc="../http/ngx_http_core_module.xml" id="client_max_body_size"/>,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	225 and a sufficient buffer size should be set using
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	226 <link doc="../http/ngx_http_core_module.xml" id="client_body_buffer_size"/>.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	227 The property is available only in the
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	228 <link doc="../http/ngx_http_js_module.xml" id="js_content"/> directive.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	229 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	230
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	231 <tag-name id="r_request_text"><literal>r.requestText</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	232 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	233 the same as <link id="r_request_buffer"><literal>r.requestBuffer</literal></link>,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	234 but returns a <literal>string</literal>.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	235 Note that
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	236 it may convert bytes invalid in utf8 encoding into the replacement character.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	237 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	238
2546 6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	239 <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	240 <tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	241 returns an array of key-value pairs
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	242 exactly as they were received from the client
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	243 (<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	244 <para>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	245 For example, with the following request headers:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	246 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	247 Host: localhost
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	248 Foo: bar
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	249 foo: bar2
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	250 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	251 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	252 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	253 [
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	254 ['Host', 'localhost'],
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	255 ['Foo', 'bar'],
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	256 ['foo', 'bar2']
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	257 ]
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	258 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	259 All <literal>foo</literal> headers
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	260 can be collected with the syntax:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	261 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	262 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	263 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	264 the output will be:
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	265 <example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	266 ['bar', 'bar2']
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	267 </example>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	268 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	269 duplicate field values are not merged.
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	270 </para>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	271 </tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	272
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	273 <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	274 <tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	275 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	276 (<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	277 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	278 duplicate field values are not merged.
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	279 </tag-desc>
6093e9f3615e Documented rawHeadersIn and rawHeadersOut in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2545 diff changeset	280
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	281 <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	282 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	283 the property is deprecated since
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	284 <link doc="changes.xml" id="njs0.5.0">0.5.0</link>,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	285 the <link id="r_response_buffer"><literal>r.responseBuffer</literal></link>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	286 or
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	287 the <link id="r_response_text"><literal>r.responseText</literal></link>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	288 property
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	289 should be used instead.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	290 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	291
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	292 <tag-name id="r_response_buffer"><literal>r.responseBuffer</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	293 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	294 holds the <link id="r_subrequest">subrequest</link> response body,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	295 read-only
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	296 (since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>).
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	297 The size of <literal>r.responseBuffer</literal> is limited by the
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	298 <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	299 directive.
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
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	302 <tag-name id="r_response_text"><literal>r.responseText</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	303 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	304 the same as <link id="r_response_buffer"><literal>r.responseBuffer</literal></link>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	305 but returns a string
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	306 (since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>).
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	307 Note that
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	308 it may convert bytes invalid in utf8 encoding into the replacement character.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	309 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	310
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	311 <tag-name id="r_return"><literal>r.return(status[,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	312 string \| Buffer])</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	313 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	314 sends the entire response
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	315 with the specified <literal>status</literal> to the client.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	316 The response can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	317 (<link doc="changes.xml" id="njs0.5.0">0.5.0</link>).
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	318 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	319 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	320 (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	321 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	322 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	323 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	324
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	325 <tag-name id="r_send"><literal>r.send(string
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	326 \| Buffer)</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	327 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	328 sends a part of the response body to the client.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	329 The data sent can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	330 (<link doc="changes.xml" id="njs0.5.0">0.5.0</link>)
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	331 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	332
2663 a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	333 <tag-name id="r_sendbuffer"><literal>r.sendBuffer(<value>data</value>[,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	334 <value>options</value>])</literal></tag-name>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	335 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	336 adds data to the chain of data chunks to be forwarded to the next body filter
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	337 (<link doc="changes.xml" id="njs0.5.2">0.5.2</link>).
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	338 The actual forwarding happens later,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	339 when the all the data chunks of the current chain are processed.
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	340 <para>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	341 The data can be a string or Buffer.
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	342 The <literal>options</literal> is an object used
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	343 to override nginx buffer flags derived from an incoming data chunk buffer.
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	344 The flags can be overridden with the following flags:
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	345 <list type="tag">
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	346
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	347 <tag-name><literal>last</literal></tag-name>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	348 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	349 boolean,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	350 true if the buffer is the last buffer
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	351 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	352
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	353 <tag-name><literal>flush</literal></tag-name>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	354 <tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	355 boolean,
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	356 true if the buffer should have the <literal>flush</literal> flag
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	357 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	358 </list>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	359 </para>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	360 The method may be called only from the
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	361 <link doc="../http/ngx_http_js_module.xml" id="js_body_filter"/> function.
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	362 </tag-desc>
a33d8f0f48b2 Documented r.done and r.sendBuffer in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2653 diff changeset	363
2571 3e47eecce384 Added id to r.sendHeader in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2570 diff changeset	364 <tag-name id="r_send_header"><literal>r.sendHeader()</literal></tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	365 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	366 sends the HTTP headers to the client
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	367 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	368
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	369 <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	370 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	371 status, writable
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	372 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	373
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	374 <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	375 <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	376 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	377 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	378 <literal>options</literal>, and installs
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	379 an optional completion <literal>callback</literal>.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	380
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	381 <para>
2340 537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	382 A
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	383 <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	384 shares its input headers with the client request.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	385 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	386 <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	387 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	388 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	389 <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	390 directive can be used.
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	391 </para>
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	392
537130c40c1f Updated r.subrequest desctiption in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2338 diff changeset	393 <para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	394 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	395 holds the subrequest arguments string.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	396 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	397 an object with the following keys:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	398 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	399 <tag-name><literal>args</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	400 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	401 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	402 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	403 <tag-name><literal>body</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	404 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	405 request body,
ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	406 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	407 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	408
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	409 <tag-name><literal>method</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	410 <tag-desc>
2344 ea8ccaac18b4 Added default values for r.subrequest options in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2340 diff changeset	411 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	412 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	413
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	414 <tag-name><literal>detached</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	415 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	416 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	417 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	418 Responses to detached subrequests are ignored.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	419 Unlike ordinary subrequests, a detached subrequest
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	420 can be created inside a variable handler.
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	421 The <literal>detached</literal> flag and callback argument
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	422 are mutually exclusive.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	423 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	424
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	425 </list>
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
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	428 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	429 The completion <literal>callback</literal> receives
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	430 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	431 identical to the parent request object.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	432 </para>
2484 2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	433
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	434 <para>
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	435 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	436 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	437 the <literal>Promise</literal> object
2aa02672d54f Added a note to r.subrequest in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2446 diff changeset	438 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	439 </para>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	440 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	441
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	442 <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	443 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	444 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	445 in request,
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	446 <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	447 read-only
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	448 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	449
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	450 <tag-name id="r_raw_variables"><literal>r.rawVariables{}</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	451 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	452 nginx <link id="r_variables">variables</link> as Buffers,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	453 writable
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	454 (since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>)
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	455 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	456
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	457 <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	458 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	459 nginx variables object, writable
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	460 (since <link doc="changes.xml" id="njs0.2.8">0.2.8</link>)
2545 dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	461 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	462
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	463 <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	464 <tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	465 writes a <literal>string</literal> to the error log
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	466 on the <literal>warning</literal> level of logging
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	467 </tag-desc>
dca5a7053a6c Sorted alphabetically njs http methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2544 diff changeset	468
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	469 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	470 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	471
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	472 </section>
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
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	475 <section id="stream" name="Stream Session">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	476
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	477 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	478 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	479 <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	480 module.
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	481 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	482 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	483
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 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	486
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	487 <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	488 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	489 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	490 <link id="s_done"><literal>s.done(0)</literal></link>
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	491 (<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	492 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	493
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	494 <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	495 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	496 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	497 <link id="s_done"><literal>s.done(-5)</literal></link>
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	498 (<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	499 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	500
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	501 <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	502 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	503 an alias to
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	504 <link id="s_done"><literal>s.done(403)</literal></link>
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	505 (<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	506 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	507
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	508 <tag-name id="s_done"><literal>s.done([<value>code</value>]</literal>)</tag-name>
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	509 <tag-desc>
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	510 sets an exit <literal>code</literal> for the current
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	511 <link doc="../stream/stream_processing.xml">phase</link> handler
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	512 to a code value, by default <literal>0</literal>.
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	513 The actual finalization happens when the js handler is completed
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	514 and all pending events, for example, from
2679 8f3e9ff2785f Corrected syntax of njs.on() and ngx.fetch() in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2670 diff changeset	515 <link id="ngx_fetch"><literal>ngx.fetch()</literal></link> or
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	516 <link id="settimeout"><literal>setTimeout()</literal></link>,
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	517 are processed
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	518 (<link doc="changes.xml" id="njs0.2.4">0.2.4</link>).
2670 e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	519 <para>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	520 Possible code values:
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	521 <list type="bullet">
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	522
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	523 <listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	524 <literal>0</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	525 successful finalization, passing control to the next phase
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	526 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	527
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	528 <listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	529 <literal>-5</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	530 undecided, passing control to the next handler of the current phase (if any)
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	531 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	532
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	533 <listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	534 <literal>403</literal>—
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	535 access is forbidden
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	536 </listitem>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	537
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	538 </list>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	539 </para>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	540 May be called only from a phase handler function:
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	541 <link doc="../stream/ngx_stream_js_module.xml" id="js_access"><literal>js_access</literal></link>
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	542 or
e53592a1d979 Improved descriptions of s.done, s.allow, s.decline, s.deny. Yaroslav Zhuravlev <yar@nginx.com> parents: 2668 diff changeset	543 <link doc="../stream/ngx_stream_js_module.xml" id="js_preread"><literal>js_preread</literal></link>.
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	544 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	545
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	546 <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	547 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	548 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	549 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	550 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	551
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	552 <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	553 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	554 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	555 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	556 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	557
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	558 <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	559 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	560 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	561 (<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	562 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	563
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	564 <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	565 <value>callback</value>)</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	566 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	567 registers a <literal>callback</literal>
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	568 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	569 (<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	570
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	571 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	572 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	573 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	574 <tag-name><literal>upload</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	575 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	576 new data (string) from a client
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	577 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	578
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	579 <tag-name><literal>download</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	580 <tag-desc>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	581 new data (string) to a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	582 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	583
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	584 <tag-name><literal>upstream</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	585 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	586 new data (Buffer) from a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	587 (since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>)
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	588 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	589
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	590 <tag-name><literal>downstream</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	591 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	592 new data (Buffer) to a client
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	593 (since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>)
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	594 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	595
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	596 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	597 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	598
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	599 <para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	600 The completion callback has the following prototype:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	601 <literal>callback(data, flags)</literal>, where
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	602 <literal>data</literal> is string or Buffer (depending on the event type)
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	603 <literal>flags</literal> is an object
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	604 with the following properties:
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	605 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	606 <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	607 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	608 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	609 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	610
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	611 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	612 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	613 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	614
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	615 <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	616 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	617 client address, read-only
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	618 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	619
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	620 <tag-name id="s_raw_variables"><literal>s.rawVariables</literal></tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	621 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	622 nginx <link id="s_variables">variables</link> as Buffers,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	623 writable
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	624 (since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>)
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	625 </tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	626
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	627 <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	628 <value>options</value>])</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	629 <tag-desc>
2667 2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	630 adds data to the chain of data chunks that will be forwarded in
2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	631 the forward direction:
2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	632 in download callback to a client; in upload to an upstream server
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	633 (<link doc="changes.xml" id="njs0.2.4">0.2.4</link>).
2667 2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	634 The actual forwarding happens later,
2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	635 when the all the data chunks of the current chain are processed.
2085eb315672 Updated description of s.send in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2666 diff changeset	636 <para>
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	637 The data can be a string or Buffer
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	638 (<link doc="changes.xml" id="njs0.5.0">0.5.0</link>).
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	639 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	640 to override nginx buffer flags derived from an incoming data chunk buffer.
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	641 The flags can be overridden with the following flags:
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	642 <list type="tag">
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	643
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	644 <tag-name><literal>last</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	645 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	646 boolean,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	647 true if the buffer is the last buffer
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	648 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	649
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	650 <tag-name><literal>flush</literal></tag-name>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	651 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	652 boolean,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	653 true if the buffer should have the <literal>flush</literal> flag
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	654 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	655 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	656 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	657 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	658 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	659
2665 529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	660 <tag-name id="s_status"><literal>s.status</literal></tag-name>
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	661 <tag-desc>
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	662 session status code, an alias to the
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	663 <link doc="../stream/ngx_stream_core_module.xml" id="var_status"><literal>$status</literal></link>
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	664 variable,
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	665 read only
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	666 (since <link doc="changes.xml" id="njs0.5.2">0.5.2</link>)
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	667 </tag-desc>
529114f1108a Documented s.status property in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2663 diff changeset	668
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	669 <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	670 <tag-desc>
2338 39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	671 nginx variables object, writable
39ac205f90b7 Documented that r.variables{} and s.variables{} are writable. Yaroslav Zhuravlev <yar@nginx.com> parents: 2337 diff changeset	672 (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	673 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	674
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	675 <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	676 <tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	677 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	678 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	679 </tag-desc>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	680
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	681 </list>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	682 </para>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	683
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	684 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	685
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	686
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	687 <section id="response" name="Response">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	688
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	689 <para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	690 The <literal>Response</literal> interface is available since
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	691 <link doc="changes.xml" id="njs0.5.1">0.5.1</link>.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	692
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	693 <list type="tag">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	694
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	695 <tag-name id="response_arraybuffer"><literal>arrayBuffer()</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	696 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	697 Takes a <literal>Response</literal> stream and reads it to completion.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	698 Returns a <literal>Promise</literal> that resolves with
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	699 an <literal>ArrayBuffer</literal>.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	700 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	701
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	702 <tag-name id="response_bodyused"><literal>bodyUsed</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	703 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	704 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	705 if the body was read.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	706 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	707
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	708 <tag-name id="response_headers"><literal>headers</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	709 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	710 The <literal>Headers</literal> read-only object associated with the
2668 e067ad74b0cd Corrected links to Response Object in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2667 diff changeset	711 <link id="response"><literal>Response</literal></link>:
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	712
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	713 <list type="tag">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	714
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	715 <tag-name id="headers_get"><literal>get(<value>name</value>)</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	716 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	717 returns a string containing the values of all headers with the specified name
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	718 separated by a comma and a space
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	719 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	720
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	721 <tag-name id="headers_getall"><literal>getAll(<value>name</value>)</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	722 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	723 returns an array containing the values of all headers with the specified name
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	724 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	725
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	726 <tag-name id="headers_has"><literal>has(<value>name</value>)</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	727 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	728 returns a boolean value
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	729 indicating whether a header with the specified name exists
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	730 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	731
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	732 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	733 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	734
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	735 <tag-name id="response_json"><literal>json()</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	736 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	737 Takes a <literal>Response</literal> stream and reads it to completion.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	738 Returns a <literal>Promise</literal> that resolves with
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	739 the result of parsing the body text as JSON.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	740 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	741
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	742 <tag-name id="response_ok"><literal>ok</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	743 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	744 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	745 if the response was successful (status codes between 200–299).
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	746 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	747
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	748 <tag-name id="response_redirect"><literal>redirected</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	749 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	750 A boolean value, <literal>true</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	751 if the response is the result of a redirect.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	752 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	753
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	754 <tag-name id="response_status"><literal>status</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	755 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	756 The status code of the response.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	757 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	758
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	759 <tag-name id="response_statustext"><literal>statusText</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	760 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	761 The status message corresponding to the status code.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	762 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	763
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	764 <tag-name id="response_text"><literal>text()</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	765 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	766 Takes a <literal>Response</literal> stream and reads it to completion.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	767 Returns a <literal>Promise</literal> that resolves with a string.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	768 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	769
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	770 <tag-name id="response_type"><literal>type</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	771 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	772 The type of the response.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	773 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	774
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	775 <tag-name id="response_url"><literal>url</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	776 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	777 The URL of the response.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	778 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	779
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	780 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	781 </para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	782
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	783 </section>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	784
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	785
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	786 <section id="ngx" name="ngx">
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	787
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	788 <para>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	789 The <literal>ngx</literal> global object is available
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	790 since <link doc="changes.xml" id="njs0.5.0">0.5.0</link>.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	791 <list type="tag">
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	792
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	793 <tag-name id="ngx_fetch"><literal>ngx.fetch(<value>url</value>,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	794 [<value>options</value>])</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	795 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	796 Makes a request to fetch an URL
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	797 (<link doc="changes.xml" id="njs0.5.1">0.5.1</link>),
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	798 returns a <literal>Promise</literal> that resolves with
2668 e067ad74b0cd Corrected links to Response Object in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2667 diff changeset	799 the <link id="response"><literal>Response</literal></link> object.
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	800 Only the <literal>http://</literal> scheme is supported,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	801 redirects are not handled.
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	802 <para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	803 The <literal>options</literal> parameter is expected to be an object
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	804 with the following keys:
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	805 <list type="tag">
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	806
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	807 <tag-name id="fetch_body"><literal>body</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	808 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	809 request body,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	810 by default is empty
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	811 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	812
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	813 <tag-name id="fetch_buffer_size"><literal>buffer_size</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	814 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	815 the buffer size for reading the response,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	816 by default is <literal>4096</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	817 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	818
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	819 <tag-name id="fetch_headers"><literal>headers</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	820 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	821 request headers object
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	822 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	823
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	824 <tag-name id="fetch_get"><literal>max_response_body_size</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	825 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	826 the maximum size of the response body in bytes,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	827 by default is <literal>32768</literal>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	828 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	829
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	830 <tag-name id="fetch_method"><literal>method</literal></tag-name>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	831 <tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	832 HTTP method,
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	833 by default the <literal>GET</literal> method is used
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	834 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	835
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	836 </list>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	837 Example:
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	838 <example>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	839 ngx.fetch('http://nginx.org/')
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	840 .then(reply => reply.text())
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	841 .then(body => r.return(200, body))
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	842 .catch(e => r.return(501, e.message))
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	843 </example>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	844 </para>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	845 </tag-desc>
9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	846
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	847 <tag-name id="ngx_log"><literal>ngx.log</literal>(<value>level</value>,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	848 <value>message</value>)</tag-name>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	849 <tag-desc>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	850 Writes a message to the error log with the specified level of logging.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	851 The <value>level</value> parameter specifies one of the log levels,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	852 the <value>message</value> parameter can be a string or Buffer.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	853 The following log levels can be specified:
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	854 <literal>ngx.INFO</literal>,
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	855 <literal>ngx.WARN</literal>, and
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	856 <literal>ngx.ERR</literal>.
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	857 </tag-desc>
2653 9fc25ea7a92c Documented ngx.fetch and Response interface in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2647 diff changeset	858
2628 0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	859 </list>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	860 </para>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	861
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	862 </section>
0ce45b4edb75 njs-0.5.0. Yaroslav Zhuravlev <yar@nginx.com> parents: 2612 diff changeset	863
2247 0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	864 </section>
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	865
0f16ef9a8dbe Created "nginx objects" section in reference.xml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2246 diff changeset	866
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	867 <section id="builtin_objects" name="built-in objects">
2405 dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	868
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	869
2666 68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	870 <section id="njs" name="njs">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	871
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	872 <para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	873 The <literal>njs</literal> object is a global object
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	874 that represents the current VM instance
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	875 (since <link doc="changes.xml" id="njs0.2.0">0.2.0</link>).
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	876 </para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	877
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	878 <para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	879 <list type="tag">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	880
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	881 <tag-name id="njs_version"><literal>njs.version</literal></tag-name>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	882 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	883 Returns a string with the current version of njs
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	884 (for example, “0.5.2”).
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	885 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	886
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	887 <tag-name id="njs_dump"><literal>njs.dump(<value>value</value>)</literal></tag-name>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	888 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	889 Returns the pretty-print string representation for a value.
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	890 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	891
2679 8f3e9ff2785f Corrected syntax of njs.on() and ngx.fetch() in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2670 diff changeset	892 <tag-name id="njs_on"><literal>njs.on(<value>event</value>,
8f3e9ff2785f Corrected syntax of njs.on() and ngx.fetch() in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2670 diff changeset	893 <value>callback</value>)</literal></tag-name>
2666 68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	894 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	895 Registers a callback for the specified VM event
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	896 (since <link doc="changes.xml" id="njs0.5.2">0.5.2</link>).
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	897 An event may be one of the following strings:
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	898 <list type="tag">
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	899
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	900 <tag-name><literal>exit</literal></tag-name>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	901 <tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	902 is called before the VM is destroyed.
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	903 The callback is called without arguments.
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	904 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	905
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	906 </list>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	907 </tag-desc>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	908
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	909 </list>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	910 </para>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	911
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	912 </section>
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	913
68c0566a375f Documented njs global object in njs Refernce. Yaroslav Zhuravlev <yar@nginx.com> parents: 2665 diff changeset	914
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	915 <section id="process" name="process">
2405 dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	916
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	917 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	918 The <literal>process</literal> object is a global object
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	919 that provides information about the current process
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	920 (<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	921 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	922
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	923 <para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	924 <list type="tag">
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	925
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	926 <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	927 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	928 Returns an array that contains the command line arguments
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	929 passed when the current process was launched.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	930 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	931
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	932 <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	933 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	934 Returns an object containing the user environment.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	935 <note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	936 By default, nginx removes all environment variables inherited
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	937 from its parent process except the TZ variable.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	938 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	939 to preserve some of the inherited variables.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	940 </note>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	941 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	942
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	943 <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	944 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	945 Returns the PID of the current process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	946 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	947
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	948 <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	949 <tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	950 Returns the PID of the current parent process.
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	951 </tag-desc>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	952
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	953 </list>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	954 </para>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	955
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	956 </section>
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	957
dbf68c949522 Documented the "process" global object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2394 diff changeset	958
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	959 <section id="string" name="String">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	960
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	961 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	962 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	963 a byte string.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	964 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	965
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	966 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	967 A Unicode string corresponds to an ECMAScript string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	968 which contains Unicode characters.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	969 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	970
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	971 <para>
2315 ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	972 Byte strings contain a sequence of bytes
ae56e4613280 Corrected language in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2313 diff changeset	973 and are used to serialize Unicode strings
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	974 to external data and deserialize from external sources.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	975 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	976 a Unicode string to a byte string using UTF8 encoding:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	977 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	978 >> '£'.toUTF8().toString('hex')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	979 '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	980 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	981 The <link id="string_tobytes">toBytes()</link> method serializes
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	982 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	983 otherwise, <literal>null</literal> is returned:
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	984 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	985 >> '£'.toBytes().toString('hex')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	986 '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	987 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	988
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	989 <list type="tag">
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	990
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	991 <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	992 \| <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	993 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	994 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	995 or from an encoded string
2337 867fe207f13e Updated links to changes.xml in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	996 (<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	997 The encoding can be
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	998 <literal>hex</literal>,
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	999 <literal>base64</literal>, and
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	1000 <literal>base64url</literal>.
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	1001 The method is deprecated since
0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	1002 <link doc="changes.xml" id="njs0.4.4">0.4.4</link>,
0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	1003 the <literal>Buffer.from</literal> method should be used instead:
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	1004 <example>
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	1005 >> Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]).toString()
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	1006 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	1007
2605 0ec1e1b063d7 Deprecated String.bytesFrom method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2604 diff changeset	1008 >> Buffer.from('YnVmZmVy', 'base64').toString()
2211 660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	1009 'buffer'
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	1010 </example>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	1011 </tag-desc>
660229c5c92f Documented String.bytesFrom() method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2207 diff changeset	1012
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	1013 <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	1014 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1015 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	1016 Returns a new Unicode string from a byte string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1017 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	1018 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1019
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	1020 <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	1021 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1022 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	1023 Converts a byte string containing a valid UTF8 string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1024 into a Unicode string,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1025 otherwise <literal>null</literal> is returned.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1026 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1027
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	1028 <tag-name id="string_tobytes"><literal>String.prototype.toBytes(<value>start</value>[,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	1029 <value>end</value>])</literal></tag-name>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1030 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	1031 Serializes a Unicode string to a byte string.
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1032 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	1033 found in the string.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1034 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1035
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	1036 <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	1037 <tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1038 <para>
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	1039 Encodes a string to
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1040 <literal>hex</literal>,
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1041 <literal>base64</literal>, or
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	1042 <literal>base64url</literal>:
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	1043 <example>
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	1044 >> 'αβγδ'.toString('base64url')
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	1045 'zrHOss6zzrQ'
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	1046 </example>
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	1047 Before version <link doc="changes.xml" id="njs0.4.3">0.4.3</link>,
e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	1048 only a <link id="string_tobytes">byte string</link> could be encoded:
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1049 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1050 >> 'αβγδ'.toUTF8().toString('base64url')
2214 e029f4bc7ede Added quotes to njs examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2212 diff changeset	1051 'zrHOss6zzrQ'
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1052 </example>
2582 e162a71453b0 Improved String.prototype.toString() for ordinary strings in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2579 diff changeset	1053 </para>
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1054 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1055
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1056 <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	1057 <value>end</value>])</literal></tag-name>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1058 <tag-desc>
2569 2edc64c05b0e Removed ECMAScript methods from njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2564 diff changeset	1059 Serializes a Unicode string
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1060 to a byte string using UTF8 encoding.
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1061 <example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1062 >> 'αβγδ'.toUTF8().length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1063 8
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1064 >> 'αβγδ'.length
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1065 4
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1066 </example>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1067 </tag-desc>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1068
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1069 </list>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1070 </para>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1071
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1072 </section>
8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1073
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1074 </section>
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1075
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1076
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1077 <section id="webapi" name="web API">
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1078
2186 8e2b3aadc3ce Added njs String object. Yaroslav Zhuravlev <yar@nginx.com> parents: 2183 diff changeset	1079
2585 7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1080 <section id="textdecoder" name="Text Decoder">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1081
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1082 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1083 The <literal>TextDecoder</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1084 produces a stream of code points
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1085 from a stream of bytes
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1086 (<link doc="changes.xml" id="njs0.4.3">0.4.3</link>).
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1087 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1088
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1089 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1090 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1091
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1092 <tag-name><literal>TextDecoder([[<value>encoding</value>],
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1093 <value>options</value>])</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1094 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1095 Creates a new <literal>TextDecoder</literal> object
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1096 for specified <literal>encoding</literal>,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1097 currently, only UTF-8 is supported.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1098 The <literal>options</literal> is
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1099 <literal>TextDecoderOptions</literal> dictionary with the property:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1100
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1101 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1102
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1103 <tag-name><literal>fatal</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1104 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1105 boolean flag indicating if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1106 <link id="textdecoder_decode"><literal>TextDecoder.decode()</literal></link>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1107 must throw the <value>TypeError</value> exception when
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1108 a coding error is found, by default is <literal>false</literal>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1109 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1110
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1111 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1112 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1113
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1114 <tag-name id="textdecoder_encoding"><literal>TextDecoder.prototype.encoding</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1115 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1116 Returns a string with the name of the encoding used by
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1117 <link id="textdecoder"><literal>TextDecoder()</literal></link>,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1118 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1119 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1120
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1121 <tag-name id="textdecoder_fatal"><literal>TextDecoder.prototype.fatal</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1122 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1123 boolean flag, <literal>true</literal> if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1124 the error mode is fatal,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1125 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1126 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1127
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1128 <tag-name id="textdecoder_ignorebom"><literal>TextDecoder.prototype.ignoreBOM</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1129 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1130 boolean flag, <literal>true</literal> if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1131 the byte order marker is ignored,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1132 read-only.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1133 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1134
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1135 <tag-name id="textdecoder_decode"><literal>TextDecoder.prototype.decode(<value>buffer</value>,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1136 [<value>options</value>])</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1137 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1138 Returns a string with the text
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1139 decoded from the <literal>buffer</literal> by
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1140 <link id="textdecoder"><literal>TextDecoder()</literal></link>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1141 The buffer can be <literal>ArrayBuffer</literal>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1142 The <literal>options</literal> is
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1143 <literal>TextDecodeOptions</literal> dictionary with the property:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1144
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1145 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1146
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1147 <tag-name><literal>stream</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1148 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1149 boolean flag indicating if
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1150 additional data will follow in subsequent calls to <literal>decode()</literal>:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1151 <literal>true</literal> if processing the data in chunks, and
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1152 <literal>false</literal> for the final chunk
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1153 or if the data is not chunked.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1154 By default is <literal>false</literal>.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1155 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1156
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1157 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1158 <example>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1159 >> (new TextDecoder()).decode(new Uint8Array([206,177,206,178]))
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1160 αβ
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1161 </example>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1162 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1163
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1164 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1165 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1166
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1167 </section>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1168
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1169
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1170 <section id="textencoder" name="Text Encoder">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1171
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1172 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1173 The <literal>TextEncoder</literal> object
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1174 produces a byte stream with UTF-8 encoding
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1175 from a stream of code points
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1176 (<link doc="changes.xml" id="njs0.4.3">0.4.3</link>).
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1177 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1178
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1179 <para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1180 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1181
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1182 <tag-name><literal>TextEncoder()</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1183 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1184 Returns a newly constructed <literal>TextEncoder</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1185 that will generate a byte stream with UTF-8 encoding.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1186 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1187
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1188 <tag-name id="textencoder_encode"><literal>TextEncoder.prototype.encode(<value>string</value>)</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1189 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1190 Encodes <literal>string</literal> into a <literal>Uint8Array</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1191 with UTF-8 encoded text.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1192 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1193
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1194 <tag-name id="textencoder_encodeinto"><literal>TextEncoder.prototype.encodeInto(<value>string</value>,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1195 <value>uint8Array</value>)</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1196 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1197 Encodes a <literal>string</literal> to UTF-8,
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1198 puts the result into destination <literal>Uint8Array</literal>, and
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1199 returns a dictionary object that shows the progress of the encoding.
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1200 The dictionary object contains two members:
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1201
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1202 <list type="tag">
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1203
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1204 <tag-name><literal>read</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1205 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1206 the number of UTF-16 units of code from the source <literal>string</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1207 converted to UTF-8
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1208 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1209
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1210 <tag-name><literal>written</literal></tag-name>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1211 <tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1212 the number of bytes modified in the destination <literal>Uint8Array</literal>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1213 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1214
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1215 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1216 </tag-desc>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1217
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1218 </list>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1219 </para>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1220
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1221 </section>
7035221dbe37 Documented TextDecoder and TextEncoder in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2583 diff changeset	1222
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1223 </section>
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1224
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1225
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1226 <section id="njs_api_timers" name="timers">
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1227
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1228 <para>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1229 <list type="tag">
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1230
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1231 <tag-name id="cleartimeout"><literal>clearTimeout(<value>timeout</value>)</literal></tag-name>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1232 <tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1233 Cancels a <literal>timeout</literal> object
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	1234 created by <link id="settimeout"><literal>setTimeout()</literal></link>.
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1235 </tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1236
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1237 <tag-name id="settimeout"><literal>setTimeout(<value>function</value>,
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	1238 <value>milliseconds</value>[,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	1239 <value>argument1</value>,
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	1240 <value>argumentN</value>])</literal></tag-name>
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1241 <tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1242 Calls a <literal>function</literal>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1243 after a specified number of <literal>milliseconds</literal>.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1244 One or more optional <literal>arguments</literal>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1245 can be passed to the specified function.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1246 Returns a <literal>timeout</literal> object.
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1247 <example>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1248 function handler(v)
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1249 {
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1250 // ...
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1251 }
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1252
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1253 t = setTimeout(handler, 12);
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1254
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1255 // ...
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1256
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1257 clearTimeout(t);
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1258 </example>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1259 </tag-desc>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1260
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1261 </list>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1262 </para>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1263
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1264 </section>
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1265
2687 7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1266
7ff9d8bda757 Revised TOC in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2685 diff changeset	1267 <section id="builtin_modules" name="built-in modules">
2578 fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1268
fafb7767c128 Restructured njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2571 diff changeset	1269
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1270 <section id="buffer" name="Buffer">
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1271
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1272 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1273 <list type="tag">
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1274
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1275 <tag-name id="buffer_alloc"><literal>Buffer.alloc(<value>size</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1276 <value>fill</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1277 <value>encoding</value>]]))</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1278 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1279 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1280 Allocates a new Buffer of a specified <value>size</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1281 If <value>fill</value> is not specified, the Buffer will be zero-filled.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1282 If <value>fill</value> is specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1283 the allocated Buffer will be initialized by calling
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1284 <link id="buf_fill"><literal>buf.fill(fill)</literal></link>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1285 If <value>fill</value> and <value>encoding</value> are specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1286 the allocated Buffer will be initialized by calling
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1287 <link id="buf_fill"><literal>buf.fill(fill,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1288 encoding)</literal></link>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1289 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1290
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1291 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1292 The <value>fill</value> parameter may be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1293 <value>string</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1294 <value>Buffer</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1295 <value>Uint8Array</value>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1296 <value>integer</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1297 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1298 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1299
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1300 <tag-name id="buffer_alloc_unsafe"><literal>Buffer.allocUnsafe(<value>size</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1301 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1302 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1303 The same as
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1304 <link id="buffer_alloc"><literal>Buffer.alloc()</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1305 with the difference that the memory allocated for the buffer is not initialized,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1306 the contents of the new buffer is unknown and may contain sensitive data.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1307 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1308 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1309
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1310 <tag-name id="buffer_bytelength"><literal>Buffer.byteLength(<value>value</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1311 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1312 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1313 Returns the byte length of a specified value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1314 when encoded using <value>encoding</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1315 The value can be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1316 <literal>string</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1317 <literal>Buffer</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1318 <literal>TypedArray</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1319 <literal>DataView</literal>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1320 <literal>ArrayBuffer</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1321 If the value is a <value>string</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1322 the <literal>encoding</literal> parameter is its encoding, can be
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	1323 <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1324 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1325 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1326 <value>base64url</value>;
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	1327 by default is <value>utf8</value>.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1328 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1329
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1330 <tag-name id="buffer_compare"><literal>Buffer.compare(<value>buffer1</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1331 <value>buffer2</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1332 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1333 Compares <value>buffer1</value> with <value>buffer2</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1334 when sorting arrays of Buffer instances.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1335 Returns
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1336 <literal>0</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1337 <value>buffer1</value> is the same as <value>buffer2</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1338 <literal>1</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1339 <value>buffer2</value> should come before <value>buffer1</value> when sorted, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1340 <literal>-1</literal> if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1341 <value>buffer2</value> should come after <value>buffer1</value> when sorted.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1342 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1343
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1344 <tag-name id="buffer_concat"><literal>Buffer.concat(<value>list</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1345 <value>totalLength</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1346 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1347 Returns a new Buffer
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1348 which is the result of concatenating all the Buffer instances in the list.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1349 If there are no items in the list or the total length is 0,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1350 a new zero-length Buffer is returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1351 If <value>totalLength</value> is not specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1352 it is calculated from the Buffer instances in list by adding their lengths.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1353 If <value>totalLength</value> is specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1354 it is coerced to an unsigned integer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1355 If the combined length of the Buffers in list exceeds
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1356 <value>totalLength</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1357 the result is truncated to <value>totalLength</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1358 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1359
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1360 <tag-name id="buffer_from_array"><literal>Buffer.from(<value>array</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1361 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1362 Allocates a new Buffer using an array of bytes
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1363 in the range <literal>0</literal> – <literal>255</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1364 Array entries outside that range will be truncated.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1365 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1366
2612 6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	1367 <tag-name id="buffer_from_arraybuffer"><literal>Buffer.from(<value>arrayBuffer</value>,
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	1368 <value>byteOffset</value>[,
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	1369 <value>length</value>]])</literal></tag-name>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	1370 <tag-desc>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	1371 Creates a view of the <value>ArrayBuffer</value>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	1372 without copying the underlying memory.
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	1373 The optional <value>byteOffset</value> and <value>length</value> arguments
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	1374 specify a memory range within the <value>arrayBuffer</value>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	1375 that will be shared by the Buffer.
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	1376 </tag-desc>
6fdefb00858f Documented Buffer.from(arrayBuffer) method in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2609 diff changeset	1377
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1378 <tag-name id="buffer_from_buffer"><literal>Buffer.from(<value>buffer</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1379 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1380 Copies the passed buffer data onto a new Buffer instance.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1381 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1382
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1383 <tag-name id="buffer_from_object"><literal>Buffer.from(<value>object</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1384 <value>offsetOrEncoding</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1385 <value>length</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1386 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1387 For objects whose <literal>valueOf()</literal> function
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1388 returns a value not strictly equal to object,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1389 returns
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1390 <literal>Buffer.from(object.valueOf()</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1391 <literal>offsetOrEncoding</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1392 <literal>length</literal>).
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1393 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1394
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1395 <tag-name id="buffer_from_string"><literal>Buffer.from(<value>string</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1396 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1397 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1398 Creates a new Buffer with a <value>string</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1399 The <value>encoding</value> parameter identifies the character encoding
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1400 to be used when converting a string into bytes.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1401 The encoding can be
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	1402 <literal>utf8</literal>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1403 <literal>hex</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1404 <literal>base64</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1405 <literal>base64url</literal>;
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	1406 by default is <literal>utf8</literal>.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1407 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1408
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1409 <tag-name id="buffer_is_buffer"><literal>Buffer.isBuffer(<value>object</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1410 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1411 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1412 returns <literal>true</literal> if <value>object</value> is a Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1413 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1414
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1415 <tag-name id="buffer_is_encoding"><literal>Buffer.isEncoding(<value>encoding</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1416 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1417 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1418 returns <literal>true</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1419 if encoding is the name of a supported character encoding.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1420 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1421
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1422 <tag-name id="buf_index"><literal>buffer[<value>index</value>]</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1423 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1424 The index operator that can be used to get and set the octet
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1425 at position <literal>index</literal> in <literal>buffer</literal>.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1426 The values refer to individual bytes,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1427 so the legal value range is between 0 and 255 (decimal).
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1428 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1429
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1430 <tag-name id="buf_buffer"><literal>buf.buffer</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1431 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1432 The underlying <literal>ArrayBuffer</literal> object
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1433 based on which this Buffer object is created.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1434 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1435
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1436 <tag-name id="buf_byte_offset"><literal>buf.byteOffset</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1437 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1438 An integer,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1439 specifying the <literal>byteOffset</literal> of the Buffers
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1440 underlying <literal>ArrayBuffer</literal> object.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1441 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1442
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1443 <tag-name id="buf_compare"><literal>buf.compare(<value>target</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1444 <value>targetStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1445 <value>targetEnd</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1446 <value>sourceStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1447 <value>sourceEnd</value>]]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1448 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1449 Compares buffer with <value>target</value> and returns a number
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1450 indicating whether buffer comes before, after, or is the same
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1451 as <value>target</value> in sort order.
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1452 Comparison is based on the actual sequence of bytes in each Buffer.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1453 The <literal>targetStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1454 the offset within <value>target</value> at which to begin comparison,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1455 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1456 The <literal>targetEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1457 the offset within <value>target</value> at which to end comparison,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1458 by default is <literal>target.length</literal>.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1459 The <literal>sourceStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1460 the offset within buffer at which to begin comparison,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1461 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1462 The <literal>sourceEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1463 the offset within buffer at which to end comparison (not inclusive),
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1464 by default is <literal>buf.length</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1465 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1466
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1467 <tag-name id="buf_copy"><literal>buf.copy(<value>target</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1468 <value>targetStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1469 <value>sourceStart</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1470 <value>sourceEnd</value>]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1471 <tag-desc>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1472 Copies data from a region of buffer to a region in <value>target</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1473 even if the target memory region overlaps with buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1474 The <literal>target</literal> parameter is a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1475 <value>Buffer</value> or <value>Uint8Array</value> to copy into.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1476
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1477 <para>
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1478 The <literal>targetStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1479 the offset within target at which to begin writing,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1480 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1481 The <literal>sourceStart</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1482 the offset within buffer from which to begin copying,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1483 by default is 0.
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1484 The <literal>sourceEnd</literal> is an integer specifying
0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1485 the offset within buffer at which to stop copying (not inclusive)
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1486 by default is <value>buf.length</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1487 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1488 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1489
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1490 <tag-name id="buf_equals"><literal>buf.equals(<value>otherBuffer</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1491 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1492 A boolean value,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1493 returns <literal>true</literal> if both Buffer and <value>otherBuffer</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1494 have exactly the same bytes.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1495 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1496
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1497 <tag-name id="buf_fill"><literal>buf.fill(<value>value</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1498 <value>offset</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1499 <value>end</value>]][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1500 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1501 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1502 Fills the Buffer with the specified <value>value</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1503 If the <value>offset</value> and <value>end</value> are not specified,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1504 the entire Buffer will be filled.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1505 The <value>value</value> is coerced to <value>uint32</value> if it is not a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1506 <literal>string</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1507 <literal>Buffer</literal>, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1508 <literal>integer</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1509 If the resulting integer is greater than 255,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1510 the Buffer will be filled with <value>value</value> and 255.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1511 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1512
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1513 <tag-name id="buf_includes"><literal>buf.includes(<value>value</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1514 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1515 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1516 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1517 Equivalent to
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1518 <link id="buf_indexof"><literal>buf.indexOf()</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1519 <literal>!== -1</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1520 returns <literal>true</literal> if the <value>value</value> was found
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1521 in Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1522 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1523
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1524 <tag-name id="buf_indexof"><literal>buf.indexOf(<value>value</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1525 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1526 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1527 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1528 Returns an integer which is the index of the first occurrence of
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1529 <value>value</value> in Buffer, or <value>-1</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1530 if Buffer does not contain value.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1531 The <value>value</value> can be a
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1532 <literal>string</literal> with specified <value>encoding</value>
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	1533 (by default <value>utf8</value>),
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1534 <literal>Buffer</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1535 <literal>Unit8Array</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1536 or a number between 0 and 255.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1537 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1538
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1539 <tag-name id="buf_lastindexof"><literal>buf.lastIndexOf(<value>value</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1540 <value>byteOffset</value>][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1541 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1542 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1543 The same as
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1544 <link id="buf_indexof"><literal>buf.indexOf()</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1545 except the last occurrence of the <value>value</value> is found
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1546 instead of the first occurrence.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1547 The <value>value</value> can be a string, Buffer, or
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1548 integer between 1 and 255.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1549 If the <value>value</value> is an empty string or empty Buffer,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1550 <literal>byteOffset</literal> will be returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1551 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1552
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1553 <tag-name id="buf_length"><literal>buf.length</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1554 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1555 Returns the number of bytes in Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1556 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1557
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1558 <tag-name id="buf_readintbe"><literal>buf.readIntBE(<value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1559 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1560 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1561 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1562 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1563 and interprets the result as a big-endian,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1564 two's complement signed value supporting up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1565 The <value>byteLength</value> parameter is an integer between 1 and 6
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1566 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1567 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1568 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1569 <literal>buf.readInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1570 <literal>buf.readInt16BE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1571 <literal>buf.readInt32BE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1572 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1573 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1574
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1575 <tag-name id="buf_readintle"><literal>buf.readIntLE(<value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1576 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1577 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1578 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1579 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1580 and interprets the result as a little-endian,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1581 two's complement signed value supporting up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1582 The <value>byteLength</value> parameter is an integer between 1 and 6
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1583 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1584 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1585 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1586 <literal>buf.readInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1587 <literal>buf.readInt16LE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1588 <literal>buf.readInt32LE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1589 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1590 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1591
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1592 <tag-name id="buf_readuintbe"><literal>buf.readUIntBE(<value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1593 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1594 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1595 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1596 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1597 and interprets the result as a big-endian
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1598 integer supporting up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1599 The <value>byteLength</value> parameter is an integer between 1 and 6
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1600 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1601 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1602 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1603 <literal>buf.readUInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1604 <literal>buf.readUInt16BE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1605 <literal>buf.readUInt32BE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1606 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1607 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1608
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1609 <tag-name id="buf_readuintle"><literal>buf.readUIntLE(<value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1610 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1611 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1612 Reads the <value>byteLength</value> from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1613 at the specified <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1614 and interprets the result as a little-endian
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1615 integer supporting up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1616 The <value>byteLength</value> parameter is an integer between 1 and 6
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1617 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1618 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1619 The similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1620 <literal>buf.readUInt8([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1621 <literal>buf.readUInt16LE([offset])</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1622 <literal>buf.readUInt32LE([offset])</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1623 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1624 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1625
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1626 <tag-name id="buf_readdobulebe"><literal>buf.readDoubleBE</literal>([<value>offset</value>])</tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1627 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1628 Reads a 64-bit, big-endian double from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1629 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1630 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1631
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1632 <tag-name id="buf_readdobulele"><literal>buf.readDoubleLE</literal>([<value>offset</value>])</tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1633 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1634 Reads a 64-bit, little-endian double from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1635 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1636 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1637
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1638 <tag-name id="buf_readfloatbe"><literal>buf.readFloatBE</literal>([<value>offset</value>])</tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1639 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1640 Reads a 32-bit, big-endian float from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1641 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1642 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1643
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1644 <tag-name id="buf_readfloatle"><literal>buf.readFloatLE</literal>([<value>offset</value>])</tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1645 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1646 Reads a 32-bit, little-endian float from <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1647 at the specified <value>offset</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1648 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1649
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1650 <tag-name id="buf_subarray"><literal>buf.subarray[<value>start</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1651 <value>end</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1652 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1653 Returns a new <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1654 that references the same memory as the original,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1655 but offset and cropped by
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1656 <value>start</value> and <value>end</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1657 If <value>end</value> is greater than
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1658 <link id="buf_length"><literal>buf.length</literal></link>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1659 the same result as that of end equal to
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1660 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1661 is returned.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1662 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1663
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1664 <tag-name id="buf_slice"><literal>buf.slice[<value>start</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1665 <value>end</value>]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1666 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1667 Returns a new <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1668 that references the same memory as the original,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1669 but offset and cropped by the
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1670 <value>start</value> and <value>end</value> values.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1671 The method is not compatible with the
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1672 <literal>Uint8Array.prototype.slice()</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1673 which is a superclass of Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1674 To copy the slice, use
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1675 <literal>Uint8Array.prototype.slice()</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1676 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1677
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1678 <tag-name id="buf_swap16"><literal>buf.swap16</literal>()</tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1679 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1680 Interprets <literal>buf</literal> as an array of unsigned 16-bit numbers
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1681 and swaps the byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1682 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1683 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1684 is not a multiple of 2.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1685 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1686
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1687 <tag-name id="buf_swap32"><literal>buf.swap32</literal>()</tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1688 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1689 Interprets <literal>buf</literal> as an array of unsigned 32-bit numbers
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1690 and swaps the byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1691 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1692 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1693 is not a multiple of 4.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1694 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1695
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1696 <tag-name id="buf_swap64"><literal>buf.swap64</literal>()</tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1697 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1698 Interprets <literal>buf</literal> as an array of 64-bit numbers
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1699 and swaps byte order in-place.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1700 Throws an error if
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1701 <link id="buf_length"><literal>buf.length</literal></link>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1702 is not a multiple of 8.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1703 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1704
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1705 <tag-name id="buf_tojson"><literal>buf.toJSON</literal>()</tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1706 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1707 Returns a JSON representation of <literal>buf.</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1708 <literal>JSON.stringify()</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1709 implicitly calls this function when stringifying a Buffer instance.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1710 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1711
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1712 <tag-name id="buf_tostring"><literal>buf.toString([<value>encoding</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1713 <value>start</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1714 <value>end</value>]]])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1715 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1716 Decodes <literal>buf</literal> to a string
2647 0085d9f7dc3f Minor corrections in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2631 diff changeset	1717 according to the specified character <value>encoding</value>
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	1718 which can be <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1719 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1720 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1721 <value>base64url</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1722 The <value>start</value> and <value>end</value> parameters
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1723 may be passed to decode only a subset of Buffer.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1724 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1725
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1726 <tag-name id="buf_write"><literal>buf.write(<value>string</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1727 <value>offset</value>[,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1728 <value>length</value>]][,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1729 <value>encoding</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1730 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1731 Writes a <value>string</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1732 at <value>offset</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1733 according to the character <value>encoding</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1734 The <value>length</value> parameter is the number of bytes to write.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1735 If Buffer did not contain enough space to fit the entire string,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1736 only part of string will be written,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1737 however, partially encoded characters will not be written.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1738 The <value>encoding</value> can be
2631 7da360f50017 Unified spelling of "utf-8" in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2630 diff changeset	1739 <value>utf8</value>,
2609 99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1740 <value>hex</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1741 <value>base64</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1742 <value>base64url</value>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1743 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1744
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1745 <tag-name id="buf_writeintbe"><literal>buf.writeIntBE(<value>value</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1746 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1747 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1748 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1749 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1750 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1751 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1752 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1753 The <value>byteLength</value> parameter is an integer between 1 and 6
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1754 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1755 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1756 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1757 <literal>buf.writeInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1758 <literal>buf.writeInt16BE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1759 <literal>buf.writeInt32BE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1760 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1761 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1762
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1763 <tag-name id="buf_writeintle"><literal>buf.writeIntLE(<value>value</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1764 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1765 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1766 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1767 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1768 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1769 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1770 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1771 The <value>byteLength</value> parameter is an integer between 1 and 6
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1772 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1773 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1774 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1775 <literal>buf.writeInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1776 <literal>buf.writeInt16LE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1777 <literal>buf.writeInt32LE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1778 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1779 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1780
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1781 <tag-name id="buf_writeuintbe"><literal>buf.writeUIntBE(<value>value</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1782 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1783 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1784 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1785 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1786 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1787 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1788 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1789 The <value>byteLength</value> parameter is an integer between 1 and 6
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1790 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1791 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1792 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1793 <literal>buf.writeUInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1794 <literal>buf.writeUInt16BE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1795 <literal>buf.writeUInt32BE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1796 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1797 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1798
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1799 <tag-name id="buf_writeuintle"><literal>buf.writeUIntLE(<value>value</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1800 <value>offset</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1801 <value>byteLength</value>)</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1802 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1803 Writes <value>byteLength</value> bytes of <value>value</value>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1804 to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1805 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1806 Supports up to 48 bits of accuracy.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1807 The <value>byteLength</value> parameter is an integer between 1 and 6
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1808 specifying the number of bytes to read.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1809 <para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1810 The following similar methods are also supported:
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1811 <literal>buf.writeUInt8</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1812 <literal>buf.writeUInt16LE</literal>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1813 <literal>buf.writeUInt32LE</literal>.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1814 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1815 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1816
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1817 <tag-name id="buf_writedoublebe"><literal>buf.writeDoubleBE(<value>value</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1818 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1819 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1820 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1821 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1822 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1823
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1824 <tag-name id="buf_writedoublele"><literal>buf.writeDoubleLE(<value>value</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1825 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1826 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1827 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1828 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1829 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1830
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1831 <tag-name id="buf_writefloatbe"><literal>buf.writeFloatBE(<value>value</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1832 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1833 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1834 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1835 at the specified <value>offset</value> as big-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1836 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1837
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1838 <tag-name id="buf_writefloatle"><literal>buf.writeFloatLE(<value>value</value>,
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1839 [<value>offset</value>])</literal></tag-name>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1840 <tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1841 Writes the <value>value</value> to <literal>buf</literal>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1842 at the specified <value>offset</value> as little-endian.
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1843 </tag-desc>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1844
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1845 </list>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1846 </para>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1847
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1848 </section>
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1849
99bd2ae8d2be Added Buffer to njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2605 diff changeset	1850
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1851 <section id="crypto" name="Crypto">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1852
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1853 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1854 The Crypto module provides cryptographic functionality support.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1855 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	1856 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1857
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1858 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1859 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1860
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	1861 <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	1862 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1863 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	1864 that can be used to generate hash digests
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1865 using the given <value>algorithm</value>.
2496 9dddac1420fe Fixed typo in njs reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2484 diff changeset	1866 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1867 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1868 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1869 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1870 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1871
2267 c30048802769 Added links to njs reference from njs Compatibility. Yaroslav Zhuravlev <yar@nginx.com> parents: 2259 diff changeset	1872 <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	1873 <value>secret key</value>)</literal></tag-name>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1874 <tag-desc>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	1875 Creates and returns an <link id="crypto_hmac">HMAC</link> object that uses
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	1876 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	1877 The algorithm can be
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1878 <literal>md5</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1879 <literal>sha1</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1880 <literal>sha256</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1881 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1882
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1883 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1884 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1885
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1886
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1887 <section id="crypto_hash" name="Hash">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1888
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1889 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1890 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1891
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	1892 <tag-name id="crypto_hash_update"><literal>hash.update(<value>data</value>)</literal></tag-name>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1893 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1894 Updates the hash content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1895 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1896
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	1897 <tag-name id="crypto_hash_digest"><literal>hash.digest([<value>encoding</value>])</literal></tag-name>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1898 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1899 Calculates the digest of all of the data passed using
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1900 <literal>hash.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1901 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1902 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1903 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1904 <literal>base64url</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	1905 If encoding is not provided, a Buffer object
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	1906 (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>) is returned.
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	1907 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	1908 Before version (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>),
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	1909 a byte string was returned instead of a Buffer object.
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	1910 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1911 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1912
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1913 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1914 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1915
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1916 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1917 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1918 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1919 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1920
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1921 >> 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	1922 'BtlFlCqiamG-GMPiK_GbvKjdK10'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1923 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1924 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1925
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1926 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1927
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1928
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1929 <section id="crypto_hmac" name="HMAC">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1930
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1931 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1932 <list type="tag">
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1933
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	1934 <tag-name id="crypto_hmac_update"><literal>hmac.update(<value>data</value>)</literal></tag-name>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1935 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1936 Updates the HMAC content with the given <value>data</value>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1937 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1938
2601 5528961da54d njs-0.4.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2585 diff changeset	1939 <tag-name id="crypto_hmac_digest"><literal>hmac.digest([<value>encoding</value>])</literal></tag-name>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1940 <tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1941 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	1942 <literal>hmac.update()</literal>.
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1943 The encoding can be
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1944 <literal>hex</literal>,
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1945 <literal>base64</literal>, and
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1946 <literal>base64url</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	1947 If encoding is not provided, a Buffer object
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	1948 (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>) is returned.
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	1949 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	1950 Before version <link doc="changes.xml" id="njs0.4.4">0.4.4</link>,
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	1951 a byte string was returned instead of a Buffer object.
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	1952 </note>
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1953 </tag-desc>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1954 </list>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1955 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1956
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1957 <para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1958 <example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1959 >> var cr = require('crypto')
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1960 undefined
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1961
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1962 >> 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	1963 'Oglm93xn23_MkiaEq_e9u8zk374'
2177 79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1964 </example>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1965 </para>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1966
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1967 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1968
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1969 </section>
79297494d291 Added njs Crypto API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2176 diff changeset	1970
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1971
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1972 <section id="njs_api_fs" name="File System">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1973
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1974 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1975 The File System module provides operations with files.
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1976 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1977
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1978 <para>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1979 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	1980 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	1981 promissified versions of file system methods are available through
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1982 <literal>require('fs').promises</literal> object:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1983 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1984 > var fs = require('fs').promises;
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1985 undefined
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1986 > fs.readFile("/file/path").then((data)=>console.log(data))
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1987 <file data>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1988 </example>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1989 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	1990
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1991 <tag-name id="fs_accesssync"><literal>accessSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1992 <value>mode</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1993 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1994 Synchronously tests permissions for a file or directory
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1995 specified in the <literal>path</literal>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1996 (<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	1997 If the check fails, an error will be returned,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1998 otherwise, the method will return undefined.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	1999 <list type="tag">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2000
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2001 <tag-name><literal>mode</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2002 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2003 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	2004 The mode argument is an optional integer
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2005 that specifies the accessibility checks to be performed.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2006 <example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2007 try {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2008 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	2009 console.log('has access');
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2010 } catch (e) {
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2011 console.log('no access');)
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2012 }
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2013 </example>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2014 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2015
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2016 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2017 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2018
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	2019 <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	2020 <value>data</value>[, <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2021 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2022 Synchronously appends specified <literal>data</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2023 to a file with provided <literal>filename</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2024 The <literal>data</literal> is expected to be a string
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2025 or a Buffer object (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>).
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2026 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	2027 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2028 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2029 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2030
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2031 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2032 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2033 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2034 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2035
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2036 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2037 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2038 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	2039 by default is <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2040 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2041
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2042 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2043 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2044
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2045 <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	2046 <value>options</value>])</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2047 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2048 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	2049 (<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	2050 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	2051 <literal>integer</literal> that specifies
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2052 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	2053 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	2054 <list type="tag">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2055
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2056 <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	2057 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2058 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	2059 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2060
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2061 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2062 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2063
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2064 <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	2065 <value>options</value>])</literal></tag-name>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2066 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2067 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	2068 at the specified <literal>path</literal>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2069 (<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	2070 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	2071 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	2072 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	2073 <list type="tag">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2074
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2075 <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	2076 <tag-desc>
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2077 encoding, by default is <literal>utf8</literal>.
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2078 The encoding can be <literal>utf8</literal> and <literal>buffer</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2079 (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>).
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2080 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2081
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2082 <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	2083 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2084 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	2085 <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	2086 by default is <literal>false</literal>.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2087 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2088
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2089 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2090 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2091
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	2092 <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	2093 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2094 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2095 Synchronously returns the contents of the file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2096 with provided <literal>filename</literal>.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2097 The <literal>options</literal> parameter holds
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2098 <literal>string</literal> that specifies encoding.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2099 If an encoding is specified, a string is returned,
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2100 otherwise, a Buffer object
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2101 (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>) is returned.
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2102 <note>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2103 Before version <link doc="changes.xml" id="njs0.4.4">0.4.4</link>,
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2104 a <link id="string_tobytes">byte string</link> was returned
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2105 if encoding was not specified.
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2106 </note>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2107 Otherwise, <literal>options</literal> is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2108 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2109 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2110
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2111 <tag-name><literal>encoding</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2112 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2113 encoding, by default is not specified.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2114 The encoding can be <literal>utf8</literal>,
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2115 <literal>hex</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2116 (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>),
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2117 <literal>base64</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2118 (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>),
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2119 <literal>base64url</literal>
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2120 (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>).
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2121 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2122
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2123 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2124 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2125 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	2126 by default is <literal>r</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2127 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2128
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2129 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2130 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2131 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2132 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2133 >> var file = fs.readFileSync('/file/path.tar.gz')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2134 undefined
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2135 >> var gzipped = file.slice(0,2).toString('hex') === '1f8b'; gzipped
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2136 true
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2137 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2138 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2139
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2140 <tag-name id="fs_realpathsync"><literal>realpathSync(<value>path</value>[,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2141 <value>options</value>])</literal></tag-name>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2142 <tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2143 Synchronously computes the canonical pathname by resolving
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2144 <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	2145 <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	2146 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	2147 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	2148 to use for the path passed to the callback
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2149 (<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	2150 </tag-desc>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2151
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2152 <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	2153 <value>newPath</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2154 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2155 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	2156 <literal>oldPath</literal> to <literal>newPath</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2157 (<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	2158 <example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2159 >> var fs = require('fs')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2160 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2161 >> var file = fs.renameSync('hello.txt', 'HelloWorld.txt')
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2162 undefined
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2163 </example>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2164 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2165
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2166 <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	2167 <tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2168 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	2169 (<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	2170 </tag-desc>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2171
2509 827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2172 <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	2173 <value>path</value>)</literal></tag-name>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2174 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2175 Synchronously creates the link called <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2176 pointing to <literal>target</literal> using
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2177 <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	2178 (<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	2179 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	2180 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2181
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2182 <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	2183 <tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2184 Synchronously unlinks a file by <literal>path</literal>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2185 (<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	2186 </tag-desc>
827a6d7fe108 Reordered alphabetically njs file system methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2508 diff changeset	2187
2570 44792f1ee284 Added IDs to methods in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2569 diff changeset	2188 <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	2189 <value>data</value>[,
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2190 <value>options</value>])</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2191 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2192 Synchronously writes <literal>data</literal> to a file
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2193 with provided <literal>filename</literal>.
2604 a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2194 The <literal>data</literal> is expected to be a string
a29676472a11 Added Buffer object info to some njs methods. Yaroslav Zhuravlev <yar@nginx.com> parents: 2601 diff changeset	2195 or a Buffer object (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>).
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2196 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	2197 if the file exists, it will be replaced.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2198 The <literal>options</literal> parameter is expected to be
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2199 an object with the following keys:
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2200 <list type="tag">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2201 <tag-name><literal>mode</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2202 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2203 mode option, by default is <literal>0o666</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2204 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2205
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2206 <tag-name><literal>flag</literal></tag-name>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2207 <tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2208 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	2209 by default is <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2210 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2211
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2212 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2213 <example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2214 >> var fs = require('fs')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2215 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2216 >> var file = fs.writeFileSync('hello.txt', 'Hello world')
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2217 undefined
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2218 </example>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2219 </tag-desc>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2220
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2221 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2222 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2223
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2224
2563 428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2225 <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	2226
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2227 <para>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2228 <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	2229 a file or a subdirectory.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2230 When
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2231 <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	2232 is called with the
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2233 <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	2234 option,
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2235 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	2236
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2237 <list type= "bullet" compact="no">
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2238
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2239 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2240 <literal>dirent.isBlockDevice()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2241 <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	2242 a block device.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2243 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2244
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2245 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2246 <literal>dirent.isCharacterDevice()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2247 <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	2248 a character device.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2249 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2250
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2251 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2252 <literal>dirent.isDirectory()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2253 <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	2254 a file system directory.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2255 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2256
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2257 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2258 <literal>dirent.isFIFO()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2259 <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	2260 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	2261 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2262
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2263 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2264 <literal>dirent.isFile()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2265 <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	2266 a regular file.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2267 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2268
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2269 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2270 <literal>dirent.isSocket()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2271 <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	2272 a socket.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2273 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2274
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2275 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2276 <literal>dirent.isSymbolicLink()</literal>—returns
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2277 <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	2278 a symbolic link.
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2279 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2280
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2281 <listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2282 <literal>dirent.name</literal>—
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2283 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	2284 </listitem>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2285
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2286 </list>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2287 </para>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2288
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2289 </section>
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2290
428a8cf1911b Documented mkdirSync, readdirSync, rmdirSync, fs.Dirent in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2546 diff changeset	2291
2507 8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2292 <section id="access_const" name="File Access Constants">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2293
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2294 <para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2295 The <link id="fs_accesssync"><literal>access()</literal></link> method
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2296 can accept the following flags.
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2297 These flags are exported by <literal>fs.constants</literal>:
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2298
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2299 <list type= "bullet" compact="no">
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2300
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2301 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2302 <literal>F_OK</literal>—indicates that the file
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2303 is visible to the calling process,
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2304 used by default if no mode is specified
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2305 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2306
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2307 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2308 <literal>R_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2309 read by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2310 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2311
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2312 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2313 <literal>W_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2314 written by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2315 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2316
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2317 <listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2318 <literal>X_OK</literal>—indicates that the file can be
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2319 executed by the calling process
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2320 </listitem>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2321
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2322 </list>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2323 </para>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2324
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2325 </section>
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2326
8ad2ea80e0c2 njs-0.3.9 Yaroslav Zhuravlev <yar@nginx.com> parents: 2497 diff changeset	2327
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2328 <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	2329
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2330 <para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2331 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	2332
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2333 <list type= "bullet" compact="no">
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2334
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2335 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2336 <literal>a</literal>—open a file for appending.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2337 The file is created if it does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2338 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2339
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2340 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2341 <literal>ax</literal>—the same as <literal>a</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2342 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2343 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2344
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2345 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2346 <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	2347 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	2348 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2349
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2350 <listitem>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	2351 <literal>ax+</literal>—the same as <literal>a+</literal>
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2352 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2353 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2354
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2355 <listitem>
2579 63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	2356 <literal>as</literal>—open a file for appending
63cef7604e0d Minor review of njs Reference for typos and style. Yaroslav Zhuravlev <yar@nginx.com> parents: 2578 diff changeset	2357 in synchronous mode.
2204 001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2358 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	2359 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2360
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2361 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2362 <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	2363 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2364 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	2365 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2366
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2367 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2368 <literal>r</literal>—open a file for reading.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2369 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2370 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2371
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2372 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2373 <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	2374 An exception occurs if the file does not exist
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2375 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2376
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2377 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2378 <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	2379 in synchronous mode.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2380 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	2381 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2382
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2383 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2384 <literal>w</literal>—open a file for writing.
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2385 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	2386 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2387 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2388
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2389 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2390 <literal>wx</literal>—the same as <literal>w</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2391 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2392 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2393
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2394 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2395 <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	2396 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	2397 If the file exists, it will be replaced
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2398 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2399
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2400 <listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2401 <literal>wx+</literal>—the same as <literal>w+</literal>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2402 but fails if the file already exists
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2403 </listitem>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2404
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2405 </list>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2406 </para>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2407
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2408 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2409
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2410 </section>
001f2d905fd9 Documented fileSystem methods in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2203 diff changeset	2411
2583 cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2412
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2413 <section id="querystring" name="Query String">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2414
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2415 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2416 The Query String module provides support
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2417 for parsing and formatting URL query strings
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2418 (<link doc="changes.xml" id="njs0.4.3">0.4.3</link>).
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2419 The Query String module object is returned by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2420 <literal>require('querystring')</literal>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2421 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2422
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2423 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2424 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2425
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2426 <tag-name id="querystring_decode"><literal>querystring.decode()</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2427 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2428 is an alias for
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2429 <link id="querystring_parse"><literal>querystring.parse()</literal></link>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2430 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2431
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2432 <tag-name id="querystring_encode"><literal>querystring.encode()</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2433 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2434 is an alias for
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2435 <link id="querystring_stringify"><literal>querystring.stringify()</literal></link>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2436 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2437
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2438 <tag-name id="querystring_escape"><literal>querystring.escape(<value>string</value>)</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2439 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2440 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2441 Performs URL encoding of the given <literal>string</literal>,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2442 returns an escaped query string.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2443 The method is used by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2444 <link id="querystring_stringify"><literal>querystring.stringify()</literal></link>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2445 and should not be used directly.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2446 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2447 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2448
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2449 <tag-name id="querystring_parse"><literal>querystring.parse(<value>string</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2450 <value>separator</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2451 <value>equal</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2452 <value>options</value>]]])</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2453 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2454 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2455 Parses the query string URL and returns an object.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2456 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2457
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2458 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2459 The <literal>separator</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2460 for delimiting key and value pairs in the query string,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2461 by default is “<literal>&</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2462 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2463
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2464 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2465 The <literal>equal</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2466 for delimiting keys and values in the query string,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2467 by default is “<literal>=</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2468 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2469
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2470 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2471 The <literal>options</literal> parameter is expected to be
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2472 an object with the following keys:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2473 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2474 <tag-name><literal>decodeURIComponent</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2475 <value>function</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2476 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2477 Function used
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2478 to decode percent-encoded characters in the query string,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2479 by default is
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2480 <link id="querystring_unescape"><literal>querystring.unescape()</literal></link>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2481 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2482
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2483 <tag-name><literal>maxKeys</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2484 <value>number</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2485 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2486 the maximum number of keys to parse,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2487 by default is <literal>1000</literal>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2488 The <literal>0</literal> value removes limitations for counting keys.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2489 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2490
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2491 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2492 By default, percent-encoded characters within the query string are assumed
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2493 to use the UTF-8 encoding,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2494 invalid UTF-8 sequences will be replaced with
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2495 the <literal>U+FFFD</literal> replacement character.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2496 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2497
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2498 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2499 For example, for the following query string
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2500 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2501 'foo=bar&abc=xyz&abc=123'
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2502 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2503 the output will be:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2504 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2505 {
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2506 foo: 'bar',
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2507 abc: ['xyz', '123']
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2508 }
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2509 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2510 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2511
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2512 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2513
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2514 <tag-name id="querystring_stringify"><literal>querystring.stringify(<value>object</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2515 <value>separator</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2516 <value>equal</value>[,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2517 <value>options</value>]]])</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2518 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2519 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2520 Serializes an object and returns a URL query string.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2521 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2522
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2523 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2524 The <literal>separator</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2525 for delimiting key and value pairs in the query string,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2526 by default is “<literal>&</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2527 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2528
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2529 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2530 The <literal>equal</literal> parameter is a substring
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2531 for delimiting keys and values in the query string,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2532 by default is “<literal>=</literal>”.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2533 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2534
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2535 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2536 The <literal>options</literal> parameter is expected to be
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2537 an object with the following keys:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2538 <list type="tag">
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2539 <tag-name><literal>encodeURIComponent</literal>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2540 <value>function</value></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2541 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2542 The function to use when converting
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2543 URL-unsafe characters to percent-encoding in the query string,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2544 by default is
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2545 <link id="querystring_escape"><literal>querystring.escape()</literal></link>.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2546 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2547
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2548 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2549 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2550
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2551 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2552 By default, characters that require percent-encoding within the query string
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2553 are encoded as UTF-8.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2554 If other encoding is required, then
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2555 <literal>encodeURIComponent</literal> option should be specified.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2556 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2557
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2558 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2559 For example, for the following command
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2560 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2561 querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], 123: '' });
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2562 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2563 the query string will be:
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2564 <example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2565 'foo=bar&baz=qux&baz=quux&123='
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2566 </example>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2567 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2568
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2569 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2570
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2571 <tag-name id="querystring_unescape"><literal>querystring.unescape(<value>string</value>)</literal></tag-name>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2572 <tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2573 <para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2574 Performs decoding of URL percent-encoded characters
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2575 of the <literal>string</literal>,
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2576 returns an unescaped query string.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2577 The method is used by
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2578 <link id="querystring_parse"><literal>querystring.parse()</literal></link>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2579 and should not be used directly.
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2580 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2581 </tag-desc>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2582
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2583 </list>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2584 </para>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2585
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2586 </section>
cd97adddd757 Documented Query String in njs Reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2582 diff changeset	2587
2176 95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	2588 </section>
95b406f1f347 Added njs JSON API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2175 diff changeset	2589
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	2590 </article>

Mercurial > hg > nginx-site

annotate xml/en/docs/njs/reference.xml @ 2687:7ff9d8bda757